tigrc.5.txt

   1 tigrc(5)
   2 ========
   3
   4 NAME
   5 ----
   6 tigrc - tig configuration file
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 *set*   'variable' *=* 'value'
  13 *bind*  'keymap' 'key' 'action'
  14 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
  15
  16
  17 DESCRIPTION
  18 -----------
  19
  20 You can permanently set an option by putting it in the `~/.tigrc` file.  The
  21 file consists of a series of 'commands'.  Each line of the file may contain
  22 only one command.
  23
  24 The hash mark ('#') is used as a 'comment' character. All text after the
  25 comment character to the end of the line is ignored. You can use comments to
  26 annotate your initialization file.
  27
  28 Alternatively, options can be set by putting them in one of the git
  29 configuration files, which are read by tig on startup. See 'git-config(1)' for
  30 which files to use.
  31
  32 Set command
  33 -----------
  34
  35 A few selective variables can be configured via the set command. The syntax
  36 is:
  37
  38 [verse]
  39 *set* variables *=* value
  40
  41 Examples:
  42
  43 --------------------------------------------------------------------------
  44 set show-author = yes           # Show author?
  45 set show-date = relative        # Show relative commit date.
  46 set show-rev-graph = yes        # Show revision graph?
  47 set show-refs = yes             # Show references?
  48 set show-line-numbers = no      # Show line numbers?
  49 set line-number-interval = 5    # Interval between line numbers
  50 set commit-encoding = "UTF-8"   # Commit encoding
  51 set horizontal-scroll = 33%     # Scroll 33% of the view width
  52 --------------------------------------------------------------------------
  53
  54 Or in the git configuration files:
  55
  56 --------------------------------------------------------------------------
  57 [tig]
  58         show-date = yes         # Show commit date?
  59         author-width = 10       # Set width of the author column
  60         line-graphics = no      # Disable graphics characters
  61         tab-size = 8            # Number of spaces per tab
  62 --------------------------------------------------------------------------
  63
  64 The type of variables are either bool, int, string, or mixed.
  65
  66 Valid bool values::
  67
  68         To set a bool variable to true use either "1", "true", or "yes".
  69         Any other value will set the variable to false.
  70
  71 Valid int values::
  72
  73         A non-negative integer.
  74
  75 Valid string values::
  76
  77         A string of characters. Optionally, use either ' or " as delimiters.
  78
  79 Valid mixed values::
  80
  81         These values are composites of the above types. The valid values are
  82         specified in the description.
  83
  84 Variables
  85 ~~~~~~~~~
  86
  87 The following variables can be set:
  88
  89 'show-author' (bool)::
  90 'show-rev-graph' (bool)::
  91 'show-refs' (bool)::
  92
  93         Whether to show author, revision graph, and references
  94         (branches, tags, and remotes) in the main view on start-up. Can all be
  95         toggled.
  96
  97 'show-date' (bool or "relative" or "short")::
  98
  99         Whether and how to show date. If set to "relative" a relative date will be
 100         used, e.g. "2 minutes ago". If set to "short" no time information is
 101         shown. Can be toggled.
 102
 103 'author-width' (int)::
 104
 105         Width of the author column. When set to 5 or below, the author name
 106         will be abbreviated to the author's initials.
 107
 108 'line-graphics' (bool)::
 109
 110         Whether to use graphic characters for line drawing.
 111
 112 'line-number-interval' (int)::
 113
 114         Interval between line numbers. Note, you have to toggle on line
 115         numbering with 'n' or the `-n` command line option.  The default is to
 116         number every line.
 117
 118 'tab-size' (int)::
 119
 120         Number of spaces per tab. The default is 8 spaces.
 121
 122 'horizontal-scroll' (mixed)::
 123
 124         Interval to scroll horizontally in each step. Can be specified either
 125         as the number of columns, e.g. '5', or as a percentage of the view
 126         width, e.g. '33%', where the maximum is 100%. For percentages it is
 127         always ensured that at least one column is scrolled. The default is to
 128         scroll '50%' of the view width.
 129
 130 'split-view-height' (mixed)::
 131
 132         Height of the lower view in a split view. Can be specified either as
 133         the number of rows, e.g. '5', or as a percentage of the view height,
 134         e.g. '80%', where the maximum is 100%. It is always ensured that the
 135         smaller of the views is at least four rows high. The default is a view
 136         height of '66%'.
 137
 138 'commit-encoding' (string)::
 139
 140         The encoding used for commits. The default is UTF-8. Not this option
 141         is shadowed by the "i18n.commitencoding" option in `.git/config`.
 142
 143 Bind command
 144 ------------
 145
 146 Using bind commands keys can be mapped to an action when pressed in a given
 147 key map. The syntax is:
 148
 149 [verse]
 150 *bind* 'keymap' 'key' 'action'
 151
 152 Examples:
 153
 154 --------------------------------------------------------------------------
 155 # A few keybindings
 156 bind main w scroll-line-up
 157 bind main s scroll-line-down
 158 bind main space enter
 159 bind diff a previous
 160 bind diff d next
 161 bind diff b move-first-line
 162 # An external command to update from upstream
 163 bind generic F !git fetch
 164 --------------------------------------------------------------------------
 165
 166 Or in the git configuration files:
 167
 168 --------------------------------------------------------------------------
 169 [tig "bind"]
 170         # 'unbind' the default quit key binding
 171         main = Q none
 172         # Cherry-pick current commit onto current branch
 173         generic = C !git cherry-pick %(commit)
 174 --------------------------------------------------------------------------
 175
 176 Keys are mapped by first searching the keybindings for the current view, then
 177 the keybindings for the *generic* keymap, and last the default keybindings.
 178 Thus, the view keybindings shadow the generic keybindings which Shadow the
 179 built-in keybindings.
 180
 181 --
 182
 183 Keymaps::
 184
 185 Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
 186 *tree*, *blob*, *blame*, *branch*, and *generic*.  Use *generic* to set key
 187 mapping in all keymaps.
 188
 189 Key values::
 190
 191 Key values should never be quoted. Use either the ASCII value or one of the
 192 following symbolic key names. Symbolic key names are case insensitive, Use
 193 *Hash* to bind to the `#` key, since the hash mark is used as a comment
 194 character.
 195
 196 *Enter*, *Space*, *Backspace*, *Tab*, *Escape*, *Left*, *Right*, *Up*, *Down*,
 197 *Insert*, *Delete*, *Hash*, *Home*, *End*, *PageUp*, *PageDown*, *F1*, *F2*, *F3*,
 198 *F4*, *F5*, *F6*, *F7*, *F8*, *F9*, *F10*, *F11*, *F12*.
 199
 200 Action names::
 201
 202 Valid action names are described below. Note, all names are
 203 case-insensitive, and you may use '-', '_', and '.' interchangeably,
 204 e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
 205
 206 --
 207
 208 Actions
 209 ~~~~~~~
 210
 211 Apart from the action names listed below, all actions starting with a '!' will
 212 be available as an external command. External commands can contain variable
 213 names that will be substituted before the command is run. Valid variable names
 214 are:
 215
 216 ifdef::backend-xhtml11[]
 217 [frame="none"]
 218 `-----------------------`-----------------------------------------------------
 219 endif::backend-xhtml11[]
 220 Browsing state variables
 221 ------------------------------------------------------------------------------
 222 %(head)                 The currently viewed 'head' ID. Defaults to HEAD
 223 %(commit)               The currently selected commit ID.
 224 %(blob)                 The currently selected blob ID.
 225 %(directory)            The current directory path in the tree view; \
 226                         empty for the root directory.
 227 %(file)                 The currently selected file.
 228 %(ref)                  The reference given to blame or HEAD if undefined.
 229 ------------------------------------------------------------------------------
 230
 231 As an example, the following external command will save the current commit as
 232 a patch file: "!git format-patch -1 %(commit)". If your external command
 233 require use of dynamic features, such as subshells, expansion of environment
 234 variables and process control, this can be achieved by using a combination of
 235 git aliases and tig external commands. The following example entries can be
 236 put in either the .gitconfig or .git/config file:
 237
 238 --------------------------------------------------------------------------
 239 [alias]
 240         gitk-bg = !"gitk HEAD --not $(git rev-parse --remotes) &"
 241         publish = !"for i in origin public; do git push $i; done"
 242 [tig "bind"]
 243         generic = V !git gitk-bg
 244         generic = > !git publish
 245 --------------------------------------------------------------------------
 246
 247 ifdef::backend-xhtml11[]
 248 [frame="none"]
 249 `-----------------------`-----------------------------------------------------
 250 endif::backend-xhtml11[]
 251 View switching:
 252 ------------------------------------------------------------------------------
 253 view-main               Show main view
 254 view-diff               Show diff view
 255 view-log                Show log view
 256 view-tree               Show tree view
 257 view-blob               Show blob view
 258 view-blame              Show blame view
 259 view-branch             Show branch view
 260 view-status             Show status view
 261 view-stage              Show stage view
 262 view-pager              Show pager view
 263 view-help               Show help page
 264 ------------------------------------------------------------------------------
 265
 266 ifdef::backend-xhtml11[]
 267 [frame="none"]
 268 `-----------------------`-----------------------------------------------------
 269 endif::backend-xhtml11[]
 270 View manipulation:
 271 ------------------------------------------------------------------------------
 272 enter                   Enter current line and scroll
 273 next                    Move to next
 274 previous                Move to previous
 275 parent                  Move to parent
 276 view-next               Move focus to next view
 277 refresh                 Reload and refresh view
 278 maximize                Maximize the current view
 279 view-close              Close the current view
 280 quit                    Close all views and quit
 281 ------------------------------------------------------------------------------
 282
 283 ifdef::backend-xhtml11[]
 284 [frame="none"]
 285 `-----------------------`-----------------------------------------------------
 286 endif::backend-xhtml11[]
 287 View specific actions:
 288 ------------------------------------------------------------------------------
 289 status-update           Update file status
 290 status-merge            Resolve unmerged file
 291 stage-next              Find next chunk to stage
 292 ------------------------------------------------------------------------------
 293
 294 ifdef::backend-xhtml11[]
 295 [frame="none"]
 296 `-----------------------`-----------------------------------------------------
 297 endif::backend-xhtml11[]
 298 Cursor navigation:
 299 ------------------------------------------------------------------------------
 300 move-up                 Move cursor one line up
 301 move-down               Move cursor one line down
 302 move-page-down          Move cursor one page down
 303 move-page-up            Move cursor one page up
 304 move-first-line         Move cursor to first line
 305 move-last-line          Move cursor to last line
 306 ------------------------------------------------------------------------------
 307
 308 ifdef::backend-xhtml11[]
 309 [frame="none"]
 310 `-----------------------`-----------------------------------------------------
 311 endif::backend-xhtml11[]
 312 Scrolling:
 313 ------------------------------------------------------------------------------
 314 scroll-line-up          Scroll one line up
 315 scroll-line-down        Scroll one line down
 316 scroll-page-up          Scroll one page up
 317 scroll-page-down        Scroll one page down
 318 scroll-left             Scroll one column left
 319 scroll-right            Scroll one column right
 320 ------------------------------------------------------------------------------
 321
 322 ifdef::backend-xhtml11[]
 323 [frame="none"]
 324 `-----------------------`-----------------------------------------------------
 325 endif::backend-xhtml11[]
 326 Searching:
 327 ------------------------------------------------------------------------------
 328 search                  Search the view
 329 search-back             Search backwards in the view
 330 find-next               Find next search match
 331 find-prev               Find previous search match
 332 ------------------------------------------------------------------------------
 333
 334 ifdef::backend-xhtml11[]
 335 [frame="none"]
 336 `-----------------------`-----------------------------------------------------
 337 endif::backend-xhtml11[]
 338 Misc:
 339 ------------------------------------------------------------------------------
 340 prompt                  Bring up the prompt
 341 screen-redraw           Redraw the screen
 342 screen-resize           Resize the screen
 343 show-version            Show version information
 344 stop-loading            Stop all loading views
 345 options                 Open options menu
 346 toggle-lineno           Toggle line numbers
 347 toggle-date             Toggle date display
 348 toggle-author           Toggle author display
 349 toggle-rev-graph        Toggle revision graph visualization
 350 toggle-refs             Toggle reference display
 351 edit                    Open in editor
 352 none                    Do nothing
 353 ------------------------------------------------------------------------------
 354
 355
 356 Color command
 357 -------------
 358
 359 Color commands control highlighting and the user interface styles. If your
 360 terminal supports color, these commands can be used to assign foreground and
 361 background combinations to certain areas. Optionally, an attribute can be
 362 given as the last parameter. The syntax is:
 363
 364 [verse]
 365 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
 366
 367 Examples:
 368
 369 ------------------------------------------------------------------------------
 370 # Overwrite the default terminal colors to white on black.
 371 color default           white   black
 372 # Diff colors
 373 color diff-header       yellow  default
 374 color diff-index        blue    default
 375 color diff-chunk        magenta default
 376 --------------------------------------------------------------------------
 377
 378 Or in the git configuration files:
 379
 380 --------------------------------------------------------------------------
 381 [tig "color"]
 382         # A strange looking cursor line
 383         cursor          red     default underline
 384         # UI colors
 385         title-blur      white   blue
 386         title-focus     white   blue    bold
 387 ------------------------------------------------------------------------------
 388
 389 Area names::
 390
 391         Valid area names are described below. Note, all names are
 392         case-insensitive, and you may use '-', '_', and '.' interchangeably,
 393         e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
 394
 395 Color names::
 396
 397         Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
 398         *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
 399         default terminal colors. This is recommended for background colors if
 400         you are using a terminal with a transparent background.
 401 +
 402 Colors can also be specified using the keywords color0, color1, ..., colorN-1
 403 (N being the number of colors supported by your terminal). This is useful when
 404 you remap the colors for your display or want to enable colors supported by
 405 256-color terminals.
 406
 407 Attribute names::
 408
 409         Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
 410         *standout*, and *underline*. Note, not all attributes may be supported
 411         by the terminal.
 412
 413 UI colors
 414 ~~~~~~~~~
 415
 416 The colors and attributes to be used for the text that is not highlighted or
 417 that specify the use of the default terminal colors can be controlled by
 418 setting the *default* color option.
 419
 420 ifdef::backend-xhtml11[]
 421 [frame="none"]
 422 `-----------------------`-----------------------------------------------------
 423 endif::backend-xhtml11[]
 424 General:
 425 ------------------------------------------------------------------------------
 426 default                 Overwrite default terminal colors (see above).
 427 cursor                  The cursor line.
 428 status                  The status window showing info messages.
 429 title-focus             The title window for the current view.
 430 title-blur              The title window of any backgrounded view.
 431 delimiter               Delimiter shown for truncated lines.
 432 line-number             Line numbers.
 433 date                    The commit date.
 434 author                  The commit author.
 435 mode                    The file mode holding the permissions and type.
 436 ------------------------------------------------------------------------------
 437
 438 ifdef::backend-xhtml11[]
 439 [frame="none"]
 440 `-----------------------`-----------------------------------------------------
 441 endif::backend-xhtml11[]
 442 Main view colors:
 443 ------------------------------------------------------------------------------
 444 main-revgraph           The revision graph.
 445 main-commit             The commit comment.
 446 main-head               Label of the current branch.
 447 main-remote             Label of a remote.
 448 main-tracked            Label of the remote tracked by the current branch.
 449 main-tag                Label of a signed tag.
 450 main-local-tag          Label of a local tag.
 451 main-ref                Label of any other reference.
 452 ------------------------------------------------------------------------------
 453
 454 ifdef::backend-xhtml11[]
 455 [frame="none"]
 456 `-----------------------`-----------------------------------------------------
 457 endif::backend-xhtml11[]
 458 Status view:
 459 ------------------------------------------------------------------------------
 460 stat-head               The "On branch"-line.
 461 stat-section            Status section titles,
 462 stat-staged             Status flag of staged files.
 463 stat-unstaged           Status flag of unstaged files.
 464 stat-untracked          Status flag of untracked files.
 465 ------------------------------------------------------------------------------
 466
 467 ifdef::backend-xhtml11[]
 468 [frame="none"]
 469 `-----------------------`-----------------------------------------------------
 470 endif::backend-xhtml11[]
 471 Blame view:
 472 ------------------------------------------------------------------------------
 473 blame-id                The commit ID.
 474 ------------------------------------------------------------------------------
 475
 476 ifdef::backend-xhtml11[]
 477 [frame="none"]
 478 `-----------------------`-----------------------------------------------------
 479 endif::backend-xhtml11[]
 480 Tree view:
 481 ------------------------------------------------------------------------------
 482 tree-head               The "Directory /"-line
 483 tree-dir                The directory name.
 484 tree-file               The file name.
 485 ------------------------------------------------------------------------------
 486
 487 Highlighting
 488 ~~~~~~~~~~~~
 489
 490 --
 491
 492 Diff markup::
 493
 494 Options concerning diff start, chunks and lines added and deleted.
 495
 496 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
 497
 498 Enhanced git diff markup::
 499
 500 Extra diff information emitted by the git diff machinery, such as mode
 501 changes, rename detection, and similarity.
 502
 503 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
 504 *diff-rename-from*, *diff-rename-to*, *diff-similarity*, *diff-dissimilarity*
 505 *diff-tree*, *diff-index*
 506
 507 Pretty print commit headers::
 508
 509 Commit diffs and the revision logs are usually formatted using pretty printed
 510 headers , unless `--pretty=raw` was given. This includes lines, such as merge
 511 info, commit ID, and author and committer date.
 512
 513 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*,
 514 *pp-refs*
 515
 516 Raw commit header::
 517
 518 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
 519 omnipresent.
 520
 521 *commit*, *parent*, *tree*, *author*, *committer*
 522
 523 Commit message::
 524
 525 For now only `Signed-off-by` and `Acked-by` lines are colorized.
 526
 527 *signoff*, *acked*
 528
 529 Tree markup::
 530
 531 Colors for information of the tree view.
 532
 533 *tree-dir*, *tree-file*
 534
 535 --
 536
 537 COPYRIGHT
 538 ---------
 539 Copyright (c) 2006-2009 Jonas Fonseca <fonseca@diku.dk>
 540
 541 Licensed under the terms of the GNU General Public License.
 542
 543 SEE ALSO
 544 --------
 545 manpage:tig[1], git-config(1),
 546 and the http://jonas.nitro.dk/tig/manual.html[tig manual].