Sync docs
[tig] / manual.html
index 0f787e7..43a2b14 100644 (file)
@@ -306,6 +306,11 @@ commit with the log message, diffstat, and the diff.</p>
 <a href="#history-commands">History Commands</a>\r
 </p>\r
 </li>\r
+<li>\r
+<p>\r
+<a href="#tree-commands">Tree Commands</a>\r
+</p>\r
+</li>\r
 </ul>\r
 </li>\r
 <li>\r
@@ -328,6 +333,13 @@ commit with the log message, diffstat, and the diff.</p>
 <a href="#title-window">Title Windows</a>\r
 </p>\r
 </li>\r
+</ul>\r
+</li>\r
+<li>\r
+<p>\r
+<a href="#keys">Default Keybindings</a>\r
+</p>\r
+<ul>\r
 <li>\r
 <p>\r
 <a href="#view-switching">View Switching</a>\r
@@ -348,6 +360,11 @@ commit with the log message, diffstat, and the diff.</p>
 <a href="#view-scrolling">Scrolling</a>\r
 </p>\r
 </li>\r
+<li>\r
+<p>\r
+<a href="#searching">Searching</a>\r
+</p>\r
+</li>\r
 </ul>\r
 </li>\r
 <li>\r
@@ -506,6 +523,28 @@ TIG_MAIN_CMD
 </p>\r
 </dd>\r
 </dl>\r
+<h3><a id="tree-commands"></a>2.3. Tree Commands</h3>\r
+<dl>\r
+<dt>\r
+TIG_TREE_CMD\r
+</dt>\r
+<dd>\r
+<p>\r
+        The command used for the tree view. Takes two arguments, the first\r
+        is the revision ID and the second is the path of the directory tree,\r
+        empty for the root directory. Defaults to "git ls-tree %s %s".\r
+</p>\r
+</dd>\r
+<dt>\r
+TIG_BLOB_CMD\r
+</dt>\r
+<dd>\r
+<p>\r
+        The command used for the blob view. Takes one argument which is\r
+        the blob ID. Defaults to "git cat-file blob %s".\r
+</p>\r
+</dd>\r
+</dl>\r
 </div>\r
 <h2><a id="viewer"></a>3. The Viewer</h2>\r
 <div class="sectionbody">\r
@@ -523,7 +562,7 @@ and the diff view in the bottom window. You can switch between the two views
 by pressing <em>Tab</em>. To maximize the log view again, simply press <em>l</em>.</p>\r
 <h3><a id="commit-id"></a>3.1. Current Head and Commit ID</h3>\r
 <p>The viewer keeps track of both what head and commit ID you are currently\r
-viewing. The commit ID will follow the cursor line and change everytime time\r
+viewing. The commit ID will follow the cursor line and change every time\r
 you highlight a different commit. Whenever you reopen the diff view it will be\r
 reloaded, if the commit ID changed.</p>\r
 <p>The head ID is used when opening the main and log view to indicate from what\r
@@ -563,6 +602,25 @@ The diff view
 </p>\r
 </dd>\r
 <dt>\r
+The tree view\r
+</dt>\r
+<dd>\r
+<p>\r
+        Lists directory trees associated with the current revision allowing\r
+        subdirectories to be descended or ascended and file blobs to be\r
+        viewed.\r
+</p>\r
+</dd>\r
+<dt>\r
+The blob view\r
+</dt>\r
+<dd>\r
+<p>\r
+        Displays the file content or "blob" of data associated with a file\r
+        name.\r
+</p>\r
+</dd>\r
+<dt>\r
 The pager view\r
 </dt>\r
 <dd>\r
@@ -595,271 +653,405 @@ be appended:</p>
 <pre><tt>[main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s</tt></pre>\r
 </div></div>\r
 </div>\r
-<h2><a id="keys"></a>4. Keys</h2>\r
+<h2><a id="keys"></a>4. Default Keybindings</h2>\r
 <div class="sectionbody">\r
 <p>Below the default key bindings are shown.</p>\r
 <h3><a id="view-switching"></a>4.1. 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
-</dl>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="hsides"\r
+cellspacing="0" cellpadding="4">\r
+<col width="91" />\r
+<col width="788" />\r
+<thead>\r
+  <tr>\r
+    <th align="left">\r
+    Key\r
+    </th>\r
+    <th align="left">\r
+    Action\r
+    </th>\r
+  </tr>\r
+</thead>\r
+<tbody valign="top">\r
+  <tr>\r
+    <td align="left">\r
+    m\r
+    </td>\r
+    <td align="left">\r
+    Switch to main view.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    d\r
+    </td>\r
+    <td align="left">\r
+    Switch to diff view.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    l\r
+    </td>\r
+    <td align="left">\r
+    Switch to log view.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    p\r
+    </td>\r
+    <td align="left">\r
+    Switch to pager view.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    t\r
+    </td>\r
+    <td align="left">\r
+    Switch to (directory) tree view.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    f\r
+    </td>\r
+    <td align="left">\r
+    Switch to (file) blob view.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    h\r
+    </td>\r
+    <td align="left">\r
+    Show man page.\r
+    </td>\r
+  </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
 <h3><a id="view-manipulation"></a>4.2. View Manipulation</h3>\r
-<dl>\r
-<dt>\r
-q\r
-</dt>\r
-<dd>\r
-<p>\r
-        Close view, if multiple views are open it will jump back to the\r
-        previous view in the view stack. If it is the last open view it\r
-        will quit. Use <em>Q</em> to quit all views at once.\r
-</p>\r
-</dd>\r
-<dt>\r
-Enter\r
-</dt>\r
-<dd>\r
-<p>\r
-        This key is "context sensitive" depending on what view you are\r
-        currently in. When in log view on a commit line or in the main\r
-        view, split the view and show the commit diff. In the diff view\r
-        pressing Enter will simply scroll the view one line down.\r
-</p>\r
-</dd>\r
-<dt>\r
-Tab\r
-</dt>\r
-<dd>\r
-<p>\r
-        Switch to next view.\r
-</p>\r
-</dd>\r
-<dt>\r
-Up\r
-</dt>\r
-<dd>\r
-<p>\r
-        This key is "context sensitive" and will move the cursor one\r
-        line up. However, uf you opened a diff view from the main view\r
-        (split- or full-screen) it will change the cursor to point to\r
-        the previous commit in the main view and update the diff view\r
-        to display it.\r
-</p>\r
-</dd>\r
-<dt>\r
-Down\r
-</dt>\r
-<dd>\r
-<p>\r
-        Similar to <em>Up</em> but will move down.\r
-</p>\r
-</dd>\r
-</dl>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="hsides"\r
+cellspacing="0" cellpadding="4">\r
+<col width="91" />\r
+<col width="788" />\r
+<thead>\r
+  <tr>\r
+    <th align="left">\r
+    Key\r
+    </th>\r
+    <th align="left">\r
+    Action\r
+    </th>\r
+  </tr>\r
+</thead>\r
+<tbody valign="top">\r
+  <tr>\r
+    <td align="left">\r
+    q\r
+    </td>\r
+    <td align="left">\r
+    Close view, if multiple views are open it will jump back to the         previous view in the view stack. If it is the last open view it         will quit. Use <em>Q</em> to quit all views at once.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    Enter\r
+    </td>\r
+    <td align="left">\r
+    This key is "context sensitive" depending on what view you are         currently in. When in log view on a commit line or in the main         view, split the view and show the commit diff. In the diff view         pressing Enter will simply scroll the view one line down.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    Tab\r
+    </td>\r
+    <td align="left">\r
+    Switch to next view.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    Up\r
+    </td>\r
+    <td align="left">\r
+    This key is "context sensitive" and will move the cursor one         line up. However, if you opened a diff view from the main view         (split- or full-screen) it will change the cursor to point to         the previous commit in the main view and update the diff view         to display it.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    Down\r
+    </td>\r
+    <td align="left">\r
+    Similar to <em>Up</em> but will move down.\r
+    </td>\r
+  </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
 <h3><a id="cursor-nav"></a>4.3. Cursor Navigation</h3>\r
-<dl>\r
-<dt>\r
-j\r
-</dt>\r
-<dd>\r
-<p>\r
-        Move cursor one line up.\r
-</p>\r
-</dd>\r
-<dt>\r
-k\r
-</dt>\r
-<dd>\r
-<p>\r
-        Move cursor one line down.\r
-</p>\r
-</dd>\r
-<dt>\r
-PgUp\r
-</dt>\r
-<dt>\r
-b\r
-</dt>\r
-<dt>\r
--\r
-</dt>\r
-<dd>\r
-<p>\r
-        Move cursor one page up.\r
-</p>\r
-</dd>\r
-<dt>\r
-PgDown\r
-</dt>\r
-<dt>\r
-Space\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
+<div class="tableblock">\r
+<table rules="none"\r
+frame="hsides"\r
+cellspacing="0" cellpadding="4">\r
+<col width="91" />\r
+<col width="788" />\r
+<thead>\r
+  <tr>\r
+    <th align="left">\r
+    Key\r
+    </th>\r
+    <th align="left">\r
+    Action\r
+    </th>\r
+  </tr>\r
+</thead>\r
+<tbody valign="top">\r
+  <tr>\r
+    <td align="left">\r
+    j\r
+    </td>\r
+    <td align="left">\r
+    Move cursor one line up.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    k\r
+    </td>\r
+    <td align="left">\r
+    Move cursor one line down.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    PgUp,-,a\r
+    </td>\r
+    <td align="left">\r
+    Move cursor one page up.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    PgDown\r
+    </td>\r
+    <td align="left">\r
+    Space   Move cursor one page down.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    Home\r
+    </td>\r
+    <td align="left">\r
+    Jump to first line.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    End\r
+    </td>\r
+    <td align="left">\r
+    Jump to last line.\r
+    </td>\r
+  </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
 <h3><a id="view-scrolling"></a>4.4. 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><a id="misc-keys"></a>4.5. 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 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
-g\r
-</dt>\r
-<dd>\r
-<p>\r
-        Toggle revision graph visualization 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 class="tableblock">\r
+<table rules="none"\r
+frame="hsides"\r
+cellspacing="0" cellpadding="4">\r
+<col width="91" />\r
+<col width="788" />\r
+<thead>\r
+  <tr>\r
+    <th align="left">\r
+    Key\r
+    </th>\r
+    <th align="left">\r
+    Action\r
+    </th>\r
+  </tr>\r
+</thead>\r
+<tbody valign="top">\r
+  <tr>\r
+    <td align="left">\r
+    Insert\r
+    </td>\r
+    <td align="left">\r
+    Scroll view one line up.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    Delete\r
+    </td>\r
+    <td align="left">\r
+    Scroll view one line down.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    w\r
+    </td>\r
+    <td align="left">\r
+    Scroll view one page up.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    s\r
+    </td>\r
+    <td align="left">\r
+    Scroll view one page down.\r
+    </td>\r
+  </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+<h3><a id="searching"></a>4.5. Searching</h3>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="hsides"\r
+cellspacing="0" cellpadding="4">\r
+<col width="91" />\r
+<col width="788" />\r
+<thead>\r
+  <tr>\r
+    <th align="left">\r
+    Key\r
+    </th>\r
+    <th align="left">\r
+    Action\r
+    </th>\r
+  </tr>\r
+</thead>\r
+<tbody valign="top">\r
+  <tr>\r
+    <td align="left">\r
+    /\r
+    </td>\r
+    <td align="left">\r
+    Search the view. Opens a prompt for entering search regex to use.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    ?\r
+    </td>\r
+    <td align="left">\r
+    Search backwards in the view. Also prompts for regex.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    n\r
+    </td>\r
+    <td align="left">\r
+    Find next match for the current search regex.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    N\r
+    </td>\r
+    <td align="left">\r
+    Find previous match for the current search regex.\r
+    </td>\r
+  </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+<h3><a id="misc-keys"></a>4.6. Misc</h3>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="hsides"\r
+cellspacing="0" cellpadding="4">\r
+<col width="91" />\r
+<col width="788" />\r
+<thead>\r
+  <tr>\r
+    <th align="left">\r
+    Key\r
+    </th>\r
+    <th align="left">\r
+    Action\r
+    </th>\r
+  </tr>\r
+</thead>\r
+<tbody valign="top">\r
+  <tr>\r
+    <td align="left">\r
+    Q\r
+    </td>\r
+    <td align="left">\r
+    Quit.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    r\r
+    </td>\r
+    <td align="left">\r
+    Redraw screen.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    z\r
+    </td>\r
+    <td align="left">\r
+    Stop all background loading. This can be useful if you use         tig in a repository with a long history without limiting         the revision log.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    v\r
+    </td>\r
+    <td align="left">\r
+    Show version.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    <em>.</em>\r
+    </td>\r
+    <td align="left">\r
+    Toggle line numbers on/off.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    g\r
+    </td>\r
+    <td align="left">\r
+    Toggle revision graph visualization on/off.\r
+    </td>\r
+  </tr>\r
+  <tr>\r
+    <td align="left">\r
+    <em>:</em>\r
+    </td>\r
+    <td align="left">\r
+    Open prompt. This allows you to specify what git command         to run. Example <tt>:log -p</tt>\r
+    </td>\r
+  </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
 </div>\r
 <h2><a id="refspec"></a>5. Revision Specification</h2>\r
 <div class="sectionbody">\r
 <p>This section describes various ways to specify what revisions to display or\r
 otherwise limit the view to. Tig does not itself parse the described\r
-revision options so refer to the relevant git man pages for futher\r
+revision options so refer to the relevant git man pages for further\r
 information. Relevant man pages besides git-log(1) are git-diff(1) and\r
 git-rev-list(1).</p>\r
 <p>You can tune the interaction with git by making use of the options explained\r
@@ -962,20 +1154,12 @@ accomplished using:</p>
 <ul>\r
 <li>\r
 <p>\r
-In it's current state tig is pretty much UTF-8 only.\r
-</p>\r
-</li>\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
+Proper locale support: in it's current state tig is pretty much UTF-8 only.\r
 </p>\r
 </li>\r
 <li>\r
 <p>\r
-The cursor can wrap-around on the last line and cause the\r
-   window to scroll.\r
+Horizontal scrolling.\r
 </p>\r
 </li>\r
 </ul>\r
@@ -1007,22 +1191,28 @@ the Free Software Foundation; either version 2 of the License, or
 <ul>\r
 <li>\r
 <p>\r
-Homepage: <a href="http://jonas.nitro.dk/tig">http://jonas.nitro.dk/tig</a>\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
+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>\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://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary">http://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary</a>\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
@@ -1060,7 +1250,7 @@ gitview(1)
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
-Last updated 14-Jun-2006 22:28:53 CEST\r
+Last updated 25-Sep-2006 01:14:32 CEST\r
 </div>\r
 </div>\r
 </body>\r