1 tigrc(5)
2 ========
4 NAME
5 ----
6 tigrc - tig user configuration file
9 SYNOPSIS
10 --------
11 [verse]
12 .............................................................................
13 *set* variable *=* value
14 *bind* keymap key action
15 *color* area fgcolor bgcolor [attributes]
16 .............................................................................
19 DESCRIPTION
20 -----------
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
24 only one command.
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.
31 Set command
32 -----------
34 A few selective variables can be configured via the set command. The syntax
35 is:
37 [verse]
38 ..............................................................................
39 *set* variables *=* value
40 ..............................................................................
42 Examples:
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.
53 Valid bool values::
55 To set a bool variable to true use either "1", "true", or "yes".
56 Any other value will set the variable to false.
58 Valid int values::
60 A non-negative integer.
62 Valid string values::
64 A string of characters. Optionally, use either ' or " as delimiters.
66 Variables
67 ~~~~~~~~~
69 The following variables can be set:
71 'show-rev-graph' (bool)::
73 Show revision graph in the main view on startup. Can be toggled with
74 'g'.
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
80 number every line.
82 'tab-size' (int)::
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`.
92 Bind command
93 ------------
95 Using bind commands keys can be mapped to an action when pressed in a given
96 key map. The syntax is:
98 [verse]
99 ..............................................................................
100 *bind* 'keymap' 'key' 'action'
101 ..............................................................................
103 Examples:
105 --------------------------------------------------------------------------
106 # A few keybindings
107 bind main w scroll-line-up
108 bind main s scroll-line-down
109 bind main space enter
110 bind diff a previous
111 bind diff d next
112 bind diff b move-first-line
113 # 'unbind' the default quit key binding
114 bind main Q none
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 shaddow the generic keybindings which shaddow the
120 built-in keybindings.
122 --
124 Keymaps::
126 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, and *generic*. Use
127 *generic* to set key mapping in all keymaps.
129 Key values::
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
134 character.
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*.
140 Action names::
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.
146 --
148 Actions
149 ~~~~~~~
151 ifdef::backend-xhtml11[]
152 [frame="none"]
153 `-----------------------`-----------------------------------------------------
154 endif::backend-xhtml11[]
155 View switching:
156 ------------------------------------------------------------------------------
157 view-main Show main view
158 view-diff Show diff view
159 view-log Show log view
160 view-help Show help page
161 view-pager Show pager view
162 ------------------------------------------------------------------------------
164 ifdef::backend-xhtml11[]
165 [frame="none"]
166 `-----------------------`-----------------------------------------------------
167 endif::backend-xhtml11[]
168 View manipulation:
169 ------------------------------------------------------------------------------
170 enter Enter current line and scroll
171 next Move to next
172 previous Move to previous
173 view-next Move focus to next view
174 view-close Close the current view
175 quit Close all views and quit
176 ------------------------------------------------------------------------------
178 ifdef::backend-xhtml11[]
179 [frame="none"]
180 `-----------------------`-----------------------------------------------------
181 endif::backend-xhtml11[]
182 Cursor navigation:
183 ------------------------------------------------------------------------------
184 move-up Move cursor one line up
185 move-down Move cursor one line down
186 move-page_down Move cursor one page down
187 move-page_up Move cursor one page up
188 move-first_line Move cursor to first line
189 move-last_line Move cursor to last line
190 ------------------------------------------------------------------------------
192 ifdef::backend-xhtml11[]
193 [frame="none"]
194 `-----------------------`-----------------------------------------------------
195 endif::backend-xhtml11[]
196 Scrolling:
197 ------------------------------------------------------------------------------
198 scroll-line_up Scroll one line up
199 scroll-line_down Scroll one line down
200 scroll-page_up Scroll one page up
201 scroll-page_down Scroll one page down
202 ------------------------------------------------------------------------------
204 ifdef::backend-xhtml11[]
205 [frame="none"]
206 `-----------------------`-----------------------------------------------------
207 endif::backend-xhtml11[]
208 Misc:
209 ------------------------------------------------------------------------------
210 none Do nothing
211 prompt Bring up the prompt
212 screen-redraw Redraw the screen
213 screen-resize Resize the screen
214 show-version Show version information
215 stop-loading Stop all loading views
216 toggle-lineno Toggle line numbers
217 toggle-rev_graph Toggle revision graph visualization
218 ------------------------------------------------------------------------------
221 Color command
222 -------------
224 Color commands control highlighting and the user interface styles. If your
225 terminal supports color, these commands can be used to assign foreground and
226 backgound combinations to certain areas. Optionally, an attribute can be given
227 as the last parameter. The syntax is:
229 [verse]
230 ..............................................................................
231 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
232 ..............................................................................
234 Examples:
236 ------------------------------------------------------------------------------
237 # Diff colors
238 color diff-header yellow default
239 color diff-index blue default
240 color diff-chunk magenta default
241 # A strange looking cursor line
242 color cursor red default underline
243 # UI colors
244 color title-blur white blue
245 color title-focus white blue bold
246 ------------------------------------------------------------------------------
248 Area names::
250 Valid area names are described below. Note, all names are
251 case-insensitive, and you may use '-', '_', and '.' interchangeably,
252 e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
254 Color names::
256 Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
257 *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
258 default terminal colors.
260 Attribute names::
262 Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
263 *standout*, and *underline*. Note, not all attributes may be supported
264 by the terminal.
267 UI colors
268 ~~~~~~~~~
270 --
272 Status window colors::
274 Appearance of the bottom window showing info messages.
276 *status*
278 Title window colors::
280 Appearence of the title windows when they are attached
281 to any backgrounded windows and the current window.
283 *title-blur*, *title-focus*
285 Cursor line colors::
287 *cursor*
289 Main view specific::
291 Appearance of the various columns in the main view, including the '~' used for
292 delimiting long author names and labels for tag and branch references.
294 *main-date*, *main-author*, *main-commit*, *main-delim*, *main-tag*,
295 *main-ref*
297 --
299 Highlighting
300 ~~~~~~~~~~~~
302 The colors and attributes for text that is not highlighted can be controlled
303 by changing the *default* color option.
305 --
307 Diff markup::
309 Options concerning diff start, chunks and lines added and deleted.
311 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
313 Enhanced git diff markup::
315 Extra diff information emitted by the git diff machinery, such as mode
316 changes, rename detection, and similarity.
318 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
319 *diff-rename-from*, *diff-rename-to*, *diff-similarity* *diff-dissimilarity*
320 *diff-tree*, *diff-index*
322 Pretty print commit headers::
324 Commit diffs and the revision logs are usually formatted using pretty printed
325 headers , unless `--pretty=raw` was given. This includes lines, such as merge
326 info, commit ID, and author and comitter date.
328 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*
330 Raw commit header::
332 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
333 omnipresent.
335 *commit*, *parent*, *tree*, *author*, *committer*
337 Commit message::
339 For now only `Signed-off-by` and `Acked-by` lines are colorized.
341 *signoff*, *acked*
343 --
345 COPYRIGHT
346 ---------
347 Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
349 Licensed under the terms of the GNU General Public License.
351 SEE ALSO
352 --------
353 gitlink:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual].