| 1 | <div id="preamble">\r |
| 2 | <div class="sectionbody">\r |
| 3 | <p>Tig is a git repository browser that additionally can act as a pager for output\r |
| 4 | of various git commands.</p>\r |
| 5 | <p>When browsing repositories, it uses the underlying git commands to present the\r |
| 6 | user with various views, such as summarized revision log and showing the commit\r |
| 7 | with the log message, diffstat, and the diff.</p>\r |
| 8 | <p>Using it as a pager, it will display input from stdin and try to colorize it.</p>\r |
| 9 | </div>\r |
| 10 | </div>\r |
| 11 | <h2>Getting it</h2>\r |
| 12 | <div class="sectionbody">\r |
| 13 | <p>To get tig either grab the Makefile and tig.c files from the home page:</p>\r |
| 14 | <ul>\r |
| 15 | <li>\r |
| 16 | <p>\r |
| 17 | <a href="http://jonas.nitro.dk/tig/">http://jonas.nitro.dk/tig/</a>\r |
| 18 | </p>\r |
| 19 | </li>\r |
| 20 | </ul>\r |
| 21 | <p>or clone the tig repository using the URL:</p>\r |
| 22 | <ul>\r |
| 23 | <li>\r |
| 24 | <p>\r |
| 25 | <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a>\r |
| 26 | </p>\r |
| 27 | </li>\r |
| 28 | </ul>\r |
| 29 | <p>Documentation files are available either at the home page or in the above\r |
| 30 | repository in the branch named <em>release</em>.</p>\r |
| 31 | </div>\r |
| 32 | <h2>Installation instructions</h2>\r |
| 33 | <div class="sectionbody">\r |
| 34 | <p>To install tig simply run:</p>\r |
| 35 | <div class="literalblock">\r |
| 36 | <div class="content">\r |
| 37 | <pre><tt>$ make install</tt></pre>\r |
| 38 | </div></div>\r |
| 39 | <p>To install documentation run:</p>\r |
| 40 | <div class="literalblock">\r |
| 41 | <div class="content">\r |
| 42 | <pre><tt>$ make install-docs</tt></pre>\r |
| 43 | </div></div>\r |
| 44 | <p>The following tools and packages are needed:</p>\r |
| 45 | <div class="tableblock">\r |
| 46 | <table rules="none"\r |
| 47 | frame="hsides"\r |
| 48 | cellspacing="0" cellpadding="4">\r |
| 49 | <col width="365" />\r |
| 50 | <col width="537" />\r |
| 51 | <thead>\r |
| 52 | <tr>\r |
| 53 | <th align="left">\r |
| 54 | Tool\r |
| 55 | </th>\r |
| 56 | <th align="left">\r |
| 57 | Description\r |
| 58 | </th>\r |
| 59 | </tr>\r |
| 60 | </thead>\r |
| 61 | <tbody valign="top">\r |
| 62 | <tr>\r |
| 63 | <td align="left">\r |
| 64 | git-core\r |
| 65 | </td>\r |
| 66 | <td align="left">\r |
| 67 | Tig is just a frontend for git.\r |
| 68 | </td>\r |
| 69 | </tr>\r |
| 70 | <tr>\r |
| 71 | <td align="left">\r |
| 72 | ncurses\r |
| 73 | </td>\r |
| 74 | <td align="left">\r |
| 75 | Be sure to also have development files installed. Usually they are available in a\r |
| 76 | </td>\r |
| 77 | </tr>\r |
| 78 | <tr>\r |
| 79 | <td align="left">\r |
| 80 | \r |
| 81 | </td>\r |
| 82 | <td align="left">\r |
| 83 | separate package ending with <tt>-dev</tt>.\r |
| 84 | </td>\r |
| 85 | </tr>\r |
| 86 | <tr>\r |
| 87 | <td align="left">\r |
| 88 | asciidoc (>= 7.0), xmlto\r |
| 89 | </td>\r |
| 90 | <td align="left">\r |
| 91 | For building documentation. (Optional)\r |
| 92 | </td>\r |
| 93 | </tr>\r |
| 94 | </tbody>\r |
| 95 | </table>\r |
| 96 | </div>\r |
| 97 | <div class="admonitionblock">\r |
| 98 | <table><tr>\r |
| 99 | <td class="icon">\r |
| 100 | <div class="title">Note</div>\r |
| 101 | </td>\r |
| 102 | <td class="content">You need to install the tig(1) man page in order for the internal help to\r |
| 103 | be available.</td>\r |
| 104 | </tr></table>\r |
| 105 | </div>\r |
| 106 | </div>\r |