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
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
9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
\r
11 border: 1px solid red;
\r
16 margin: 1em 5% 1em 5%;
\r
20 a:visited { color: fuchsia; }
\r
34 h1, h2, h3, h4, h5, h6 {
\r
36 font-family: sans-serif;
\r
38 margin-bottom: 0.5em;
\r
43 border-bottom: 2px solid silver;
\r
46 border-bottom: 2px solid silver;
\r
56 border: 1px solid silver;
\r
61 margin-bottom: 0.5em;
\r
71 font-family: sans-serif;
\r
78 font-family: sans-serif;
\r
82 font-family: sans-serif;
\r
84 border-top: 2px solid silver;
\r
90 padding-bottom: 0.5em;
\r
94 padding-bottom: 0.5em;
\r
98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
\r
99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
\r
100 div.admonitionblock {
\r
103 margin-bottom: 1.5em;
\r
105 div.admonitionblock {
\r
107 margin-bottom: 2.5em;
\r
110 div.content { /* Block element content. */
\r
114 /* Block element titles. */
\r
115 div.title, caption.title {
\r
116 font-family: sans-serif;
\r
120 margin-bottom: 0.5em;
\r
126 td div.title:first-child {
\r
129 div.content div.title:first-child {
\r
132 div.content + div.title {
\r
136 div.sidebarblock > div.content {
\r
137 background: #ffffee;
\r
138 border: 1px solid silver;
\r
142 div.listingblock > div.content {
\r
143 border: 1px solid silver;
\r
144 background: #f4f4f4;
\r
148 div.quoteblock > div.content {
\r
149 padding-left: 2.0em;
\r
151 div.quoteblock .attribution {
\r
155 div.admonitionblock .icon {
\r
156 vertical-align: top;
\r
159 text-decoration: underline;
\r
161 padding-right: 0.5em;
\r
163 div.admonitionblock td.content {
\r
164 padding-left: 0.5em;
\r
165 border-left: 2px solid silver;
\r
168 div.exampleblock > div.content {
\r
169 border-left: 2px solid silver;
\r
173 div.verseblock div.content {
\r
177 div.imageblock div.content { padding-left: 0; }
\r
178 div.imageblock img { border: 1px solid silver; }
\r
179 span.image img { border-style: none; }
\r
183 margin-bottom: 0.8em;
\r
188 font-style: italic;
\r
190 dd > *:first-child {
\r
195 list-style-position: outside;
\r
198 list-style-type: lower-alpha;
\r
201 div.tableblock > table {
\r
202 border-color: #527bbd;
\r
206 font-family: sans-serif;
\r
215 margin-bottom: 0.8em;
\r
218 vertical-align: top;
\r
219 font-style: italic;
\r
220 padding-right: 0.8em;
\r
223 vertical-align: top;
\r
227 div#footer-badges { display: none; }
\r
229 /* Workarounds for IE6's broken and incomplete CSS2. */
\r
231 div.sidebar-content {
\r
232 background: #ffffee;
\r
233 border: 1px solid silver;
\r
236 div.sidebar-title, div.image-title {
\r
237 font-family: sans-serif;
\r
240 margin-bottom: 0.5em;
\r
243 div.listingblock div.content {
\r
244 border: 1px solid silver;
\r
245 background: #f4f4f4;
\r
249 div.quoteblock-content {
\r
250 padding-left: 2.0em;
\r
253 div.exampleblock-content {
\r
254 border-left: 2px solid silver;
\r
255 padding-left: 0.5em;
\r
258 <title>The tig Manual</title>
\r
262 <h1>The tig Manual</h1>
\r
263 <span id="author">Jonas Fonseca</span><br />
\r
264 <span id="email"><tt><<a href="mailto:fonseca@diku.dk">fonseca@diku.dk</a>></tt></span><br />
\r
266 <div id="preamble">
\r
267 <div class="sectionbody">
\r
268 <p>This is the manual for tig, the ncurses-based text-mode interface for git.
\r
269 Tig allows you to browse changes in a git repository and can additionally act
\r
270 as a pager for output of various git commands. When used as a pager, it will
\r
271 display input from stdin and colorize it.</p>
\r
272 <p>When browsing repositories, tig uses the underlying git commands to present
\r
273 the user with various views, such as summarized commit log and showing the
\r
274 commit with the log message, diffstat, and the diff.</p>
\r
275 <p><strong>Table of Contents</strong></p>
\r
279 <a href="#calling-conventions">Calling Conventions</a>
\r
284 <a href="#pager-mode">Pager Mode</a>
\r
289 <a href="#cmd-options">Git Command Options</a>
\r
296 <a href="#env-variables">Environment Variables</a>
\r
301 <a href="#repo-refs">Repository References</a>
\r
306 <a href="#history-commands">History Commands</a>
\r
313 <a href="#viewer">The Viewer</a>
\r
318 <a href="#commit-id">Current Head and Commit ID</a>
\r
323 <a href="#views">Views</a>
\r
328 <a href="#title-window">Title Windows</a>
\r
335 <a href="#keys">Default Keybindings</a>
\r
340 <a href="#view-switching">View Switching</a>
\r
345 <a href="#view-manipulation">View Manipulation</a>
\r
350 <a href="#cursor-nav">Cursor Navigation</a>
\r
355 <a href="#view-scrolling">Scrolling</a>
\r
362 <a href="#refspec">Revision Specification</a>
\r
367 <a href="#path-limiting">Limit by Path Name</a>
\r
372 <a href="#date-number-limiting">Limit by Date or Number</a>
\r
377 <a href="#commit-range-limiting">Limiting by Commit Ranges</a>
\r
382 <a href="#reachability-limiting">Limiting by Reachability</a>
\r
387 <a href="#refspec-combi">Combining Revisions Specification</a>
\r
392 <a href="#refspec-all">Examining All Repository References</a>
\r
399 <a href="#copy-right">Copyright</a>
\r
404 <a href="#references">References and Related Tools</a>
\r
410 <h2><a id="calling-conventions"></a>1. Calling Conventions</h2>
\r
411 <div class="sectionbody">
\r
412 <h3><a id="pager-mode"></a>1.1. Pager Mode</h3>
\r
413 <p>If stdin is a pipe, any log or diff options will be ignored and the pager view
\r
414 will be opened loading data from stdin. The pager mode can be used for
\r
415 colorizing output from various git commands.</p>
\r
416 <p>Example on how to colorize the output of git-show(1):</p>
\r
417 <div class="listingblock">
\r
418 <div class="content">
\r
419 <pre><tt>$ git show | tig</tt></pre>
\r
421 <h3><a id="cmd-options"></a>1.2. Git Command Options</h3>
\r
422 <p>All git command options specified on the command line will be passed to the
\r
423 given command and all will be shell quoted before they are passed to the
\r
425 <div class="admonitionblock">
\r
428 <div class="title">Note</div>
\r
430 <td class="content">If you specify options for the main view, you should not use the
\r
431 <tt>—pretty</tt> option as this option will be set automatically to the format
\r
432 expected by the main view.</td>
\r
435 <p>Example on how to open the log view and show both author and committer
\r
437 <div class="listingblock">
\r
438 <div class="content">
\r
439 <pre><tt>$ tig log --pretty=fuller</tt></pre>
\r
441 <p>See the <a href="#refspec">"Specifying revisions"</a> section below for an introduction
\r
442 to revision options supported by the git commands. For details on specific git
\r
443 command options, refer to the man page of the command in question.</p>
\r
445 <h2><a id="env-variables"></a>2. Environment Variables</h2>
\r
446 <div class="sectionbody">
\r
447 <p>Several options related to the interface with git can be configured via
\r
448 environment options.</p>
\r
449 <h3><a id="repo-refs"></a>2.1. Repository References</h3>
\r
450 <p>Commits that are referenced by tags and branch heads will be marked by the
\r
451 reference name surrounded by <em>[</em> and <em>]</em>:</p>
\r
452 <div class="listingblock">
\r
453 <div class="content">
\r
454 <pre><tt>2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1</tt></pre>
\r
456 <p>If you want to filter out certain directories under <tt>.git/refs/</tt>, say <tt>tmp</tt>
\r
457 you can do it by setting the following variable:</p>
\r
458 <div class="listingblock">
\r
459 <div class="content">
\r
460 <pre><tt>$ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig</tt></pre>
\r
462 <p>Or set the variable permanently in your environment.</p>
\r
469 Set command for retrieving all repository references. The command
\r
470 should output data in the same format as git-ls-remote(1).
\r
474 <h3><a id="history-commands"></a>2.2. History Commands</h3>
\r
475 <p>It is possible to alter which commands are used for the different views. If
\r
476 for example you prefer commits in the main view to be sorted by date and only
\r
477 show 500 commits, use:</p>
\r
478 <div class="listingblock">
\r
479 <div class="content">
\r
480 <pre><tt>$ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig</tt></pre>
\r
482 <p>Or set the variable permanently in your environment.</p>
\r
483 <p>Notice, how <tt>%s</tt> is used to specify the commit reference. There can be a
\r
484 maximum of 5 <tt>%s</tt> ref specifications.</p>
\r
491 The command used for the diff view. By default, git show is used
\r
500 The command used for the log view. If you prefer to have both
\r
501 author and committer shown in the log view be sure to pass
\r
502 <tt>—pretty=fuller</tt> to git log.
\r
510 The command used for the main view. Note, you must always specify
\r
511 the option: <tt>—pretty=raw</tt> since the main view parser expects to
\r
517 <h2><a id="viewer"></a>3. The Viewer</h2>
\r
518 <div class="sectionbody">
\r
519 <p>The display consists of a status window on the last line of the screen and one
\r
520 or more views. The default is to only show one view at the time but it is
\r
521 possible to split both the main and log view to also show the commit diff.</p>
\r
522 <p>If you are in the log view and press <em>Enter</em> when the current line is a commit
\r
524 <div class="listingblock">
\r
525 <div class="content">
\r
526 <pre><tt>commit 4d55caff4cc89335192f3e566004b4ceef572521</tt></pre>
\r
528 <p>You will split the view so that the log view is displayed in the top window
\r
529 and the diff view in the bottom window. You can switch between the two views
\r
530 by pressing <em>Tab</em>. To maximize the log view again, simply press <em>l</em>.</p>
\r
531 <h3><a id="commit-id"></a>3.1. Current Head and Commit ID</h3>
\r
532 <p>The viewer keeps track of both what head and commit ID you are currently
\r
533 viewing. The commit ID will follow the cursor line and change everytime time
\r
534 you highlight a different commit. Whenever you reopen the diff view it will be
\r
535 reloaded, if the commit ID changed.</p>
\r
536 <p>The head ID is used when opening the main and log view to indicate from what
\r
537 revision to show history.</p>
\r
538 <h3><a id="views"></a>3.2. Views</h3>
\r
539 <p>Various <em>views</em> of a repository is presented. Each view is based on output
\r
540 from an external command, most often <em>git log</em>, <em>git diff</em>, or <em>git show</em>.</p>
\r
547 Is the default view, and it shows a one line summary of each commit
\r
548 in the chosen list of revisions. The summary includes commit date,
\r
549 author, and the first line of the log message. Additionally, any
\r
550 repository references, such as tags, will be shown.
\r
558 Presents a more rich view of the revision log showing the whole log
\r
559 message and the diffstat.
\r
567 Shows either the diff of the current working tree, that is, what
\r
568 has changed since the last commit, or the commit diff complete
\r
569 with log message, diffstat and diff.
\r
577 Is used for displaying both input from stdin and output from git
\r
578 commands entered in the internal prompt.
\r
586 Displays key binding quick reference.
\r
590 <h3><a id="title-window"></a>3.3. Title Windows</h3>
\r
591 <p>Each view has a title window which shows the name of the view, current commit
\r
592 ID if available, and where the view is positioned:</p>
\r
593 <div class="listingblock">
\r
594 <div class="content">
\r
595 <pre><tt>[main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)</tt></pre>
\r
597 <p>By default, the title of the current view is highlighted using bold font. For
\r
598 long loading views (taking over 3 seconds) the time since loading started will
\r
600 <div class="listingblock">
\r
601 <div class="content">
\r
602 <pre><tt>[main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s</tt></pre>
\r
605 <h2><a id="keys"></a>4. Default Keybindings</h2>
\r
606 <div class="sectionbody">
\r
607 <p>Below the default key bindings are shown.</p>
\r
608 <h3><a id="view-switching"></a>4.1. View Switching</h3>
\r
609 <div class="tableblock">
\r
610 <table rules="none"
\r
612 cellspacing="0" cellpadding="4">
\r
614 <col width="788" />
\r
625 <tbody valign="top">
\r
631 Switch to main view.
\r
639 Switch to diff view.
\r
647 Switch to log view.
\r
655 Switch to pager view.
\r
669 <h3><a id="view-manipulation"></a>4.2. View Manipulation</h3>
\r
670 <div class="tableblock">
\r
671 <table rules="none"
\r
673 cellspacing="0" cellpadding="4">
\r
675 <col width="788" />
\r
686 <tbody valign="top">
\r
692 Close view, if multiple views are open it will jump back to the previous view in the view stack. If it is the last open view it will quit. Use <em>Q</em> to quit all views at once.
\r
700 This key is "context sensitive" depending on what view you are currently in. When in log view on a commit line or in the main view, split the view and show the commit diff. In the diff view pressing Enter will simply scroll the view one line down.
\r
708 Switch to next view.
\r
716 This key is "context sensitive" and will move the cursor one line up. However, uf you opened a diff view from the main view (split- or full-screen) it will change the cursor to point to the previous commit in the main view and update the diff view to display it.
\r
724 Similar to <em>Up</em> but will move down.
\r
730 <h3><a id="cursor-nav"></a>4.3. Cursor Navigation</h3>
\r
731 <div class="tableblock">
\r
732 <table rules="none"
\r
734 cellspacing="0" cellpadding="4">
\r
736 <col width="788" />
\r
747 <tbody valign="top">
\r
753 Move cursor one line up.
\r
761 Move cursor one line down.
\r
769 Move cursor one page up.
\r
777 Space Move cursor one page down.
\r
785 Jump to first line.
\r
799 <h3><a id="view-scrolling"></a>4.4. Scrolling</h3>
\r
800 <div class="tableblock">
\r
801 <table rules="none"
\r
803 cellspacing="0" cellpadding="4">
\r
805 <col width="788" />
\r
816 <tbody valign="top">
\r
822 Scroll view one line up.
\r
830 Scroll view one line down.
\r
838 Scroll view one page up.
\r
846 Scroll view one page down.
\r
852 <h3><a id="misc-keys"></a>4.5. Misc</h3>
\r
853 <div class="tableblock">
\r
854 <table rules="none"
\r
856 cellspacing="0" cellpadding="4">
\r
858 <col width="788" />
\r
869 <tbody valign="top">
\r
891 Stop all background loading. This can be useful if you use tig in a repository with a long history without limiting the revision log.
\r
907 Toggle line numbers on/off.
\r
915 Toggle revision graph visualization on/off.
\r
923 Open prompt. This allows you to specify what git command to run. Example <tt>:log -p</tt>
\r
930 <h2><a id="refspec"></a>5. Revision Specification</h2>
\r
931 <div class="sectionbody">
\r
932 <p>This section describes various ways to specify what revisions to display or
\r
933 otherwise limit the view to. Tig does not itself parse the described
\r
934 revision options so refer to the relevant git man pages for futher
\r
935 information. Relevant man pages besides git-log(1) are git-diff(1) and
\r
936 git-rev-list(1).</p>
\r
937 <p>You can tune the interaction with git by making use of the options explained
\r
938 in this section. For example, by configuring the environment variables
\r
939 described in the <a href="#history-commands">"History commands"</a> section.</p>
\r
940 <h3><a id="path-limiting"></a>5.1. Limit by Path Name</h3>
\r
941 <p>If you are interested only in those revisions that made changes to a specific
\r
942 file (or even several files) list the files like this:</p>
\r
943 <div class="listingblock">
\r
944 <div class="content">
\r
945 <pre><tt>$ tig log Makefile README</tt></pre>
\r
947 <p>To avoid ambiguity with repository references such as tag name, be sure to
\r
948 separate file names from other git options using "--". So if you have a file
\r
949 named <em>master</em> it will clash with the reference named <em>master</em>, and thus you
\r
950 will have to use:</p>
\r
951 <div class="listingblock">
\r
952 <div class="content">
\r
953 <pre><tt>$ tig log -- master</tt></pre>
\r
955 <div class="admonitionblock">
\r
958 <div class="title">Note</div>
\r
960 <td class="content">For the main view, avoiding ambiguity will in some cases require you to
\r
961 specify two "--" options. The first will make tig stop option processing
\r
962 and the latter will be passed to git log.</td>
\r
965 <h3><a id="date-number-limiting"></a>5.2. Limit by Date or Number</h3>
\r
966 <p>To speed up interaction with git, you can limit the amount of commits to show
\r
967 both for the log and main view. Either limit by date using e.g.
\r
968 <tt>—since=1.month</tt> or limit by the number of commits using <tt>-n400</tt>.</p>
\r
969 <p>If you are only interested in changed that happened between two dates you can
\r
971 <div class="listingblock">
\r
972 <div class="content">
\r
973 <pre><tt>$ tig -- --after="May 5th" --before="2006-05-16 15:44"</tt></pre>
\r
975 <div class="admonitionblock">
\r
978 <div class="title">Note</div>
\r
980 <td class="content">If you want to avoid having to quote dates containing spaces you can use
\r
981 "." instead, e.g. <tt>—after=May.5th</tt>.</td>
\r
984 <h3><a id="commit-range-limiting"></a>5.3. Limiting by Commit Ranges</h3>
\r
985 <p>Alternatively, commits can be limited to a specific range, such as "all
\r
986 commits between <em>tag-1.0</em> and <em>tag-2.0</em>". For example:</p>
\r
987 <div class="listingblock">
\r
988 <div class="content">
\r
989 <pre><tt>$ tig log tag-1.0..tag-2.0</tt></pre>
\r
991 <p>This way of commit limiting makes it trivial to only browse the commits which
\r
992 haven't been pushed to a remote branch. Assuming <em>origin</em> is your upstream
\r
993 remote branch, using:</p>
\r
994 <div class="listingblock">
\r
995 <div class="content">
\r
996 <pre><tt>$ tig log origin..HEAD</tt></pre>
\r
998 <p>will list what will be pushed to the remote branch. Optionally, the ending
\r
999 <em>HEAD</em> can be left out since it is implied.</p>
\r
1000 <h3><a id="reachability-limiting"></a>5.4. Limiting by Reachability</h3>
\r
1001 <p>Git interprets the range specifier "tag-1.0..tag-2.0" as "all commits
\r
1002 reachable from <em>tag-2.0</em> but not from <em>tag-1.0</em>". Where reachability refers
\r
1003 to what commits are ancestors (or part of the history) of the branch or tagged
\r
1004 revision in question.</p>
\r
1005 <p>If you prefer to specify which commit to preview in this way use the
\r
1007 <div class="listingblock">
\r
1008 <div class="content">
\r
1009 <pre><tt>$ tig log tag-2.0 ^tag-1.0</tt></pre>
\r
1011 <p>You can think of <em>^</em> as a negation operator. Using this alternate syntax, it
\r
1012 is possible to further prune commits by specifying multiple branch cut offs.</p>
\r
1013 <h3><a id="refspec-combi"></a>5.5. Combining Revisions Specification</h3>
\r
1014 <p>Revisions options can to some degree be combined, which makes it possible to
\r
1015 say "show at most 20 commits from within the last month that changed files
\r
1016 under the Documentation/ directory."</p>
\r
1017 <div class="listingblock">
\r
1018 <div class="content">
\r
1019 <pre><tt>$ tig -- --since=1.month -n20 -- Documentation/</tt></pre>
\r
1021 <h3><a id="refspec-all"></a>5.6. Examining All Repository References</h3>
\r
1022 <p>In some cases, it can be useful to query changes across all references in a
\r
1023 repository. An example is to ask "did any line of development in this
\r
1024 repository change a particular file within the last week". This can be
\r
1025 accomplished using:</p>
\r
1026 <div class="listingblock">
\r
1027 <div class="content">
\r
1028 <pre><tt>$ tig -- --all --since=1.week -- Makefile</tt></pre>
\r
1032 <div class="sectionbody">
\r
1033 <p>Known bugs and problems:</p>
\r
1037 In it's current state tig is pretty much UTF-8 only.
\r
1042 If the screen width is very small the main view can draw
\r
1043 outside the current view causing bad wrapping. Same goes
\r
1044 for title and status windows.
\r
1049 The cursor can wrap-around on the last line and cause the
\r
1055 <h2><a id="copy-right"></a>7. Copyright</h2>
\r
1056 <div class="sectionbody">
\r
1057 <p>Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk></p>
\r
1058 <p>This program is free software; you can redistribute it and/or modify
\r
1059 it under the terms of the GNU General Public License as published by
\r
1060 the Free Software Foundation; either version 2 of the License, or
\r
1061 (at your option) any later version.</p>
\r
1063 <h2><a id="references"></a>8. References and Related Tools</h2>
\r
1064 <div class="sectionbody">
\r
1069 <a href="tig.1.html">tig(1)</a>
\r
1074 <a href="tigrc.5.html">tigrc(5)</a>
\r
1078 <p>Online resources:</p>
\r
1082 Homepage: <a href="http://jonas.nitro.dk/tig">http://jonas.nitro.dk/tig</a>
\r
1087 Manual: <a href="http://jonas.nitro.dk/tig/manual.html">http://jonas.nitro.dk/tig/manual.html</a>
\r
1092 Releases: <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a>
\r
1097 Git URL: <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a>
\r
1102 Gitweb: <a href="http://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary">http://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary</a>
\r
1106 <p>Git porcelains:</p>
\r
1110 <a href="http://www.kernel.org/pub/software/scm/git/docs/">git</a>,
\r
1115 <a href="http://www.kernel.org/pub/software/scm/cogito/docs/">Cogito</a>
\r
1119 <p>Other git repository browsers:</p>
\r
1139 <div id="footer-text">
\r
1140 Last updated 15-Jun-2006 01:28:21 CEST
\r
~mdw / tig / blob