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