path: root/doc/tigrc.5.adoc

tigrc(5)
========
:docext: adoc

NAME
----
tigrc - Tig configuration file


SYNOPSIS
--------
[verse]
_______________________________________________________________________
*set*   'variable' *=* 'value'
*bind*  'keymap' 'key' 'action'
*color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
*source* 'path'
_______________________________________________________________________


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.  Commands can span multiple lines if each line is
terminated by a backslash ('\') character. 

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.

Certain options can be manipulated at runtime via the option menu. In
addition, options can also be toggled with the `:toggle` prompt command
or by entering the configuration command into the prompt.

In some environments, a user's configuration will be stored in the alternate
location `$XDG_CONFIG_HOME/tig/config`.  For brevity, this document will
refer only to `~/.tigrc`.

Git configuration
-----------------

Alternatively to using `~/.tigrc`, Tig 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. The following example show the basic
syntax to use for settings, bindings and colors.

// TEST: gitconfig
--------------------------------------------------------------------------
[tig] show-changes = true
[tig "color"] cursor = yellow red bold 
[tig "bind"] generic = P parent
--------------------------------------------------------------------------

In addition to tig-specific options, the following Git options are read from
the Git configuration:

'color.*'::

	Colors for the various UI types. Can be configured via the 'git-colors'
	setting.

'core.abbrev'::

	The width of the commit ID. See also 'id-width' option.

'core.editor'::

	The editor command. Can be overridden by setting TIG_EDITOR or
	GIT_EDITOR.

'core.worktree'::

	The path to the root of the working tree.

'gui.encoding'::

	The encoding to use for displaying of file content.

'i18n.commitencoding'::

	The encoding used for commits. The default is UTF-8.

Set command
-----------

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

[verse]
*set* variables *=* value

Examples:

// TEST: tigrc
--------------------------------------------------------------------------
set commit-order = topo		# Order commits topologically
set git-colors = no		# Do not read Git's color settings.
set horizontal-scroll = 33%	# Scroll 33% of the view width
set blame-options = -C -C -C	# Blame lines from other files

# Wrap branch names with () and tags with <>
set reference-format = (branch) <tag>

# Configure blame view columns using command spanning multiple lines.
set blame-view = \
	date:default \
	author:abbreviated \
	file-name:auto \
	id:yes,color \
	line-number:yes,interval=5 text
--------------------------------------------------------------------------

Or in the Git configuration files:

// TEST: gitconfig
--------------------------------------------------------------------------
[tig]
	line-graphics = no	# Disable graphics characters
	tab-size = 8		# Number of spaces per tab
--------------------------------------------------------------------------

The type of variables is 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:

'diff-options' (string)::

	A space-separated string of diff options to use in the diff view.
	git-show(1) is used for formatting and always passes --patch-with-stat.
	Can control display of commit header metadata, passing option --format.
	This option overrides any options specified in the TIG_DIFF_OPTS
	environment variable (described in manpage:tig[1]), but is itself
	overridden by diff flags given on the command line invocation.

'blame-options' (string)::

	A space-separated string of default blame options. Can be used for
	telling git-blame(1) how to detect the origin of lines. The options
	are ignored when Tig is started in blame mode and given blame options
	on the command line.

'log-options' (string)::

	A space-separated string of default options that should be passed to the
	git-log(1) command used by the log view. Options can be overridden by
	command line options. Used internally override custom `pretty.format'
	settings that break the log view.

'main-options' (string)::

	A space-separated string of default options that should be passed to the
	git-log(1) command used by the main view. Options can be overridden by
	command line options.

'reference-format' (string)::

	A space-separated string of format strings used for formatting reference
	names. Wrap the name of the reference type with the characters you would
	like to use for formatting, e.g. `[tag]` and `<remote>`. If no format is
	specified for `local-tag`, the format for `tag` is used. Similarly, if no
	format is specified for `tracked-remote` the `remote` format is used.
	Prefix with `hide:` to not show that reference type, e.g. `hide:remote`.
	Supported reference types are:
	 - head			: The current HEAD.
	 - tag			: An annotated tag.
	 - local-tag		: A lightweight tag.
	 - remote		: A remote.
	 - tracked-remote	: The remote tracked by current HEAD.
	 - replace		: A replaced reference.
	 - branch		: A branch.
	 - stash		: The stash.
	 - other		: Any other reference.

'line-graphics' (mixed) [ascii|default|utf-8|auto|<bool>]::

	What type of character graphics for line drawing. "auto" means "utf-8"
	if the locale is UTF-8, "default" otherwise.

'truncation-delimiter' (mixed) [utf-8|<string>]::

	A single character to draw where columns are truncated. The default is
	"~".  The special value "utf-8" refers to the character "⋯"
	("Midline Horizontal Ellipsis").

'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.

'git-colors' (list)::

	A space-separated list of "key=value" pairs where the key is a Git color
	name and the value is a Tig color name, e.g. "branch.current=main-head"
	and "grep.filename=grep.file". Set to "no" to disable.

'show-notes' (mixed) [<reference>|<bool>]::

	Whether to show notes for a commit. When set to a note reference the
	reference is passed to `git show --notes=`. Notes are enabled by
	default.

'show-changes' (bool)::

	Whether to show staged and unstaged changes in the main view.

'show-untracked' (bool)::

	Whether to show also untracked changes in the main view.

'vertical-split' (mixed) [auto|<bool>]::

	Whether to split the view horizontally or vertically.
	"auto" (which is the default) means that it will depend on the window
	dimensions. When true vertical orientation is used, and false sets the
	orientation to horizontal.

'split-view-height' (mixed)::

	The height of the bottom view in a horizontally split display. 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 '67%'.

'split-view-width' (mixed)::

	Width of the right-most view in a vertically split display. Can be
	specified either as the number of column, e.g. '5', or as a percentage
	of the view width, e.g. '80%', where the maximum is 100%. It is always
	ensured that the smaller of the views is at least four columns wide. The
	default is '50%'.

'status-show-untracked-dirs' (bool)::

	Show untracked directories contents in the status view (analog to
	`git ls-files --directory` option). On by default.

'status-show-untracked-files' (bool)::

	Show untracked files in the status view (mirrors Git's
	`status.showUntrackedFiles` option). On by default.

'tab-size' (int)::

	Number of spaces per tab. The default is 8 spaces.

'diff-context' (int)::

	Number of context lines to show for diffs.

'diff-highlight' (mixed)::

	Whether to highlight diffs using Git's 'diff-highlight' program. Defaults
	to false. When set to true then 'diff-highlight' is used, else the option
	value is used as the path. When this option is in effect, highlighted
	regions are governed by `color diff-add-highlight` and
	`color diff-del-highlight`.

'ignore-space' (mixed) [no|all|some|at-eol|<bool>]::

	Ignore space changes in diff view. By default no space changes are
	ignored. Changing this to "all", "some" or "at-eol" is equivalent to
	passing "--ignore-all-space", "--ignore-space" or
	"--ignore-space-at-eol" respectively to `git diff` or `git show`. +
	 +
	*Warning:* when `ignore-space` is set to `some`, `all` or `at-eol`, then
	the *status-update* and *status-revert* may fail when updating or
	reverting chunks containing lines with space changes. Similarly,
	*stage-update-line* may fail when updating a line adjacent to a line
	with space changes

'commit-order' (enum) [auto|default|topo|date|author-date|reverse]::

	Commit ordering using the default (chronological reverse) order,
	topological order, date order or reverse order. When set to "auto"
	(which is the default), topological order is automatically used in the
	main view when the commit graph is enabled. In repositories with a long
	commit history it is advised to set this option to "default" to speed up
	loading of the main view.

'ignore-case' (enum) [no|yes|smart-case]::

	Ignore case in searches. "smart-case" ignores case if the search string
	doesn't contain any uppercase letters. By default, the search is case
	sensitive.

'mailmap' (bool)::

	Read canonical name and email addresses for authors and committers from
	`.mailmap`. Off by default. See `git-shortlog(1)`.

'wrap-lines' (bool)::

	Wrap long lines. By default, lines are not wrapped.
	Not compatible with line numbers enabled.

'focus-child' (bool)::

	Whether to focus the child view when it is opened. When disabled the
	focus will remain in the parent view, avoiding reloads of the child
	view when navigating the parent view. True by default.

'send-child-enter' (bool)::

	Whether to send "enter" key presses to the child view, even if parent
	view is active. When disabled the child view has to be explicitly
	focused to receive the "enter" key presses. In practice only relevant
	when `set focus-child = no`. True by default.

'editor-line-number' (bool)::

	Whether to pass the selected line number to the editor command. The
	line number is passed as `+<line-number>` in front of the file name.
	Example: `vim +10 tig.c`

'history-size' (int)::

	Size of the persistent `~/.tig_history` file when compiled with readline
	support. Default is 500. Set to 0 to disable.

'mouse' (bool)::

	Whether to enable mouse support. Off by default since it makes selecting
	text from the terminal less intuitive. When enabled hold down Shift (or
	Option on Mac) to select text. Mouse support requires that ncurses
	itself support mouse events.

'mouse-scroll' (int)::

	Interval to scroll up or down using the mouse. The default is 3 lines.
	Mouse support requires that ncurses itself support mouse events and that
	you have enabled mouse support in ~/.tigrc with `set mouse = true`.

'mouse-wheel-cursor' (bool)::

	Whether to prefer moving the cursor to scrolling the view when using the
	mouse wheel. Off by default. Combines well with `set mouse-scroll = 1`.
	Mouse support requires that ncurses itself support mouse events and that
	you have enabled mouse support in ~/.tigrc with `set mouse = true`.

'pager-autoscroll' (bool)::

	Whether to scroll automatically the pager view while loading. Move the
	cursor out of the last line to stop scrolling and back in to resume.

'pgrp' (bool)::

	Make tig process-group leader when starting and clean all processes
	when exiting. Off by default. Do not enable this option if you are
	using a Zsh version affected by zsh-workers/43379. Run `xclip` with
	`setsid` to keep clipboard content after exiting tig. If you are using
	git-credential-cache helper, set option `credentialCache.ignoreSIGHUP`.

'start-on-head' (bool)::

	Start with cursor on HEAD commit.

'refresh-mode' (mixed) [manual|auto|after-command|periodic|<bool>]::

	Configures how views are refreshed based on modifications to watched
	files in the repository. When set to 'manual', nothing is refreshed
	automatically. When set to 'auto', views are refreshed when a
	modification is detected in another view. When set to 'after-command'
	only refresh after returning from an external command. When set to
	'periodic', visible views are refreshed periodically using
	'refresh-interval'.

'refresh-interval' (int)::

	Interval in seconds between view refresh update checks when
	'refresh-mode' is set to 'periodic'.

'file-args' (args)::

	Command line arguments referring to files. These are filtered using
	`git-rev-parse(1)`.

'rev-args' (args)::

	Command line arguments referring to revisions. These are filtered using
	`git-rev-parse(1)`.

View settings
~~~~~~~~~~~~~

The view settings define the order and options for the different columns of a
view. Each view setting expects a space-separated list of column specifications.
Column specifications starts with the column type, and can optionally be
followed by a colon (`:`) and a list of column options. E.g. the following
column specification defines an 'author' column displaying the author email and
with a fixed width of 20 characters: `author:email,width=20`.

The first option value in a col