6 tigrc - tig user configuration file
12 .............................................................................
13 *set* 'variable' *=* 'value'
14 *bind* 'keymap' 'key' 'action'
15 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
16 .............................................................................
22 You can permanently set an option by putting it in the `~/.tigrc` file. The
23 file consists of a series of 'commands'. Each line of the file may contain
26 The hash mark ('#') is used as a 'comment' character. All text after the
27 comment character to the end of the line is ignored. You can use comments to
28 annotate your initialization file.
34 A few selective variables can be configured via the set command. The syntax
38 ..............................................................................
39 *set* variables *=* value
40 ..............................................................................
44 --------------------------------------------------------------------------
45 set show-author = yes # Show author?
46 set show-date = yes # Show commit date?
47 set show-rev-graph = yes # Show revision graph?
48 set show-refs = yes # Show references?
49 set show-line-numbers = no # Show line numbers?
50 set author-width = 10 # Set width of the author column
51 set line-graphics = no # Disable graphics characters
52 set line-number-interval = 5 # Interval between line numbers
53 set tab-size = 8 # Number of spaces per tab
54 set encoding = "UTF-8" # Commit encoding
55 --------------------------------------------------------------------------
57 The type of variables are either bool, int, and string.
61 To set a bool variable to true use either "1", "true", or "yes".
62 Any other value will set the variable to false.
66 A non-negative integer.
70 A string of characters. Optionally, use either ' or " as delimiters.
75 The following variables can be set:
77 'show-author' (bool)::
79 'show-rev-graph' (bool)::
82 Whether to show author, date, revision graph, and references
83 (branches, tags, and remotes) in the main view on start-up. Can all be
86 'author-width' (int)::
88 Width of the author column. When set to 5 or below, the author name
89 will be abbreviated to the author's initials.
91 'line-graphics' (bool)::
93 Whether to use graphic characters for line drawing.
95 'line-number-interval' (int)::
97 Interval between line numbers. Note, you have to toggle on line
98 numbering with 'n' or the `-n` command line option. The default is to
103 Number of spaces per tab. The default is 8 spaces.
105 'commit-encoding' (string)::
107 The encoding used for commits. The default is UTF-8. Not this option
108 is shadowed by the "i18n.commitencoding" option in `.git/config`.
114 Using bind commands keys can be mapped to an action when pressed in a given
115 key map. The syntax is:
118 ..............................................................................
119 *bind* 'keymap' 'key' 'action'
120 ..............................................................................
124 --------------------------------------------------------------------------
126 bind main w scroll-line-up
127 bind main s scroll-line-down
128 bind main space enter
131 bind diff b move-first-line
132 # 'unbind' the default quit key binding
134 # An external command to update from upstream
135 bind generic F !git fetch
136 # Cherry-pick current commit onto current branch
137 bind generic C !git cherry-pick %(commit)
138 --------------------------------------------------------------------------
140 Keys are mapped by first searching the keybindings for the current view, then
141 the keybindings for the *generic* keymap, and last the default keybindings.
142 Thus, the view keybindings shadow the generic keybindings which Shadow the
143 built-in keybindings.
149 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
150 and *generic*. Use *generic* to set key mapping in all keymaps.
154 Key values should never be quoted. Use either the ASCII value or one of the
155 following symbolic key names. Symbolic key names are case insensitive, Use
156 *Hash* to bind to the `#` key, since the hash mark is used as a comment
159 *Enter*, *Space*, *Backspace*, *Tab*, *Escape*, *Left*, *Right*, *Up*, *Down*,
160 *Insert*, *Delete*, *Hash*, *Home*, *End*, *PageUp*, *PageDown*, *F1*, *F2*, *F3*,
161 *F4*, *F5*, *F6*, *F7*, *F8*, *F9*, *F10*, *F11*, *F12*.
165 Valid action names are described below. Note, all names are
166 case-insensitive, and you may use '-', '_', and '.' interchangeably,
167 e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
174 Apart from the action names listed below, all actions starting with a '!' will
175 be available as an external command. External commands can contain variable
176 names that will be substituted before the command is run. Valid variable names
179 ifdef::backend-xhtml11[]
181 `-----------------------`-----------------------------------------------------
182 endif::backend-xhtml11[]
183 Browsing state variables
184 ------------------------------------------------------------------------------
185 %(head) The currently viewed 'head' ID. Defaults to HEAD
186 %(commit) The currently selected commit ID.
187 %(blob) The currently selected blob ID.
188 %(directory) The current directory path in the tree view; \
189 empty for the root directory.
190 %(file) The currently selected file.
191 %(ref) The reference given to blame or HEAD if undefined.
192 ------------------------------------------------------------------------------
194 As an example, the following external command will save the current commit as
195 a patch file: "!git format-patch -1 %(commit)".
197 ifdef::backend-xhtml11[]
199 `-----------------------`-----------------------------------------------------
200 endif::backend-xhtml11[]
202 ------------------------------------------------------------------------------
203 view-main Show main view
204 view-diff Show diff view
205 view-log Show log view
206 view-tree Show tree view
207 view-blob Show blob view
208 view-blame Show blame view
209 view-status Show status view
210 view-stage Show stage view
211 view-pager Show pager view
212 view-help Show help page
213 ------------------------------------------------------------------------------
215 ifdef::backend-xhtml11[]
217 `-----------------------`-----------------------------------------------------
218 endif::backend-xhtml11[]
220 ------------------------------------------------------------------------------
221 enter Enter current line and scroll
223 previous Move to previous
224 parent Move to parent
225 view-next Move focus to next view
226 refresh Reload and refresh view
227 maximize Maximize the current view
228 view-close Close the current view
229 quit Close all views and quit
230 ------------------------------------------------------------------------------
232 ifdef::backend-xhtml11[]
234 `-----------------------`-----------------------------------------------------
235 endif::backend-xhtml11[]
236 View specific actions:
237 ------------------------------------------------------------------------------
238 status-update Update file status
239 status-merge Resolve unmerged file
240 stage-next Find next chunk to stage
241 ------------------------------------------------------------------------------
243 ifdef::backend-xhtml11[]
245 `-----------------------`-----------------------------------------------------
246 endif::backend-xhtml11[]
248 ------------------------------------------------------------------------------
249 move-up Move cursor one line up
250 move-down Move cursor one line down
251 move-page-down Move cursor one page down
252 move-page-up Move cursor one page up
253 move-first-line Move cursor to first line
254 move-last-line Move cursor to last line
255 ------------------------------------------------------------------------------
257 ifdef::backend-xhtml11[]
259 `-----------------------`-----------------------------------------------------
260 endif::backend-xhtml11[]
262 ------------------------------------------------------------------------------
263 scroll-line-up Scroll one line up
264 scroll-line-down Scroll one line down
265 scroll-page-eup Scroll one page up
266 scroll-page-down Scroll one page down
267 ------------------------------------------------------------------------------
269 ifdef::backend-xhtml11[]
271 `-----------------------`-----------------------------------------------------
272 endif::backend-xhtml11[]
274 ------------------------------------------------------------------------------
275 search Search the view
276 search-back Search backwards in the view
277 find-next Find next search match
278 find-prev Find previous search match
279 ------------------------------------------------------------------------------
281 ifdef::backend-xhtml11[]
283 `-----------------------`-----------------------------------------------------
284 endif::backend-xhtml11[]
286 ------------------------------------------------------------------------------
287 prompt Bring up the prompt
288 screen-redraw Redraw the screen
289 screen-resize Resize the screen
290 show-version Show version information
291 stop-loading Stop all loading views
292 toggle-lineno Toggle line numbers
293 toggle-date Toggle date display
294 toggle-author Toggle author display
295 toggle-rev-graph Toggle revision graph visualization
296 toggle-refs Toggle reference display
299 ------------------------------------------------------------------------------
305 Color commands control highlighting and the user interface styles. If your
306 terminal supports color, these commands can be used to assign foreground and
307 background combinations to certain areas. Optionally, an attribute can be
308 given as the last parameter. The syntax is:
311 ..............................................................................
312 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
313 ..............................................................................
317 ------------------------------------------------------------------------------
318 # Overwrite the default terminal colors to white on black.
319 color default white black
321 color diff-header yellow default
322 color diff-index blue default
323 color diff-chunk magenta default
324 # A strange looking cursor line
325 color cursor red default underline
327 color title-blur white blue
328 color title-focus white blue bold
329 ------------------------------------------------------------------------------
333 Valid area names are described below. Note, all names are
334 case-insensitive, and you may use '-', '_', and '.' interchangeably,
335 e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
339 Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
340 *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
341 default terminal colors. This is recommended for background colors
342 if you are using a terminal with a transparent background.
346 Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
347 *standout*, and *underline*. Note, not all attributes may be supported
353 The colors and attributes to be used for the text that is not highlighted or
354 that specify the use of the default terminal colors can be controlled by
355 setting the *default* color option.
357 ifdef::backend-xhtml11[]
359 `-----------------------`-----------------------------------------------------
360 endif::backend-xhtml11[]
362 ------------------------------------------------------------------------------
363 default Overwrite default terminal colors (see above).
364 cursor The cursor line.
365 status The status window showing info messages.
366 title-focus The title window for the current view.
367 title-blur The title window of any backgrounded view.
368 delimiter Delimiter shown for truncated lines.
369 line-number Line numbers.
370 date The commit date.
371 ------------------------------------------------------------------------------
373 ifdef::backend-xhtml11[]
375 `-----------------------`-----------------------------------------------------
376 endif::backend-xhtml11[]
378 ------------------------------------------------------------------------------
379 main-author The commit author.
380 main-revgraph The revision graph.
381 main-commit The commit comment.
382 main-head Label of the current branch.
383 main-remote Label of a remote.
384 main-tracked Label of the remote tracked by the current branch.
385 main-tag Label of a signed tag.
386 main-local-tag Label of a local tag.
387 main-ref Label of any other reference.
388 ------------------------------------------------------------------------------
390 ifdef::backend-xhtml11[]
392 `-----------------------`-----------------------------------------------------
393 endif::backend-xhtml11[]
395 ------------------------------------------------------------------------------
396 stat-head The "On branch"-line.
397 stat-section Status section titles,
398 stat-staged Status flag of staged files.
399 stat-unstaged Status flag of unstaged files.
400 stat-untracked Status flag of untracked files.
401 ------------------------------------------------------------------------------
403 ifdef::backend-xhtml11[]
405 `-----------------------`-----------------------------------------------------
406 endif::backend-xhtml11[]
408 ------------------------------------------------------------------------------
409 blame-id The commit ID.
410 ------------------------------------------------------------------------------
419 Options concerning diff start, chunks and lines added and deleted.
421 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
423 Enhanced git diff markup::
425 Extra diff information emitted by the git diff machinery, such as mode
426 changes, rename detection, and similarity.
428 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
429 *diff-rename-from*, *diff-rename-to*, *diff-similarity*, *diff-dissimilarity*
430 *diff-tree*, *diff-index*
432 Pretty print commit headers::
434 Commit diffs and the revision logs are usually formatted using pretty printed
435 headers , unless `--pretty=raw` was given. This includes lines, such as merge
436 info, commit ID, and author and committer date.
438 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*,
443 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
446 *commit*, *parent*, *tree*, *author*, *committer*
450 For now only `Signed-off-by` and `Acked-by` lines are colorized.
456 Colors for information of the tree view.
458 *tree-dir*, *tree-file*
464 Copyright (c) 2006-2009 Jonas Fonseca <fonseca@diku.dk>
466 Licensed under the terms of the GNU General Public License.
470 manpage:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual].