tigrc(5): document the tree view colors

[tig.git] / tigrc.5.txt

diff --git a/tigrc.5.txt b/tigrc.5.txt
index 00fd186d22f26b66ae5f5a849c73c1ec39101629..149fcd7a9fedf08532ea950515933bee1ad8f872 100644 (file)
--- a/tigrc.5.txt
+++ b/tigrc.5.txt
@@ -47,6 +47,7 @@ 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 author-width = 10          # Set width of the author column
 set line-graphics = no         # Disable graphics characters
 set line-number-interval = 5   # Interval between line numbers
 set tab-size = 8               # Number of spaces per tab
@@ -82,6 +83,11 @@ The following variables can be set:
        (branches, tags, and remotes) in the main view on start-up. Can all be
        toggled.
 
+'author-width' (int)::
+
+       Width of the author column. When set to 5 or below, the author name
+       will be abbreviated to the author's initials.
+
 'line-graphics' (bool)::
 
        Whether to use graphic characters for line drawing.
@@ -127,7 +133,7 @@ bind diff b move-first-line
 bind main Q none
 # An external command to update from upstream
 bind generic F !git fetch
-# Cherry-pick current commit unto current branch
+# Cherry-pick current commit onto current branch
 bind generic C !git cherry-pick %(commit)
 --------------------------------------------------------------------------
 
@@ -168,10 +174,25 @@ Actions
 Apart from the action names listed below, all actions starting with a '!' will
 be available as an external command. External commands can contain variable
 names that will be substituted before the command is run. Valid variable names
-are "%(head)", "%(commit)", and "%(blob)".
+are:
+
+ifdef::backend-xhtml11[]
+[frame="none"]
+`-----------------------`-----------------------------------------------------
+endif::backend-xhtml11[]
+Browsing state variables
+------------------------------------------------------------------------------
+%(head)                        The currently viewed 'head' ID. Defaults to HEAD
+%(commit)              The currently selected commit ID.
+%(blob)                        The currently selected blob ID.
+%(directory)           The current directory path in the tree view; \
+                       empty for the root directory.
+%(file)                        The currently selected file.
+%(ref)                 The reference given to blame or HEAD if undefined.
+------------------------------------------------------------------------------
 
 As an example, the following external command will save the current commit as
-a patch file: "!git format-patch %(commit)^..%(commit)".
+a patch file: "!git format-patch -1 %(commit)".
 
 ifdef::backend-xhtml11[]
 [frame="none"]
@@ -200,6 +221,7 @@ View manipulation:
 enter                  Enter current line and scroll
 next                   Move to next
 previous               Move to previous
+parent                 Move to parent
 view-next              Move focus to next view
 refresh                        Reload and refresh view
 maximize               Maximize the current view
@@ -207,6 +229,17 @@ view-close         Close the current view
 quit                   Close all views and quit
 ------------------------------------------------------------------------------
 
+ifdef::backend-xhtml11[]
+[frame="none"]
+`-----------------------`-----------------------------------------------------
+endif::backend-xhtml11[]
+View specific actions:
+------------------------------------------------------------------------------
+status-update          Update file status
+status-merge           Resolve unmerged file
+stage-next             Find next chunk to stage
+------------------------------------------------------------------------------
+
 ifdef::backend-xhtml11[]
 [frame="none"]
 `-----------------------`-----------------------------------------------------
@@ -231,6 +264,8 @@ scroll-line-up              Scroll one line up
 scroll-line-down       Scroll one line down
 scroll-page-eup                Scroll one page up
 scroll-page-down       Scroll one page down
+scroll-left            Scroll one column left
+scroll-right           Scroll one column right
 ------------------------------------------------------------------------------
 
 ifdef::backend-xhtml11[]
@@ -251,7 +286,6 @@ ifdef::backend-xhtml11[]
 endif::backend-xhtml11[]
 Misc:
 ------------------------------------------------------------------------------
-none                   Do nothing
 prompt                 Bring up the prompt
 screen-redraw          Redraw the screen
 screen-resize          Resize the screen
@@ -262,11 +296,8 @@ toggle-date                Toggle date display
 toggle-author          Toggle author display
 toggle-rev-graph       Toggle revision graph visualization
 toggle-refs            Toggle reference display
-status-update          Update file status
-status-merge           Resolve unmerged file
-stage-next             Find next chunk to stage
-tree-parent            Switch to parent directory in tree view
 edit                   Open in editor
+none                   Do nothing
 ------------------------------------------------------------------------------
 
 
@@ -339,6 +370,8 @@ title-blur          The title window of any backgrounded view.
 delimiter              Delimiter shown for truncated lines.
 line-number            Line numbers.
 date                   The commit date.
+author                 The commit author.
+mode                   The file mode holding the permissions and type.
 ------------------------------------------------------------------------------
 
 ifdef::backend-xhtml11[]
@@ -347,7 +380,6 @@ ifdef::backend-xhtml11[]
 endif::backend-xhtml11[]
 Main view colors:
 ------------------------------------------------------------------------------
-main-author            The commit author.
 main-revgraph          The revision graph.
 main-commit            The commit comment.
 main-head              Label of the current branch.
@@ -380,6 +412,17 @@ Blame view:
 blame-id               The commit ID.
 ------------------------------------------------------------------------------
 
+ifdef::backend-xhtml11[]
+[frame="none"]
+`-----------------------`-----------------------------------------------------
+endif::backend-xhtml11[]
+Tree view:
+------------------------------------------------------------------------------
+tree-head              The "Directory /"-line
+tree-dir               The directory name.
+tree-file              The file name.
+------------------------------------------------------------------------------
+
 Highlighting
 ~~~~~~~~~~~~
 
@@ -432,7 +475,7 @@ Colors for information of the tree view.
 
 COPYRIGHT
 ---------
-Copyright (c) 2006-2008 Jonas Fonseca <fonseca@diku.dk>
+Copyright (c) 2006-2009 Jonas Fonseca <fonseca@diku.dk>
 
 Licensed under the terms of the GNU General Public License.