Add support for displaying relative dates

[tig.git] / tigrc.5.txt

diff --git a/tigrc.5.txt b/tigrc.5.txt
index 8b9628f030152f09f3a6523c455809481a9d416e..3ead320ee54e3bc4d05f4526e1ea226cf22595f8 100644 (file)
--- a/tigrc.5.txt
+++ b/tigrc.5.txt
@@ -9,11 +9,9 @@ tigrc - tig configuration file
 SYNOPSIS
 --------
 [verse]
-.............................................................................
 *set*   'variable' *=* 'value'
 *bind*  'keymap' 'key' 'action'
 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
-.............................................................................
 
 
 DESCRIPTION
@@ -38,14 +36,13 @@ A few selective variables can be configured via the set command. The syntax
 is:
 
 [verse]
-..............................................................................
 *set* variables *=* value
-..............................................................................
 
 Examples:
 
 --------------------------------------------------------------------------
 set show-author = yes          # Show author?
+set show-date = relative       # Show relative commit date.
 set show-rev-graph = yes       # Show revision graph?
 set show-refs = yes            # Show references?
 set show-line-numbers = no     # Show line numbers?
@@ -90,14 +87,19 @@ Variables
 The following variables can be set:
 
 'show-author' (bool)::
-'show-date' (bool)::
 'show-rev-graph' (bool)::
 'show-refs' (bool)::
 
-       Whether to show author, date, revision graph, and references
+       Whether to show author, revision graph, and references
        (branches, tags, and remotes) in the main view on start-up. Can all be
        toggled.
 
+'show-date' (bool or "relative" or "short")::
+
+       Whether and how to show date. If set to "relative" a relative date will be
+       used, e.g. "2 minutes ago". If set to "short" no time information is
+       shown. Can be toggled.
+
 'author-width' (int)::
 
        Width of the author column. When set to 5 or below, the author name
@@ -125,12 +127,19 @@ The following variables can be set:
        always ensured that at least one column is scrolled. The default is to
        scroll '50%' of the view width.
 
+'split-view-height' (mixed)::
+
+       Height of the lower view in a split view. Can be specified either as
+       the number of rows, e.g. '5', or as a percentage of the view height,
+       e.g. '80%', where the maximum is 100%. It is always ensured that the
+       smaller of the views is at least four rows high. The default is a view
+       height of '66%'.
+
 'commit-encoding' (string)::
 
        The encoding used for commits. The default is UTF-8. Not this option
        is shadowed by the "i18n.commitencoding" option in `.git/config`.
 
-
 Bind command
 ------------
 
@@ -138,9 +147,7 @@ Using bind commands keys can be mapped to an action when pressed in a given
 key map. The syntax is:
 
 [verse]
-..............................................................................
 *bind* 'keymap' 'key' 'action'
-..............................................................................
 
 Examples:
 
@@ -355,9 +362,7 @@ background combinations to certain areas. Optionally, an attribute can be
 given as the last parameter. The syntax is:
 
 [verse]
-..............................................................................
 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
-..............................................................................
 
 Examples: