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