[tig] / manual.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
<head>\r
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />\r
<meta name="generator" content="AsciiDoc 7.0.2" />\r
<style type="text/css">\r
/* Debug borders */\r
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {\r
/*\r
  border: 1px solid red;\r
*/\r
}\r
\r
body {\r
  margin: 1em 5% 1em 5%;\r
}\r
\r
a { color: blue; }\r
a:visited { color: fuchsia; }\r
\r
em {\r
  font-style: italic;\r
}\r
\r
strong {\r
  font-weight: bold;\r
}\r
\r
tt {\r
  color: navy;\r
}\r
\r
h1, h2, h3, h4, h5, h6 {\r
  color: #527bbd;\r
  font-family: sans-serif;\r
  margin-top: 1.2em;\r
  margin-bottom: 0.5em;\r
  line-height: 1.3;\r
}\r
\r
h1 {\r
  border-bottom: 2px solid silver;\r
}\r
h2 {\r
  border-bottom: 2px solid silver;\r
  padding-top: 0.5em;\r
}\r
\r
div.sectionbody {\r
  font-family: serif;\r
  margin-left: 0;\r
}\r
\r
hr {\r
  border: 1px solid silver;\r
}\r
\r
p {\r
  margin-top: 0.5em;\r
  margin-bottom: 0.5em;\r
}\r
\r
pre {\r
  padding: 0;\r
  margin: 0;\r
}\r
\r
span#author {\r
  color: #527bbd;\r
  font-family: sans-serif;\r
  font-weight: bold;\r
  font-size: 1.2em;\r
}\r
span#email {\r
}\r
span#revision {\r
  font-family: sans-serif;\r
}\r
\r
div#footer {\r
  font-family: sans-serif;\r
  font-size: small;\r
  border-top: 2px solid silver;\r
  padding-top: 0.5em;\r
  margin-top: 4.0em;\r
}\r
div#footer-text {\r
  float: left;\r
  padding-bottom: 0.5em;\r
}\r
div#footer-badges {\r
  float: right;\r
  padding-bottom: 0.5em;\r
}\r
\r
div#preamble,\r
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,\r
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,\r
div.admonitionblock {\r
  margin-right: 10%;\r
  margin-top: 1.5em;\r
  margin-bottom: 1.5em;\r
}\r
div.admonitionblock {\r
  margin-top: 2.5em;\r
  margin-bottom: 2.5em;\r
}\r
\r
div.content { /* Block element content. */\r
  padding: 0;\r
}\r
\r
/* Block element titles. */\r
div.title, caption.title {\r
  font-family: sans-serif;\r
  font-weight: bold;\r
  text-align: left;\r
  margin-top: 1.0em;\r
  margin-bottom: 0.5em;\r
}\r
div.title + * {\r
  margin-top: 0;\r
}\r
\r
td div.title:first-child {\r
  margin-top: 0.0em;\r
}\r
div.content div.title:first-child {\r
  margin-top: 0.0em;\r
}\r
div.content + div.title {\r
  margin-top: 0.0em;\r
}\r
\r
div.sidebarblock > div.content {\r
  background: #ffffee;\r
  border: 1px solid silver;\r
  padding: 0.5em;\r
}\r
\r
div.listingblock > div.content {\r
  border: 1px solid silver;\r
  background: #f4f4f4;\r
  padding: 0.5em;\r
}\r
\r
div.quoteblock > div.content {\r
  padding-left: 2.0em;\r
}\r
div.quoteblock .attribution {\r
  text-align: right;\r
}\r
\r
div.admonitionblock .icon {\r
  vertical-align: top;\r
  font-size: 1.1em;\r
  font-weight: bold;\r
  text-decoration: underline;\r
  color: #527bbd;\r
  padding-right: 0.5em;\r
}\r
div.admonitionblock td.content {\r
  padding-left: 0.5em;\r
  border-left: 2px solid silver;\r
}\r
\r
div.exampleblock > div.content {\r
  border-left: 2px solid silver;\r
  padding: 0.5em;\r
}\r
\r
div.verseblock div.content {\r
  white-space: pre;\r
}\r
\r
div.imageblock div.content { padding-left: 0; }\r
div.imageblock img { border: 1px solid silver; }\r
span.image img { border-style: none; }\r
\r
dl {\r
  margin-top: 0.8em;\r
  margin-bottom: 0.8em;\r
}\r
dt {\r
  margin-top: 0.5em;\r
  margin-bottom: 0;\r
  font-style: italic;\r
}\r
dd > *:first-child {\r
  margin-top: 0;\r
}\r
\r
ul, ol {\r
    list-style-position: outside;\r
}\r
ol.olist2 {\r
  list-style-type: lower-alpha;\r
}\r
\r
div.tableblock > table {\r
  border-color: #527bbd;\r
  border-width: 3px;\r
}\r
thead {\r
  font-family: sans-serif;\r
  font-weight: bold;\r
}\r
tfoot {\r
  font-weight: bold;\r
}\r
\r
div.hlist {\r
  margin-top: 0.8em;\r
  margin-bottom: 0.8em;\r
}\r
td.hlist1 {\r
  vertical-align: top;\r
  font-style: italic;\r
  padding-right: 0.8em;\r
}\r
td.hlist2 {\r
  vertical-align: top;\r
}\r
\r
@media print {\r
  div#footer-badges { display: none; }\r
}\r
/* Workarounds for IE6's broken and incomplete CSS2. */\r
\r
div.sidebar-content {\r
  background: #ffffee;\r
  border: 1px solid silver;\r
  padding: 0.5em;\r
}\r
div.sidebar-title, div.image-title {\r
  font-family: sans-serif;\r
  font-weight: bold;\r
  margin-top: 0.0em;\r
  margin-bottom: 0.5em;\r
}\r
\r
div.listingblock div.content {\r
  border: 1px solid silver;\r
  background: #f4f4f4;\r
  padding: 0.5em;\r
}\r
\r
div.quoteblock-content {\r
  padding-left: 2.0em;\r
}\r
\r
div.exampleblock-content {\r
  border-left: 2px solid silver;\r
  padding-left: 0.5em;\r
}\r
</style>\r
<title>The tig Manual</title>\r
</head>\r
<body>\r
<div id="header">\r
<h1>The tig Manual</h1>\r
<span id="author">Jonas Fonseca</span><br />\r
<span id="email"><tt>&lt;<a href="mailto:fonseca@diku.dk">fonseca@diku.dk</a>&gt;</tt></span><br />\r
</div>\r
<div id="preamble">\r
<div class="sectionbody">\r
<p>This is the manual for tig, the ncurses-based text-mode interface for git.\r
Tig allows you to browse changes in a git repository and can additionally act\r
as a pager for output of various git commands. When used as a pager, it will\r
display input from stdin and colorize it.</p>\r
<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
<li>\r
<p>\r
<a href="#tree-commands">Tree 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
</ul>\r
</li>\r
<li>\r
<p>\r
<a href="#keys">Default Keybindings</a>\r
</p>\r
<ul>\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
<li>\r
<p>\r
<a href="#searching">Searching</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><a id="calling-conventions"></a>1. Calling Conventions</h2>\r
<div class="sectionbody">\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="listingblock">\r
<div class="content">\r
<pre><tt>$ git show | tig</tt></pre>\r
</div></div>\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 class="admonitionblock">\r
<table><tr>\r
<td class="icon">\r
<div class="title">Note</div>\r
</td>\r
<td class="content">If you specify options for the main view, you should not use the\r
<tt>&#8212;pretty</tt> option as this option will be set automatically to the format\r
expected by the main view.</td>\r
</tr></table>\r
</div>\r
<p>Example on how to open the log view and show both author and committer\r
information:</p>\r
<div class="listingblock">\r
<div class="content">\r
<pre><tt>$ tig log --pretty=fuller</tt></pre>\r
</div></div>\r
<p>See the <a href="#refspec">"Specifying revisions"</a> section below for an introduction\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><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><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="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="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>Or set the variable permanently in your environment.</p>\r
<dl>\r
<dt>\r
TIG_LS_REMOTE\r
</dt>\r
<dd>\r
<p>\r
        Set command for retrieving all repository references. The command\r
        should output data in the same format as git-ls-remote(1).\r
</p>\r
</dd>\r
</dl>\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="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
<p>Or set the variable permanently in your environment.</p>\r
<p>Notice, how <tt>%s</tt> is used to specify the commit reference. There can be a\r
maximum of 5 <tt>%s</tt> ref specifications.</p>\r
<dl>\r
<dt>\r
TIG_DIFF_CMD\r
</dt>\r
<dd>\r
<p>\r
        The command used for the diff view. By default, git show is used\r
        as a backend.\r
</p>\r
</dd>\r
<dt>\r
TIG_LOG_CMD\r
</dt>\r
<dd>\r
<p>\r
        The command used for the log view. If you prefer to have both\r
        author and committer shown in the log view be sure to pass\r
        <tt>&#8212;pretty=fuller</tt> to git log.\r
</p>\r
</dd>\r
<dt>\r
TIG_MAIN_CMD\r
</dt>\r
<dd>\r
<p>\r
        The command used for the main view. Note, you must always specify\r
        the option: <tt>&#8212;pretty=raw</tt> since the main view parser expects to\r
        read that format.\r
</p>\r
</dd>\r
</dl>\r
<h3><a id="tree-commands"></a>2.3. Tree Commands</h3>\r
<dl>\r
<dt>\r
TIG_TREE_CMD\r
</dt>\r
<dd>\r
<p>\r
        The command used for the tree view. Takes two arguments, the first\r
        is the revision ID and the second is the path of the directory tree,\r
        empty for the root directory. Defaults to "git ls-tree %s %s".\r
</p>\r
</dd>\r
<dt>\r
TIG_BLOB_CMD\r
</dt>\r
<dd>\r
<p>\r
        The command used for the blob view. Takes one argument which is\r
        the blob ID. Defaults to "git cat-file blob %s".\r
</p>\r
</dd>\r
</dl>\r
</div>\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="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><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 every 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><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
The main view\r
</dt>\r
<dd>\r
<p>\r
        Is the default view, and it shows a one line summary of each commit\r
        in the chosen list of revisions. The summary includes commit date,\r
        author, and the first line of the log message. Additionally, any\r
        repository references, such as tags, will be shown.\r
</p>\r
</dd>\r
<dt>\r
The log view\r
</dt>\r
<dd>\r
<p>\r
        Presents a more rich view of the revision log showing the whole log\r
        message and the diffstat.\r
</p>\r
</dd>\r
<dt>\r
The diff view\r
</dt>\r
<dd>\r
<p>\r
        Shows either the diff of the current working tree, that is, what\r
        has changed since the last commit, or the commit diff complete\r
        with log message, diffstat and diff.\r
</p>\r
</dd>\r
<dt>\r
The tree view\r
</dt>\r
<dd>\r
<p>\r
        Lists directory trees associated with the current revision allowing\r
        subdirectories to be descended or ascended and file blobs to be\r
        viewed.\r
</p>\r
</dd>\r
<dt>\r
The blob view\r
</dt>\r
<dd>\r
<p>\r
        Displays the file content or "blob" of data associated with a file\r
        name.\r
</p>\r
</dd>\r
<dt>\r
The pager view\r
</dt>\r
<dd>\r
<p>\r
        Is used for displaying both input from stdin and output from git\r
        commands entered in the internal prompt.\r
</p>\r
</dd>\r
<dt>\r
The help view\r
</dt>\r
<dd>\r
<p>\r
        Displays key binding quick reference.\r
</p>\r
</dd>\r
</dl>\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="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="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><a id="keys"></a>4. Default Keybindings</h2>\r
<div class="sectionbody">\r
<p>Below the default key bindings are shown.</p>\r
<h3><a id="view-switching"></a>4.1. View Switching</h3>\r
<div class="tableblock">\r
<table rules="none"\r
frame="hsides"\r
cellspacing="0" cellpadding="4">\r
<col width="91" />\r
<col width="788" />\r
<thead>\r
  <tr>\r
    <th align="left">\r
    Key\r
    </th>\r
    <th align="left">\r
    Action\r
    </th>\r
  </tr>\r
</thead>\r
<tbody valign="top">\r
  <tr>\r
    <td align="left">\r
    m\r
    </td>\r
    <td align="left">\r
    Switch to main view.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    d\r
    </td>\r
    <td align="left">\r
    Switch to diff view.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    l\r
    </td>\r
    <td align="left">\r
    Switch to log view.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    p\r
    </td>\r
    <td align="left">\r
    Switch to pager view.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    t\r
    </td>\r
    <td align="left">\r
    Switch to (directory) tree view.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    f\r
    </td>\r
    <td align="left">\r
    Switch to (file) blob view.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    h\r
    </td>\r
    <td align="left">\r
    Show man page.\r
    </td>\r
  </tr>\r
</tbody>\r
</table>\r
</div>\r
<h3><a id="view-manipulation"></a>4.2. View Manipulation</h3>\r
<div class="tableblock">\r
<table rules="none"\r
frame="hsides"\r
cellspacing="0" cellpadding="4">\r
<col width="91" />\r
<col width="788" />\r
<thead>\r
  <tr>\r
    <th align="left">\r
    Key\r
    </th>\r
    <th align="left">\r
    Action\r
    </th>\r
  </tr>\r
</thead>\r
<tbody valign="top">\r
  <tr>\r
    <td align="left">\r
    q\r
    </td>\r
    <td align="left">\r
    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
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    Enter\r
    </td>\r
    <td align="left">\r
    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
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    Tab\r
    </td>\r
    <td align="left">\r
    Switch to next view.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    Up\r
    </td>\r
    <td align="left">\r
    This key is "context sensitive" and will move the cursor one         line up. However, if 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
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    Down\r
    </td>\r
    <td align="left">\r
    Similar to <em>Up</em> but will move down.\r
    </td>\r
  </tr>\r
</tbody>\r
</table>\r
</div>\r
<h3><a id="cursor-nav"></a>4.3. Cursor Navigation</h3>\r
<div class="tableblock">\r
<table rules="none"\r
frame="hsides"\r
cellspacing="0" cellpadding="4">\r
<col width="91" />\r
<col width="788" />\r
<thead>\r
  <tr>\r
    <th align="left">\r
    Key\r
    </th>\r
    <th align="left">\r
    Action\r
    </th>\r
  </tr>\r
</thead>\r
<tbody valign="top">\r
  <tr>\r
    <td align="left">\r
    j\r
    </td>\r
    <td align="left">\r
    Move cursor one line up.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    k\r
    </td>\r
    <td align="left">\r
    Move cursor one line down.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    PgUp,-,a\r
    </td>\r
    <td align="left">\r
    Move cursor one page up.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    PgDown\r
    </td>\r
    <td align="left">\r
    Space   Move cursor one page down.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    Home\r
    </td>\r
    <td align="left">\r
    Jump to first line.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    End\r
    </td>\r
    <td align="left">\r
    Jump to last line.\r
    </td>\r
  </tr>\r
</tbody>\r
</table>\r
</div>\r
<h3><a id="view-scrolling"></a>4.4. Scrolling</h3>\r
<div class="tableblock">\r
<table rules="none"\r
frame="hsides"\r
cellspacing="0" cellpadding="4">\r
<col width="91" />\r
<col width="788" />\r
<thead>\r
  <tr>\r
    <th align="left">\r
    Key\r
    </th>\r
    <th align="left">\r
    Action\r
    </th>\r
  </tr>\r
</thead>\r
<tbody valign="top">\r
  <tr>\r
    <td align="left">\r
    Insert\r
    </td>\r
    <td align="left">\r
    Scroll view one line up.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    Delete\r
    </td>\r
    <td align="left">\r
    Scroll view one line down.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    w\r
    </td>\r
    <td align="left">\r
    Scroll view one page up.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    s\r
    </td>\r
    <td align="left">\r
    Scroll view one page down.\r
    </td>\r
  </tr>\r
</tbody>\r
</table>\r
</div>\r
<h3><a id="searching"></a>4.5. Searching</h3>\r
<div class="tableblock">\r
<table rules="none"\r
frame="hsides"\r
cellspacing="0" cellpadding="4">\r
<col width="91" />\r
<col width="788" />\r
<thead>\r
  <tr>\r
    <th align="left">\r
    Key\r
    </th>\r
    <th align="left">\r
    Action\r
    </th>\r
  </tr>\r
</thead>\r
<tbody valign="top">\r
  <tr>\r
    <td align="left">\r
    /\r
    </td>\r
    <td align="left">\r
    Search the view. Opens a prompt for entering search regex to use.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    ?\r
    </td>\r
    <td align="left">\r
    Search backwards in the view. Also prompts for regex.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    n\r
    </td>\r
    <td align="left">\r
    Find next match for the current search regex.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    N\r
    </td>\r
    <td align="left">\r
    Find previous match for the current search regex.\r
    </td>\r
  </tr>\r
</tbody>\r
</table>\r
</div>\r
<h3><a id="misc-keys"></a>4.6. Misc</h3>\r
<div class="tableblock">\r
<table rules="none"\r
frame="hsides"\r
cellspacing="0" cellpadding="4">\r
<col width="91" />\r
<col width="788" />\r
<thead>\r
  <tr>\r
    <th align="left">\r
    Key\r
    </th>\r
    <th align="left">\r
    Action\r
    </th>\r
  </tr>\r
</thead>\r
<tbody valign="top">\r
  <tr>\r
    <td align="left">\r
    Q\r
    </td>\r
    <td align="left">\r
    Quit.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    r\r
    </td>\r
    <td align="left">\r
    Redraw screen.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    z\r
    </td>\r
    <td align="left">\r
    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
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    v\r
    </td>\r
    <td align="left">\r
    Show version.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    <em>.</em>\r
    </td>\r
    <td align="left">\r
    Toggle line numbers on/off.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    g\r
    </td>\r
    <td align="left">\r
    Toggle revision graph visualization on/off.\r
    </td>\r
  </tr>\r
  <tr>\r
    <td align="left">\r
    <em>:</em>\r
    </td>\r
    <td align="left">\r
    Open prompt. This allows you to specify what git command         to run. Example <tt>:log -p</tt>\r
    </td>\r
  </tr>\r
</tbody>\r
</table>\r
</div>\r
</div>\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 does not itself parse the described\r
revision options so refer to the relevant git man pages for further\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><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="listingblock">\r
<div class="content">\r
<pre><tt>$ tig log Makefile README</tt></pre>\r
</div></div>\r
<p>To avoid ambiguity with repository references such as tag name, be sure to\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="listingblock">\r
<div class="content">\r
<pre><tt>$ tig log -- master</tt></pre>\r
</div></div>\r
<div class="admonitionblock">\r
<table><tr>\r
<td class="icon">\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 stop option processing\r
and the latter will be passed to git log.</td>\r
</tr></table>\r
</div>\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>&#8212;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="listingblock">\r
<div class="content">\r
<pre><tt>$ tig -- --after="May 5th" --before="2006-05-16 15:44"</tt></pre>\r
</div></div>\r
<div class="admonitionblock">\r
<table><tr>\r
<td class="icon">\r
<div class="title">Note</div>\r
</td>\r
<td class="content">If you want to avoid having to quote dates containing spaces you can use\r
"." instead, e.g. <tt>&#8212;after=May.5th</tt>.</td>\r
</tr></table>\r
</div>\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="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="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><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="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><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="listingblock">\r
<div class="content">\r
<pre><tt>$ tig -- --since=1.month -n20 -- Documentation/</tt></pre>\r
</div></div>\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="listingblock">\r
<div class="content">\r
<pre><tt>$ tig -- --all --since=1.week -- Makefile</tt></pre>\r
</div></div>\r
</div>\r
<h2>6. BUGS</h2>\r
<div class="sectionbody">\r
<p>Known bugs and problems:</p>\r
<ul>\r
<li>\r
<p>\r
Proper locale support: in it's current state tig is pretty much UTF-8 only.\r
</p>\r
</li>\r
<li>\r
<p>\r
Horizontal scrolling.\r
</p>\r
</li>\r
</ul>\r
</div>\r
<h2><a id="copy-right"></a>7. Copyright</h2>\r
<div class="sectionbody">\r
<p>Copyright (c) 2006 Jonas Fonseca &lt;fonseca@diku.dk&gt;</p>\r
<p>This program is free software; you can redistribute it and/or modify\r
it under the terms of the GNU General Public License as published by\r
the Free Software Foundation; either version 2 of the License, or\r
(at your option) any later version.</p>\r
</div>\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
Homepage:    <a href="http://jonas.nitro.dk/tig">http://jonas.nitro.dk/tig</a>\r
</p>\r
</li>\r
<li>\r
<p>\r
Manual:      <a href="http://jonas.nitro.dk/tig/manual.html">http://jonas.nitro.dk/tig/manual.html</a>\r
</p>\r
</li>\r
<li>\r
<p>\r
Releases:    <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a>\r
</p>\r
</li>\r
<li>\r
<p>\r
Git URL:     <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a> or\r
                git://repo.or.cz/tig.git\r
</p>\r
</li>\r
<li>\r
<p>\r
Gitweb:      <a href="http://repo.or.cz/?p=tig.git;a=summary">http://repo.or.cz/?p=tig.git;a=summary</a>\r
</p>\r
</li>\r
</ul>\r
<p>Git porcelains:</p>\r
<ul>\r
<li>\r
<p>\r
<a href="http://www.kernel.org/pub/software/scm/git/docs/">git</a>,\r
</p>\r
</li>\r
<li>\r
<p>\r
<a href="http://www.kernel.org/pub/software/scm/cogito/docs/">Cogito</a>\r
</p>\r
</li>\r
</ul>\r
<p>Other git repository browsers:</p>\r
<ul>\r
<li>\r
<p>\r
gitk(1)\r
</p>\r
</li>\r
<li>\r
<p>\r
qgit(1)\r
</p>\r
</li>\r
<li>\r
<p>\r
gitview(1)\r
</p>\r
</li>\r
</ul>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated 25-Sep-2006 01:14:32 CEST\r
</div>\r
</div>\r
</body>\r
</html>\r