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-rev-graph = yes # Show revision graph?
46 set line-number-interval = 5 # Interval between line numbers
47 set tab-size = 8 # Number of spaces pr tab
48 set encoding = "UTF-8" # Commit encoding
49 --------------------------------------------------------------------------
51 The type of variables are either bool, int, and string.
55 To set a bool variable to true use either "1", "true", or "yes".
56 Any other value will set the variable to false.
60 A non-negative integer.
64 A string of characters. Optionally, use either ' or " as delimiters.
69 The following variables can be set:
71 'show-rev-graph' (bool)::
73 Show revision graph in the main view on start-up. Can be toggled with
76 'line-number-interval' (int)::
78 Interval between line numbers. Note, you have to toggle on line
79 numbering with 'n' or the `-n` command line option. The default is to
84 Number of spaces per tab. The default is 8 spaces.
86 'commit-encoding' (string)::
88 The encoding used for commits. The default is UTF-8. Not this option
89 is shadowed by the "i18n.commitencoding" option in `.git/config`.
95 Using bind commands keys can be mapped to an action when pressed in a given
96 key map. The syntax is:
99 ..............................................................................
100 *bind* 'keymap' 'key' 'action'
101 ..............................................................................
105 --------------------------------------------------------------------------
107 bind main w scroll-line-up
108 bind main s scroll-line-down
109 bind main space enter
112 bind diff b move-first-line
113 # 'unbind' the default quit key binding
115 --------------------------------------------------------------------------
117 Keys are mapped by first searching the keybindings for the current view, then
118 the keybindings for the *generic* keymap, and last the default keybindings.
119 Thus, the view keybindings shadow the generic keybindings which Shadow the
120 built-in keybindings.
126 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
127 and *generic*. Use *generic* to set key mapping in all keymaps.
131 Key values should never be quoted. Use either the ASCII value or one of the
132 following symbolic key names. Symbolic key names are case insensitive, Use
133 *Hash* to bind to the `#` key, since the hash mark is used as a comment
136 *Enter*, *Space*, *Backspace*, *Tab*, *Escape*, *Left*, *Right*, *Up*, *Down*,
137 *Insert*, *Delete*, *Hash*, *Home*, *End*, *PageUp*, *PageDown*, *F1*, *F2*, *F3*,
138 *F4*, *F5*, *F6*, *F7*, *F8*, *F9*, *F10*, *F11*, *F12*.
142 Valid action names are described below. Note, all names are
143 case-insensitive, and you may use '-', '_', and '.' interchangeably,
144 e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
151 ifdef::backend-xhtml11[]
153 `-----------------------`-----------------------------------------------------
154 endif::backend-xhtml11[]
156 ------------------------------------------------------------------------------
157 view-main Show main view
158 view-diff Show diff view
159 view-log Show log view
160 view-tree Show tree view
161 view-blob Show blob view
162 view-status Show status view
163 view-stage Show stage view
164 view-pager Show pager view
165 view-help Show help page
166 ------------------------------------------------------------------------------
168 ifdef::backend-xhtml11[]
170 `-----------------------`-----------------------------------------------------
171 endif::backend-xhtml11[]
173 ------------------------------------------------------------------------------
174 enter Enter current line and scroll
176 previous Move to previous
177 view-next Move focus to next view
178 view-close Close the current view
179 quit Close all views and quit
180 ------------------------------------------------------------------------------
182 ifdef::backend-xhtml11[]
184 `-----------------------`-----------------------------------------------------
185 endif::backend-xhtml11[]
187 ------------------------------------------------------------------------------
188 move-up Move cursor one line up
189 move-down Move cursor one line down
190 move-page-down Move cursor one page down
191 move-page-up Move cursor one page up
192 move-first-line Move cursor to first line
193 move-last-line Move cursor to last line
194 ------------------------------------------------------------------------------
196 ifdef::backend-xhtml11[]
198 `-----------------------`-----------------------------------------------------
199 endif::backend-xhtml11[]
201 ------------------------------------------------------------------------------
202 scroll-line-up Scroll one line up
203 scroll-line-down Scroll one line down
204 scroll-page-eup Scroll one page up
205 scroll-page-down Scroll one page down
206 ------------------------------------------------------------------------------
208 ifdef::backend-xhtml11[]
210 `-----------------------`-----------------------------------------------------
211 endif::backend-xhtml11[]
213 ------------------------------------------------------------------------------
214 search Search the view
215 search-back Search backwards in the view
216 find-next Find next search match
217 find-prev Find previous search match
218 ------------------------------------------------------------------------------
220 ifdef::backend-xhtml11[]
222 `-----------------------`-----------------------------------------------------
223 endif::backend-xhtml11[]
225 ------------------------------------------------------------------------------
227 prompt Bring up the prompt
228 screen-redraw Redraw the screen
229 screen-resize Resize the screen
230 show-version Show version information
231 stop-loading Stop all loading views
232 toggle-lineno Toggle line numbers
233 toggle-rev-graph Toggle revision graph visualization
234 status-update Update file status
236 cherry-pick Cherry-pick commit to current branch
237 ------------------------------------------------------------------------------
243 Color commands control highlighting and the user interface styles. If your
244 terminal supports color, these commands can be used to assign foreground and
245 background combinations to certain areas. Optionally, an attribute can be given
246 as the last parameter. The syntax is:
249 ..............................................................................
250 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
251 ..............................................................................
255 ------------------------------------------------------------------------------
257 color diff-header yellow default
258 color diff-index blue default
259 color diff-chunk magenta default
260 # A strange looking cursor line
261 color cursor red default underline
263 color title-blur white blue
264 color title-focus white blue bold
265 ------------------------------------------------------------------------------
269 Valid area names are described below. Note, all names are
270 case-insensitive, and you may use '-', '_', and '.' interchangeably,
271 e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
275 Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
276 *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
277 default terminal colors.
281 Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
282 *standout*, and *underline*. Note, not all attributes may be supported
291 Status window colors::
293 Appearance of the bottom window showing info messages.
297 Title window colors::
299 Appearance of the title windows when they are attached
300 to any backgrounded windows and the current window.
302 *title-blur*, *title-focus*
310 Appearance of the various columns in the main view, including the '~' used for
311 delimiting long author names and labels for tag and branch references.
313 *main-date*, *main-author*, *main-commit*, *main-delim*, *main-tag*,
314 *main-ref*, *main-remote*
321 The colors and attributes for text that is not highlighted can be controlled
322 by changing the *default* color option.
328 Options concerning diff start, chunks and lines added and deleted.
330 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
332 Enhanced git diff markup::
334 Extra diff information emitted by the git diff machinery, such as mode
335 changes, rename detection, and similarity.
337 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
338 *diff-rename-from*, *diff-rename-to*, *diff-similarity* *diff-dissimilarity*
339 *diff-tree*, *diff-index*
341 Pretty print commit headers::
343 Commit diffs and the revision logs are usually formatted using pretty printed
344 headers , unless `--pretty=raw` was given. This includes lines, such as merge
345 info, commit ID, and author and committer date.
347 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*
351 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
354 *commit*, *parent*, *tree*, *author*, *committer*
358 For now only `Signed-off-by` and `Acked-by` lines are colorized.
366 Copyright (c) 2006-2007 Jonas Fonseca <fonseca@diku.dk>
368 Licensed under the terms of the GNU General Public License.
372 gitlink:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual].