6 tigrc - tig configuration file
12 *set* 'variable' *=* 'value'
13 *bind* 'keymap' 'key' 'action'
14 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
20 You can permanently set an option by putting it in the `~/.tigrc` file. The
21 file consists of a series of 'commands'. Each line of the file may contain
24 The hash mark ('#') is used as a 'comment' character. All text after the
25 comment character to the end of the line is ignored. You can use comments to
26 annotate your initialization file.
28 Alternatively, options can be set by putting them in one of the git
29 configuration files, which are read by tig on startup. See 'git-config(1)' for
35 A few selective variables can be configured via the set command. The syntax
39 *set* variables *=* value
43 --------------------------------------------------------------------------
44 set show-author = abbreviated # Show abbreviated author names.
45 set show-date = relative # Show relative commit date.
46 set show-rev-graph = yes # Show revision graph?
47 set show-refs = yes # Show references?
48 set show-line-numbers = no # Show line numbers?
49 set line-number-interval = 5 # Interval between line numbers
50 set commit-encoding = "UTF-8" # Commit encoding
51 set horizontal-scroll = 33% # Scroll 33% of the view width
52 --------------------------------------------------------------------------
54 Or in the git configuration files:
56 --------------------------------------------------------------------------
58 show-date = yes # Show commit date?
59 author-width = 10 # Set width of the author column
60 line-graphics = no # Disable graphics characters
61 tab-size = 8 # Number of spaces per tab
62 --------------------------------------------------------------------------
64 The type of variables are either bool, int, string, or mixed.
68 To set a bool variable to true use either "1", "true", or "yes".
69 Any other value will set the variable to false.
73 A non-negative integer.
77 A string of characters. Optionally, use either ' or " as delimiters.
81 These values are composites of the above types. The valid values are
82 specified in the description.
87 The following variables can be set:
89 'show-rev-graph' (bool)::
92 Whether to show revision graph, and references (branches, tags, and
93 remotes) in the main view on start-up. Can all be toggled.
95 'show-author' (mixed) ["abbreviated" | "default" | bool]::
97 How to display author names. If set to "abbreviated" author initials
98 will be shown. Can be toggled.
100 'show-date' (mixed) ["relative" | "short" | "default" | "local" | bool]::
102 Whether and how to show date. If set to "relative" a relative date will be
103 used, e.g. "2 minutes ago". If set to "short" no time information is
104 shown. If set to "local", localtime(3) is used. Can be toggled.
106 'author-width' (int)::
108 Width of the author column. When set to 5 or below, the author name
109 will be abbreviated to the author's initials.
111 'line-graphics' (bool)::
113 Whether to use graphic characters for line drawing.
115 'line-number-interval' (int)::
117 Interval between line numbers. Note, you have to toggle on line
118 numbering with 'n' or the `-n` command line option. The default is to
123 Number of spaces per tab. The default is 8 spaces.
125 'horizontal-scroll' (mixed)::
127 Interval to scroll horizontally in each step. Can be specified either
128 as the number of columns, e.g. '5', or as a percentage of the view
129 width, e.g. '33%', where the maximum is 100%. For percentages it is
130 always ensured that at least one column is scrolled. The default is to
131 scroll '50%' of the view width.
133 'split-view-height' (mixed)::
135 Height of the lower view in a split view. Can be specified either as
136 the number of rows, e.g. '5', or as a percentage of the view height,
137 e.g. '80%', where the maximum is 100%. It is always ensured that the
138 smaller of the views is at least four rows high. The default is a view
141 'commit-encoding' (string)::
143 The encoding used for commits. The default is UTF-8. Note this option
144 is shadowed by the "i18n.commitencoding" option in `.git/config`.
149 Using bind commands keys can be mapped to an action when pressed in a given
150 key map. The syntax is:
153 *bind* 'keymap' 'key' 'action'
157 --------------------------------------------------------------------------
159 bind main w scroll-line-up
160 bind main s scroll-line-down
161 bind main space enter
164 bind diff b move-first-line
165 # An external command to update from upstream
166 bind generic F !git fetch
167 --------------------------------------------------------------------------
169 Or in the git configuration files:
171 --------------------------------------------------------------------------
173 # 'unbind' the default quit key binding
175 # Cherry-pick current commit onto current branch
176 generic = C !git cherry-pick %(commit)
177 --------------------------------------------------------------------------
179 Keys are mapped by first searching the keybindings for the current view, then
180 the keybindings for the *generic* keymap, and last the default keybindings.
181 Thus, the view keybindings shadow the generic keybindings which Shadow the
182 built-in keybindings.
188 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
189 *tree*, *blob*, *blame*, *branch*, and *generic*. Use *generic* to set key
190 mapping in all keymaps.
194 Key values should never be quoted. Use either the ASCII value or one of the
195 following symbolic key names. Symbolic key names are case insensitive, Use
196 *Hash* to bind to the `#` key, since the hash mark is used as a comment
199 *Enter*, *Space*, *Backspace*, *Tab*, *Escape*, *Left*, *Right*, *Up*, *Down*,
200 *Insert*, *Delete*, *Hash*, *Home*, *End*, *PageUp*, *PageDown*, *F1*, *F2*, *F3*,
201 *F4*, *F5*, *F6*, *F7*, *F8*, *F9*, *F10*, *F11*, *F12*.
205 Valid action names are described below. Note, all names are
206 case-insensitive, and you may use '-', '_', and '.' interchangeably,
207 e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
214 Apart from the action names listed below, all actions starting with a '!' will
215 be available as an external command. External commands can contain variable
216 names that will be substituted before the command is run. Valid variable names
219 .Browsing state variables
220 [frame="none",grid="none",cols="25<m,75<"]
221 |=============================================================================
222 |%(head) |The currently viewed 'head' ID. Defaults to HEAD
223 |%(commit) |The currently selected commit ID.
224 |%(blob) |The currently selected blob ID.
225 |%(branch) |The currently selected branch name.
226 |%(directory) |The current directory path in the tree view;
227 empty for the root directory.
228 |%(file) |The currently selected file.
229 |%(ref) |The reference given to blame or HEAD if undefined.
230 |%(revargs) |The revision arguments passed on the command line.
231 |%(fileargs) |The file arguments passed on the command line.
232 |%(diffargs) |The diff options passed on the command line.
233 |=============================================================================
235 As an example, the following external command will save the current commit as
236 a patch file: "!git format-patch -1 %(commit)". If your external command
237 require use of dynamic features, such as subshells, expansion of environment
238 variables and process control, this can be achieved by using a combination of
239 git aliases and tig external commands. The following example entries can be
240 put in either the .gitconfig or .git/config file:
242 --------------------------------------------------------------------------
244 gitk-bg = !"gitk HEAD --not $(git rev-parse --remotes) &"
245 publish = !"for i in origin public; do git push $i; done"
247 generic = V !git gitk-bg
248 generic = > !git publish
249 --------------------------------------------------------------------------
252 [frame="none",grid="none",cols="25<m,75<"]
253 |=============================================================================
254 |view-main |Show main view
255 |view-diff |Show diff view
256 |view-log |Show log view
257 |view-tree |Show tree view
258 |view-blob |Show blob view
259 |view-blame |Show blame view
260 |view-branch |Show branch view
261 |view-status |Show status view
262 |view-stage |Show stage view
263 |view-pager |Show pager view
264 |view-help |Show help page
265 |=============================================================================
268 [frame="none",grid="none",cols="25<m,75<"]
269 |=============================================================================
270 |enter |Enter current line and scroll
272 |previous |Move to previous
273 |parent |Move to parent
274 |view-next |Move focus to next view
275 |refresh |Reload and refresh view
276 |maximize |Maximize the current view
277 |view-close |Close the current view
278 |quit |Close all views and quit
279 |=============================================================================
281 .View specific actions
282 [frame="none",grid="none",cols="25<m,75<"]
283 |=============================================================================
284 |status-update |Update file status
285 |status-merge |Resolve unmerged file
286 |stage-next |Find next chunk to stage
287 |=============================================================================
290 [frame="none",grid="none",cols="25<m,75<"]
291 |=============================================================================
292 |move-up |Move cursor one line up
293 |move-down |Move cursor one line down
294 |move-page-down |Move cursor one page down
295 |move-page-up |Move cursor one page up
296 |move-first-line |Move cursor to first line
297 |move-last-line |Move cursor to last line
298 |=============================================================================
301 [frame="none",grid="none",cols="25<m,75<"]
302 |=============================================================================
303 |scroll-line-up |Scroll one line up
304 |scroll-line-down |Scroll one line down
305 |scroll-page-up |Scroll one page up
306 |scroll-page-down |Scroll one page down
307 |scroll-first-col |Scroll to the first column
308 |scroll-left |Scroll one column left
309 |scroll-right |Scroll one column right
310 |=============================================================================
313 [frame="none",grid="none",cols="25<m,75<"]
314 |=============================================================================
315 |search |Search the view
316 |search-back |Search backwards in the view
317 |find-next |Find next search match
318 |find-prev |Find previous search match
319 |=============================================================================
322 [frame="none",grid="none",cols="25<m,75<"]
323 |=============================================================================
324 |prompt |Bring up the prompt
325 |screen-redraw |Redraw the screen
326 |screen-resize |Resize the screen
327 |show-version |Show version information
328 |stop-loading |Stop all loading views
329 |options |Open options menu
330 |toggle-lineno |Toggle line numbers
331 |toggle-date |Toggle date display
332 |toggle-author |Toggle author display
333 |toggle-rev-graph |Toggle revision graph visualization
334 |toggle-refs |Toggle reference display
335 |edit |Open in editor
337 |=============================================================================
343 Color commands control highlighting and the user interface styles. If your
344 terminal supports color, these commands can be used to assign foreground and
345 background combinations to certain areas. Optionally, an attribute can be
346 given as the last parameter. The syntax is:
349 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
353 ------------------------------------------------------------------------------
354 # Overwrite the default terminal colors to white on black.
355 color default white black
357 color diff-header yellow default
358 color diff-index blue default
359 color diff-chunk magenta default
360 --------------------------------------------------------------------------
362 Or in the git configuration files:
364 --------------------------------------------------------------------------
366 # A strange looking cursor line
367 cursor red default underline
369 title-blur white blue
370 title-focus white blue bold
371 ------------------------------------------------------------------------------
375 Valid area names are described below. Note, all names are
376 case-insensitive, and you may use '-', '_', and '.' interchangeably,
377 e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
381 Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
382 *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
383 default terminal colors. This is recommended for background colors if
384 you are using a terminal with a transparent background.
386 Colors can also be specified using the keywords color0, color1, ..., colorN-1
387 (N being the number of colors supported by your terminal). This is useful when
388 you remap the colors for your display or want to enable colors supported by
393 Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
394 *standout*, and *underline*. Note, not all attributes may be supported
400 The colors and attributes to be used for the text that is not highlighted or
401 that specify the use of the default terminal colors can be controlled by
402 setting the *default* color option.
405 [frame="none",grid="none",cols="25<m,75<"]
406 |=============================================================================
407 |default |Overwrite default terminal colors (see above).
408 |cursor |The cursor line.
409 |status |The status window showing info messages.
410 |title-focus |The title window for the current view.
411 |title-blur |The title window of any backgrounded view.
412 |delimiter |Delimiter shown for truncated lines.
413 |line-number |Line numbers.
414 |date |The commit date.
415 |author |The commit author.
416 |mode |The file mode holding the permissions and type.
417 |=============================================================================
420 [frame="none",grid="none",cols="25<m,75<"]
421 |=============================================================================
422 |main-revgraph |The revision graph.
423 |main-commit |The commit comment.
424 |main-head |Label of the current branch.
425 |main-remote |Label of a remote.
426 |main-tracked |Label of the remote tracked by the current branch.
427 |main-tag |Label of a signed tag.
428 |main-local-tag |Label of a local tag.
429 |main-ref |Label of any other reference.
430 |=============================================================================
433 [frame="none",grid="none",cols="25<m,75<"]
434 |=============================================================================
435 |stat-head |The "On branch"-line.
436 |stat-section |Status section titles,
437 |stat-staged |Status flag of staged files.
438 |stat-unstaged |Status flag of unstaged files.
439 |stat-untracked |Status flag of untracked files.
440 |=============================================================================
443 [frame="none",grid="none",cols="25<m,75<"]
444 |=============================================================================
445 |blame-id |The commit ID.
446 |=============================================================================
449 [frame="none",grid="none",cols="25<m,75<"]
450 |=============================================================================
451 |tree-head |The "Directory /"-line
452 |tree-dir |The directory name.
453 |tree-file |The file name.
454 |=============================================================================
463 Options concerning diff start, chunks and lines added and deleted.
465 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
467 Enhanced git diff markup::
469 Extra diff information emitted by the git diff machinery, such as mode
470 changes, rename detection, and similarity.
472 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
473 *diff-rename-from*, *diff-rename-to*, *diff-similarity*, *diff-dissimilarity*
474 *diff-tree*, *diff-index*
476 Pretty print commit headers::
478 Commit diffs and the revision logs are usually formatted using pretty printed
479 headers , unless `--pretty=raw` was given. This includes lines, such as merge
480 info, commit ID, and author and committer date.
482 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*,
487 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
490 *commit*, *parent*, *tree*, *author*, *committer*
494 `Signed-off-by`, `Acked-by`, `Reviewed-by` and `Tested-by` lines are colorized.
496 *signoff*, *acked*, *reviewed*, *tested*
500 Colors for information of the tree view.
502 *tree-dir*, *tree-file*
508 Copyright (c) 2006-2010 Jonas Fonseca <fonseca@diku.dk>
510 Licensed under the terms of the GNU General Public License.
514 manpage:tig[1], manpage:tigmanual[7], git-config(1),
515 and the http://jonas.nitro.dk/tig/manual.html[tig manual].