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]'
17 DESCRIPTION
18 -----------
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
22 only one command.
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
30 which files to use.
32 Set command
33 -----------
35 A few selective variables can be configured via the set command. The syntax
36 is:
38 [verse]
39 *set* variables *=* value
41 Examples:
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 --------------------------------------------------------------------------
57 [tig]
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.
66 Valid bool values::
68 To set a bool variable to true use either "1", "true", or "yes".
69 Any other value will set the variable to false.
71 Valid int values::
73 A non-negative integer.
75 Valid string values::
77 A string of characters. Optionally, use either ' or " as delimiters.
79 Valid mixed values::
81 These values are composites of the above types. The valid values are
82 specified in the description.
84 Variables
85 ~~~~~~~~~
87 The following variables can be set:
89 'show-rev-graph' (bool)::
90 'show-refs' (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
119 number every line.
121 'tab-size' (int)::
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
139 height of '66%'.
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`.
146 'status-untracked-dirs' (bool)::
148 Show untracked directories contents in the status view (analog to
149 `git ls-files --directory` option. On by default.
152 Bind command
153 ------------
155 Using bind commands keys can be mapped to an action when pressed in a given
156 key map. The syntax is:
158 [verse]
159 *bind* 'keymap' 'key' 'action'
161 Examples:
163 --------------------------------------------------------------------------
164 # A few keybindings
165 bind main w scroll-line-up
166 bind main s scroll-line-down
167 bind main space enter
168 bind diff a previous
169 bind diff d next
170 bind diff b move-first-line
171 # An external command to update from upstream
172 bind generic F !git fetch
173 --------------------------------------------------------------------------
175 Or in the git configuration files:
177 --------------------------------------------------------------------------
178 [tig "bind"]
179 # 'unbind' the default quit key binding
180 main = Q none
181 # Cherry-pick current commit onto current branch
182 generic = C !git cherry-pick %(commit)
183 --------------------------------------------------------------------------
185 Keys are mapped by first searching the keybindings for the current view, then
186 the keybindings for the *generic* keymap, and last the default keybindings.
187 Thus, the view keybindings shadow the generic keybindings which Shadow the
188 built-in keybindings.
190 --
192 Keymaps::
194 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
195 *tree*, *blob*, *blame*, *branch*, and *generic*. Use *generic* to set key
196 mapping in all keymaps.
198 Key values::
200 Key values should never be quoted. Use either the ASCII value or one of the
201 following symbolic key names. Symbolic key names are case insensitive, Use
202 *Hash* to bind to the `#` key, since the hash mark is used as a comment
203 character.
205 *Enter*, *Space*, *Backspace*, *Tab*, *Escape*, *Left*, *Right*, *Up*, *Down*,
206 *Insert*, *Delete*, *Hash*, *Home*, *End*, *PageUp*, *PageDown*, *F1*, *F2*, *F3*,
207 *F4*, *F5*, *F6*, *F7*, *F8*, *F9*, *F10*, *F11*, *F12*.
209 Action names::
211 Valid action names are described below. Note, all names are
212 case-insensitive, and you may use '-', '_', and '.' interchangeably,
213 e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
215 --
217 Actions
218 ~~~~~~~
220 Apart from the action names listed below, all actions starting with a '!' will
221 be available as an external command. External commands can contain variable
222 names that will be substituted before the command is run. Valid variable names
223 are:
225 .Browsing state variables
226 [frame="none",grid="none",cols="25<m,75<"]
227 |=============================================================================
228 |%(head) |The currently viewed 'head' ID. Defaults to HEAD
229 |%(commit) |The currently selected commit ID.
230 |%(blob) |The currently selected blob ID.
231 |%(branch) |The currently selected branch name.
232 |%(directory) |The current directory path in the tree view;
233 empty for the root directory.
234 |%(file) |The currently selected file.
235 |%(ref) |The reference given to blame or HEAD if undefined.
236 |%(revargs) |The revision arguments passed on the command line.
237 |%(fileargs) |The file arguments passed on the command line.
238 |%(diffargs) |The diff options passed on the command line.
239 |=============================================================================
241 As an example, the following external command will save the current commit as
242 a patch file: "!git format-patch -1 %(commit)". If your external command
243 require use of dynamic features, such as subshells, expansion of environment
244 variables and process control, this can be achieved by using a combination of
245 git aliases and tig external commands. The following example entries can be
246 put in either the .gitconfig or .git/config file:
248 --------------------------------------------------------------------------
249 [alias]
250 gitk-bg = !"gitk HEAD --not $(git rev-parse --remotes) &"
251 publish = !"for i in origin public; do git push $i; done"
252 [tig "bind"]
253 generic = V !git gitk-bg
254 generic = > !git publish
255 --------------------------------------------------------------------------
257 .View switching
258 [frame="none",grid="none",cols="25<m,75<"]
259 |=============================================================================
260 |view-main |Show main view
261 |view-diff |Show diff view
262 |view-log |Show log view
263 |view-tree |Show tree view
264 |view-blob |Show blob view
265 |view-blame |Show blame view
266 |view-branch |Show branch view
267 |view-status |Show status view
268 |view-stage |Show stage view
269 |view-pager |Show pager view
270 |view-help |Show help page
271 |=============================================================================
273 .View manipulation
274 [frame="none",grid="none",cols="25<m,75<"]
275 |=============================================================================
276 |enter |Enter current line and scroll
277 |next |Move to next
278 |previous |Move to previous
279 |parent |Move to parent
280 |view-next |Move focus to next view
281 |refresh |Reload and refresh view
282 |maximize |Maximize the current view
283 |view-close |Close the current view
284 |quit |Close all views and quit
285 |=============================================================================
287 .View specific actions
288 [frame="none",grid="none",cols="25<m,75<"]
289 |=============================================================================
290 |status-update |Update file status
291 |status-merge |Resolve unmerged file
292 |stage-next |Find next chunk to stage
293 |=============================================================================
295 .Cursor navigation
296 [frame="none",grid="none",cols="25<m,75<"]
297 |=============================================================================
298 |move-up |Move cursor one line up
299 |move-down |Move cursor one line down
300 |move-page-down |Move cursor one page down
301 |move-page-up |Move cursor one page up
302 |move-first-line |Move cursor to first line
303 |move-last-line |Move cursor to last line
304 |=============================================================================
306 .Scrolling
307 [frame="none",grid="none",cols="25<m,75<"]
308 |=============================================================================
309 |scroll-line-up |Scroll one line up
310 |scroll-line-down |Scroll one line down
311 |scroll-page-up |Scroll one page up
312 |scroll-page-down |Scroll one page down
313 |scroll-first-col |Scroll to the first column
314 |scroll-left |Scroll one column left
315 |scroll-right |Scroll one column right
316 |=============================================================================
318 .Searching
319 [frame="none",grid="none",cols="25<m,75<"]
320 |=============================================================================
321 |search |Search the view
322 |search-back |Search backwards in the view
323 |find-next |Find next search match
324 |find-prev |Find previous search match
325 |=============================================================================
327 .Misc
328 [frame="none",grid="none",cols="25<m,75<"]
329 |=============================================================================
330 |prompt |Bring up the prompt
331 |screen-redraw |Redraw the screen
332 |screen-resize |Resize the screen
333 |show-version |Show version information
334 |stop-loading |Stop all loading views
335 |options |Open options menu
336 |toggle-lineno |Toggle line numbers
337 |toggle-date |Toggle date display
338 |toggle-author |Toggle author display
339 |toggle-rev-graph |Toggle revision graph visualization
340 |toggle-refs |Toggle reference display
341 |edit |Open in editor
342 |none |Do nothing
343 |=============================================================================
346 Color command
347 -------------
349 Color commands control highlighting and the user interface styles. If your
350 terminal supports color, these commands can be used to assign foreground and
351 background combinations to certain areas. Optionally, an attribute can be
352 given as the last parameter. The syntax is:
354 [verse]
355 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
357 Examples:
359 ------------------------------------------------------------------------------
360 # Overwrite the default terminal colors to white on black.
361 color default white black
362 # Diff colors
363 color diff-header yellow default
364 color diff-index blue default
365 color diff-chunk magenta default
366 --------------------------------------------------------------------------
368 Or in the git configuration files:
370 --------------------------------------------------------------------------
371 [tig "color"]
372 # A strange looking cursor line
373 cursor red default underline
374 # UI colors
375 title-blur white blue
376 title-focus white blue bold
377 ------------------------------------------------------------------------------
379 Area names::
381 Valid area names are described below. Note, all names are
382 case-insensitive, and you may use '-', '_', and '.' interchangeably,
383 e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
385 Color names::
387 Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
388 *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
389 default terminal colors. This is recommended for background colors if
390 you are using a terminal with a transparent background.
391 +
392 Colors can also be specified using the keywords color0, color1, ..., colorN-1
393 (N being the number of colors supported by your terminal). This is useful when
394 you remap the colors for your display or want to enable colors supported by
395 256-color terminals.
397 Attribute names::
399 Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
400 *standout*, and *underline*. Note, not all attributes may be supported
401 by the terminal.
403 UI colors
404 ~~~~~~~~~
406 The colors and attributes to be used for the text that is not highlighted or
407 that specify the use of the default terminal colors can be controlled by
408 setting the *default* color option.
410 .General
411 [frame="none",grid="none",cols="25<m,75<"]
412 |=============================================================================
413 |default |Overwrite default terminal colors (see above).
414 |cursor |The cursor line.
415 |status |The status window showing info messages.
416 |title-focus |The title window for the current view.
417 |title-blur |The title window of any backgrounded view.
418 |delimiter |Delimiter shown for truncated lines.
419 |line-number |Line numbers.
420 |date |The commit date.
421 |author |The commit author.
422 |mode |The file mode holding the permissions and type.
423 |=============================================================================
425 .Main view colors
426 [frame="none",grid="none",cols="25<m,75<"]
427 |=============================================================================
428 |main-revgraph |The revision graph.
429 |main-commit |The commit comment.
430 |main-head |Label of the current branch.
431 |main-remote |Label of a remote.
432 |main-tracked |Label of the remote tracked by the current branch.
433 |main-tag |Label of a signed tag.
434 |main-local-tag |Label of a local tag.
435 |main-ref |Label of any other reference.
436 |=============================================================================
438 .Status view
439 [frame="none",grid="none",cols="25<m,75<"]
440 |=============================================================================
441 |stat-head |The "On branch"-line.
442 |stat-section |Status section titles,
443 |stat-staged |Status flag of staged files.
444 |stat-unstaged |Status flag of unstaged files.
445 |stat-untracked |Status flag of untracked files.
446 |=============================================================================
448 .Blame view
449 [frame="none",grid="none",cols="25<m,75<"]
450 |=============================================================================
451 |blame-id |The commit ID.
452 |=============================================================================
454 .Tree view
455 [frame="none",grid="none",cols="25<m,75<"]
456 |=============================================================================
457 |tree-head |The "Directory /"-line
458 |tree-dir |The directory name.
459 |tree-file |The file name.
460 |=============================================================================
462 Highlighting
463 ~~~~~~~~~~~~
465 --
467 Diff markup::
469 Options concerning diff start, chunks and lines added and deleted.
471 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
473 Enhanced git diff markup::
475 Extra diff information emitted by the git diff machinery, such as mode
476 changes, rename detection, and similarity.
478 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
479 *diff-rename-from*, *diff-rename-to*, *diff-similarity*, *diff-dissimilarity*
480 *diff-tree*, *diff-index*
482 Pretty print commit headers::
484 Commit diffs and the revision logs are usually formatted using pretty printed
485 headers , unless `--pretty=raw` was given. This includes lines, such as merge
486 info, commit ID, and author and committer date.
488 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*,
489 *pp-refs*
491 Raw commit header::
493 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
494 omnipresent.
496 *commit*, *parent*, *tree*, *author*, *committer*
498 Commit message::
500 `Signed-off-by`, `Acked-by`, `Reviewed-by` and `Tested-by` lines are colorized.
502 *signoff*, *acked*, *reviewed*, *tested*
504 Tree markup::
506 Colors for information of the tree view.
508 *tree-dir*, *tree-file*
510 --
512 COPYRIGHT
513 ---------
514 Copyright (c) 2006-2010 Jonas Fonseca <fonseca@diku.dk>
516 Licensed under the terms of the GNU General Public License.
518 SEE ALSO
519 --------
520 manpage:tig[1], manpage:tigmanual[7], git-config(1),
521 and the http://jonas.nitro.dk/tig/manual.html[tig manual].