mdw@git.distorted.org.uk Git - tig/blob - README.html

   1 <div style="font-family: monospace;">
   2 <h1>Tig: text-mode interface for git</h1>
   3 <div id="preamble">
   4 <div class="sectionbody">
   5 <p>Tig is a git repository browser that additionally can act as a pager for output
   6 from various git commands.</p>
   7 <p>When browsing repositories, it uses the underlying git commands to present the
   8 user with various views, such as summarized revision log and showing the commit
   9 with the log message, diffstat, and the diff.</p>
  10 <p>Using it as a pager, it will display input from stdin and colorize it.</p>
  11 </div>
  12 </div>
  13 <h2>Resources</h2>
  14 <div class="sectionbody">
  15 <ul>
  16 <li>
  17 <p>
  18 Homepage:    <a href="http://jonas.nitro.dk/tig">http://jonas.nitro.dk/tig</a>
  19 </p>
  20 </li>
  21 <li>
  22 <p>
  23 Manual:      <a href="http://jonas.nitro.dk/tig/manual.html">http://jonas.nitro.dk/tig/manual.html</a>
  24 </p>
  25 </li>
  26 <li>
  27 <p>
  28 Releases:    <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a>
  29 </p>
  30 </li>
  31 <li>
  32 <p>
  33 Git URL:     <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a> or
  34                 git://repo.or.cz/tig.git
  35 </p>
  36 </li>
  37 <li>
  38 <p>
  39 Gitweb:      <a href="http://repo.or.cz/?p=tig.git;a=summary">http://repo.or.cz/?p=tig.git;a=summary</a>
  40 </p>
  41 </li>
  42 </ul>
  43 </div>
  44 <h2>Installation instructions</h2>
  45 <div class="sectionbody">
  46 <p>Download a tarball from <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a> or clone the tig
  47 repository <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a>. Documentation files are
  48 available either in the tarballs or in the above repository in the branch named
  49 <em>release</em>.</p>
  50 <p>To install tig simply run:</p>
  51 <div class="literalblock">
  52 <div class="content">
  53 <pre><tt>$ make install</tt></pre>
  54 </div></div>
  55 <p>To install documentation run:</p>
  56 <div class="literalblock">
  57 <div class="content">
  58 <pre><tt>$ make install-docs</tt></pre>
  59 </div></div>
  60 <p>Edit the Makefile if you need to configure specific compiler or linker flags.
  61 On FreeBSD for example the c library does not support the iconv interface and
  62 to compile tig you need to append <tt>-L/usr/local/lib -liconv</tt> to <tt>LDLIBS</tt> and
  63 <tt>-I/usr/local/include</tt> to the <tt>CFLAGS</tt> variable.</p>
  64 <p>The following tools and packages are needed:</p>
  65 <div class="tableblock">
  66 <table rules="none"
  67 frame="hsides"
  68 cellspacing="0" cellpadding="4">
  69 <col width="365" />
  70 <col width="537" />
  71 <thead>
  72   <tr>
  73     <th align="left">
  74     Tool
  75     </th>
  76     <th align="left">
  77     Description
  78     </th>
  79   </tr>
  80 </thead>
  81 <tbody valign="top">
  82   <tr>
  83     <td align="left">
  84     git-core
  85     </td>
  86     <td align="left">
  87     Tig is just a frontend for git.
  88     </td>
  89   </tr>
  90   <tr>
  91     <td align="left">
  92     ncurses
  93     </td>
  94     <td align="left">
  95     Be sure to also have development files                                 installed. Usually they are available in a                                 separate package ending with <tt>-dev</tt>.
  96     </td>
  97   </tr>
  98   <tr>
  99     <td align="left">
 100     iconv
 101     </td>
 102     <td align="left">
 103     If iconv is not provided by the c library                                 you need to change the Makefile to link it                                 into the binary.
 104     </td>
 105   </tr>
 106   <tr>
 107     <td align="left">
 108     asciidoc (&gt;= 7.0), xmlto
 109     </td>
 110     <td align="left">
 111     For building documentation. (Optional)
 112     </td>
 113   </tr>
 114 </tbody>
 115 </table>
 116 </div>
 117 </div>
 118 </div>