Fix previous/next with branch+main view

[tig.git] / tigrc.5.txt

diff --git a/tigrc.5.txt b/tigrc.5.txt
index d37b8b8e3922acae0b60fa60ba1a03d209cc8dd7..247afdf901299a8c1ba078a1c577ffccdf9d6b96 100644 (file)
--- a/tigrc.5.txt
+++ b/tigrc.5.txt
@@ -46,24 +46,25 @@ Examples:
 
 --------------------------------------------------------------------------
 set show-author = yes          # Show author?
-set show-date = yes            # Show commit date?
 set show-rev-graph = yes       # Show revision graph?
 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:
 
 --------------------------------------------------------------------------
 [tig]
+       show-date = yes         # Show commit date?
        author-width = 10       # Set width of the author column
        line-graphics = no      # Disable graphics characters
        tab-size = 8            # Number of spaces per tab
-       encoding = "UTF-8"      # Commit encoding
 --------------------------------------------------------------------------
 
-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 +79,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 +117,14 @@ 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.
+
 'commit-encoding' (string)::
 
        The encoding used for commits. The default is UTF-8. Not this option
@@ -162,7 +176,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 +222,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 +249,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