git.oblomov.eu Git - tig/blob - tigrc.5.txt

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