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