tigrc(5) - Linux man page

Name

tigrc - tig configuration file

Synopsis

set   variable = value
bind  keymap key action
color area fgcolor bgcolor [attributes]

Description

You can permanently set an option by putting it in the ~/.tigrc file. The file consists of a series of commands. Each line of the file may contain only one command.

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

A few selective variables can be configured via the set command. The syntax is:

set variables = value

Examples:

set show-author = abbreviated   # Show abbreviated author names.
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 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

The type of variables are either bool, int, string, or mixed. Valid bool values

To set a bool variable to true use either "1", "true", or "yes". Any other value will set the variable to false.

Valid int values

A non-negative integer.

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

The following variables can be set: show-rev-graph (bool): Whether to show revision graph in the main view on start-up. Can be toggled. See also line-graphics options.
show-refs (bool): Whether to show references (branches, tags, and remotes) in the main view on start-up. Can be toggled.
show-author (mixed) ["abbreviated" | "default" | bool]: How to display author names. If set to "abbreviated" author initials will be shown. Can be toggled.
show-date (mixed) ["relative" | "short" | "default" | "local" | bool]: 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. If set to "local", localtime(3) is used. Can 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 (mixed) [ "ascii" | "default" | "utf-8" | bool]: What type of character graphics for line drawing.
line-number-interval (int): Interval between line numbers. Note, you have to toggle on line numbering with n or the -n command line option. The default is to number every line.
tab-size (int): 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. Note this option is shadowed by the "i18n.commitencoding" option in .git/config.
status-untracked-dirs (bool): Show untracked directories contents in the status view (analog to git ls-files --directory option. On by default.

Bind Command

Using bind commands keys can be mapped to an action when pressed in a given key map. The syntax is:

bind keymap key action

Examples:

# A few keybindings
bind main w scroll-line-up
bind main s scroll-line-down
bind main space enter
bind diff a previous
bind diff d next
bind diff b move-first-line
# An external command to update from upstream
bind generic F !git fetch

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 the keybindings for the generic keymap, and last the default keybindings. Thus, the view keybindings shadow the generic keybindings which Shadow the built-in keybindings.
Keymaps

Valid keymaps are: main, diff, log, help, pager, status, stage, tree, blob, blame, branch, and generic. Use generic to set key mapping in all keymaps.

Key values

Key values should never be quoted. Use either the ASCII value or one of the following symbolic key names. Symbolic key names are case insensitive, Use Hash to bind to the # key, since the hash mark is used as a comment character.

Enter, Space, Backspace, Tab, Escape, Left, Right, Up, Down, Insert, Delete, Hash, Home, End, PageUp, PageDown, F1, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12.
Action names

Valid action names are described below. Note, all names are case-insensitive, and you may use -, _, and . interchangeably, e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.

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:
Table 1. Browsing state variables
As an example, the following external command will save the current commit as 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

Table 2. View switching
Table 3. View manipulation
Table 4. View specific actions
Table 5. Cursor navigation
Table 6. Scrolling
Table 7. Searching
Table 8. Misc

Color Command

Color commands control highlighting and the user interface styles. If your terminal supports color, these commands can be used to assign foreground and background combinations to certain areas. Optionally, an attribute can be given as the last parameter. The syntax is:

color area fgcolor bgcolor [attributes]

Examples:

# Overwrite the default terminal colors to white on black.
color default           white   black
# Diff colors
color diff-header       yellow  default
color diff-index        blue    default
color diff-chunk        magenta default

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

Valid area names are described below. Note, all names are case-insensitive, and you may use -, _, and . interchangeably, e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.

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.

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

Valid attributes include: normal, blink, bold, dim, reverse, standout, and underline. Note, not all attributes may be supported by the terminal.

UI colors

The colors and attributes to be used for the text that is not highlighted or that specify the use of the default terminal colors can be controlled by setting the default color option.
Table 9. General
Table 10. Main view colors
Table 11. Status view
Table 12. Blame view
Table 13. Tree view

Highlighting

Diff markup: Options concerning diff start, chunks and lines added and deleted.
diff-header, diff-chunk, diff-add, diff-del
Enhanced git diff markup: Extra diff information emitted by the git diff machinery, such as mode changes, rename detection, and similarity.
diff-oldmode, diff-newmode, diff-copy-from, diff-copy-to, diff-rename-from, diff-rename-to, diff-similarity, diff-dissimilarity diff-tree, diff-index
Pretty print commit headers: Commit diffs and the revision logs are usually formatted using pretty printed headers , unless --pretty=raw was given. This includes lines, such as merge info, commit ID, and author and committer date.
pp-author, pp-commit, pp-merge, pp-date, pp-adate, pp-cdate, pp-refs
Raw commit header: Usually shown when --pretty=raw is given, however commit is pretty much omnipresent.
commit, parent, tree, author, committer
Commit message: Signed-off-by, Acked-by, Reviewed-by and Tested-by lines are colorized.
signoff, acked, reviewed, tested
Tree markup: Colors for information of the tree view.
tree-dir, tree-file

Copyright

Licensed under the terms of the GNU General Public License.

Notes

1. fonseca@diku.dk: mailto:fonseca@diku.dk
2. tig manual: http://jonas.nitro.dk/tig/manual.html

tigrc(5) - Linux man page

Name

Synopsis

Description

Set Command

Bind Command

Color Command

Copyright

See Also

Notes