Document the refresh request
[tig] / tigrc.5.txt
1 tigrc(5)
2 ========
3
4 NAME
5 ----
6 tigrc - tig user configuration file
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 .............................................................................
13 *set*   variable *=* value
14 *bind*  keymap key action
15 *color* area fgcolor bgcolor [attributes]
16 .............................................................................
17
18
19 DESCRIPTION
20 -----------
21
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.
25
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.
29
30
31 Set command
32 -----------
33
34 A few selective variables can be configured via the set command. The syntax
35 is:
36
37 [verse]
38 ..............................................................................
39         *set* variables *=* value
40 ..............................................................................
41
42 Examples:
43
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 --------------------------------------------------------------------------
50
51 The type of variables are either bool, int, and string.
52
53 Valid bool values::
54
55         To set a bool variable to true use either "1", "true", or "yes".
56         Any other value will set the variable to false.
57
58 Valid int values::
59
60         A non-negative integer.
61
62 Valid string values::
63
64         A string of characters. Optionally, use either ' or " as delimiters.
65
66 Variables
67 ~~~~~~~~~
68
69 The following variables can be set:
70
71 'show-rev-graph' (bool)::
72
73         Show revision graph in the main view on start-up. Can be toggled with
74         'g'.
75
76 'line-number-interval' (int)::
77
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.
81
82 'tab-size' (int)::
83
84         Number of spaces per tab. The default is 8 spaces.
85
86 'commit-encoding' (string)::
87
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`.
90
91
92 Bind command
93 ------------
94
95 Using bind commands keys can be mapped to an action when pressed in a given
96 key map. The syntax is:
97
98 [verse]
99 ..............................................................................
100         *bind* 'keymap' 'key' 'action'
101 ..............................................................................
102
103 Examples:
104
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 --------------------------------------------------------------------------
116
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.
121
122 --
123
124 Keymaps::
125
126 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
127 and *generic*.  Use *generic* to set key mapping in all keymaps.
128
129 Key values::
130
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.
135
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*.
139
140 Action names::
141
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.
145
146 --
147
148 Actions
149 ~~~~~~~
150
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-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 ------------------------------------------------------------------------------
167
168 ifdef::backend-xhtml11[]
169 [frame="none"]
170 `-----------------------`-----------------------------------------------------
171 endif::backend-xhtml11[]
172 View manipulation:
173 ------------------------------------------------------------------------------
174 enter                   Enter current line and scroll
175 next                    Move to next
176 previous                Move to previous
177 view-next               Move focus to next view
178 refresh                 Reload and refresh view
179 view-close              Close the current view
180 quit                    Close all views and quit
181 ------------------------------------------------------------------------------
182
183 ifdef::backend-xhtml11[]
184 [frame="none"]
185 `-----------------------`-----------------------------------------------------
186 endif::backend-xhtml11[]
187 Cursor navigation:
188 ------------------------------------------------------------------------------
189 move-up                 Move cursor one line up
190 move-down               Move cursor one line down
191 move-page-down          Move cursor one page down
192 move-page-up            Move cursor one page up
193 move-first-line         Move cursor to first line
194 move-last-line          Move cursor to last line
195 ------------------------------------------------------------------------------
196
197 ifdef::backend-xhtml11[]
198 [frame="none"]
199 `-----------------------`-----------------------------------------------------
200 endif::backend-xhtml11[]
201 Scrolling:
202 ------------------------------------------------------------------------------
203 scroll-line-up          Scroll one line up
204 scroll-line-down        Scroll one line down
205 scroll-page-eup         Scroll one page up
206 scroll-page-down        Scroll one page down
207 ------------------------------------------------------------------------------
208
209 ifdef::backend-xhtml11[]
210 [frame="none"]
211 `-----------------------`-----------------------------------------------------
212 endif::backend-xhtml11[]
213 Searching:
214 ------------------------------------------------------------------------------
215 search                  Search the view
216 search-back             Search backwards in the view
217 find-next               Find next search match
218 find-prev               Find previous search match
219 ------------------------------------------------------------------------------
220
221 ifdef::backend-xhtml11[]
222 [frame="none"]
223 `-----------------------`-----------------------------------------------------
224 endif::backend-xhtml11[]
225 Misc:
226 ------------------------------------------------------------------------------
227 none                    Do nothing
228 prompt                  Bring up the prompt
229 screen-redraw           Redraw the screen
230 screen-resize           Resize the screen
231 show-version            Show version information
232 stop-loading            Stop all loading views
233 toggle-lineno           Toggle line numbers
234 toggle-rev-graph        Toggle revision graph visualization
235 status-update           Update file status
236 edit                    Open in editor
237 cherry-pick             Cherry-pick commit to current branch
238 ------------------------------------------------------------------------------
239
240
241 Color command
242 -------------
243
244 Color commands control highlighting and the user interface styles. If your
245 terminal supports color, these commands can be used to assign foreground and
246 background combinations to certain areas. Optionally, an attribute can be given
247 as the last parameter. The syntax is:
248
249 [verse]
250 ..............................................................................
251         *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
252 ..............................................................................
253
254 Examples:
255
256 ------------------------------------------------------------------------------
257         # Diff colors
258         color diff-header       yellow  default
259         color diff-index        blue    default
260         color diff-chunk        magenta default
261         # A strange looking cursor line
262         color cursor            red     default underline
263         # UI colors
264         color title-blur        white   blue
265         color title-focus       white   blue    bold
266 ------------------------------------------------------------------------------
267
268 Area names::
269
270         Valid area names are described below. Note, all names are
271         case-insensitive, and you may use '-', '_', and '.' interchangeably,
272         e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
273
274 Color names::
275
276         Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
277         *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
278         default terminal colors.
279
280 Attribute names::
281
282         Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
283         *standout*, and *underline*. Note, not all attributes may be supported
284         by the terminal.
285
286
287 UI colors
288 ~~~~~~~~~
289
290 --
291
292 Status window colors::
293
294 Appearance of the bottom window showing info messages.
295
296 *status*
297
298 Title window colors::
299
300 Appearance of the title windows when they are attached
301 to any backgrounded windows and the current window.
302
303 *title-blur*, *title-focus*
304
305 Cursor line colors::
306
307 *cursor*
308
309 Main view specific::
310
311 Appearance of the various columns in the main view, including the '~' used for
312 delimiting long author names and labels for tag and branch references.
313
314 *main-date*, *main-author*, *main-commit*, *main-delim*, *main-tag*,
315 *main-ref*, *main-remote*
316
317 --
318
319 Highlighting
320 ~~~~~~~~~~~~
321
322 The colors and attributes for text that is not highlighted can be controlled
323 by changing the *default* color option.
324
325 --
326
327 Diff markup::
328
329 Options concerning diff start, chunks and lines added and deleted.
330
331 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
332
333 Enhanced git diff markup::
334
335 Extra diff information emitted by the git diff machinery, such as mode
336 changes, rename detection, and similarity.
337
338 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
339 *diff-rename-from*, *diff-rename-to*, *diff-similarity* *diff-dissimilarity*
340 *diff-tree*, *diff-index*
341
342 Pretty print commit headers::
343
344 Commit diffs and the revision logs are usually formatted using pretty printed
345 headers , unless `--pretty=raw` was given. This includes lines, such as merge
346 info, commit ID, and author and committer date.
347
348 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*
349
350 Raw commit header::
351
352 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
353 omnipresent.
354
355 *commit*, *parent*, *tree*, *author*, *committer*
356
357 Commit message::
358
359 For now only `Signed-off-by` and `Acked-by` lines are colorized.
360
361 *signoff*, *acked*
362
363 --
364
365 COPYRIGHT
366 ---------
367 Copyright (c) 2006-2007 Jonas Fonseca <fonseca@diku.dk>
368
369 Licensed under the terms of the GNU General Public License.
370
371 SEE ALSO
372 --------
373 gitlink:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual].