chiark / gitweb /
Sync docs
[tig] / tig.1.html
index 9d3f59cb4f590a58d8be8a4b26fbe03f5a09ca11..ae14630dfde7464b460336f1a48db3cac58b7ca3 100644 (file)
@@ -274,10 +274,10 @@ TIG(1) Manual Page
 <div class="sectionbody">\r
 <div class="verseblock">\r
 <div class="content">tig [options]\r
-tig [options] [--] [git log options]\r
-tig [options] log  [git log options]\r
-tig [options] diff [git diff options]\r
-tig [options] show [git show options]\r
+tig [options] [--] [git options]\r
+tig [options] log  [git options]\r
+tig [options] diff [git options]\r
+tig [options] show [git options]\r
 tig [options] &lt;    [git command output]</div></div>\r
 </div>\r
 <h2>DESCRIPTION</h2>\r
@@ -319,7 +319,7 @@ to colorize it.</p>
 </p>\r
 </dd>\r
 <dt>\r
--t[NSPACES], --tab-size[=NSPACES]\r
+-b[NSPACES], --tab-size[=NSPACES]\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -335,6 +335,14 @@ to colorize it.</p>
 </p>\r
 </dd>\r
 <dt>\r
+-h, --help\r
+</dt>\r
+<dd>\r
+<p>\r
+        Show help message and exit.\r
+</p>\r
+</dd>\r
+<dt>\r
 --\r
 </dt>\r
 <dd>\r
@@ -348,7 +356,7 @@ to colorize it.</p>
 </div></div>\r
 </dd>\r
 <dt>\r
-log [git log options]\r
+log\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -356,7 +364,7 @@ log [git log options]
 </p>\r
 </dd>\r
 <dt>\r
-diff [git diff options]\r
+diff\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -364,7 +372,7 @@ diff [git diff options]
 </p>\r
 </dd>\r
 <dt>\r
-show [git show options]\r
+show\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -372,7 +380,7 @@ show [git show options]
 </p>\r
 </dd>\r
 <dt>\r
-[git log options]\r
+[git options]\r
 </dt>\r
 <dd>\r
 <p>\r
@@ -388,58 +396,9 @@ show [git show options]
 </div></div>\r
 </dd>\r
 </dl>\r
-<h3>Pager mode</h3>\r
-<p>If stdin is a pipe, any log or diff options will be ignored and the\r
-pager view will be opened loading data from stdin. The pager mode\r
-can be used for colorizing output from various git commands.</p>\r
-<p>Example on how to colorize the output of git-show(1):</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>$ git show | tig</tt></pre>\r
-</div></div>\r
-<h3>Git command options</h3>\r
-<p>All git command options specified on the command line will\r
-be passed to the given command and all will be shell quoted\r
-before they are passed to the 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\r
-not use the <tt>--pretty</tt> option as this option will be set\r
-automatically to the format 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\r
-committer information:</p>\r
-<div class="literalblock">\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\r
-for an introduction to revision options supported by the git\r
-commands. For details on specific git command options, refer\r
-to the man page of the command in question.</p>\r
 </div>\r
 <h2>ENVIRONMENT VARIABLES</h2>\r
 <div class="sectionbody">\r
-<p>Several options related to the interface with git can be configured\r
-via environment options.</p>\r
-<h3>Repository references</h3>\r
-<p>Commits that are referenced by tags and branch heads will be marked\r
-by the reference name surrounded by <em>[</em> and <em>]</em>:</p>\r
-<div class="literalblock">\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\r
-<tt>tmp</tt> you can do it by setting the following variable:</p>\r
-<div class="literalblock">\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
@@ -450,19 +409,6 @@ TIG_LS_REMOTE
         should output data in the same format as git-ls-remote(1).\r
 </p>\r
 </dd>\r
-</dl>\r
-<h3><a id="view-commands"></a>View commands</h3>\r
-<p>It is possible to alter which commands are used for the different views.\r
-If for example you prefer commits in the main view to be sorted by date\r
-and only show 500 commits, use:</p>\r
-<div class="literalblock">\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\r
-be a maximum of 5 <tt>%s</tt> ref specifications.</p>\r
-<dl>\r
 <dt>\r
 TIG_DIFF_CMD\r
 </dt>\r
@@ -493,363 +439,50 @@ TIG_MAIN_CMD
 </p>\r
 </dd>\r
 </dl>\r
-</div>\r
-<h2>The viewer</h2>\r
-<div class="sectionbody">\r
-<p>tig(1) presents various <em>views</em> of a repository. 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
+<h3>Tree commands</h3>\r
 <dl>\r
 <dt>\r
-The main view\r
+TIG_TREE_CMD\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 revision. 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
+    The command used for the tree view. By default, git-ls-tree(1) is\r
+    used. The commands should expect first the commit ID and second\r
+    a path.\r
 </p>\r
 </dd>\r
 <dt>\r
-The log view\r
+TIG_BLOB_CMD\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 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 the information from the tig(1) man page. For the help view\r
-        to work you need to have the tig(1) man page installed.\r
+    The command used for the blob view. By default, git-cat-file(1) is\r
+    used. The command gets the blob ID.\r
 </p>\r
 </dd>\r
 </dl>\r
 </div>\r
-<h2>KEYS</h2>\r
+<h2>FILES</h2>\r
 <div class="sectionbody">\r
-<p>Below the default key bindings are shown.</p>\r
-<h3>View switching</h3>\r
 <dl>\r
 <dt>\r
-m\r
-</dt>\r
-<dd>\r
-<p>\r
-        Switch to main view.\r
-</p>\r
-</dd>\r
-<dt>\r
-d\r
-</dt>\r
-<dd>\r
-<p>\r
-        Switch to diff view.\r
-</p>\r
-</dd>\r
-<dt>\r
-l\r
-</dt>\r
-<dd>\r
-<p>\r
-        Switch to log view.\r
-</p>\r
-</dd>\r
-<dt>\r
-p\r
-</dt>\r
-<dd>\r
-<p>\r
-        Switch to pager view.\r
-</p>\r
-</dd>\r
-<dt>\r
-h\r
-</dt>\r
-<dd>\r
-<p>\r
-        Show man page.\r
-</p>\r
-</dd>\r
-<dt>\r
-Return\r
+<em>~/.tigrc</em>\r
 </dt>\r
 <dd>\r
 <p>\r
-        If on a commit line show the commit diff. Additionally, if in\r
-        main or log view this will split the view. To open the commit\r
-        diff in full size view either use <em>d</em> or press Return twice.\r
+        User configuration file. See <a href="tigrc.5.html">tigrc(5)</a> for examples.\r
 </p>\r
 </dd>\r
 <dt>\r
-Tab\r
+<em>.git/config</em>\r
 </dt>\r
 <dd>\r
 <p>\r
-        Switch to next view.\r
+        Repository config file. Read on start-up with the help of\r
+        git-repo-config(1).\r
 </p>\r
 </dd>\r
 </dl>\r
-<h3>Cursor navigation</h3>\r
-<dl>\r
-<dt>\r
-Up\r
-</dt>\r
-<dd>\r
-<p>\r
-        Move cursor one line up.\r
-</p>\r
-</dd>\r
-<dt>\r
-Down\r
-</dt>\r
-<dd>\r
-<p>\r
-        Move cursor one line down.\r
-</p>\r
-</dd>\r
-<dt>\r
-k\r
-</dt>\r
-<dd>\r
-<p>\r
-        Move cursor one line up and enter. When used in the main view\r
-        this will always show the diff of the current commit in the\r
-        split diff view.\r
-</p>\r
-</dd>\r
-<dt>\r
-j\r
-</dt>\r
-<dd>\r
-<p>\r
-        Move cursor one line down and enter.\r
-</p>\r
-</dd>\r
-<dt>\r
-PgUp\r
-</dt>\r
-<dd>\r
-<p>\r
-        Move cursor one page up.\r
-</p>\r
-</dd>\r
-<dt>\r
-PgDown\r
-</dt>\r
-<dd>\r
-<p>\r
-        Move cursor one page down.\r
-</p>\r
-</dd>\r
-<dt>\r
-Home\r
-</dt>\r
-<dd>\r
-<p>\r
-        Jump to first line.\r
-</p>\r
-</dd>\r
-<dt>\r
-End\r
-</dt>\r
-<dd>\r
-<p>\r
-        Jump to last line.\r
-</p>\r
-</dd>\r
-</dl>\r
-<h3>Scrolling</h3>\r
-<dl>\r
-<dt>\r
-Insert\r
-</dt>\r
-<dd>\r
-<p>\r
-        Scroll view one line up.\r
-</p>\r
-</dd>\r
-<dt>\r
-Delete\r
-</dt>\r
-<dd>\r
-<p>\r
-        Scroll view one line down.\r
-</p>\r
-</dd>\r
-<dt>\r
-w\r
-</dt>\r
-<dd>\r
-<p>\r
-        Scroll view one page up.\r
-</p>\r
-</dd>\r
-<dt>\r
-s\r
-</dt>\r
-<dd>\r
-<p>\r
-        Scroll view one page down.\r
-</p>\r
-</dd>\r
-</dl>\r
-<h3>Misc</h3>\r
-<dl>\r
-<dt>\r
-q\r
-</dt>\r
-<dd>\r
-<p>\r
-        Quit\r
-</p>\r
-</dd>\r
-<dt>\r
-r\r
-</dt>\r
-<dd>\r
-<p>\r
-        Redraw screen.\r
-</p>\r
-</dd>\r
-<dt>\r
-z\r
-</dt>\r
-<dd>\r
-<p>\r
-        Stop all background loading. This can be useful if you use\r
-        tig(1) in a repository with a long history without limiting\r
-        the revision log.\r
-</p>\r
-</dd>\r
-<dt>\r
-v\r
-</dt>\r
-<dd>\r
-<p>\r
-        Show version.\r
-</p>\r
-</dd>\r
-<dt>\r
-n\r
-</dt>\r
-<dd>\r
-<p>\r
-        Toggle line numbers on/off.\r
-</p>\r
-</dd>\r
-<dt>\r
-<em>:</em>\r
-</dt>\r
-<dd>\r
-<p>\r
-        Open prompt. This allows you to specify what git command\r
-        to run. Example:\r
-</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>:log -p</tt></pre>\r
-</div></div>\r
-</dd>\r
-</dl>\r
-</div>\r
-<h2><a id="refspec"></a>Specifying revisions</h2>\r
-<div class="sectionbody">\r
-<p>This section describes various ways to specify what revisions to display\r
-or otherwise limit the view to. Note, that tig(1) does not itself parse\r
-the described revision options.</p>\r
-</div>\r
-<h2>File history</h2>\r
-<div class="sectionbody">\r
-<p>If you are interested only in those revisions that made changes to a\r
-specific file (or even several files) list the files like this:</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>$ tig log Makefile</tt></pre>\r
-</div></div>\r
-<p>To avoid ambiguity with repository references such as tag name, be sure\r
-to separate file names from other git options using "--". So if you\r
-have a file named <em>master</em> it will clash with the reference named\r
-<em>master</em>, and thus you will have to use:</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt>$ tag 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\r
-you to specify two "--" options. The first will make tig(1) stop\r
-option processing and the latter will be passed to git log.</td>\r
-</tr></table>\r
-</div>\r
-<h3>Limit by date or number</h3>\r
-<p>To speed up interaction with git, you can limit the amount of commits\r
-to show both for the log and main view. Either limit by date using\r
-e.g. <tt>--since=1.month</tt> or limit by the number of commits using <tt>-n400</tt>.</p>\r
-<div class="admonitionblock">\r
-<table><tr>\r
-<td class="icon">\r
-<div class="title">Note</div>\r
-</td>\r
-<td class="content">You can tune the interaction with git by making use of the options\r
-explained in this section. For example, by configuring the environment\r
-variables described in the  <a href="#view-commands">"View commands"</a> section.</td>\r
-</tr></table>\r
-</div>\r
-<h3>Ranges</h3>\r
-<p>Alternatively, commits can be limited to a specific range, such as\r
-"all commits between <em>tag-1.0</em> and <em>tag-2.0</em>". For example:</p>\r
-<div class="literalblock">\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\r
-which haven't been pushed to a remote branch. Assuming <em>origin</em> is your\r
-upstream remote branch, using:</p>\r
-<div class="literalblock">\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>Limiting by reachability</h3>\r
-<p>Git interprets the range specifier "tag-1.0..tag-2.0" as\r
-"all commits reachable from <em>tag-2.0</em> but not from <em>tag-1.0</em>".\r
-If you prefer to specify which commit to preview in this way use the\r
-following:</p>\r
-<div class="literalblock">\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,\r
-it is possible to further prune commits by specifying multiple branch\r
-cut offs.</p>\r
 </div>\r
 <h2>BUGS</h2>\r
 <div class="sectionbody">\r
@@ -857,32 +490,19 @@ cut offs.</p>
 <ul>\r
 <li>\r
 <p>\r
-If the screen width is very small the main view can draw\r
-outside the current view causing bad wrapping. Same goes\r
-for title and status windows.\r
-</p>\r
-</li>\r
-</ul>\r
-</div>\r
-<h2>TODO</h2>\r
-<div class="sectionbody">\r
-<p>Features that should be explored.</p>\r
-<ul>\r
-<li>\r
-<p>\r
-Searching.\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
-Locale support.\r
+Horizontal scrolling.\r
 </p>\r
 </li>\r
 </ul>\r
 </div>\r
 <h2>COPYRIGHT</h2>\r
 <div class="sectionbody">\r
-<p>Copyright (c) Jonas Fonseca &lt;fonseca@diku.dk&gt;, 2006</p>\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
@@ -890,15 +510,41 @@ the Free Software Foundation; either version 2 of the License, or
 </div>\r
 <h2>SEE ALSO</h2>\r
 <div class="sectionbody">\r
-<div class="verseblock">\r
-<div class="content"><a href="http://www.kernel.org/pub/software/scm/git/docs/">git(7)</a>,\r
-<a href="http://www.kernel.org/pub/software/scm/cogito/docs/">cogito(7)</a>\r
-gitk(1): git repository browser written using tcl/tk,\r
-gitview(1): git repository browser written using python/gtk.</div></div>\r
+<p><a href="tigrc.5.html">tigrc(5)</a>, git(7), cogito(7), as well as other git repository browsers:\r
+gitk(1), qgit(1), gitview(1).</p>\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
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 16-May-2006 15:50:55 CEST\r
+Last updated 25-Sep-2006 01:14:26 CEST\r
 </div>\r
 </div>\r
 </body>\r