Show the active (instead of the default) keybindings in the help view

[tig.git] / tigrc.5.txt

diff --git a/tigrc.5.txt b/tigrc.5.txt
index d0e8c9118cf07251cd71721c59e27911334f0e74..1376232bd90e23902b575251db6278c3e28c42bf 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,9 +36,7 @@ A few selective variables can be configured via the set command. The syntax
 is:
 
 [verse]
-..............................................................................
 *set* variables *=* value
-..............................................................................
 
 Examples:
 
@@ -51,6 +47,7 @@ set show-refs = yes           # Show references?
 set show-line-numbers = no     # Show line numbers?
 set line-number-interval = 5   # Interval between line numbers
 set commit-encoding = "UTF-8"  # Commit encoding
+set horizontal-scroll = 33%    # Scroll 33% of the view width
 --------------------------------------------------------------------------
 
 Or in the git configuration files:
@@ -63,7 +60,7 @@ Or in the git configuration files:
        tab-size = 8            # Number of spaces per tab
 --------------------------------------------------------------------------
 
-The type of variables are either bool, int, and string.
+The type of variables are either bool, int, string, or mixed.
 
 Valid bool values::
 
@@ -78,6 +75,11 @@ Valid string values::
 
        A string of characters. Optionally, use either ' or " as delimiters.
 
+Valid mixed values::
+
+       These values are composites of the above types. The valid values are
+       specified in the description.
+
 Variables
 ~~~~~~~~~
 
@@ -111,6 +113,22 @@ The following variables can be set:
 
        Number of spaces per tab. The default is 8 spaces.
 
+'horizontal-scroll' (mixed)::
+
+       Interval to scroll horizontally in each step. Can be specified either
+       as the number of columns, e.g. '5', or as a percentage of the view
+       width, e.g. '33%', where the maximum is 100%. For percentages it is
+       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
@@ -124,9 +142,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:
 
@@ -162,7 +178,8 @@ built-in keybindings.
 Keymaps::
 
 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
-and *generic*.  Use *generic* to set key mapping in all keymaps.
+*tree*, *blob*, *blame*, *branch*, and *generic*.  Use *generic* to set key
+mapping in all keymaps.
 
 Key values::
 
@@ -207,7 +224,20 @@ Browsing state variables
 ------------------------------------------------------------------------------
 
 As an example, the following external command will save the current commit as
-a patch file: "!git format-patch -1 %(commit)".
+a patch file: "!git format-patch -1 %(commit)". If your external command
+require use of dynamic features, such as subshells, expansion of environment
+variables and process control, this can be achieved by using a combination of
+git aliases and tig external commands. The following example entries can be
+put in either the .gitconfig or .git/config file:
+
+--------------------------------------------------------------------------
+[alias]
+       gitk-bg = !"gitk HEAD --not $(git rev-parse --remotes) &"
+       publish = !"for i in origin public; do git push $i; done"
+[tig "bind"]
+       generic = V !git gitk-bg
+       generic = > !git publish
+--------------------------------------------------------------------------
 
 ifdef::backend-xhtml11[]
 [frame="none"]
@@ -221,6 +251,7 @@ view-log            Show log view
 view-tree              Show tree view
 view-blob              Show blob view
 view-blame             Show blame view
+view-branch            Show branch view
 view-status            Show status view
 view-stage             Show stage view
 view-pager             Show pager view
@@ -306,6 +337,7 @@ screen-redraw               Redraw the screen
 screen-resize          Resize the screen
 show-version           Show version information
 stop-loading           Stop all loading views
+options                        Open options menu
 toggle-lineno          Toggle line numbers
 toggle-date            Toggle date display
 toggle-author          Toggle author display
@@ -325,9 +357,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: