Sync docs
[tig] / tig.1.html
CommitLineData
2b9c2ad0
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>TIG(1)</title>\r
260</head>\r
261<body>\r
262<div id="header">\r
263<h1>\r
264TIG(1) Manual Page\r
265</h1>\r
266<h2>NAME</h2>\r
267<div class="sectionbody">\r
268<p>tig -\r
269 text-mode interface for git\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">tig [options]\r
af4c75a2
JF
277tig [options] [--] [git options]\r
278tig [options] log [git options]\r
279tig [options] diff [git options]\r
280tig [options] show [git options]\r
2b9c2ad0
JF
281tig [options] &lt; [git command output]</div></div>\r
282</div>\r
283<h2>DESCRIPTION</h2>\r
284<div class="sectionbody">\r
285<p>Browse changes in a git repository. Additionally, tig(1) can also act\r
286as a pager for output of various git commands.</p>\r
287<p>When browsing repositories, tig(1) uses the underlying git commands\r
288to present the user with various views, such as summarized commit log\r
289and showing the commit with the log message, diffstat, and the diff.</p>\r
290<p>Using tig(1) as a pager, it will display input from stdin and try\r
291to colorize it.</p>\r
292</div>\r
293<h2>OPTIONS</h2>\r
294<div class="sectionbody">\r
295<dl>\r
296<dt>\r
297-l\r
298</dt>\r
299<dd>\r
300<p>\r
301 Start up in log view using the internal log command.\r
302</p>\r
303</dd>\r
304<dt>\r
305-d\r
306</dt>\r
307<dd>\r
308<p>\r
309 Start up in diff view using the internal diff command.\r
310</p>\r
311</dd>\r
312<dt>\r
313-n[INTERVAL], --line-number[=INTERVAL]\r
314</dt>\r
315<dd>\r
316<p>\r
317 Prefix line numbers in log and diff view.\r
318 Optionally, with interval different than each line.\r
319</p>\r
320</dd>\r
321<dt>\r
3ad8214b 322-b[NSPACES], --tab-size[=NSPACES]\r
2b9c2ad0
JF
323</dt>\r
324<dd>\r
325<p>\r
326 Set the number of spaces tabs should be expanded to.\r
327</p>\r
328</dd>\r
329<dt>\r
330-v, --version\r
331</dt>\r
332<dd>\r
333<p>\r
334 Show version and exit.\r
335</p>\r
336</dd>\r
337<dt>\r
ffe3a8da
JF
338-h, --help\r
339</dt>\r
340<dd>\r
341<p>\r
342 Show help message and exit.\r
343</p>\r
344</dd>\r
345<dt>\r
2b9c2ad0
JF
346--\r
347</dt>\r
348<dd>\r
349<p>\r
350 End of tig(1) options. Useful when specifying command\r
351 options for the main view. Example:\r
352</p>\r
353<div class="literalblock">\r
354<div class="content">\r
355<pre><tt>$ tig -- --since=1.month</tt></pre>\r
356</div></div>\r
357</dd>\r
358<dt>\r
af4c75a2 359log\r
2b9c2ad0
JF
360</dt>\r
361<dd>\r
362<p>\r
363 Open log view using the given git log options.\r
364</p>\r
365</dd>\r
366<dt>\r
af4c75a2 367diff\r
2b9c2ad0
JF
368</dt>\r
369<dd>\r
370<p>\r
371 Open diff view using the given git diff options.\r
372</p>\r
373</dd>\r
374<dt>\r
af4c75a2 375show\r
2b9c2ad0
JF
376</dt>\r
377<dd>\r
378<p>\r
379 Open diff view using the given git show options.\r
380</p>\r
381</dd>\r
382<dt>\r
af4c75a2 383[git options]\r
2b9c2ad0
JF
384</dt>\r
385<dd>\r
386<p>\r
387 tig(1) will stop the option parsing when the first\r
388 command line parameter not starting with "-" is\r
389 encountered. All options including this one will be\r
390 passed to git log when loading the main view.\r
391 This makes it possible to say:\r
392</p>\r
393<div class="literalblock">\r
394<div class="content">\r
395<pre><tt>$ tig tag-1.0..HEAD</tt></pre>\r
396</div></div>\r
397</dd>\r
398</dl>\r
2b9c2ad0
JF
399</div>\r
400<h2>ENVIRONMENT VARIABLES</h2>\r
401<div class="sectionbody">\r
2b9c2ad0
JF
402<dl>\r
403<dt>\r
404TIG_LS_REMOTE\r
405</dt>\r
406<dd>\r
407<p>\r
408 Set command for retrieving all repository references. The command\r
409 should output data in the same format as git-ls-remote(1).\r
410</p>\r
411</dd>\r
2b9c2ad0
JF
412<dt>\r
413TIG_DIFF_CMD\r
414</dt>\r
415<dd>\r
416<p>\r
417 The command used for the diff view. By default, git show is used\r
418 as a backend.\r
419</p>\r
420</dd>\r
421<dt>\r
422TIG_LOG_CMD\r
423</dt>\r
424<dd>\r
425<p>\r
426 The command used for the log view. If you prefer to have both\r
427 author and committer shown in the log view be sure to pass\r
428 <tt>--pretty=fuller</tt> to git log.\r
429</p>\r
430</dd>\r
431<dt>\r
432TIG_MAIN_CMD\r
433</dt>\r
434<dd>\r
435<p>\r
436 The command used for the main view. Note, you must always specify\r
437 the option: <tt>--pretty=raw</tt> since the main view parser expects to\r
438 read that format.\r
439</p>\r
440</dd>\r
441</dl>\r
af4c75a2
JF
442<h3>Tree commands</h3>\r
443<dl>\r
444<dt>\r
445TIG_TREE_CMD\r
446</dt>\r
447<dd>\r
448<p>\r
449 The command used for the tree view. By default, git-ls-tree(1) is\r
450 used. The commands should expect first the commit ID and second\r
451 a path.\r
452</p>\r
453</dd>\r
454<dt>\r
455TIG_BLOB_CMD\r
456</dt>\r
457<dd>\r
458<p>\r
459 The command used for the blob view. By default, git-cat-file(1) is\r
460 used. The command gets the blob ID.\r
461</p>\r
462</dd>\r
463</dl>\r
2b9c2ad0 464</div>\r
3ad8214b 465<h2>FILES</h2>\r
2b9c2ad0 466<div class="sectionbody">\r
2b9c2ad0
JF
467<dl>\r
468<dt>\r
3ad8214b 469<em>~/.tigrc</em>\r
2b9c2ad0
JF
470</dt>\r
471<dd>\r
472<p>\r
b484cbc8 473 User configuration file. See <a href="tigrc.5.html">tigrc(5)</a> for examples.\r
2b9c2ad0
JF
474</p>\r
475</dd>\r
476<dt>\r
3ad8214b 477<em>.git/config</em>\r
2b9c2ad0
JF
478</dt>\r
479<dd>\r
480<p>\r
af4c75a2 481 Repository config file. Read on start-up with the help of\r
3ad8214b 482 git-repo-config(1).\r
2b9c2ad0
JF
483</p>\r
484</dd>\r
485</dl>\r
486</div>\r
3ad8214b 487<h2>BUGS</h2>\r
2b9c2ad0 488<div class="sectionbody">\r
3ad8214b
JF
489<p>Known bugs and problems:</p>\r
490<ul>\r
491<li>\r
2b9c2ad0 492<p>\r
af4c75a2 493Proper locale support: in it's current state tig is pretty much UTF-8 only.\r
2b9c2ad0 494</p>\r
3ad8214b
JF
495</li>\r
496<li>\r
2b9c2ad0 497<p>\r
af4c75a2 498Horizontal scrolling.\r
2b9c2ad0 499</p>\r
3ad8214b 500</li>\r
3ad8214b
JF
501</ul>\r
502</div>\r
503<h2>COPYRIGHT</h2>\r
504<div class="sectionbody">\r
505<p>Copyright (c) 2006 Jonas Fonseca &lt;fonseca@diku.dk&gt;</p>\r
506<p>This program is free software; you can redistribute it and/or modify\r
507it under the terms of the GNU General Public License as published by\r
508the Free Software Foundation; either version 2 of the License, or\r
509(at your option) any later version.</p>\r
510</div>\r
511<h2>SEE ALSO</h2>\r
512<div class="sectionbody">\r
5c09dc14
JF
513<p><a href="tigrc.5.html">tigrc(5)</a>, git(7), cogito(7), as well as other git repository browsers:\r
514gitk(1), qgit(1), gitview(1).</p>\r
515<p>Online resources:</p>\r
3ad8214b
JF
516<ul>\r
517<li>\r
2b9c2ad0 518<p>\r
60e10e16 519Homepage: <a href="http://jonas.nitro.dk/tig">http://jonas.nitro.dk/tig</a>\r
2b9c2ad0 520</p>\r
3ad8214b 521</li>\r
2b9c2ad0
JF
522<li>\r
523<p>\r
60e10e16 524Manual: <a href="http://jonas.nitro.dk/tig/manual.html">http://jonas.nitro.dk/tig/manual.html</a>\r
ffe3a8da
JF
525</p>\r
526</li>\r
527<li>\r
528<p>\r
60e10e16 529Releases: <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a>\r
2b9c2ad0
JF
530</p>\r
531</li>\r
2b9c2ad0
JF
532<li>\r
533<p>\r
60e10e16
JF
534Git URL: <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a> or\r
535 git://repo.or.cz/tig.git\r
2b9c2ad0
JF
536</p>\r
537</li>\r
538<li>\r
539<p>\r
60e10e16 540Gitweb: <a href="http://repo.or.cz/?p=tig.git;a=summary">http://repo.or.cz/?p=tig.git;a=summary</a>\r
2b9c2ad0
JF
541</p>\r
542</li>\r
543</ul>\r
544</div>\r
2b9c2ad0
JF
545<div id="footer">\r
546<div id="footer-text">\r
60e10e16 547Last updated 25-Sep-2006 01:14:26 CEST\r
2b9c2ad0
JF
548</div>\r
549</div>\r
550</body>\r
551</html>\r