<div style="font-family: sans-serif;">
<h1>Tig: text-mode interface for git</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p>Tig is a git repository browser that additionally can act as a pager for output
from various git commands.</p></div>
<div class="paragraph"><p>When browsing repositories, it uses the underlying git commands to present the
user with various views, such as summarized revision log and showing the commit
with the log message, diffstat, and the diff.</p></div>
<div class="paragraph"><p>Using it as a pager, it will display input from stdin and colorize it.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_resources">Resources</h2>
<div class="sectionbody">
<div class="ulist"><ul>
<li>
<p>
Homepage:    <a href="http://jonas.nitro.dk/tig/">http://jonas.nitro.dk/tig/</a>
</p>
</li>
<li>
<p>
Manual:      <a href="http://jonas.nitro.dk/tig/manual.html">http://jonas.nitro.dk/tig/manual.html</a>
</p>
</li>
<li>
<p>
Tarballs:    <a href="http://jonas.nitro.dk/tig/releases/">http://jonas.nitro.dk/tig/releases/</a>
</p>
</li>
<li>
<p>
Git URL:     git://github.com/jonas/tig.git (master) or
                git://repo.or.cz/tig.git (mirror)
</p>
</li>
<li>
<p>
Gitweb:      <a href="http://repo.or.cz/w/tig.git">http://repo.or.cz/w/tig.git</a>
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_installation_instructions">Installation instructions</h2>
<div class="sectionbody">
<div class="paragraph"><p>Download a tarball from <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a> or clone the tig
repository <a href="http://github.com/jonas/tig">git://github.com/jonas/tig.git</a>.
Documentation files are available in the tarballs and in the <em>release</em> branch
of the tig repository.</p></div>
<div class="paragraph"><p>The quick and simple way to install tig with documentation is to run:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>$ make
$ make install install-doc</tt></pre>
</div></div>
<div class="paragraph"><p>From tig&#8217;s git repository it is also possible to install documentation directly
from the release branch to avoid installing the documentation tool chain:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>$ make install-release-doc</tt></pre>
</div></div>
<div class="paragraph"><p>Optionally, you can use the <tt>configure</tt> script to detect dependencies:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>$ ./configure
$ make
$ make install</tt></pre>
</div></div>
<div class="paragraph"><p>If your iconv library is not in the default library and include path, you&#8217;ll
probably want to pass the "--with-libiconv" option to the "configure" script to
tell it where to look. Note, if you are building from the tig repository, you
need to first make the configure script:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>$ make configure</tt></pre>
</div></div>
<div class="paragraph"><p>Build settings are read from the file "config.make". To manually configure tig
to use the ncurses library with wide character support, add the line:</p></div>
<div class="literalblock">
<div class="content">
<pre><tt>LDLIBS = -lncursesw</tt></pre>
</div></div>
<div class="paragraph"><p>Release notes documenting notable changes are available in the NEWS file. When
upgrading, you are advised to also read them after you have completed the
installation.</p></div>
<div class="paragraph"><p>The following tools and packages are needed:</p></div>
<div class="tableblock">
<table rules="all"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="20%" />
<col width="80%" />
<thead>
<tr>
<th align="left" valign="top">Tool                           </th>
<th align="left" valign="top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">git-core</p></td>
<td align="left" valign="top"><p class="table">Tig is just a frontend for git.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">ncurses or ncursesw</p></td>
<td align="left" valign="top"><p class="table">Be sure to have the development files
                                 installed. Usually they are available in a
                                 separate package ending with <tt>-dev</tt>.
                                 Note also that ncurses with wide character
                                 support (ncursesw) is required to properly
                                 handle UTF-8 encoded strings.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">iconv</p></td>
<td align="left" valign="top"><p class="table">If iconv is not provided by the c library
                                 you need to change the Makefile to link it
                                 into the binary.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="paragraph"><p>The following optional tools and packages are needed for creating the
configure script and building documentation:</p></div>
<div class="tableblock">
<table rules="all"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="20%" />
<col width="80%" />
<thead>
<tr>
<th align="left" valign="top">Tool                           </th>
<th align="left" valign="top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">autoconf</p></td>
<td align="left" valign="top"><p class="table">Contains autoreconf for generating configure
                                 from configure.ac.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">asciidoc (&gt;= 8.4)</p></td>
<td align="left" valign="top"><p class="table">Generates HTML and (DocBook) XML from text.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">xmlto</p></td>
<td align="left" valign="top"><p class="table">Generates manpages and chunked HTML from XML.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">DocBook XSL (&gt;= 1.72.0)</p></td>
<td align="left" valign="top"><p class="table">Used by xmlto for building manpages.</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">DocBook (DSSL/Jade) tools</p></td>
<td align="left" valign="top"><p class="table">Generates PDF from XML.
                                Also known as docbook-utils.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>