git.oblomov.eu Git - tig/blob - 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 onto 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:
 177
 178 ifdef::backend-xhtml11[]
 179 [frame="none"]
 180 `-----------------------`-----------------------------------------------------
 181 endif::backend-xhtml11[]
 182 Browsing state variables
 183 ------------------------------------------------------------------------------
 184 %(head)                 The currently viewed 'head' ID. Defaults to HEAD
 185 %(commit)               The currently selected commit ID.
 186 %(blob)                 The currently selected blob ID.
 187 ------------------------------------------------------------------------------
 188
 189 As an example, the following external command will save the current commit as
 190 a patch file: "!git format-patch -1 %(commit)".
 191
 192 ifdef::backend-xhtml11[]
 193 [frame="none"]
 194 `-----------------------`-----------------------------------------------------
 195 endif::backend-xhtml11[]
 196 View switching:
 197 ------------------------------------------------------------------------------
 198 view-main               Show main view
 199 view-diff               Show diff view
 200 view-log                Show log view
 201 view-tree               Show tree view
 202 view-blob               Show blob view
 203 view-blame              Show blame view
 204 view-status             Show status view
 205 view-stage              Show stage view
 206 view-pager              Show pager view
 207 view-help               Show help page
 208 ------------------------------------------------------------------------------
 209
 210 ifdef::backend-xhtml11[]
 211 [frame="none"]
 212 `-----------------------`-----------------------------------------------------
 213 endif::backend-xhtml11[]
 214 View manipulation:
 215 ------------------------------------------------------------------------------
 216 enter                   Enter current line and scroll
 217 next                    Move to next
 218 previous                Move to previous
 219 view-next               Move focus to next view
 220 refresh                 Reload and refresh view
 221 maximize                Maximize the current view
 222 view-close              Close the current view
 223 quit                    Close all views and quit
 224 ------------------------------------------------------------------------------
 225
 226 ifdef::backend-xhtml11[]
 227 [frame="none"]
 228 `-----------------------`-----------------------------------------------------
 229 endif::backend-xhtml11[]
 230 Cursor navigation:
 231 ------------------------------------------------------------------------------
 232 move-up                 Move cursor one line up
 233 move-down               Move cursor one line down
 234 move-page-down          Move cursor one page down
 235 move-page-up            Move cursor one page up
 236 move-first-line         Move cursor to first line
 237 move-last-line          Move cursor to last line
 238 ------------------------------------------------------------------------------
 239
 240 ifdef::backend-xhtml11[]
 241 [frame="none"]
 242 `-----------------------`-----------------------------------------------------
 243 endif::backend-xhtml11[]
 244 Scrolling:
 245 ------------------------------------------------------------------------------
 246 scroll-line-up          Scroll one line up
 247 scroll-line-down        Scroll one line down
 248 scroll-page-eup         Scroll one page up
 249 scroll-page-down        Scroll one page down
 250 ------------------------------------------------------------------------------
 251
 252 ifdef::backend-xhtml11[]
 253 [frame="none"]
 254 `-----------------------`-----------------------------------------------------
 255 endif::backend-xhtml11[]
 256 Searching:
 257 ------------------------------------------------------------------------------
 258 search                  Search the view
 259 search-back             Search backwards in the view
 260 find-next               Find next search match
 261 find-prev               Find previous search match
 262 ------------------------------------------------------------------------------
 263
 264 ifdef::backend-xhtml11[]
 265 [frame="none"]
 266 `-----------------------`-----------------------------------------------------
 267 endif::backend-xhtml11[]
 268 Misc:
 269 ------------------------------------------------------------------------------
 270 none                    Do nothing
 271 prompt                  Bring up the prompt
 272 screen-redraw           Redraw the screen
 273 screen-resize           Resize the screen
 274 show-version            Show version information
 275 stop-loading            Stop all loading views
 276 toggle-lineno           Toggle line numbers
 277 toggle-date             Toggle date display
 278 toggle-author           Toggle author display
 279 toggle-rev-graph        Toggle revision graph visualization
 280 toggle-refs             Toggle reference display
 281 status-update           Update file status
 282 status-merge            Resolve unmerged file
 283 stage-next              Find next chunk to stage
 284 tree-parent             Switch to parent directory in tree view
 285 edit                    Open in editor
 286 ------------------------------------------------------------------------------
 287
 288
 289 Color command
 290 -------------
 291
 292 Color commands control highlighting and the user interface styles. If your
 293 terminal supports color, these commands can be used to assign foreground and
 294 background combinations to certain areas. Optionally, an attribute can be
 295 given as the last parameter. The syntax is:
 296
 297 [verse]
 298 ..............................................................................
 299 *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
 300 ..............................................................................
 301
 302 Examples:
 303
 304 ------------------------------------------------------------------------------
 305 # Overwrite the default terminal colors to white on black.
 306 color default           white   black
 307 # Diff colors
 308 color diff-header       yellow  default
 309 color diff-index        blue    default
 310 color diff-chunk        magenta default
 311 # A strange looking cursor line
 312 color cursor            red     default underline
 313 # UI colors
 314 color title-blur        white   blue
 315 color title-focus       white   blue    bold
 316 ------------------------------------------------------------------------------
 317
 318 Area names::
 319
 320         Valid area names are described below. Note, all names are
 321         case-insensitive, and you may use '-', '_', and '.' interchangeably,
 322         e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.
 323
 324 Color names::
 325
 326         Valid colors include: *white*, *black*, *green*, *magenta*, *blue*,
 327         *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the
 328         default terminal colors. This is recommended for background colors
 329         if you are using a terminal with a transparent background.
 330
 331 Attribute names::
 332
 333         Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*,
 334         *standout*, and *underline*. Note, not all attributes may be supported
 335         by the terminal.
 336
 337 UI colors
 338 ~~~~~~~~~
 339
 340 The colors and attributes to be used for the text that is not highlighted or
 341 that specify the use of the default terminal colors can be controlled by
 342 setting the *default* color option.
 343
 344 ifdef::backend-xhtml11[]
 345 [frame="none"]
 346 `-----------------------`-----------------------------------------------------
 347 endif::backend-xhtml11[]
 348 General:
 349 ------------------------------------------------------------------------------
 350 default                 Overwrite default terminal colors (see above).
 351 cursor                  The cursor line.
 352 status                  The status window showing info messages.
 353 title-focus             The title window for the current view.
 354 title-blur              The title window of any backgrounded view.
 355 delimiter               Delimiter shown for truncated lines.
 356 line-number             Line numbers.
 357 date                    The commit date.
 358 ------------------------------------------------------------------------------
 359
 360 ifdef::backend-xhtml11[]
 361 [frame="none"]
 362 `-----------------------`-----------------------------------------------------
 363 endif::backend-xhtml11[]
 364 Main view colors:
 365 ------------------------------------------------------------------------------
 366 main-author             The commit author.
 367 main-revgraph           The revision graph.
 368 main-commit             The commit comment.
 369 main-head               Label of the current branch.
 370 main-remote             Label of a remote.
 371 main-tracked            Label of the remote tracked by the current branch.
 372 main-tag                Label of a signed tag.
 373 main-local-tag          Label of a local tag.
 374 main-ref                Label of any other reference.
 375 ------------------------------------------------------------------------------
 376
 377 ifdef::backend-xhtml11[]
 378 [frame="none"]
 379 `-----------------------`-----------------------------------------------------
 380 endif::backend-xhtml11[]
 381 Status view:
 382 ------------------------------------------------------------------------------
 383 stat-head               The "On branch"-line.
 384 stat-section            Status section titles,
 385 stat-staged             Status flag of staged files.
 386 stat-unstaged           Status flag of unstaged files.
 387 stat-untracked          Status flag of untracked files.
 388 ------------------------------------------------------------------------------
 389
 390 ifdef::backend-xhtml11[]
 391 [frame="none"]
 392 `-----------------------`-----------------------------------------------------
 393 endif::backend-xhtml11[]
 394 Blame view:
 395 ------------------------------------------------------------------------------
 396 blame-id                The commit ID.
 397 ------------------------------------------------------------------------------
 398
 399 Highlighting
 400 ~~~~~~~~~~~~
 401
 402 --
 403
 404 Diff markup::
 405
 406 Options concerning diff start, chunks and lines added and deleted.
 407
 408 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
 409
 410 Enhanced git diff markup::
 411
 412 Extra diff information emitted by the git diff machinery, such as mode
 413 changes, rename detection, and similarity.
 414
 415 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
 416 *diff-rename-from*, *diff-rename-to*, *diff-similarity*, *diff-dissimilarity*
 417 *diff-tree*, *diff-index*
 418
 419 Pretty print commit headers::
 420
 421 Commit diffs and the revision logs are usually formatted using pretty printed
 422 headers , unless `--pretty=raw` was given. This includes lines, such as merge
 423 info, commit ID, and author and committer date.
 424
 425 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*,
 426 *pp-refs*
 427
 428 Raw commit header::
 429
 430 Usually shown when `--pretty=raw` is given, however 'commit' is pretty much
 431 omnipresent.
 432
 433 *commit*, *parent*, *tree*, *author*, *committer*
 434
 435 Commit message::
 436
 437 For now only `Signed-off-by` and `Acked-by` lines are colorized.
 438
 439 *signoff*, *acked*
 440
 441 Tree markup::
 442
 443 Colors for information of the tree view.
 444
 445 *tree-dir*, *tree-file*
 446
 447 --
 448
 449 COPYRIGHT
 450 ---------
 451 Copyright (c) 2006-2008 Jonas Fonseca <fonseca@diku.dk>
 452
 453 Licensed under the terms of the GNU General Public License.
 454
 455 SEE ALSO
 456 --------
 457 manpage:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual].