Merge with ssh://diku/~/tig
[tig] / tigrc.5.txt
1 tigrc(5)
2 ========
3
4 NAME
5 ----
6 tigrc - tig user configuration file
7
8 SYNOPSIS
9 --------
10 [verse]
11 .............................................................................
12 *color* 'fgcolor' 'bgcolor' '[attributes]'
13 .............................................................................
14
15 DESCRIPTION
16 -----------
17 You can permanently set an option by putting it in the `~/.tigrc` file.
18 The file consists of a series of 'commands'.  Each
19 line of the file may contain only one command.
20
21 The hash mark ('#'), or semi-colon (';') is used as a 'comment' character.
22 All text after the comment character to the end of the line is ignored.
23 You can use comments to annotate your initialization file.
24
25 Color options
26 -------------
27
28 Color options control highlighting and the user interface styles.
29 If  your terminal supports color, these commands can be used to assign
30 foreground/backgound combinations to certain areas. Optionally, an
31 attribute can be given as the last parameter. The syntax is:
32
33 [verse]
34 ..........................................................................
35         *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
36 ..........................................................................
37
38 Valid colors include: *white*, *black*, *green*, *magenta*, *blue*, *cyan*,
39 *yellow*, *red*, *default*. Use *default* to refer to the default terminal
40 colors.
41
42 Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*, *standout*,
43 and *underline*. Note, not all attributes may be supported by the terminal.
44
45 Valid area names are described below. Note, all names are case-insensitive,
46 and you may use '-', '_', and '.' interchangeably. So "Diff-Header",
47 "DIFF_HEADER", and "diff.header" are the same.
48
49 Diff markup
50 ~~~~~~~~~~~
51
52 Options concerning diff start, chunks and lines added and deleted.
53
54 *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
55
56 Enhanced git diff markup
57 ~~~~~~~~~~~~~~~~~~~~~~~~
58
59 Extra diff information emitted by the git diff machinery, such as mode
60 changes, rename detection, and similarity.
61
62 *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
63 *diff-rename-from*, *diff-rename-to*, *diff-similarity* *diff-dissimilarity*
64 *diff-tree*, *diff-index*
65
66 Pretty print commit headers
67 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
68
69 Commit diffs and the revision logs are usually formatted using pretty
70 printed headers , unless `--pretty=raw` was given. This includes lines,
71 such as merge info, commit ID, and author and comitter date.
72
73 *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*
74
75 Raw commit header
76 ~~~~~~~~~~~~~~~~~
77
78 Usually shown when `--pretty=raw` is given, however 'commit' is pretty
79 much omnipresent.
80
81 *commit*, *parent*, *tree*, *author*, *committer*
82
83 Commit message
84 ~~~~~~~~~~~~~~
85
86 For now only `Signed-off-by lines` are colorized.
87
88 *signoff*
89
90 UI colors
91 ~~~~~~~~~
92
93 Colors for text not matching any of the above: *default*
94
95 Status window colors: *status*
96
97 Title window colors: *title-blur*, *title-focus*
98
99 Cursor line colors: *cursor*
100
101 Main view specific: *main-date*, *main-author*, *main-commit*, *main-delim*,
102 *main-tag*, *main-ref*
103
104
105 EXAMPLES
106 --------
107
108 Some sample options:
109
110 ==========================================================================
111         # Diff colors
112         color diff-header       yellow  default
113         color diff-index        blue    default
114         color diff-chunk        magenta default
115         # UI colors
116         color title-blur        white   blue
117         color title-focus       white   blue    bold
118 ==========================================================================
119
120 SEE ALSO
121 --------
122 tig(1)