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