Correctly report allocation failure in argv_append
[tig.git] / tigrc.5.txt
blob12fbda3cf06087ef283b981dfc33b1908ab9d6f4
1 tigrc(5)
2 ========
4 NAME
5 ----
6 tigrc - tig configuration file
9 SYNOPSIS
10 --------
11 [verse]
12 *set*   'variable' *=* 'value'
13 *bind*  'keymap' 'key' 'action'
14 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
15 *source* 'path'
18 DESCRIPTION
19 -----------
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
23 only one command.
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 Git configuration
30 -----------------
32 Alternatively to using `~/.tigrc`, tig options can be set by putting them in
33 one of the git configuration files, which are read by tig on startup. See
34 'git-config(1)' for which files to use. The following example show the basic
35 syntax to use for settings, bindings and colors.
37 --------------------------------------------------------------------------
38 [tig] show-rev-graph = true
39 [tig "color"] cursor = yellow red bold 
40 [tig "bind"] generic = P parent
41 --------------------------------------------------------------------------
43 In addition to tig-specific options, the following git options are read from
44 the git configuration:
46 'color.*'::
48         Colors for the various UI types. Can be completely disabled by setting
49         'read-git-colors'.
51 'core.abbrev'::
53         The width of the commit ID. See also 'id-width' option.
55 'core.editor'::
57         The editor command. Can be overridden by setting GIT_EDITOR.
59 'core.worktree'::
61         The path to the root of the working tree.
63 'gui.encoding'::
65         The encoding to use for displaying of file content.
67 Set command
68 -----------
70 A few selective variables can be configured via the set command. The syntax
71 is:
73 [verse]
74 *set* variables *=* value
76 Examples:
78 --------------------------------------------------------------------------
79 set show-author = abbreviated   # Show abbreviated author names.
80 set show-date = relative        # Show relative commit date.
81 set show-rev-graph = yes        # Show revision graph?
82 set show-refs = yes             # Show references?
83 set commit-order = topo         # Order commits topologically
84 set read-git-colors = no        # Do not read git's color settings.
85 set show-line-numbers = no      # Show line numbers?
86 set line-number-interval = 5    # Interval between line numbers
87 set horizontal-scroll = 33%     # Scroll 33% of the view width
88 set blame-options = -C -C -C    # Blame lines from other files
89 --------------------------------------------------------------------------
91 Or in the git configuration files:
93 --------------------------------------------------------------------------
94 [tig]
95         show-date = yes         # Show commit date?
96         author-width = 10       # Set width of the author column
97         line-graphics = no      # Disable graphics characters
98         tab-size = 8            # Number of spaces per tab
99 --------------------------------------------------------------------------
101 The type of variables is either bool, int, string, or mixed.
103 Valid bool values::
105         To set a bool variable to true use either "1", "true", or "yes".
106         Any other value will set the variable to false.
108 Valid int values::
110         A non-negative integer.
112 Valid string values::
114         A string of characters. Optionally, use either ' or " as delimiters.
116 Valid mixed values::
118         These values are composites of the above types. The valid values are
119         specified in the description.
121 Variables
122 ~~~~~~~~~
124 The following variables can be set:
126 'author-width' (int)::
128         Width of the author column. When set to 5 or below, the author name
129         will be abbreviated to the author's initials.
132 'filename-width' (int)::
134         Width of the filename column.
136 'id-width' (int)::
138         Width of the commit ID. When unset tig will use the value of
139         'core.abbrev' if found or default to 7.  See git-config(1) on how to
140         set 'core.abbrev'.
142 'blame-options' (string)::
144         A space separated string of extra blame options. Can be used for
145         telling git-blame(1) how to detect the origin of lines. The value
146         is ignored when tig is started in blame mode and given blame options
147         on the command line.
149 'line-graphics' (mixed) [ "ascii" | "default" | "utf-8" | bool]::
151         What type of character graphics for line drawing.
153 'line-number-interval' (int)::
155         Interval between line numbers. Note, you have to toggle on line
156         numbering with ".".  The default is to number every fifth line.
158 'horizontal-scroll' (mixed)::
160         Interval to scroll horizontally in each step. Can be specified either
161         as the number of columns, e.g. '5', or as a percentage of the view
162         width, e.g. '33%', where the maximum is 100%. For percentages it is
163         always ensured that at least one column is scrolled. The default is to
164         scroll '50%' of the view width.
166 'read-git-colors' (bool)::
168         Whether to read git's color settings. True by default.
170 'show-author' (mixed) ["abbreviated" | "full" | bool]::
172         How to display author names. If set to "abbreviated" author initials
173         will be shown. Can be toggled.
175 'show-filename' (mixed) ["auto" | "always" | bool]::
177         When to display file names. If set to "auto" file names are shown
178         only when needed, e.g. when running: tig blame -C <file>.
180 'show-date' (mixed) ["relative" | "short" | "default" | "local" | bool]::
182         Whether and how to show date. If set to "relative" a relative date will be
183         used, e.g. "2 minutes ago". If set to "short" no time information is
184         shown. If set to "local", localtime(3) is used. Can be toggled.
186 'show-notes' (mixed) [note reference | bool]::
188         Whether to show notes for a commit. When set to a note reference the
189         reference is passed to `git show --notes=`. Notes are enabled by
190         default.
192 'show-refs' (bool)::
194         Whether to show references (branches, tags, and remotes) in the main
195         view on start-up. Can be toggled.
197 'show-id' (bool)::
199         Whether to show commit IDs in the main view. Disabled by default. Can
200         be toggled. See also 'id-width' option.
202 'show-rev-graph' (bool)::
204         Whether to show revision graph in the main view on start-up.
205         Can be toggled. See also line-graphics options.
207 'show-changes' (bool)::
209         Whether to show staged and unstaged changes in the main view.
210         Can be toggled.
212 'vertical-split' (bool)::
214         Whether to split the view horizontally or vertically.
216 'split-view-height' (mixed)::
218         Height of the lower view in a split view. Can be specified either as
219         the number of rows, e.g. '5', or as a percentage of the view height,
220         e.g. '80%', where the maximum is 100%. It is always ensured that the
221         smaller of the views is at least four rows high. The default is a view
222         height of '66%'.
224 'status-untracked-dirs' (bool)::
226         Show untracked directories contents in the status view (analog to
227         `git ls-files --directory` option). On by default.
229 'tab-size' (int)::
231         Number of spaces per tab. The default is 8 spaces.
233 'diff-context' (int)::
235         Number of context lines to show for diffs.
237 'ignore-space' (mixed) ["no" | "all" | "some" | "at-eol" | bool]::
239     Ignore space changes in diff view. By default no space changes are ignored.
240     Changing this to "all", "some" or "at-eol" is equivalent to passing
241     "--ignore-all-space", "--ignore-space" or "--ignore-space-at-eol"
242     respectively to `git diff` or `git show`.
244 'commit-order' (mixed) ["default" | "topo" | "date" | "reverse" | bool]::
246         Commit ordering using the default (chronological reverse) order,
247         topological order, date order or reverse order. The default order is
248         used when the option is set to false, and topo order when set to true.
250 'ignore-case' (bool)::
252         Ignore case in searches. By default, the search is case sensitive.
254 'wrap-lines' (bool)::
256         Wrap long lines. By default, lines are not wrapped.
257         Not compatible with line numbers enabled.
259 Bind command
260 ------------
262 Using bind commands keys can be mapped to an action when pressed in a given
263 key map. The syntax is:
265 [verse]
266 *bind* 'keymap' 'key' 'action'
268 Examples:
270 --------------------------------------------------------------------------
271 # A few keybindings
272 bind main w scroll-line-up
273 bind main s scroll-line-down
274 bind main space enter
275 bind diff a previous
276 bind diff d next
277 bind diff b move-first-line
278 # An external command to update from upstream
279 bind generic F !git fetch
280 --------------------------------------------------------------------------
282 Or in the git configuration files:
284 --------------------------------------------------------------------------
285 [tig "bind"]
286         # 'unbind' the default quit key binding
287         main = Q none
288         # Cherry-pick current commit onto current branch
289         generic = C !git cherry-pick %(commit)
290 --------------------------------------------------------------------------
292 Keys are mapped by first searching the keybindings for the current view, then
293 the keybindings for the *generic* keymap, and last the default keybindings.
294 Thus, the view keybindings shadow the generic keybindings which Shadow the
295 built-in keybindings.
299 Keymaps::
301 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
302 *tree*, *blob*, *blame*, *branch*, and *generic*.  Use *generic* to set key
303 mapping in all keymaps.
305 Key values::
307 Key values should never be quoted. Use either the ASCII value or one of the
308 following symbolic key names. Symbolic key names are case insensitive, Use
309 *Hash* to bind to the `#` key, since the hash mark is used as a comment
310 character.
312 *Enter*, *Space*, *Backspace*, *Tab*, *Escape*, *Left*, *Right*, *Up*, *Down*,
313 *Insert*, *Delete*, *Hash*, *Home*, *End*, *PageUp*, *PageDown*, *F1*, *F2*, *F3*,
314 *F4*, *F5*, *F6*, *F7*, *F8*, *F9*, *F10*, *F11*, *F12*.
316 Action names::
318 Valid action names are described below. Note, all names are
319 case-insensitive, and you may use '-', '_', and '.' interchangeably,
320 e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
324 Actions
325 ~~~~~~~
327 Apart from the action names listed below, all actions starting with a '!' will
328 be available as an external command. External commands can contain variable
329 names that will be substituted before the command is run. Valid variable names
330 are:
332 .Browsing state variables
333 [frame="none",grid="none",cols="25<m,75<"]
334 |=============================================================================
335 |%(head)                |The currently viewed 'head' ID. Defaults to HEAD
336 |%(commit)              |The currently selected commit ID.
337 |%(blob)                |The currently selected blob ID.
338 |%(branch)              |The currently selected branch name.
339 |%(directory)           |The current directory path in the tree view;
340                          empty for the root directory.
341 |%(file)                |The currently selected file.
342 |%(ref)                 |The reference given to blame or HEAD if undefined.
343 |%(revargs)             |The revision arguments passed on the command line.
344 |%(fileargs)            |The file arguments passed on the command line.
345 |%(diffargs)            |The diff options passed on the command line.
346 |%(prompt)              |Prompt for the argument value.
347 |=============================================================================
349 As an example, the following external command will save the current commit as
350 a patch file: "!git format-patch -1 %(commit)". If your external command
351 requires use of dynamic features, such as subshells, expansion of environment
352 variables and process control, this can be achieved by using a combination of
353 git aliases and tig external commands. The following example entries can be
354 put in either the .gitconfig or .git/config file:
356 --------------------------------------------------------------------------
357 [alias]
358         gitk-bg = !"gitk HEAD --not $(git rev-parse --remotes) &"
359         publish = !"for i in origin public; do git push $i; done"
360 [tig "bind"]
361         # @-prefix means that the console output will not be shown.
362         generic = V !@git gitk-bg
363         generic = > !git publish
364 --------------------------------------------------------------------------
366 By default, commands are run in the foreground with their console output
367 shown. For different behavior, commands can be prefixed with one or more of
368 the following control flags to specify how it should be executed:
370 .External command control flags
371 [frame="none",grid="none",cols="25<m,75<"]
372 |=============================================================================
373 |@                      |Run the command in the background with no output.
374 |?                      |Prompt the user before executing the command.
375 |<                      |Exit tig after executing the command.
376 |=============================================================================
378 Control flags can be combined, e.g. "!?<git commit" will prompt whether to
379 execute the command and will exit tig after completion.
381 .View switching
382 [frame="none",grid="none",cols="25<m,75<"]
383 |=============================================================================
384 |view-main              |Show main view
385 |view-diff              |Show diff view
386 |view-log               |Show log view
387 |view-tree              |Show tree view
388 |view-blob              |Show blob view
389 |view-blame             |Show blame view
390 |view-branch            |Show branch view
391 |view-status            |Show status view
392 |view-stage             |Show stage view
393 |view-pager             |Show pager view
394 |view-help              |Show help page
395 |=============================================================================
397 .View manipulation
398 [frame="none",grid="none",cols="25<m,75<"]
399 |=============================================================================
400 |enter                  |Enter current line and scroll
401 |next                   |Move to next
402 |previous               |Move to previous
403 |parent                 |Move to parent
404 |view-next              |Move focus to next view
405 |refresh                |Reload and refresh view
406 |maximize               |Maximize the current view
407 |view-close             |Close the current view
408 |quit                   |Close all views and quit
409 |=============================================================================
411 .View specific actions
412 [frame="none",grid="none",cols="25<m,75<"]
413 |=============================================================================
414 |status-update          |Update file status
415 |status-merge           |Resolve unmerged file
416 |stage-update-line      |Stage single line
417 |stage-next             |Find next chunk to stage
418 |diff-context-up        |Increase the diff context
419 |diff-context-down      |Decrease the diff context
420 |=============================================================================
422 .Cursor navigation
423 [frame="none",grid="none",cols="25<m,75<"]
424 |=============================================================================
425 |move-up                |Move cursor one line up
426 |move-down              |Move cursor one line down
427 |move-page-down         |Move cursor one page down
428 |move-page-up           |Move cursor one page up
429 |move-first-line        |Move cursor to first line
430 |move-last-line         |Move cursor to last line
431 |=============================================================================
433 .Scrolling
434 [frame="none",grid="none",cols="25<m,75<"]
435 |=============================================================================
436 |scroll-line-up         |Scroll one line up
437 |scroll-line-down       |Scroll one line down
438 |scroll-page-up         |Scroll one page up
439 |scroll-page-down       |Scroll one page down
440 |scroll-first-col       |Scroll to the first column
441 |scroll-left            |Scroll one column left
442 |scroll-right           |Scroll one column right
443 |=============================================================================
445 .Searching
446 [frame="none",grid="none",cols="25<m,75<"]
447 |=============================================================================
448 |search                 |Search the view
449 |search-back            |Search backwards in the view
450 |find-next              |Find next search match
451 |find-prev              |Find previous search match
452 |=============================================================================
454 .Misc
455 [frame="none",grid="none",cols="25<m,75<"]
456 |=============================================================================
457 |prompt                 |Bring up the prompt
458 |screen-redraw          |Redraw the screen
459 |screen-resize          |Resize the screen
460 |show-version           |Show version information
461 |stop-loading           |Stop all loading views
462 |options                |Open options menu
463 |toggle-lineno          |Toggle line numbers
464 |toggle-date            |Toggle date display
465 |toggle-author          |Toggle author display
466 |toggle-filename        |Toggle file name display
467 |toggle-rev-graph       |Toggle revision graph visualization
468 |toggle-graphic         |Toggle (line) graphics mode
469 |toggle-refs            |Toggle reference display
470 |edit                   |Open in editor
471 |none                   |Do nothing
472 |=============================================================================
475 Color command
476 -------------
478 Color commands control highlighting and the user interface styles. If your
479 terminal supports color, these commands can be used to assign foreground and
480 background combinations to certain areas. Optionally, an attribute can be
481 given as the last parameter. The syntax is:
483 [verse]
484 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
486 Examples:
488 ------------------------------------------------------------------------------
489 # Override the default terminal colors to white on black.
490 color default           white   black
491 # Diff colors
492 color diff-header       yellow  default
493 color diff-index        blue    default
494 color diff-chunk        magenta default
495 color "Reported-by:"    green   default
496 --------------------------------------------------------------------------
498 Or in the git configuration files:
500 --------------------------------------------------------------------------
501 [tig "color"]
502         # A strange looking cursor line
503         cursor          red     default underline
504         # UI colors
505         title-blur      white   blue
506         title-focus     white   blue    bold
507 ------------------------------------------------------------------------------
509 Area names::
511         Can be either a built-in area name or a custom quoted string. The
512         latter allows custom color rules to be added for lines matching a
513         quoted string.
514         Valid built-in area names are described below. Note, all names are
515         case-insensitive, and you may use '-', '_', and '.' interchangeably,
516         e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
518 Color names::
520         Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
521         *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
522         default terminal colors. This is recommended for background colors if
523         you are using a terminal with a transparent background.
525 Colors can also be specified using the keywords color0, color1, ..., colorN-1
526 (N being the number of colors supported by your terminal). This is useful when
527 you remap the colors for your display or want to enable colors supported by
528 256-color terminals.
530 Attribute names::
532         Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
533         *standout*, and *underline*. Note, not all attributes may be supported
534         by the terminal.
536 UI colors
537 ~~~~~~~~~
539 The colors and attributes to be used for the text that is not highlighted or
540 that specify the use of the default terminal colors can be controlled by
541 setting the *default* color option.
543 .General
544 [frame="none",grid="none",cols="25<m,75<"]
545 |=============================================================================
546 |default                |Override default terminal colors (see above).
547 |cursor                 |The cursor line.
548 |status                 |The status window showing info messages.
549 |title-focus            |The title window for the current view.
550 |title-blur             |The title window of any backgrounded view.
551 |delimiter              |Delimiter shown for truncated lines.
552 |line-number            |Line numbers.
553 |id                     |The commit ID.
554 |date                   |The commit date.
555 |author                 |The commit author.
556 |mode                   |The file mode holding the permissions and type.
557 |=============================================================================
559 .Main view colors
560 [frame="none",grid="none",cols="25<m,75<"]
561 |=============================================================================
562 |graph-commit           |The commit dot in the revision graph.
563 |palette-[0-6]          |7 different colors,
564 used for distinguishing branches or commits.
565 example: palette-0 = red
566 |main-commit            |The commit comment.
567 |main-head              |Label of the current branch.
568 |main-remote            |Label of a remote.
569 |main-tracked           |Label of the remote tracked by the current branch.
570 |main-tag               |Label of a signed tag.
571 |main-local-tag         |Label of a local tag.
572 |main-ref               |Label of any other reference.
573 |=============================================================================
575 .Status view
576 [frame="none",grid="none",cols="25<m,75<"]
577 |=============================================================================
578 |stat-head              |The "On branch"-line.
579 |stat-section           |Status section titles,
580 |stat-staged            |Status flag of staged files.
581 |stat-unstaged          |Status flag of unstaged files.
582 |stat-untracked         |Status flag of untracked files.
583 |=============================================================================
585 .Tree view
586 [frame="none",grid="none",cols="25<m,75<"]
587 |=============================================================================
588 |tree-head              |The "Directory /"-line
589 |tree-dir               |The directory name.
590 |tree-file              |The file name.
591 |=============================================================================
593 Highlighting
594 ~~~~~~~~~~~~
598 Diff markup::
600 Options concerning diff start, chunks and lines added and deleted.
602 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
604 Enhanced git diff markup::
606 Extra diff information emitted by the git diff machinery, such as mode
607 changes, rename detection, and similarity.
609 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
610 *diff-rename-from*, *diff-rename-to*, *diff-deleted-file-mode*,
611 *diff-similarity*, *diff-dissimilarity* *diff-tree*, *diff-index*, *diff-stat*
613 Pretty print commit headers::
615 Commit diffs and the revision logs are usually formatted using pretty printed
616 headers , unless `--pretty=raw` was given. This includes lines, such as merge
617 info, commit ID, and author and committer date.
619 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*,
620 *pp-refs*
622 Raw commit header::
624 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
625 omnipresent.
627 *commit*, *parent*, *tree*, *author*, *committer*
629 Commit message::
631 `Signed-off-by`, `Acked-by`, `Reviewed-by` and `Tested-by` lines are colorized.
633 *signoff*, *acked*, *reviewed*, *tested*
635 Tree markup::
637 Colors for information of the tree view.
639 *tree-dir*, *tree-file*
643 Source command
644 -------------
646 Source commands make it possible to read additional configuration files.
647 Sourced files are included in-place, meaning when a 'source' command is
648 encountered the file will be immediately read. Any commands later in the
649 current configuration file will take precedence. The syntax is:
651 [verse]
652 *source* 'path'
654 Examples:
656 ------------------------------------------------------------------------------
657 source ~/.tig/colorscheme.tigrc
658 source ~/.tig/keybindings.tigrc
659 --------------------------------------------------------------------------
661 COPYRIGHT
662 ---------
663 Copyright (c) 2006-2012 Jonas Fonseca <fonseca@diku.dk>
665 This program is free software; you can redistribute it and/or modify
666 it under the terms of the GNU General Public License as published by
667 the Free Software Foundation; either version 2 of the License, or
668 (at your option) any later version.
670 SEE ALSO
671 --------
672 manpage:tig[1], manpage:tigmanual[7], git-config(1),
673 and the http://jonas.nitro.dk/tig/manual.html[tig manual].