Merge with master
[tig] / tigrc.5.html
CommitLineData
3ad8214b
JF
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
4<head>\r
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
6<meta name="generator" content="AsciiDoc 7.0.2" />\r
7<style type="text/css">\r
8/* Debug borders */\r
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
10/*\r
11 border: 1px solid red;\r
12*/\r
13}\r
14\r
15body {\r
16 margin: 1em 5% 1em 5%;\r
17}\r
18\r
19a { color: blue; }\r
20a:visited { color: fuchsia; }\r
21\r
22em {\r
23 font-style: italic;\r
24}\r
25\r
26strong {\r
27 font-weight: bold;\r
28}\r
29\r
30tt {\r
31 color: navy;\r
32}\r
33\r
34h1, h2, h3, h4, h5, h6 {\r
35 color: #527bbd;\r
36 font-family: sans-serif;\r
37 margin-top: 1.2em;\r
38 margin-bottom: 0.5em;\r
39 line-height: 1.3;\r
40}\r
41\r
42h1 {\r
43 border-bottom: 2px solid silver;\r
44}\r
45h2 {\r
46 border-bottom: 2px solid silver;\r
47 padding-top: 0.5em;\r
48}\r
49\r
50div.sectionbody {\r
51 font-family: serif;\r
52 margin-left: 0;\r
53}\r
54\r
55hr {\r
56 border: 1px solid silver;\r
57}\r
58\r
59p {\r
60 margin-top: 0.5em;\r
61 margin-bottom: 0.5em;\r
62}\r
63\r
64pre {\r
65 padding: 0;\r
66 margin: 0;\r
67}\r
68\r
69span#author {\r
70 color: #527bbd;\r
71 font-family: sans-serif;\r
72 font-weight: bold;\r
73 font-size: 1.2em;\r
74}\r
75span#email {\r
76}\r
77span#revision {\r
78 font-family: sans-serif;\r
79}\r
80\r
81div#footer {\r
82 font-family: sans-serif;\r
83 font-size: small;\r
84 border-top: 2px solid silver;\r
85 padding-top: 0.5em;\r
86 margin-top: 4.0em;\r
87}\r
88div#footer-text {\r
89 float: left;\r
90 padding-bottom: 0.5em;\r
91}\r
92div#footer-badges {\r
93 float: right;\r
94 padding-bottom: 0.5em;\r
95}\r
96\r
97div#preamble,\r
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
100div.admonitionblock {\r
101 margin-right: 10%;\r
102 margin-top: 1.5em;\r
103 margin-bottom: 1.5em;\r
104}\r
105div.admonitionblock {\r
106 margin-top: 2.5em;\r
107 margin-bottom: 2.5em;\r
108}\r
109\r
110div.content { /* Block element content. */\r
111 padding: 0;\r
112}\r
113\r
114/* Block element titles. */\r
115div.title, caption.title {\r
116 font-family: sans-serif;\r
117 font-weight: bold;\r
118 text-align: left;\r
119 margin-top: 1.0em;\r
120 margin-bottom: 0.5em;\r
121}\r
122div.title + * {\r
123 margin-top: 0;\r
124}\r
125\r
126td div.title:first-child {\r
127 margin-top: 0.0em;\r
128}\r
129div.content div.title:first-child {\r
130 margin-top: 0.0em;\r
131}\r
132div.content + div.title {\r
133 margin-top: 0.0em;\r
134}\r
135\r
136div.sidebarblock > div.content {\r
137 background: #ffffee;\r
138 border: 1px solid silver;\r
139 padding: 0.5em;\r
140}\r
141\r
142div.listingblock > div.content {\r
143 border: 1px solid silver;\r
144 background: #f4f4f4;\r
145 padding: 0.5em;\r
146}\r
147\r
148div.quoteblock > div.content {\r
149 padding-left: 2.0em;\r
150}\r
151div.quoteblock .attribution {\r
152 text-align: right;\r
153}\r
154\r
155div.admonitionblock .icon {\r
156 vertical-align: top;\r
157 font-size: 1.1em;\r
158 font-weight: bold;\r
159 text-decoration: underline;\r
160 color: #527bbd;\r
161 padding-right: 0.5em;\r
162}\r
163div.admonitionblock td.content {\r
164 padding-left: 0.5em;\r
165 border-left: 2px solid silver;\r
166}\r
167\r
168div.exampleblock > div.content {\r
169 border-left: 2px solid silver;\r
170 padding: 0.5em;\r
171}\r
172\r
173div.verseblock div.content {\r
174 white-space: pre;\r
175}\r
176\r
177div.imageblock div.content { padding-left: 0; }\r
178div.imageblock img { border: 1px solid silver; }\r
179span.image img { border-style: none; }\r
180\r
181dl {\r
182 margin-top: 0.8em;\r
183 margin-bottom: 0.8em;\r
184}\r
185dt {\r
186 margin-top: 0.5em;\r
187 margin-bottom: 0;\r
188 font-style: italic;\r
189}\r
190dd > *:first-child {\r
191 margin-top: 0;\r
192}\r
193\r
194ul, ol {\r
195 list-style-position: outside;\r
196}\r
197ol.olist2 {\r
198 list-style-type: lower-alpha;\r
199}\r
200\r
201div.tableblock > table {\r
202 border-color: #527bbd;\r
203 border-width: 3px;\r
204}\r
205thead {\r
206 font-family: sans-serif;\r
207 font-weight: bold;\r
208}\r
209tfoot {\r
210 font-weight: bold;\r
211}\r
212\r
213div.hlist {\r
214 margin-top: 0.8em;\r
215 margin-bottom: 0.8em;\r
216}\r
217td.hlist1 {\r
218 vertical-align: top;\r
219 font-style: italic;\r
220 padding-right: 0.8em;\r
221}\r
222td.hlist2 {\r
223 vertical-align: top;\r
224}\r
225\r
226@media print {\r
227 div#footer-badges { display: none; }\r
228}\r
229include::./stylesheets/xhtml11-manpage.css[]\r
230/* Workarounds for IE6's broken and incomplete CSS2. */\r
231\r
232div.sidebar-content {\r
233 background: #ffffee;\r
234 border: 1px solid silver;\r
235 padding: 0.5em;\r
236}\r
237div.sidebar-title, div.image-title {\r
238 font-family: sans-serif;\r
239 font-weight: bold;\r
240 margin-top: 0.0em;\r
241 margin-bottom: 0.5em;\r
242}\r
243\r
244div.listingblock div.content {\r
245 border: 1px solid silver;\r
246 background: #f4f4f4;\r
247 padding: 0.5em;\r
248}\r
249\r
250div.quoteblock-content {\r
251 padding-left: 2.0em;\r
252}\r
253\r
254div.exampleblock-content {\r
255 border-left: 2px solid silver;\r
256 padding-left: 0.5em;\r
257}\r
258</style>\r
259<title>tigrc(5)</title>\r
260</head>\r
261<body>\r
262<div id="header">\r
263<h1>\r
264tigrc(5) Manual Page\r
265</h1>\r
266<h2>NAME</h2>\r
267<div class="sectionbody">\r
268<p>tigrc -\r
269 tig user configuration file\r
270</p>\r
271</div>\r
272</div>\r
273<h2>SYNOPSIS</h2>\r
274<div class="sectionbody">\r
275<div class="verseblock">\r
276<div class="content"><strong>color</strong> <em>fgcolor</em> <em>bgcolor</em> <em>[attributes]</em></div></div>\r
277</div>\r
278<h2>DESCRIPTION</h2>\r
279<div class="sectionbody">\r
280<p>You can permanently set an option by putting it in the <tt>~/.tigrc</tt> file.\r
281The file consists of a series of <em>commands</em>. Each\r
282line of the file may contain only one command.</p>\r
283<p>The hash mark (<em>#</em>), or semi-colon (<em>;</em>) is used as a <em>comment</em> character.\r
284All text after the comment character to the end of the line is ignored.\r
285You can use comments to annotate your initialization file.</p>\r
286</div>\r
287<h2>Color options</h2>\r
288<div class="sectionbody">\r
289<p>Color options control highlighting and the user interface styles.\r
290If your terminal supports color, these commands can be used to assign\r
291foreground/backgound combinations to certain areas. Optionally, an\r
292attribute can be given as the last parameter. The syntax is:</p>\r
293<div class="verseblock">\r
294<div class="content"> <strong>color</strong> <em>area</em> <em>fgcolor</em> <em>bgcolor</em> <em>[attributes]</em></div></div>\r
295<p>Valid colors include: <strong>white</strong>, <strong>black</strong>, <strong>green</strong>, <strong>magenta</strong>, <strong>blue</strong>, <strong>cyan</strong>,\r
296<strong>yellow</strong>, <strong>red</strong>, <strong>default</strong>. Use <strong>default</strong> to refer to the default terminal\r
297colors.</p>\r
298<p>Valid attributes include: <strong>normal</strong>, <strong>blink</strong>, <strong>bold</strong>, <strong>dim</strong>, <strong>reverse</strong>, <strong>standout</strong>,\r
299and <strong>underline</strong>. Note, not all attributes may be supported by the terminal.</p>\r
300<p>Valid area names are described below. Note, all names are case-insensitive,\r
301and you may use <em>-</em>, <em>_</em>, and <em>.</em> interchangeably. So "Diff-Header",\r
302"DIFF_HEADER", and "diff.header" are the same.</p>\r
303<h3>Diff markup</h3>\r
304<p>Options concerning diff start, chunks and lines added and deleted.</p>\r
305<p><strong>diff-header</strong>, <strong>diff-chunk</strong>, <strong>diff-add</strong>, <strong>diff-del</strong></p>\r
306<h3>Enhanced git diff markup</h3>\r
307<p>Extra diff information emitted by the git diff machinery, such as mode\r
308changes, rename detection, and similarity.</p>\r
309<p><strong>diff-oldmode</strong>, <strong>diff-newmode</strong>, <strong>diff-copy-from</strong>, <strong>diff-copy-to</strong>,\r
310<strong>diff-rename-from</strong>, <strong>diff-rename-to</strong>, <strong>diff-similarity</strong> <strong>diff-dissimilarity</strong>\r
311<strong>diff-tree</strong>, <strong>diff-index</strong></p>\r
312<h3>Pretty print commit headers</h3>\r
313<p>Commit diffs and the revision logs are usually formatted using pretty\r
314printed headers , unless <tt>--pretty=raw</tt> was given. This includes lines,\r
315such as merge info, commit ID, and author and comitter date.</p>\r
316<p><strong>pp-author</strong>, <strong>pp-commit</strong>, <strong>pp-merge</strong>, <strong>pp-date</strong>, <strong>pp-adate</strong>, <strong>pp-cdate</strong></p>\r
317<h3>Raw commit header</h3>\r
318<p>Usually shown when <tt>--pretty=raw</tt> is given, however <em>commit</em> is pretty\r
319much omnipresent.</p>\r
320<p><strong>commit</strong>, <strong>parent</strong>, <strong>tree</strong>, <strong>author</strong>, <strong>committer</strong></p>\r
321<h3>Commit message</h3>\r
322<p>For now only <tt>Signed-off-by lines</tt> are colorized.</p>\r
323<p><strong>signoff</strong></p>\r
324<h3>UI colors</h3>\r
325<p>Colors for text not matching any of the above: <strong>default</strong></p>\r
326<p>Status window colors: <strong>status</strong></p>\r
327<p>Title window colors: <strong>title-blur</strong>, <strong>title-focus</strong></p>\r
328<p>Cursor line colors: <strong>cursor</strong></p>\r
329<p>Main view specific: <strong>main-date</strong>, <strong>main-author</strong>, <strong>main-commit</strong>, <strong>main-delim</strong>,\r
330<strong>main-tag</strong>, <strong>main-ref</strong></p>\r
331</div>\r
332<h2>EXAMPLES</h2>\r
333<div class="sectionbody">\r
334<p>Some sample options:</p>\r
335<div class="exampleblock">\r
336<div class="exampleblock-content">\r
337<div class="literalblock">\r
338<div class="content">\r
339<pre><tt># Diff colors\r
340color diff-header yellow default\r
341color diff-index blue default\r
342color diff-chunk magenta default\r
343# UI colors\r
344color title-blur white blue\r
345color title-focus white blue bold</tt></pre>\r
346</div></div>\r
347</div></div>\r
348</div>\r
349<h2>SEE ALSO</h2>\r
350<div class="sectionbody">\r
351<p>tig(1)</p>\r
352</div>\r
353<div id="footer">\r
354<div id="footer-text">\r
355Last updated 29-May-2006 21:46:30 CEST\r
356</div>\r
357</div>\r
358</body>\r
359</html>\r