| 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 |
| 26 | \fIset\fR variable \fI=\fR value |
| 27 | \fIbind\fR keymap key action |
| 28 | \fIcolor\fR area fgcolor bgcolor [attributes] |
| 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 | |
| 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\&. |
| 38 | |
| 39 | .SH "SET COMMAND" |
| 40 | |
| 41 | |
| 42 | A few selective variables can be configured via the set command\&. The syntax is: |
| 43 | |
| 44 | .nf |
| 45 | \fIset\fR variables \fI=\fR value |
| 46 | .fi |
| 47 | |
| 48 | |
| 49 | Examples: |
| 50 | |
| 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 |
| 57 | |
| 58 | |
| 59 | The type of variables are either bool, int, and string\&. |
| 60 | |
| 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\&. |
| 64 | |
| 65 | .TP |
| 66 | Valid int values |
| 67 | A non\-negative integer\&. |
| 68 | |
| 69 | .TP |
| 70 | Valid string values |
| 71 | A string of characters\&. Optionally, use either ' or " as delimiters\&. |
| 72 | |
| 73 | .SS "Variables" |
| 74 | |
| 75 | |
| 76 | The following variables can be set: |
| 77 | |
| 78 | .TP |
| 79 | \fIshow\-rev\-graph\fR (bool) |
| 80 | Show revision graph in the main view on startup\&. Can be toggled with \fIg\fR\&. |
| 81 | |
| 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\&. |
| 85 | |
| 86 | .TP |
| 87 | \fItab\-size\fR (int) |
| 88 | Number of spaces per tab\&. The default is 8 spaces\&. |
| 89 | |
| 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\&. |
| 93 | |
| 94 | .SH "BIND COMMAND" |
| 95 | |
| 96 | |
| 97 | Using bind commands keys can be mapped to an action when pressed in a given key map\&. The syntax is: |
| 98 | |
| 99 | .nf |
| 100 | \fIbind\fR \fIkeymap\fR \fIkey\fR \fIaction\fR |
| 101 | .fi |
| 102 | |
| 103 | |
| 104 | Examples: |
| 105 | |
| 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 |
| 114 | .fi |
| 115 | |
| 116 | |
| 117 | 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 shaddow the generic keybindings which shaddow the built\-in keybindings\&. |
| 118 | |
| 119 | .TP |
| 120 | Keymaps |
| 121 | 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\&. |
| 122 | |
| 123 | .TP |
| 124 | Key values |
| 125 | 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\&. |
| 126 | |
| 127 | \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\&. |
| 128 | |
| 129 | .TP |
| 130 | Action names |
| 131 | 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\&. |
| 132 | |
| 133 | .SS "Actions" |
| 134 | |
| 135 | .TP |
| 136 | View switching |
| 137 | |
| 138 | |
| 139 | .nf |
| 140 | view\-main Show main view |
| 141 | view\-diff Show diff view |
| 142 | view\-log Show log view |
| 143 | view\-help Show help page |
| 144 | view\-pager Show pager view |
| 145 | .fi |
| 146 | |
| 147 | .TP |
| 148 | View manipulation |
| 149 | |
| 150 | |
| 151 | .nf |
| 152 | enter Enter current line and scroll |
| 153 | next Move to next |
| 154 | previous Move to previous |
| 155 | view\-next Move focus to next view |
| 156 | view\-close Close the current view |
| 157 | quit Close all views and quit |
| 158 | .fi |
| 159 | |
| 160 | .TP |
| 161 | Cursor navigation |
| 162 | |
| 163 | |
| 164 | .nf |
| 165 | move\-up Move cursor one line up |
| 166 | move\-down Move cursor one line down |
| 167 | move\-page_down Move cursor one page down |
| 168 | move\-page_up Move cursor one page up |
| 169 | move\-first_line Move cursor to first line |
| 170 | move\-last_line Move cursor to last line |
| 171 | .fi |
| 172 | |
| 173 | .TP |
| 174 | Scrolling |
| 175 | |
| 176 | |
| 177 | .nf |
| 178 | scroll\-line_up Scroll one line up |
| 179 | scroll\-line_down Scroll one line down |
| 180 | scroll\-page_up Scroll one page up |
| 181 | scroll\-page_down Scroll one page down |
| 182 | .fi |
| 183 | |
| 184 | .TP |
| 185 | Misc |
| 186 | |
| 187 | |
| 188 | .nf |
| 189 | prompt Bring up the prompt |
| 190 | screen\-update Update the screen |
| 191 | screen\-redraw Redraw the screen |
| 192 | screen\-resize Resize the screen |
| 193 | show\-version Show version information |
| 194 | stop\-loading Stop all loading views |
| 195 | toggle\-lineno Toggle line numbers |
| 196 | toggle\-rev_graph Toggle revision graph visualization |
| 197 | .fi |
| 198 | |
| 199 | .SH "COLOR COMMAND" |
| 200 | |
| 201 | |
| 202 | Color commands control highlighting and the user interface styles\&. If your terminal supports color, these commands can be used to assign foreground and backgound combinations to certain areas\&. Optionally, an attribute can be given as the last parameter\&. The syntax is: |
| 203 | |
| 204 | .nf |
| 205 | \fIcolor\fR \fIarea\fR \fIfgcolor\fR \fIbgcolor\fR \fI[attributes]\fR |
| 206 | .fi |
| 207 | |
| 208 | |
| 209 | Examples: |
| 210 | |
| 211 | .nf |
| 212 | # Diff colors |
| 213 | color diff\-header yellow default |
| 214 | color diff\-index blue default |
| 215 | color diff\-chunk magenta default |
| 216 | # A strange looking cursor line |
| 217 | color cursor red default underline |
| 218 | # UI colors |
| 219 | color title\-blur white blue |
| 220 | color title\-focus white blue bold |
| 221 | .fi |
| 222 | |
| 223 | .TP |
| 224 | Area names |
| 225 | 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\&. |
| 226 | |
| 227 | .TP |
| 228 | Color names |
| 229 | 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\&. |
| 230 | |
| 231 | .TP |
| 232 | Attribute names |
| 233 | 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\&. |
| 234 | |
| 235 | .SS "UI colors" |
| 236 | |
| 237 | .TP |
| 238 | Status window colors |
| 239 | Appearance of the bottom window showing info messages\&. |
| 240 | |
| 241 | \fIstatus\fR |
| 242 | |
| 243 | .TP |
| 244 | Title window colors |
| 245 | Appearence of the title windows when they are attached to any backgrounded windows and the current window\&. |
| 246 | |
| 247 | \fItitle\-blur\fR, \fItitle\-focus\fR |
| 248 | |
| 249 | .TP |
| 250 | Cursor line colors |
| 251 | \fIcursor\fR |
| 252 | |
| 253 | .TP |
| 254 | Main view specific |
| 255 | 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\&. |
| 256 | |
| 257 | \fImain\-date\fR, \fImain\-author\fR, \fImain\-commit\fR, \fImain\-delim\fR, \fImain\-tag\fR, \fImain\-ref\fR |
| 258 | |
| 259 | .SS "Highlighting" |
| 260 | |
| 261 | |
| 262 | The colors and attributes for text that is not highlighted can be controlled by changing the \fIdefault\fR color option\&. |
| 263 | |
| 264 | .TP |
| 265 | Diff markup |
| 266 | Options concerning diff start, chunks and lines added and deleted\&. |
| 267 | |
| 268 | \fIdiff\-header\fR, \fIdiff\-chunk\fR, \fIdiff\-add\fR, \fIdiff\-del\fR |
| 269 | |
| 270 | .TP |
| 271 | Enhanced git diff markup |
| 272 | Extra diff information emitted by the git diff machinery, such as mode changes, rename detection, and similarity\&. |
| 273 | |
| 274 | \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 |
| 275 | |
| 276 | .TP |
| 277 | Pretty print commit headers |
| 278 | 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 comitter date\&. |
| 279 | |
| 280 | \fIpp\-author\fR, \fIpp\-commit\fR, \fIpp\-merge\fR, \fIpp\-date\fR, \fIpp\-adate\fR, \fIpp\-cdate\fR |
| 281 | |
| 282 | .TP |
| 283 | Raw commit header |
| 284 | Usually shown when \-\-pretty=raw is given, however \fIcommit\fR is pretty much omnipresent\&. |
| 285 | |
| 286 | \fIcommit\fR, \fIparent\fR, \fItree\fR, \fIauthor\fR, \fIcommitter\fR |
| 287 | |
| 288 | .TP |
| 289 | Commit message |
| 290 | For now only Signed\-off\-by lines are colorized\&. |
| 291 | |
| 292 | \fIsignoff\fR |
| 293 | |
| 294 | .SH "COPYRIGHT" |
| 295 | |
| 296 | |
| 297 | Copyright (c) 2006 Jonas Fonseca <fonseca@diku\&.dk> |
| 298 | |
| 299 | |
| 300 | Licensed under the terms of the GNU General Public License\&. |
| 301 | |
| 302 | .SH "SEE ALSO" |
| 303 | |
| 304 | |
| 305 | \fBtig\fR(1) and the tig manual: \fIhttp://jonas.nitro.dk/tig/tig.html\fR\&. |
| 306 | |