![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/tigrc.5.txt b/tigrc.5.txt
index 149fcd7a9fedf08532ea950515933bee1ad8f872..3ead320ee54e3bc4d05f4526e1ea226cf22595f8 100644 (file)
--- a/tigrc.5.txt
+++ b/tigrc.5.txt
NAME
----
NAME
----
-tigrc - tig user configuration file
+tigrc - tig configuration file
SYNOPSIS
--------
[verse]
SYNOPSIS
--------
[verse]
-.............................................................................
*set* 'variable' *=* 'value'
*bind* 'keymap' 'key' 'action'
*color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
*set* 'variable' *=* 'value'
*bind* 'keymap' 'key' 'action'
*color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
-.............................................................................
DESCRIPTION
DESCRIPTION
comment character to the end of the line is ignored. You can use comments to
annotate your initialization file.
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
-----------
Set command
-----------
is:
[verse]
is:
[verse]
-..............................................................................
*set* variables *=* value
*set* variables *=* value
-..............................................................................
Examples:
--------------------------------------------------------------------------
set show-author = yes # Show author?
Examples:
--------------------------------------------------------------------------
set show-author = yes # Show author?
-set show-date = yes # Show commit date?
+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?
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 line-number-interval = 5 # Interval between line numbers
-set tab-size = 8 # Number of spaces per tab
-set encoding = "UTF-8" # Commit encoding
+set commit-encoding = "UTF-8" # Commit encoding
+set horizontal-scroll = 33% # Scroll 33% of the view width
--------------------------------------------------------------------------
--------------------------------------------------------------------------
-The type of variables are either bool, int, and string.
+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
+--------------------------------------------------------------------------
+
+The type of variables are either bool, int, string, or mixed.
Valid bool values::
Valid bool values::
A string of characters. Optionally, use either ' or " as delimiters.
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
~~~~~~~~~
The following variables can be set:
'show-author' (bool)::
Variables
~~~~~~~~~
The following variables can be set:
'show-author' (bool)::
-'show-date' (bool)::
'show-rev-graph' (bool)::
'show-refs' (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.
(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
'author-width' (int)::
Width of the author column. When set to 5 or below, the author name
Number of spaces per tab. The default is 8 spaces.
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
is shadowed by the "i18n.commitencoding" option in `.git/config`.
'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
------------
Bind command
------------
key map. The syntax is:
[verse]
key map. The syntax is:
[verse]
-..............................................................................
*bind* 'keymap' 'key' 'action'
*bind* 'keymap' 'key' 'action'
-..............................................................................
Examples:
Examples:
bind diff a previous
bind diff d next
bind diff b move-first-line
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
# 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
--------------------------------------------------------------------------
Keys are mapped by first searching the keybindings for the current view, then
Keymaps::
Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
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::
Key values::
------------------------------------------------------------------------------
As an example, the following external command will save the current commit as
------------------------------------------------------------------------------
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"]
ifdef::backend-xhtml11[]
[frame="none"]
view-tree Show tree view
view-blob Show blob view
view-blame Show blame 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
view-status Show status view
view-stage Show stage view
view-pager Show pager view
------------------------------------------------------------------------------
scroll-line-up Scroll one line up
scroll-line-down Scroll one line down
------------------------------------------------------------------------------
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
scroll-page-down Scroll one page down
scroll-left Scroll one column left
scroll-right Scroll one column right
screen-resize Resize the screen
show-version Show version information
stop-loading Stop all loading views
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
toggle-lineno Toggle line numbers
toggle-date Toggle date display
toggle-author Toggle author display
given as the last parameter. The syntax is:
[verse]
given as the last parameter. The syntax is:
[verse]
-..............................................................................
*color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
*color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
-..............................................................................
Examples:
Examples:
color diff-header yellow default
color diff-index blue default
color diff-chunk magenta default
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::
------------------------------------------------------------------------------
Area names::
Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
*cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
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::
Attribute names::
SEE ALSO
--------
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].