Commit | Line | Data |
---|---|---|
3ad8214b JF |
1 | .\"Generated by db2man.xsl. Don't modify this, modify the source. |
2 | .de Sh \" Subsection | |
3 | .br | |
4 | .if t .Sp | |
5 | .ne 5 | |
6 | .PP | |
7 | \fB\\$1\fR | |
8 | .PP | |
9 | .. | |
10 | .de Sp \" Vertical space (when we can't use .PP) | |
11 | .if t .sp .5v | |
12 | .if n .sp | |
13 | .. | |
14 | .de Ip \" List item | |
15 | .br | |
16 | .ie \\n(.$>=3 .ne \\$3 | |
17 | .el .ne 3 | |
18 | .IP "\\$1" \\$2 | |
19 | .. | |
20 | .TH "TIGRC" 5 "" "" "" | |
21 | .SH NAME | |
22 | tigrc \- tig user configuration file | |
23 | .SH "SYNOPSIS" | |
24 | ||
25 | .nf | |
b484cbc8 JF |
26 | \fIset\fR variable \fI=\fR value |
27 | \fIbind\fR keymap key action | |
28 | \fIcolor\fR area fgcolor bgcolor [attributes] | |
3ad8214b JF |
29 | .fi |
30 | ||
31 | .SH "DESCRIPTION" | |
32 | ||
33 | ||
34 | You can permanently set an option by putting it in the ~/\&.tigrc file\&. The file consists of a series of \fIcommands\fR\&. Each line of the file may contain only one command\&. | |
35 | ||
36 | ||
b484cbc8 | 37 | The hash mark (\fI#\fR) is used as a \fIcomment\fR character\&. All text after the comment character to the end of the line is ignored\&. You can use comments to annotate your initialization file\&. |
3ad8214b | 38 | |
b484cbc8 | 39 | .SH "SET COMMAND" |
3ad8214b JF |
40 | |
41 | ||
b484cbc8 | 42 | A few selective variables can be configured via the set command\&. The syntax is: |
3ad8214b JF |
43 | |
44 | .nf | |
b484cbc8 | 45 | \fIset\fR variables \fI=\fR value |
3ad8214b JF |
46 | .fi |
47 | ||
48 | ||
b484cbc8 | 49 | Examples: |
3ad8214b | 50 | |
b484cbc8 JF |
51 | .nf |
52 | set show\-rev\-graph = yes # Show revision graph? | |
53 | set line\-number\-interval = 5 # Interval between line numbers | |
54 | set tab\-size = 8 # Number of spaces pr tab | |
55 | set encoding = "UTF\-8" # Commit encoding | |
56 | .fi | |
3ad8214b | 57 | |
3ad8214b | 58 | |
b484cbc8 | 59 | The type of variables are either bool, int, and string\&. |
3ad8214b | 60 | |
b484cbc8 JF |
61 | .TP |
62 | Valid bool values | |
63 | To set a bool variable to true use either "1", "true", or "yes"\&. Any other value will set the variable to false\&. | |
3ad8214b | 64 | |
b484cbc8 JF |
65 | .TP |
66 | Valid int values | |
67 | A non\-negative integer\&. | |
3ad8214b | 68 | |
b484cbc8 JF |
69 | .TP |
70 | Valid string values | |
71 | A string of characters\&. Optionally, use either ' or " as delimiters\&. | |
3ad8214b | 72 | |
b484cbc8 | 73 | .SS "Variables" |
3ad8214b JF |
74 | |
75 | ||
b484cbc8 | 76 | The following variables can be set: |
3ad8214b | 77 | |
b484cbc8 JF |
78 | .TP |
79 | \fIshow\-rev\-graph\fR (bool) | |
af4c75a2 | 80 | Show revision graph in the main view on start\-up\&. Can be toggled with \fIg\fR\&. |
3ad8214b | 81 | |
b484cbc8 JF |
82 | .TP |
83 | \fIline\-number\-interval\fR (int) | |
84 | Interval between line numbers\&. Note, you have to toggle on line numbering with \fIn\fR or the \-n command line option\&. The default is to number every line\&. | |
3ad8214b | 85 | |
b484cbc8 JF |
86 | .TP |
87 | \fItab\-size\fR (int) | |
88 | Number of spaces per tab\&. The default is 8 spaces\&. | |
3ad8214b | 89 | |
b484cbc8 JF |
90 | .TP |
91 | \fIcommit\-encoding\fR (string) | |
92 | The encoding used for commits\&. The default is UTF\-8\&. Not this option is shadowed by the "i18n\&.commitencoding" option in \&.git/config\&. | |
3ad8214b | 93 | |
b484cbc8 | 94 | .SH "BIND COMMAND" |
3ad8214b | 95 | |
3ad8214b | 96 | |
b484cbc8 | 97 | Using bind commands keys can be mapped to an action when pressed in a given key map\&. The syntax is: |
3ad8214b | 98 | |
b484cbc8 JF |
99 | .nf |
100 | \fIbind\fR \fIkeymap\fR \fIkey\fR \fIaction\fR | |
101 | .fi | |
3ad8214b JF |
102 | |
103 | ||
b484cbc8 | 104 | Examples: |
3ad8214b | 105 | |
b484cbc8 JF |
106 | .nf |
107 | # A few keybindings | |
108 | bind main w scroll\-line\-up | |
109 | bind main s scroll\-line\-down | |
110 | bind main space enter | |
111 | bind diff a previous | |
112 | bind diff d next | |
113 | bind diff b move\-first\-line | |
af4c75a2 JF |
114 | # 'unbind' the default quit key binding |
115 | bind main Q none | |
b484cbc8 | 116 | .fi |
3ad8214b JF |
117 | |
118 | ||
af4c75a2 | 119 | Keys are mapped by first searching the keybindings for the current view, then the keybindings for the \fIgeneric\fR keymap, and last the default keybindings\&. Thus, the view keybindings shadow the generic keybindings which Shadow the built\-in keybindings\&. |
3ad8214b | 120 | |
b484cbc8 JF |
121 | .TP |
122 | Keymaps | |
123 | Valid keymaps are: \fImain\fR, \fIdiff\fR, \fIlog\fR, \fIhelp\fR, \fIpager\fR, and \fIgeneric\fR\&. Use \fIgeneric\fR to set key mapping in all keymaps\&. | |
3ad8214b | 124 | |
b484cbc8 JF |
125 | .TP |
126 | Key values | |
127 | Key values should never be quoted\&. Use either the ASCII value or one of the following symbolic key names\&. Symbolic key names are case insensitive, Use \fIHash\fR to bind to the # key, since the hash mark is used as a comment character\&. | |
3ad8214b | 128 | |
b484cbc8 | 129 | \fIEnter\fR, \fISpace\fR, \fIBackspace\fR, \fITab\fR, \fIEscape\fR, \fILeft\fR, \fIRight\fR, \fIUp\fR, \fIDown\fR, \fIInsert\fR, \fIDelete\fR, \fIHash\fR, \fIHome\fR, \fIEnd\fR, \fIPageUp\fR, \fIPageDown\fR, \fIF1\fR, \fIF2\fR, \fIF3\fR, \fIF4\fR, \fIF5\fR, \fIF6\fR, \fIF7\fR, \fIF8\fR, \fIF9\fR, \fIF10\fR, \fIF11\fR, \fIF12\fR\&. |
3ad8214b | 130 | |
b484cbc8 JF |
131 | .TP |
132 | Action names | |
133 | Valid action names are described below\&. Note, all names are case\-insensitive, and you may use \fI\-\fR, \fI_\fR, and \fI\&.\fR interchangeably, e\&.g\&. "view\-main", "View\&.Main", and "VIEW_MAIN" are the same\&. | |
3ad8214b | 134 | |
b484cbc8 | 135 | .SS "Actions" |
3ad8214b JF |
136 | |
137 | ||
2c14847e | 138 | View switching: |
3ad8214b | 139 | |
b484cbc8 JF |
140 | .nf |
141 | view\-main Show main view | |
142 | view\-diff Show diff view | |
143 | view\-log Show log view | |
af4c75a2 JF |
144 | view\-tree Show tree view |
145 | view\-blob Show blob view | |
b484cbc8 | 146 | view\-pager Show pager view |
af4c75a2 | 147 | view\-help Show help page |
b484cbc8 | 148 | .fi |
3ad8214b JF |
149 | |
150 | ||
2c14847e | 151 | View manipulation: |
3ad8214b | 152 | |
b484cbc8 JF |
153 | .nf |
154 | enter Enter current line and scroll | |
155 | next Move to next | |
156 | previous Move to previous | |
157 | view\-next Move focus to next view | |
158 | view\-close Close the current view | |
159 | quit Close all views and quit | |
160 | .fi | |
3ad8214b | 161 | |
3ad8214b | 162 | |
2c14847e | 163 | Cursor navigation: |
3ad8214b | 164 | |
b484cbc8 JF |
165 | .nf |
166 | move\-up Move cursor one line up | |
167 | move\-down Move cursor one line down | |
af4c75a2 JF |
168 | move\-page\-down Move cursor one page down |
169 | move\-page\-up Move cursor one page up | |
170 | move\-first\-line Move cursor to first line | |
171 | move\-last\-line Move cursor to last line | |
b484cbc8 JF |
172 | .fi |
173 | ||
3ad8214b | 174 | |
2c14847e | 175 | Scrolling: |
3ad8214b | 176 | |
b484cbc8 | 177 | .nf |
af4c75a2 JF |
178 | scroll\-line\-up Scroll one line up |
179 | scroll\-line\-down Scroll one line down | |
180 | scroll\-page\-eup Scroll one page up | |
181 | scroll\-page\-down Scroll one page down | |
b484cbc8 | 182 | .fi |
3ad8214b JF |
183 | |
184 | ||
2c14847e | 185 | Misc: |
3ad8214b | 186 | |
b484cbc8 | 187 | .nf |
af4c75a2 | 188 | none Do nothing |
b484cbc8 | 189 | prompt Bring up the prompt |
b484cbc8 JF |
190 | screen\-redraw Redraw the screen |
191 | screen\-resize Resize the screen | |
192 | show\-version Show version information | |
193 | stop\-loading Stop all loading views | |
194 | toggle\-lineno Toggle line numbers | |
af4c75a2 | 195 | toggle\-rev\-graph Toggle revision graph visualization |
b484cbc8 | 196 | .fi |
3ad8214b | 197 | |
b484cbc8 | 198 | .SH "COLOR COMMAND" |
3ad8214b | 199 | |
3ad8214b | 200 | |
af4c75a2 | 201 | Color commands control highlighting and the user interface styles\&. If your terminal supports color, these commands can be used to assign foreground and background combinations to certain areas\&. Optionally, an attribute can be given as the last parameter\&. The syntax is: |
3ad8214b JF |
202 | |
203 | .nf | |
b484cbc8 | 204 | \fIcolor\fR \fIarea\fR \fIfgcolor\fR \fIbgcolor\fR \fI[attributes]\fR |
3ad8214b JF |
205 | .fi |
206 | ||
b484cbc8 JF |
207 | |
208 | Examples: | |
209 | ||
210 | .nf | |
211 | # Diff colors | |
212 | color diff\-header yellow default | |
213 | color diff\-index blue default | |
214 | color diff\-chunk magenta default | |
215 | # A strange looking cursor line | |
216 | color cursor red default underline | |
217 | # UI colors | |
218 | color title\-blur white blue | |
219 | color title\-focus white blue bold | |
220 | .fi | |
221 | ||
222 | .TP | |
223 | Area names | |
224 | Valid area names are described below\&. Note, all names are case\-insensitive, and you may use \fI\-\fR, \fI_\fR, and \fI\&.\fR interchangeably, e\&.g\&. "Diff\-Header", "DIFF_HEADER", and "diff\&.header" are the same\&. | |
225 | ||
226 | .TP | |
227 | Color names | |
228 | Valid colors include: \fIwhite\fR, \fIblack\fR, \fIgreen\fR, \fImagenta\fR, \fIblue\fR, \fIcyan\fR, \fIyellow\fR, \fIred\fR, \fIdefault\fR\&. Use \fIdefault\fR to refer to the default terminal colors\&. | |
229 | ||
230 | .TP | |
231 | Attribute names | |
232 | Valid attributes include: \fInormal\fR, \fIblink\fR, \fIbold\fR, \fIdim\fR, \fIreverse\fR, \fIstandout\fR, and \fIunderline\fR\&. Note, not all attributes may be supported by the terminal\&. | |
233 | ||
234 | .SS "UI colors" | |
235 | ||
236 | .TP | |
237 | Status window colors | |
238 | Appearance of the bottom window showing info messages\&. | |
239 | ||
240 | \fIstatus\fR | |
241 | ||
242 | .TP | |
243 | Title window colors | |
af4c75a2 | 244 | Appearance of the title windows when they are attached to any backgrounded windows and the current window\&. |
b484cbc8 JF |
245 | |
246 | \fItitle\-blur\fR, \fItitle\-focus\fR | |
247 | ||
248 | .TP | |
249 | Cursor line colors | |
250 | \fIcursor\fR | |
251 | ||
252 | .TP | |
253 | Main view specific | |
254 | Appearance of the various columns in the main view, including the \fI~\fR used for delimiting long author names and labels for tag and branch references\&. | |
255 | ||
256 | \fImain\-date\fR, \fImain\-author\fR, \fImain\-commit\fR, \fImain\-delim\fR, \fImain\-tag\fR, \fImain\-ref\fR | |
257 | ||
258 | .SS "Highlighting" | |
259 | ||
260 | ||
261 | The colors and attributes for text that is not highlighted can be controlled by changing the \fIdefault\fR color option\&. | |
262 | ||
263 | .TP | |
264 | Diff markup | |
265 | Options concerning diff start, chunks and lines added and deleted\&. | |
266 | ||
267 | \fIdiff\-header\fR, \fIdiff\-chunk\fR, \fIdiff\-add\fR, \fIdiff\-del\fR | |
268 | ||
269 | .TP | |
270 | Enhanced git diff markup | |
271 | Extra diff information emitted by the git diff machinery, such as mode changes, rename detection, and similarity\&. | |
272 | ||
273 | \fIdiff\-oldmode\fR, \fIdiff\-newmode\fR, \fIdiff\-copy\-from\fR, \fIdiff\-copy\-to\fR, \fIdiff\-rename\-from\fR, \fIdiff\-rename\-to\fR, \fIdiff\-similarity\fR \fIdiff\-dissimilarity\fR \fIdiff\-tree\fR, \fIdiff\-index\fR | |
274 | ||
275 | .TP | |
276 | Pretty print commit headers | |
af4c75a2 | 277 | Commit diffs and the revision logs are usually formatted using pretty printed headers , unless \-\-pretty=raw was given\&. This includes lines, such as merge info, commit ID, and author and committer date\&. |
b484cbc8 JF |
278 | |
279 | \fIpp\-author\fR, \fIpp\-commit\fR, \fIpp\-merge\fR, \fIpp\-date\fR, \fIpp\-adate\fR, \fIpp\-cdate\fR | |
280 | ||
281 | .TP | |
282 | Raw commit header | |
283 | Usually shown when \-\-pretty=raw is given, however \fIcommit\fR is pretty much omnipresent\&. | |
284 | ||
285 | \fIcommit\fR, \fIparent\fR, \fItree\fR, \fIauthor\fR, \fIcommitter\fR | |
286 | ||
287 | .TP | |
288 | Commit message | |
af4c75a2 | 289 | For now only Signed\-off\-by and Acked\-by lines are colorized\&. |
b484cbc8 | 290 | |
af4c75a2 | 291 | \fIsignoff\fR, \fIacked\fR |
b484cbc8 JF |
292 | |
293 | .SH "COPYRIGHT" | |
294 | ||
295 | ||
296 | Copyright (c) 2006 Jonas Fonseca <fonseca@diku\&.dk> | |
297 | ||
298 | ||
299 | Licensed under the terms of the GNU General Public License\&. | |
300 | ||
3ad8214b JF |
301 | .SH "SEE ALSO" |
302 | ||
303 | ||
5c09dc14 | 304 | \fBtig\fR(1) and the tig manual: \fIhttp://jonas.nitro.dk/tig/manual.html\fR\&. |
3ad8214b | 305 |