<p>When browsing repositories, tig uses the underlying git commands to present\r
the user with various views, such as summarized commit log and showing the\r
commit with the log message, diffstat, and the diff.</p>\r
+<p><strong>Table of Contents</strong></p>\r
+<ol>\r
+<li>\r
+<p>\r
+<a href="#calling-conventions">Calling Conventions</a>\r
+</p>\r
+<ul>\r
+<li>\r
+<p>\r
+<a href="#pager-mode">Pager Mode</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#cmd-options">Git Command Options</a>\r
+</p>\r
+</li>\r
+</ul>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#env-variables">Environment Variables</a>\r
+</p>\r
+<ul>\r
+<li>\r
+<p>\r
+<a href="#repo-refs">Repository References</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#history-commands">History Commands</a>\r
+</p>\r
+</li>\r
+</ul>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#viewer">The Viewer</a>\r
+</p>\r
+<ul>\r
+<li>\r
+<p>\r
+<a href="#commit-id">Current Head and Commit ID</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#views">Views</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#title-window">Title Windows</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#view-switching">View Switching</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#view-manipulation">View Manipulation</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#cursor-nav">Cursor Navigation</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#view-scrolling">Scrolling</a>\r
+</p>\r
+</li>\r
+</ul>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#refspec">Revision Specification</a>\r
+</p>\r
+<ul>\r
+<li>\r
+<p>\r
+<a href="#path-limiting">Limit by Path Name</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#date-number-limiting">Limit by Date or Number</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#commit-range-limiting">Limiting by Commit Ranges</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#reachability-limiting">Limiting by Reachability</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#refspec-combi">Combining Revisions Specification</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#refspec-all">Examining All Repository References</a>\r
+</p>\r
+</li>\r
+</ul>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#copy-right">Copyright</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#references">References and Related Tools</a>\r
+</p>\r
+</li>\r
+</ol>\r
</div>\r
</div>\r
-<h2>Calling Conventions</h2>\r
+<h2><a id="calling-conventions"></a>1. Calling Conventions</h2>\r
<div class="sectionbody">\r
-<h3>Pager Mode</h3>\r
+<h3><a id="pager-mode"></a>1.1. Pager Mode</h3>\r
<p>If stdin is a pipe, any log or diff options will be ignored and the pager view\r
will be opened loading data from stdin. The pager mode can be used for\r
colorizing output from various git commands.</p>\r
<p>Example on how to colorize the output of git-show(1):</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ git show | tig</tt></pre>\r
</div></div>\r
-<h3>Git Command Options</h3>\r
+<h3><a id="cmd-options"></a>1.2. Git Command Options</h3>\r
<p>All git command options specified on the command line will be passed to the\r
given command and all will be shell quoted before they are passed to the\r
shell.</p>\r
</div>\r
<p>Example on how to open the log view and show both author and committer\r
information:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig log --pretty=fuller</tt></pre>\r
</div></div>\r
to revision options supported by the git commands. For details on specific git\r
command options, refer to the man page of the command in question.</p>\r
</div>\r
-<h2>Environment Variables</h2>\r
+<h2><a id="env-variables"></a>2. Environment Variables</h2>\r
<div class="sectionbody">\r
<p>Several options related to the interface with git can be configured via\r
environment options.</p>\r
-<h3>Repository References</h3>\r
+<h3><a id="repo-refs"></a>2.1. Repository References</h3>\r
<p>Commits that are referenced by tags and branch heads will be marked by the\r
reference name surrounded by <em>[</em> and <em>]</em>:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1</tt></pre>\r
</div></div>\r
<p>If you want to filter out certain directories under <tt>.git/refs/</tt>, say <tt>tmp</tt>\r
you can do it by setting the following variable:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig</tt></pre>\r
</div></div>\r
</p>\r
</dd>\r
</dl>\r
-<h3><a id="history-commands"></a>History Commands</h3>\r
+<h3><a id="history-commands"></a>2.2. History Commands</h3>\r
<p>It is possible to alter which commands are used for the different views. If\r
for example you prefer commits in the main view to be sorted by date and only\r
show 500 commits, use:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig</tt></pre>\r
</div></div>\r
</dd>\r
</dl>\r
</div>\r
-<h2>The Viewer</h2>\r
+<h2><a id="viewer"></a>3. The Viewer</h2>\r
<div class="sectionbody">\r
<p>The display consists of a status window on the last line of the screen and one\r
or more views. The default is to only show one view at the time but it is\r
possible to split both the main and log view to also show the commit diff.</p>\r
<p>If you are in the log view and press <em>Enter</em> when the current line is a commit\r
line, such as:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>commit 4d55caff4cc89335192f3e566004b4ceef572521</tt></pre>\r
</div></div>\r
<p>You will split the view so that the log view is displayed in the top window\r
and the diff view in the bottom window. You can switch between the two views\r
by pressing <em>Tab</em>. To maximize the log view again, simply press <em>l</em>.</p>\r
-<h3>Current Head and Commit ID</h3>\r
+<h3><a id="commit-id"></a>3.1. Current Head and Commit ID</h3>\r
<p>The viewer keeps track of both what head and commit ID you are currently\r
viewing. The commit ID will follow the cursor line and change everytime time\r
you highlight a different commit. Whenever you reopen the diff view it will be\r
reloaded, if the commit ID changed.</p>\r
<p>The head ID is used when opening the main and log view to indicate from what\r
revision to show history.</p>\r
-<h3>Views</h3>\r
-<p>tig(1) presents various <em>views</em> of a repository. Each view is based on output\r
+<h3><a id="views"></a>3.2. Views</h3>\r
+<p>Various <em>views</em> of a repository is presented. Each view is based on output\r
from an external command, most often <em>git log</em>, <em>git diff</em>, or <em>git show</em>.</p>\r
<dl>\r
<dt>\r
</dt>\r
<dd>\r
<p>\r
- Displays the information from the tig(1) man page. For the help view\r
- to work you need to have the tig(1) man page installed.\r
+ Displays key binding quick reference.\r
</p>\r
</dd>\r
</dl>\r
-<h3>Title Windows</h3>\r
+<h3><a id="title-window"></a>3.3. Title Windows</h3>\r
<p>Each view has a title window which shows the name of the view, current commit\r
ID if available, and where the view is positioned:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>[main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)</tt></pre>\r
</div></div>\r
<p>By default, the title of the current view is highlighted using bold font. For\r
long loading views (taking over 3 seconds) the time since loading started will\r
be appended:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>[main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s</tt></pre>\r
</div></div>\r
</div>\r
-<h2>Keys</h2>\r
+<h2><a id="keys"></a>4. Keys</h2>\r
<div class="sectionbody">\r
<p>Below the default key bindings are shown.</p>\r
-<h3>View Switching</h3>\r
+<h3><a id="view-switching"></a>4.1. View Switching</h3>\r
<dl>\r
<dt>\r
m\r
</p>\r
</dd>\r
<dt>\r
-h\r
+h, ?\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
</dl>\r
-<h3>View Manipulation</h3>\r
+<h3><a id="view-manipulation"></a>4.2. View Manipulation</h3>\r
<dl>\r
<dt>\r
q\r
</p>\r
</dd>\r
</dl>\r
-<h3>Cursor Navigation</h3>\r
+<h3><a id="cursor-nav"></a>4.3. Cursor Navigation</h3>\r
<dl>\r
<dt>\r
j\r
</p>\r
</dd>\r
</dl>\r
-<h3>Scrolling</h3>\r
+<h3><a id="view-scrolling"></a>4.4. Scrolling</h3>\r
<dl>\r
<dt>\r
Insert\r
</p>\r
</dd>\r
</dl>\r
-<h3>Misc</h3>\r
+<h3><a id="misc-keys"></a>4.5. Misc</h3>\r
<dl>\r
<dt>\r
Q\r
<dd>\r
<p>\r
Stop all background loading. This can be useful if you use\r
- tig(1) in a repository with a long history without limiting\r
+ tig in a repository with a long history without limiting\r
the revision log.\r
</p>\r
</dd>\r
</p>\r
</dd>\r
<dt>\r
+g\r
+</dt>\r
+<dd>\r
+<p>\r
+ Toggle revision graph visualization on/off.\r
+</p>\r
+</dd>\r
+<dt>\r
<em>:</em>\r
</dt>\r
<dd>\r
</dd>\r
</dl>\r
</div>\r
-<h2><a id="refspec"></a>Revision Specification</h2>\r
+<h2><a id="refspec"></a>5. Revision Specification</h2>\r
<div class="sectionbody">\r
<p>This section describes various ways to specify what revisions to display or\r
-otherwise limit the view to. tig(1) does not itself parse the described\r
+otherwise limit the view to. Tig does not itself parse the described\r
revision options so refer to the relevant git man pages for futher\r
information. Relevant man pages besides git-log(1) are git-diff(1) and\r
git-rev-list(1).</p>\r
<p>You can tune the interaction with git by making use of the options explained\r
in this section. For example, by configuring the environment variables\r
described in the <a href="#history-commands">"History commands"</a> section.</p>\r
-<h3>Limit by Path Name</h3>\r
+<h3><a id="path-limiting"></a>5.1. Limit by Path Name</h3>\r
<p>If you are interested only in those revisions that made changes to a specific\r
file (or even several files) list the files like this:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig log Makefile README</tt></pre>\r
</div></div>\r
separate file names from other git options using "--". So if you have a file\r
named <em>master</em> it will clash with the reference named <em>master</em>, and thus you\r
will have to use:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig log -- master</tt></pre>\r
</div></div>\r
<div class="title">Note</div>\r
</td>\r
<td class="content">For the main view, avoiding ambiguity will in some cases require you to\r
-specify two "--" options. The first will make tig(1) stop option processing\r
+specify two "--" options. The first will make tig stop option processing\r
and the latter will be passed to git log.</td>\r
</tr></table>\r
</div>\r
-<h3>Limit by Date or Number</h3>\r
+<h3><a id="date-number-limiting"></a>5.2. Limit by Date or Number</h3>\r
<p>To speed up interaction with git, you can limit the amount of commits to show\r
both for the log and main view. Either limit by date using e.g.\r
<tt>—since=1.month</tt> or limit by the number of commits using <tt>-n400</tt>.</p>\r
<p>If you are only interested in changed that happened between two dates you can\r
use:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig -- --after="May 5th" --before="2006-05-16 15:44"</tt></pre>\r
</div></div>\r
"." instead, e.g. <tt>—after=May.5th</tt>.</td>\r
</tr></table>\r
</div>\r
-<h3>Limiting by Commit Ranges</h3>\r
+<h3><a id="commit-range-limiting"></a>5.3. Limiting by Commit Ranges</h3>\r
<p>Alternatively, commits can be limited to a specific range, such as "all\r
commits between <em>tag-1.0</em> and <em>tag-2.0</em>". For example:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig log tag-1.0..tag-2.0</tt></pre>\r
</div></div>\r
<p>This way of commit limiting makes it trivial to only browse the commits which\r
haven't been pushed to a remote branch. Assuming <em>origin</em> is your upstream\r
remote branch, using:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig log origin..HEAD</tt></pre>\r
</div></div>\r
<p>will list what will be pushed to the remote branch. Optionally, the ending\r
<em>HEAD</em> can be left out since it is implied.</p>\r
-<h3>Limiting by Reachability</h3>\r
+<h3><a id="reachability-limiting"></a>5.4. Limiting by Reachability</h3>\r
<p>Git interprets the range specifier "tag-1.0..tag-2.0" as "all commits\r
reachable from <em>tag-2.0</em> but not from <em>tag-1.0</em>". Where reachability refers\r
to what commits are ancestors (or part of the history) of the branch or tagged\r
revision in question.</p>\r
<p>If you prefer to specify which commit to preview in this way use the\r
following:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig log tag-2.0 ^tag-1.0</tt></pre>\r
</div></div>\r
<p>You can think of <em>^</em> as a negation operator. Using this alternate syntax, it\r
is possible to further prune commits by specifying multiple branch cut offs.</p>\r
-<h3>Combining Revisions Specification</h3>\r
+<h3><a id="refspec-combi"></a>5.5. Combining Revisions Specification</h3>\r
<p>Revisions options can to some degree be combined, which makes it possible to\r
say "show at most 20 commits from within the last month that changed files\r
under the Documentation/ directory."</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig -- --since=1.month -n20 -- Documentation/</tt></pre>\r
</div></div>\r
-<h3>Examining All Repository References</h3>\r
+<h3><a id="refspec-all"></a>5.6. Examining All Repository References</h3>\r
<p>In some cases, it can be useful to query changes across all references in a\r
repository. An example is to ask "did any line of development in this\r
repository change a particular file within the last week". This can be\r
accomplished using:</p>\r
-<div class="literalblock">\r
+<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig -- --all --since=1.week -- Makefile</tt></pre>\r
</div></div>\r
</div>\r
-<h2>BUGS</h2>\r
+<h2>6. BUGS</h2>\r
<div class="sectionbody">\r
<p>Known bugs and problems:</p>\r
<ul>\r
window to scroll.\r
</p>\r
</li>\r
-<li>\r
-<p>\r
-The prompt doesn't work while loading.\r
-</p>\r
-</li>\r
</ul>\r
</div>\r
-<h2>Copyright</h2>\r
+<h2><a id="copy-right"></a>7. Copyright</h2>\r
<div class="sectionbody">\r
<p>Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk></p>\r
<p>This program is free software; you can redistribute it and/or modify\r
the Free Software Foundation; either version 2 of the License, or\r
(at your option) any later version.</p>\r
</div>\r
-<h2>References and Related Tools</h2>\r
+<h2><a id="references"></a>8. References and Related Tools</h2>\r
<div class="sectionbody">\r
+<p>Manpages:</p>\r
+<ul>\r
+<li>\r
+<p>\r
+<a href="tig.1.html">tig(1)</a>\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="tigrc.5.html">tigrc(5)</a>\r
+</p>\r
+</li>\r
+</ul>\r
+<p>Online resources:</p>\r
<ul>\r
<li>\r
<p>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 29-May-2006 21:46:32 CEST\r
+Last updated 14-Jun-2006 22:28:53 CEST\r
</div>\r
</div>\r
</body>\r
~mdw / tig / blobdiff