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*, and
127 *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-pager Show pager view
164 view-help Show help page
165 ------------------------------------------------------------------------------
167 ifdef::backend-xhtml11[]
169 `-----------------------`-----------------------------------------------------
170 endif::backend-xhtml11[]
172 ------------------------------------------------------------------------------
173 enter Enter current line and scroll
175 previous Move to previous
176 view-next Move focus to next view
177 view-close Close the current view
178 quit Close all views and quit
179 ------------------------------------------------------------------------------
181 ifdef::backend-xhtml11[]
183 `-----------------------`-----------------------------------------------------
184 endif::backend-xhtml11[]
186 ------------------------------------------------------------------------------
187 move-up Move cursor one line up
188 move-down Move cursor one line down
189 move-page-down Move cursor one page down
190 move-page-up Move cursor one page up
191 move-first-line Move cursor to first line
192 move-last-line Move cursor to last line
193 ------------------------------------------------------------------------------
195 ifdef::backend-xhtml11[]
197 `-----------------------`-----------------------------------------------------
198 endif::backend-xhtml11[]
200 ------------------------------------------------------------------------------
201 scroll-line-up Scroll one line up
202 scroll-line-down Scroll one line down
203 scroll-page-eup Scroll one page up
204 scroll-page-down Scroll one page down
205 ------------------------------------------------------------------------------
207 ifdef::backend-xhtml11[]
209 `-----------------------`-----------------------------------------------------
210 endif::backend-xhtml11[]
212 ------------------------------------------------------------------------------
214 prompt Bring up the prompt
215 screen-redraw Redraw the screen
216 screen-resize Resize the screen
217 show-version Show version information
218 stop-loading Stop all loading views
219 toggle-lineno Toggle line numbers
220 toggle-rev-graph Toggle revision graph visualization
221 ------------------------------------------------------------------------------
227 Color commands control highlighting and the user interface styles. If your
228 terminal supports color, these commands can be used to assign foreground and
229 background combinations to certain areas. Optionally, an attribute can be given
230 as the last parameter. The syntax is:
233 ..............................................................................
234 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
235 ..............................................................................
239 ------------------------------------------------------------------------------
241 color diff-header yellow default
242 color diff-index blue default
243 color diff-chunk magenta default
244 # A strange looking cursor line
245 color cursor red default underline
247 color title-blur white blue
248 color title-focus white blue bold
249 ------------------------------------------------------------------------------
253 Valid area names are described below. Note, all names are
254 case-insensitive, and you may use '-', '_', and '.' interchangeably,
255 e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
259 Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
260 *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
261 default terminal colors.
265 Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
266 *standout*, and *underline*. Note, not all attributes may be supported
275 Status window colors::
277 Appearance of the bottom window showing info messages.
281 Title window colors::
283 Appearance of the title windows when they are attached
284 to any backgrounded windows and the current window.
286 *title-blur*, *title-focus*
294 Appearance of the various columns in the main view, including the '~' used for
295 delimiting long author names and labels for tag and branch references.
297 *main-date*, *main-author*, *main-commit*, *main-delim*, *main-tag*,
298 *main-ref*, *main-remote*
305 The colors and attributes for text that is not highlighted can be controlled
306 by changing the *default* color option.
312 Options concerning diff start, chunks and lines added and deleted.
314 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
316 Enhanced git diff markup::
318 Extra diff information emitted by the git diff machinery, such as mode
319 changes, rename detection, and similarity.
321 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
322 *diff-rename-from*, *diff-rename-to*, *diff-similarity* *diff-dissimilarity*
323 *diff-tree*, *diff-index*
325 Pretty print commit headers::
327 Commit diffs and the revision logs are usually formatted using pretty printed
328 headers , unless `--pretty=raw` was given. This includes lines, such as merge
329 info, commit ID, and author and committer date.
331 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*
335 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
338 *commit*, *parent*, *tree*, *author*, *committer*
342 For now only `Signed-off-by` and `Acked-by` lines are colorized.
350 Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
352 Licensed under the terms of the GNU General Public License.
356 gitlink:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual].