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-author = yes           # Show author?
  46 set show-date = yes             # Show commit date?
  47 set show-rev-graph = yes        # Show revision graph?
  48 set show-refs = yes             # Show references?
  49 set show-line-numbers = no      # Show line numbers?
  50 set author-width = 10           # Set width of the author column
  51 set line-graphics = no          # Disable graphics characters
  52 set line-number-interval = 5    # Interval between line numbers
  53 set tab-size = 8                # Number of spaces per tab
  54 set encoding = "UTF-8"          # Commit encoding
  55 --------------------------------------------------------------------------
  56
  57 The type of variables are either bool, int, and string.
  58
  59 Valid bool values::
  60
  61         To set a bool variable to true use either "1", "true", or "yes".
  62         Any other value will set the variable to false.
  63
  64 Valid int values::
  65
  66         A non-negative integer.
  67
  68 Valid string values::
  69
  70         A string of characters. Optionally, use either ' or " as delimiters.
  71
  72 Variables
  73 ~~~~~~~~~
  74
  75 The following variables can be set:
  76
  77 'show-author' (bool)::
  78 'show-date' (bool)::
  79 'show-rev-graph' (bool)::
  80 'show-refs' (bool)::
  81
  82         Whether to show author, date, revision graph, and references
  83         (branches, tags, and remotes) in the main view on start-up. Can all be
  84         toggled.
  85
  86 'author-width' (int)::
  87
  88         Width of the author column.
  89
  90 'line-graphics' (bool)::
  91
  92         Whether to use graphic characters for line drawing.
  93
  94 'line-number-interval' (int)::
  95
  96         Interval between line numbers. Note, you have to toggle on line
  97         numbering with 'n' or the `-n` command line option.  The default is to
  98         number every line.
  99
 100 'tab-size' (int)::
 101
 102         Number of spaces per tab. The default is 8 spaces.
 103
 104 'commit-encoding' (string)::
 105
 106         The encoding used for commits. The default is UTF-8. Not this option
 107         is shadowed by the "i18n.commitencoding" option in `.git/config`.
 108
 109
 110 Bind command
 111 ------------
 112
 113 Using bind commands keys can be mapped to an action when pressed in a given
 114 key map. The syntax is:
 115
 116 [verse]
 117 ..............................................................................
 118 *bind* 'keymap' 'key' 'action'
 119 ..............................................................................
 120
 121 Examples:
 122
 123 --------------------------------------------------------------------------
 124 # A few keybindings
 125 bind main w scroll-line-up
 126 bind main s scroll-line-down
 127 bind main space enter
 128 bind diff a previous
 129 bind diff d next
 130 bind diff b move-first-line
 131 # 'unbind' the default quit key binding
 132 bind main Q none
 133 # An external command to update from upstream
 134 bind generic F !git fetch
 135 # Cherry-pick current commit unto current branch
 136 bind generic C !git cherry-pick %(commit)
 137 --------------------------------------------------------------------------
 138
 139 Keys are mapped by first searching the keybindings for the current view, then
 140 the keybindings for the *generic* keymap, and last the default keybindings.
 141 Thus, the view keybindings shadow the generic keybindings which Shadow the
 142 built-in keybindings.
 143
 144 --
 145
 146 Keymaps::
 147
 148 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
 149 and *generic*.  Use *generic* to set key mapping in all keymaps.
 150
 151 Key values::
 152
 153 Key values should never be quoted. Use either the ASCII value or one of the
 154 following symbolic key names. Symbolic key names are case insensitive, Use
 155 *Hash* to bind to the `#` key, since the hash mark is used as a comment
 156 character.
 157
 158 *Enter*, *Space*, *Backspace*, *Tab*, *Escape*, *Left*, *Right*, *Up*, *Down*,
 159 *Insert*, *Delete*, *Hash*, *Home*, *End*, *PageUp*, *PageDown*, *F1*, *F2*, *F3*,
 160 *F4*, *F5*, *F6*, *F7*, *F8*, *F9*, *F10*, *F11*, *F12*.
 161
 162 Action names::
 163
 164 Valid action names are described below. Note, all names are
 165 case-insensitive, and you may use '-', '_', and '.' interchangeably,
 166 e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
 167
 168 --
 169
 170 Actions
 171 ~~~~~~~
 172
 173 Apart from the action names listed below, all actions starting with a '!' will
 174 be available as an external command. External commands can contain variable
 175 names that will be substituted before the command is run. Valid variable names
 176 are "%(head)", "%(commit)", and "%(blob)".
 177
 178 As an example, the following external command will save the current commit as
 179 a patch file: "!git format-patch %(commit)^..%(commit)".
 180
 181 ifdef::backend-xhtml11[]
 182 [frame="none"]
 183 `-----------------------`-----------------------------------------------------
 184 endif::backend-xhtml11[]
 185 View switching:
 186 ------------------------------------------------------------------------------
 187 view-main               Show main view
 188 view-diff               Show diff view
 189 view-log                Show log view
 190 view-tree               Show tree view
 191 view-blob               Show blob view
 192 view-blame              Show blame view
 193 view-status             Show status view
 194 view-stage              Show stage view
 195 view-pager              Show pager view
 196 view-help               Show help page
 197 ------------------------------------------------------------------------------
 198
 199 ifdef::backend-xhtml11[]
 200 [frame="none"]
 201 `-----------------------`-----------------------------------------------------
 202 endif::backend-xhtml11[]
 203 View manipulation:
 204 ------------------------------------------------------------------------------
 205 enter                   Enter current line and scroll
 206 next                    Move to next
 207 previous                Move to previous
 208 view-next               Move focus to next view
 209 refresh                 Reload and refresh view
 210 maximize                Maximize the current view
 211 view-close              Close the current view
 212 quit                    Close all views and quit
 213 ------------------------------------------------------------------------------
 214
 215 ifdef::backend-xhtml11[]
 216 [frame="none"]
 217 `-----------------------`-----------------------------------------------------
 218 endif::backend-xhtml11[]
 219 Cursor navigation:
 220 ------------------------------------------------------------------------------
 221 move-up                 Move cursor one line up
 222 move-down               Move cursor one line down
 223 move-page-down          Move cursor one page down
 224 move-page-up            Move cursor one page up
 225 move-first-line         Move cursor to first line
 226 move-last-line          Move cursor to last line
 227 ------------------------------------------------------------------------------
 228
 229 ifdef::backend-xhtml11[]
 230 [frame="none"]
 231 `-----------------------`-----------------------------------------------------
 232 endif::backend-xhtml11[]
 233 Scrolling:
 234 ------------------------------------------------------------------------------
 235 scroll-line-up          Scroll one line up
 236 scroll-line-down        Scroll one line down
 237 scroll-page-eup         Scroll one page up
 238 scroll-page-down        Scroll one page down
 239 ------------------------------------------------------------------------------
 240
 241 ifdef::backend-xhtml11[]
 242 [frame="none"]
 243 `-----------------------`-----------------------------------------------------
 244 endif::backend-xhtml11[]
 245 Searching:
 246 ------------------------------------------------------------------------------
 247 search                  Search the view
 248 search-back             Search backwards in the view
 249 find-next               Find next search match
 250 find-prev               Find previous search match
 251 ------------------------------------------------------------------------------
 252
 253 ifdef::backend-xhtml11[]
 254 [frame="none"]
 255 `-----------------------`-----------------------------------------------------
 256 endif::backend-xhtml11[]
 257 Misc:
 258 ------------------------------------------------------------------------------
 259 none                    Do nothing
 260 prompt                  Bring up the prompt
 261 screen-redraw           Redraw the screen
 262 screen-resize           Resize the screen
 263 show-version            Show version information
 264 stop-loading            Stop all loading views
 265 toggle-lineno           Toggle line numbers
 266 toggle-date             Toggle date display
 267 toggle-author           Toggle author display
 268 toggle-rev-graph        Toggle revision graph visualization
 269 toggle-refs             Toggle reference display
 270 status-update           Update file status
 271 status-merge            Resolve unmerged file
 272 stage-next              Find next chunk to stage
 273 tree-parent             Switch to parent directory in tree view
 274 edit                    Open in editor
 275 ------------------------------------------------------------------------------
 276
 277
 278 Color command
 279 -------------
 280
 281 Color commands control highlighting and the user interface styles. If your
 282 terminal supports color, these commands can be used to assign foreground and
 283 background combinations to certain areas. Optionally, an attribute can be
 284 given as the last parameter. The syntax is:
 285
 286 [verse]
 287 ..............................................................................
 288 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
 289 ..............................................................................
 290
 291 Examples:
 292
 293 ------------------------------------------------------------------------------
 294 # Overwrite the default terminal colors to white on black.
 295 color default           white   black
 296 # Diff colors
 297 color diff-header       yellow  default
 298 color diff-index        blue    default
 299 color diff-chunk        magenta default
 300 # A strange looking cursor line
 301 color cursor            red     default underline
 302 # UI colors
 303 color title-blur        white   blue
 304 color title-focus       white   blue    bold
 305 ------------------------------------------------------------------------------
 306
 307 Area names::
 308
 309         Valid area names are described below. Note, all names are
 310         case-insensitive, and you may use '-', '_', and '.' interchangeably,
 311         e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
 312
 313 Color names::
 314
 315         Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
 316         *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
 317         default terminal colors. This is recommended for background colors
 318         if you are using a terminal with a transparent background.
 319
 320 Attribute names::
 321
 322         Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
 323         *standout*, and *underline*. Note, not all attributes may be supported
 324         by the terminal.
 325
 326 UI colors
 327 ~~~~~~~~~
 328
 329 The colors and attributes to be used for the text that is not highlighted or
 330 that specify the use of the default terminal colors can be controlled by
 331 setting the *default* color option.
 332
 333 ifdef::backend-xhtml11[]
 334 [frame="none"]
 335 `-----------------------`-----------------------------------------------------
 336 endif::backend-xhtml11[]
 337 General:
 338 ------------------------------------------------------------------------------
 339 default                 Overwrite default terminal colors (see above).
 340 cursor                  The cursor line.
 341 status                  The status window showing info messages.
 342 title-focus             The title window for the current view.
 343 title-blur              The title window of any backgrounded view.
 344 delimiter               Delimiter shown for truncated lines.
 345 line-number             Line numbers.
 346 date                    The commit date.
 347 ------------------------------------------------------------------------------
 348
 349 ifdef::backend-xhtml11[]
 350 [frame="none"]
 351 `-----------------------`-----------------------------------------------------
 352 endif::backend-xhtml11[]
 353 Main view colors:
 354 ------------------------------------------------------------------------------
 355 main-author             The commit author.
 356 main-revgraph           The revision graph.
 357 main-commit             The commit comment.
 358 main-head               Label of the current branch.
 359 main-remote             Label of a remote.
 360 main-tracked            Label of the remote tracked by the current branch.
 361 main-tag                Label of a signed tag.
 362 main-local-tag          Label of a local tag.
 363 main-ref                Label of any other reference.
 364 ------------------------------------------------------------------------------
 365
 366 ifdef::backend-xhtml11[]
 367 [frame="none"]
 368 `-----------------------`-----------------------------------------------------
 369 endif::backend-xhtml11[]
 370 Status view:
 371 ------------------------------------------------------------------------------
 372 stat-head               The "On branch"-line.
 373 stat-section            Status section titles,
 374 stat-staged             Status flag of staged files.
 375 stat-unstaged           Status flag of unstaged files.
 376 stat-untracked          Status flag of untracked files.
 377 ------------------------------------------------------------------------------
 378
 379 ifdef::backend-xhtml11[]
 380 [frame="none"]
 381 `-----------------------`-----------------------------------------------------
 382 endif::backend-xhtml11[]
 383 Blame view:
 384 ------------------------------------------------------------------------------
 385 blame-id                The commit ID.
 386 ------------------------------------------------------------------------------
 387
 388 Highlighting
 389 ~~~~~~~~~~~~
 390
 391 --
 392
 393 Diff markup::
 394
 395 Options concerning diff start, chunks and lines added and deleted.
 396
 397 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
 398
 399 Enhanced git diff markup::
 400
 401 Extra diff information emitted by the git diff machinery, such as mode
 402 changes, rename detection, and similarity.
 403
 404 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
 405 *diff-rename-from*, *diff-rename-to*, *diff-similarity*, *diff-dissimilarity*
 406 *diff-tree*, *diff-index*
 407
 408 Pretty print commit headers::
 409
 410 Commit diffs and the revision logs are usually formatted using pretty printed
 411 headers , unless `--pretty=raw` was given. This includes lines, such as merge
 412 info, commit ID, and author and committer date.
 413
 414 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*,
 415 *pp-refs*
 416
 417 Raw commit header::
 418
 419 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
 420 omnipresent.
 421
 422 *commit*, *parent*, *tree*, *author*, *committer*
 423
 424 Commit message::
 425
 426 For now only `Signed-off-by` and `Acked-by` lines are colorized.
 427
 428 *signoff*, *acked*
 429
 430 Tree markup::
 431
 432 Colors for information of the tree view.
 433
 434 *tree-dir*, *tree-file*
 435
 436 --
 437
 438 COPYRIGHT
 439 ---------
 440 Copyright (c) 2006-2008 Jonas Fonseca <fonseca@diku.dk>
 441
 442 Licensed under the terms of the GNU General Public License.
 443
 444 SEE ALSO
 445 --------
 446 manpage:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual].