Code

Refactor and share view maximization code from view-close handling
[tig.git] / tigrc.5.txt
index 46656499b89c64788f072ac422eaec77d1254519..d37b8b8e3922acae0b60fa60ba1a03d209cc8dd7 100644 (file)
@@ -3,7 +3,7 @@ tigrc(5)
 
 NAME
 ----
-tigrc - tig user configuration file
+tigrc - tig configuration file
 
 
 SYNOPSIS
@@ -27,6 +27,9 @@ The hash mark ('#') is used as a 'comment' character. All text after the
 comment character to the end of the line is ignored. You can use comments to
 annotate your initialization file.
 
+Alternatively, options can be set by putting them in one of the git
+configuration files, which are read by tig on startup. See 'git-config(1)' for
+which files to use.
 
 Set command
 -----------
@@ -47,11 +50,17 @@ 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
-set encoding = "UTF-8"         # Commit encoding
+--------------------------------------------------------------------------
+
+Or in the git configuration files:
+
+--------------------------------------------------------------------------
+[tig]
+       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.
@@ -85,7 +94,8 @@ The following variables can be set:
 
 'author-width' (int)::
 
-       Width of the author column.
+       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)::
 
@@ -128,12 +138,18 @@ bind main space enter
 bind diff a previous
 bind diff d next
 bind diff b move-first-line
-# 'unbind' the default quit key binding
-bind main Q none
 # An external command to update from upstream
 bind generic F !git fetch
-# Cherry-pick current commit onto current branch
-bind generic C !git cherry-pick %(commit)
+--------------------------------------------------------------------------
+
+Or in the git configuration files:
+
+--------------------------------------------------------------------------
+[tig "bind"]
+       # 'unbind' the default quit key binding
+       main = Q none
+       # Cherry-pick current commit onto current branch
+       generic = C !git cherry-pick %(commit)
 --------------------------------------------------------------------------
 
 Keys are mapped by first searching the keybindings for the current view, then
@@ -184,6 +200,10 @@ 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
@@ -216,6 +236,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
@@ -223,6 +244,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"]
 `-----------------------`-----------------------------------------------------
@@ -245,8 +277,10 @@ Scrolling:
 ------------------------------------------------------------------------------
 scroll-line-up         Scroll one line up
 scroll-line-down       Scroll one line down
-scroll-page-eup                Scroll one page up
+scroll-page-up         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[]
@@ -267,7 +301,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
@@ -278,11 +311,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
 ------------------------------------------------------------------------------
 
 
@@ -308,11 +338,17 @@ color default             white   black
 color diff-header      yellow  default
 color diff-index       blue    default
 color diff-chunk       magenta default
-# A strange looking cursor line
-color cursor           red     default underline
-# UI colors
-color title-blur       white   blue
-color title-focus      white   blue    bold
+--------------------------------------------------------------------------
+
+Or in the git configuration files:
+
+--------------------------------------------------------------------------
+[tig "color"]
+       # A strange looking cursor line
+       cursor          red     default underline
+       # UI colors
+       title-blur      white   blue
+       title-focus     white   blue    bold
 ------------------------------------------------------------------------------
 
 Area names::
@@ -325,8 +361,13 @@ Color names::
 
        Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
        *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
-       default terminal colors. This is recommended for background colors
-       if you are using a terminal with a transparent background.
+       default terminal colors. This is recommended for background colors if
+       you are using a terminal with a transparent background.
++
+Colors can also be specified using the keywords color0, color1, ..., colorN-1
+(N being the number of colors supported by your terminal). This is useful when
+you remap the colors for your display or want to enable colors supported by
+256-color terminals.
 
 Attribute names::
 
@@ -355,6 +396,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[]
@@ -363,7 +406,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.
@@ -396,6 +438,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
 ~~~~~~~~~~~~
 
@@ -448,10 +501,11 @@ 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.
 
 SEE ALSO
 --------
-manpage:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual].
+manpage:tig[1], git-config(1),
+and the http://jonas.nitro.dk/tig/manual.html[tig manual].