6 tigrc - tig configuration file
12 *set* 'variable' *=* 'value'
13 *bind* 'keymap' 'key' 'action'
14 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
21 You can permanently set an option by putting it in the `~/.tigrc` file. The
22 file consists of a series of 'commands'. Each line of the file may contain
25 The hash mark ('#') is used as a 'comment' character. All text after the
26 comment character to the end of the line is ignored. You can use comments to
27 annotate your initialization file.
29 Alternatively, options can be set by putting them in one of the git
30 configuration files, which are read by tig on startup. See 'git-config(1)' for
36 A few selective variables can be configured via the set command. The syntax
40 *set* variables *=* value
44 --------------------------------------------------------------------------
45 set show-author = abbreviated # Show abbreviated author names.
46 set show-date = relative # Show relative commit date.
47 set show-rev-graph = yes # Show revision graph?
48 set show-refs = yes # Show references?
49 set commit-order = topo # Order commits topologically
50 set read-git-colors = no # Do not read git's color settings.
51 set show-line-numbers = no # Show line numbers?
52 set line-number-interval = 5 # Interval between line numbers
53 set horizontal-scroll = 33% # Scroll 33% of the view width
54 set blame-options = -C -C -C # Blame lines from other files
55 --------------------------------------------------------------------------
57 Or in the git configuration files:
59 --------------------------------------------------------------------------
61 show-date = yes # Show commit date?
62 author-width = 10 # Set width of the author column
63 line-graphics = no # Disable graphics characters
64 tab-size = 8 # Number of spaces per tab
65 --------------------------------------------------------------------------
67 The type of variables are either bool, int, string, or mixed.
71 To set a bool variable to true use either "1", "true", or "yes".
72 Any other value will set the variable to false.
76 A non-negative integer.
80 A string of characters. Optionally, use either ' or " as delimiters.
84 These values are composites of the above types. The valid values are
85 specified in the description.
90 The following variables can be set:
92 'author-width' (int)::
94 Width of the author column. When set to 5 or below, the author name
95 will be abbreviated to the author's initials.
98 'filename-width' (int)::
100 Width of the filename column.
102 'blame-options' (string)::
104 A space separated string of extra blame options. Can be used for
105 telling git-blame(1) how to detect the origin of lines. The value
106 is ignored when tig is started in blame mode and given blame options
109 'line-graphics' (mixed) [ "ascii" | "default" | "utf8" | bool]::
111 What type of character graphics for line drawing.
113 'line-number-interval' (int)::
115 Interval between line numbers. Note, you have to toggle on line
116 numbering with ".". The default is to number every fifth line.
118 'horizontal-scroll' (mixed)::
120 Interval to scroll horizontally in each step. Can be specified either
121 as the number of columns, e.g. '5', or as a percentage of the view
122 width, e.g. '33%', where the maximum is 100%. For percentages it is
123 always ensured that at least one column is scrolled. The default is to
124 scroll '50%' of the view width.
126 'read-git-colors' (bool)::
128 Whether to read git's color settings.
130 'show-author' (mixed) ["abbreviated" | "full" | bool]::
132 How to display author names. If set to "abbreviated" author initials
133 will be shown. Can be toggled.
135 'show-filename' (mixed) ["auto" | "always" | bool]::
137 When to display file names. If set to "auto" file names are shown
138 only when needed, e.g. when running: tig blame -C <file>.
140 'show-date' (mixed) ["relative" | "short" | "default" | "local" | bool]::
142 Whether and how to show date. If set to "relative" a relative date will be
143 used, e.g. "2 minutes ago". If set to "short" no time information is
144 shown. If set to "local", localtime(3) is used. Can be toggled.
146 'show-notes' (mixed) [note reference | bool]::
148 Whether to show notes for a commit. When set to a note reference the
149 reference is passed to `git show --notes=`. Notes are enabled by
154 Whether to show references (branches, tags, and remotes) in the main
155 view on start-up. Can be toggled.
157 'show-rev-graph' (bool)::
159 Whether to show revision graph in the main view on start-up.
160 Can be toggled. See also line-graphics options.
162 'show-changes' (bool)::
164 Whether to show staged and unstaged changes in the main view.
167 'split-view-height' (mixed)::
169 Height of the lower view in a split view. Can be specified either as
170 the number of rows, e.g. '5', or as a percentage of the view height,
171 e.g. '80%', where the maximum is 100%. It is always ensured that the
172 smaller of the views is at least four rows high. The default is a view
175 'status-untracked-dirs' (bool)::
177 Show untracked directories contents in the status view (analog to
178 `git ls-files --directory` option). On by default.
182 Number of spaces per tab. The default is 8 spaces.
184 'diff-context' (int)::
186 Number of context lines to show for diffs.
188 'ignore-space' (mixed) ["no" | "all" | "some" | "at-eol" | bool]::
190 Ignore space changes in diff view. By default no space changes are ignored.
191 Changing this to "all", "some" or "at-eol" is equivalent to passing
192 "--ignore-all-space", "--ignore-space" or "--ignore-space-at-eol"
193 respectively to `git diff` or `git show`.
195 'commit-order' (mixed) ["default" | "topo" | "date" | "reverse" | bool]::
197 Commit ordering using the default (chronological reverse) order,
198 topological order, date order or reverse order. The default order is
199 used when the option is set to false, and topo order when set to true.
204 Using bind commands keys can be mapped to an action when pressed in a given
205 key map. The syntax is:
208 *bind* 'keymap' 'key' 'action'
212 --------------------------------------------------------------------------
214 bind main w scroll-line-up
215 bind main s scroll-line-down
216 bind main space enter
219 bind diff b move-first-line
220 # An external command to update from upstream
221 bind generic F !git fetch
222 --------------------------------------------------------------------------
224 Or in the git configuration files:
226 --------------------------------------------------------------------------
228 # 'unbind' the default quit key binding
230 # Cherry-pick current commit onto current branch
231 generic = C !git cherry-pick %(commit)
232 --------------------------------------------------------------------------
234 Keys are mapped by first searching the keybindings for the current view, then
235 the keybindings for the *generic* keymap, and last the default keybindings.
236 Thus, the view keybindings shadow the generic keybindings which Shadow the
237 built-in keybindings.
243 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
244 *tree*, *blob*, *blame*, *branch*, and *generic*. Use *generic* to set key
245 mapping in all keymaps.
249 Key values should never be quoted. Use either the ASCII value or one of the
250 following symbolic key names. Symbolic key names are case insensitive, Use
251 *Hash* to bind to the `#` key, since the hash mark is used as a comment
254 *Enter*, *Space*, *Backspace*, *Tab*, *Escape*, *Left*, *Right*, *Up*, *Down*,
255 *Insert*, *Delete*, *Hash*, *Home*, *End*, *PageUp*, *PageDown*, *F1*, *F2*, *F3*,
256 *F4*, *F5*, *F6*, *F7*, *F8*, *F9*, *F10*, *F11*, *F12*.
260 Valid action names are described below. Note, all names are
261 case-insensitive, and you may use '-', '_', and '.' interchangeably,
262 e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
269 Apart from the action names listed below, all actions starting with a '!' will
270 be available as an external command. External commands can contain variable
271 names that will be substituted before the command is run. By default, commands
272 are run in the foreground with their console output shown, if they should be
273 run in the background wit no output prefix the command with '@'. Valid
276 .Browsing state variables
277 [frame="none",grid="none",cols="25<m,75<"]
278 |=============================================================================
279 |%(head) |The currently viewed 'head' ID. Defaults to HEAD
280 |%(commit) |The currently selected commit ID.
281 |%(blob) |The currently selected blob ID.
282 |%(branch) |The currently selected branch name.
283 |%(directory) |The current directory path in the tree view;
284 empty for the root directory.
285 |%(file) |The currently selected file.
286 |%(ref) |The reference given to blame or HEAD if undefined.
287 |%(revargs) |The revision arguments passed on the command line.
288 |%(fileargs) |The file arguments passed on the command line.
289 |%(diffargs) |The diff options passed on the command line.
290 |%(prompt) |Prompt for the argument value.
291 |=============================================================================
293 As an example, the following external command will save the current commit as
294 a patch file: "!git format-patch -1 %(commit)". If your external command
295 require use of dynamic features, such as subshells, expansion of environment
296 variables and process control, this can be achieved by using a combination of
297 git aliases and tig external commands. The following example entries can be
298 put in either the .gitconfig or .git/config file:
300 --------------------------------------------------------------------------
302 gitk-bg = !"gitk HEAD --not $(git rev-parse --remotes) &"
303 publish = !"for i in origin public; do git push $i; done"
305 # @-prefix means that the console output will not be shown.
306 generic = V !@git gitk-bg
307 generic = > !git publish
308 --------------------------------------------------------------------------
311 [frame="none",grid="none",cols="25<m,75<"]
312 |=============================================================================
313 |view-main |Show main view
314 |view-diff |Show diff view
315 |view-log |Show log view
316 |view-tree |Show tree view
317 |view-blob |Show blob view
318 |view-blame |Show blame view
319 |view-branch |Show branch view
320 |view-status |Show status view
321 |view-stage |Show stage view
322 |view-pager |Show pager view
323 |view-help |Show help page
324 |=============================================================================
327 [frame="none",grid="none",cols="25<m,75<"]
328 |=============================================================================
329 |enter |Enter current line and scroll
331 |previous |Move to previous
332 |parent |Move to parent
333 |view-next |Move focus to next view
334 |refresh |Reload and refresh view
335 |maximize |Maximize the current view
336 |view-close |Close the current view
337 |quit |Close all views and quit
338 |=============================================================================
340 .View specific actions
341 [frame="none",grid="none",cols="25<m,75<"]
342 |=============================================================================
343 |status-update |Update file status
344 |status-merge |Resolve unmerged file
345 |stage-update-line |Stage single line
346 |stage-next |Find next chunk to stage
347 |diff-context-up |Increase the diff context
348 |diff-context-down |Decrease the diff context
349 |=============================================================================
352 [frame="none",grid="none",cols="25<m,75<"]
353 |=============================================================================
354 |move-up |Move cursor one line up
355 |move-down |Move cursor one line down
356 |move-page-down |Move cursor one page down
357 |move-page-up |Move cursor one page up
358 |move-first-line |Move cursor to first line
359 |move-last-line |Move cursor to last line
360 |=============================================================================
363 [frame="none",grid="none",cols="25<m,75<"]
364 |=============================================================================
365 |scroll-line-up |Scroll one line up
366 |scroll-line-down |Scroll one line down
367 |scroll-page-up |Scroll one page up
368 |scroll-page-down |Scroll one page down
369 |scroll-first-col |Scroll to the first column
370 |scroll-left |Scroll one column left
371 |scroll-right |Scroll one column right
372 |=============================================================================
375 [frame="none",grid="none",cols="25<m,75<"]
376 |=============================================================================
377 |search |Search the view
378 |search-back |Search backwards in the view
379 |find-next |Find next search match
380 |find-prev |Find previous search match
381 |=============================================================================
384 [frame="none",grid="none",cols="25<m,75<"]
385 |=============================================================================
386 |prompt |Bring up the prompt
387 |screen-redraw |Redraw the screen
388 |screen-resize |Resize the screen
389 |show-version |Show version information
390 |stop-loading |Stop all loading views
391 |options |Open options menu
392 |toggle-lineno |Toggle line numbers
393 |toggle-date |Toggle date display
394 |toggle-author |Toggle author display
395 |toggle-filename |Toggle file name display
396 |toggle-rev-graph |Toggle revision graph visualization
397 |toggle-graphic |Toggle (line) graphics mode
398 |toggle-refs |Toggle reference display
399 |edit |Open in editor
401 |=============================================================================
407 Color commands control highlighting and the user interface styles. If your
408 terminal supports color, these commands can be used to assign foreground and
409 background combinations to certain areas. Optionally, an attribute can be
410 given as the last parameter. The syntax is:
413 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
417 ------------------------------------------------------------------------------
418 # Overwrite the default terminal colors to white on black.
419 color default white black
421 color diff-header yellow default
422 color diff-index blue default
423 color diff-chunk magenta default
424 color "Reported-by:" green default
425 --------------------------------------------------------------------------
427 Or in the git configuration files:
429 --------------------------------------------------------------------------
431 # A strange looking cursor line
432 cursor red default underline
434 title-blur white blue
435 title-focus white blue bold
436 ------------------------------------------------------------------------------
440 Can be either a built-in area name or a custom quoted string. The
441 latter allows custom color rules to be added for lines matching a
443 Valid built-in area names are described below. Note, all names are
444 case-insensitive, and you may use '-', '_', and '.' interchangeably,
445 e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
449 Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
450 *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
451 default terminal colors. This is recommended for background colors if
452 you are using a terminal with a transparent background.
454 Colors can also be specified using the keywords color0, color1, ..., colorN-1
455 (N being the number of colors supported by your terminal). This is useful when
456 you remap the colors for your display or want to enable colors supported by
461 Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
462 *standout*, and *underline*. Note, not all attributes may be supported
468 The colors and attributes to be used for the text that is not highlighted or
469 that specify the use of the default terminal colors can be controlled by
470 setting the *default* color option.
473 [frame="none",grid="none",cols="25<m,75<"]
474 |=============================================================================
475 |default |Overwrite default terminal colors (see above).
476 |cursor |The cursor line.
477 |status |The status window showing info messages.
478 |title-focus |The title window for the current view.
479 |title-blur |The title window of any backgrounded view.
480 |delimiter |Delimiter shown for truncated lines.
481 |line-number |Line numbers.
482 |date |The commit date.
483 |author |The commit author.
484 |mode |The file mode holding the permissions and type.
485 |=============================================================================
488 [frame="none",grid="none",cols="25<m,75<"]
489 |=============================================================================
490 |graph-commit |The commit dot in the revising graph.
491 |palette-[0-6] |7 different colors,
492 used for distinguishing branches or commits.
493 example: palette-0 = red
494 |main-commit |The commit comment.
495 |main-head |Label of the current branch.
496 |main-remote |Label of a remote.
497 |main-tracked |Label of the remote tracked by the current branch.
498 |main-tag |Label of a signed tag.
499 |main-local-tag |Label of a local tag.
500 |main-ref |Label of any other reference.
501 |=============================================================================
504 [frame="none",grid="none",cols="25<m,75<"]
505 |=============================================================================
506 |stat-head |The "On branch"-line.
507 |stat-section |Status section titles,
508 |stat-staged |Status flag of staged files.
509 |stat-unstaged |Status flag of unstaged files.
510 |stat-untracked |Status flag of untracked files.
511 |=============================================================================
514 [frame="none",grid="none",cols="25<m,75<"]
515 |=============================================================================
516 |blame-id |The commit ID.
517 |=============================================================================
520 [frame="none",grid="none",cols="25<m,75<"]
521 |=============================================================================
522 |tree-head |The "Directory /"-line
523 |tree-dir |The directory name.
524 |tree-file |The file name.
525 |=============================================================================
534 Options concerning diff start, chunks and lines added and deleted.
536 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
538 Enhanced git diff markup::
540 Extra diff information emitted by the git diff machinery, such as mode
541 changes, rename detection, and similarity.
543 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
544 *diff-rename-from*, *diff-rename-to*, *diff-similarity*, *diff-dissimilarity*
545 *diff-tree*, *diff-index*
547 Pretty print commit headers::
549 Commit diffs and the revision logs are usually formatted using pretty printed
550 headers , unless `--pretty=raw` was given. This includes lines, such as merge
551 info, commit ID, and author and committer date.
553 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*,
558 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
561 *commit*, *parent*, *tree*, *author*, *committer*
565 `Signed-off-by`, `Acked-by`, `Reviewed-by` and `Tested-by` lines are colorized.
567 *signoff*, *acked*, *reviewed*, *tested*
571 Colors for information of the tree view.
573 *tree-dir*, *tree-file*
580 Sources commands makes it possible to read additional configuration files.
581 Sourced file are treated in-place, meaning when a 'source' command is
582 encountered it will be immediately read. Any commands, later in the current
583 configuration file will take precedence. The syntax is:
590 ------------------------------------------------------------------------------
591 source ~/.tig/colorscheme.tigrc
592 source ~/.tig/keybindings.tigrc
593 --------------------------------------------------------------------------
597 Copyright (c) 2006-2010 Jonas Fonseca <fonseca@diku.dk>
599 Licensed under the terms of the GNU General Public License.
603 manpage:tig[1], manpage:tigmanual[7], git-config(1),
604 and the http://jonas.nitro.dk/tig/manual.html[tig manual].