Sync docs

diff --git a/tig.1 b/tig.1
index 85964834274c10ba79483bc7e86e82181e56235d..1273b8dd08b119d919d53f3c912b8f04fe77c198 100644 (file)
--- a/tig.1
+++ b/tig.1
@@ -64,6 +64,10 @@ Set the number of spaces tabs should be expanded to\&.
 \-v, \-\-version
 Show version and exit\&.
 
 \-v, \-\-version
 Show version and exit\&.
 

+.TP
+\-h, \-\-help
+Show help message and exit\&.
+

 .TP
 \-\-
 End of tig(1) options\&. Useful when specifying command options for the main view\&. Example:
 .TP
 \-\-
 End of tig(1) options\&. Useful when specifying command options for the main view\&. Example:


@@ -185,6 +189,29 @@ The command used for the main view\&. Note, you must always specify the option:
 .SH "THE VIEWER"
 
 
 .SH "THE VIEWER"
 
 

+The display consists of a status window on the last line of the screen and one or more views\&. The default is to only show one view at the time but it is possible to split both the main and log view to also show the commit diff\&.
+
+
+If you are in the log view and press \fIEnter\fR when the current line is a commit line, such as:
+
+.nf
+commit 4d55caff4cc89335192f3e566004b4ceef572521
+.fi
+
+
+You will split the view so that the log view is displayed in the top window and the diff view in the bottom window\&. You can switch between the two views by pressing \fITab\fR\&. To maximize the log view again, simply press \fIl\fR\&.
+
+.SS "Current head and commit ID"
+
+
+The viewer keeps track of both what head and commit ID you are currently viewing\&. The commit ID will follow the cursor line and change everytime time you highlight a different commit\&. Whenever you reopen the diff view it will be reloaded, if the commit ID changed\&.
+
+
+The head ID is used when opening the main and log view to indicate from what revision to show history\&.
+
+.SS "Views"
+
+

 tig(1) presents various \fIviews\fR of a repository\&. Each view is based on output from an external command, most often \fIgit log\fR, \fIgit diff\fR, or \fIgit show\fR\&.
 
 .TP
 tig(1) presents various \fIviews\fR of a repository\&. Each view is based on output from an external command, most often \fIgit log\fR, \fIgit diff\fR, or \fIgit show\fR\&.
 
 .TP


@@ -207,6 +234,18 @@ Is used for displaying both input from stdin and output from git commands entere
 The help view
 Displays the information from the tig(1) man page\&. For the help view to work you need to have the tig(1) man page installed\&.
 
 The help view
 Displays the information from the tig(1) man page\&. For the help view to work you need to have the tig(1) man page installed\&.
 

+.SS "Title windows"
+
+
+Each view has a title window which shows the name of the view, current commit ID if available, and where the view is positioned:
+
+.nf
+[main] c622eefaa485995320bc743431bae0d497b1d875 \- commit 1 of 61 (1%)
+.fi
+
+
+By default, the title of the current view is highlighted using bold font\&.
+

 .SH "KEYS"
 
 
 .SH "KEYS"
 
 


@@ -234,38 +273,44 @@ Switch to pager view\&.
 h
 Show man page\&.
 
 h
 Show man page\&.
 

+.SS "View manipulation"
+

 .TP
 .TP

-Return
-If on a commit line show the commit diff\&. Additionally, if in main or log view this will split the view\&. To open the commit diff in full size view either use \fId\fR or press Return twice\&.
+q
+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 \fIQ\fR to quit all views at once\&.
+
+.TP
+Enter
+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\&.

 
 .TP
 Tab
 Switch to next view\&.
 
 
 .TP
 Tab
 Switch to next view\&.
 

-.SS "Cursor navigation"
-

 .TP
 Up
 .TP
 Up

-Move cursor one line up\&.
+This key is "context sensitive" and will move the cursor one line up\&. However, uf 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\&.

 
 .TP
 Down
 
 .TP
 Down

-Move cursor one line down\&.
+Similar to \fIUp\fR but will move down\&.

 
 

-.TP
-k
-Move cursor one line up and enter\&. When used in the main view this will always show the diff of the current commit in the split diff view\&.
+.SS "Cursor navigation"

 
 .TP
 j
 
 .TP
 j

-Move cursor one line down and enter\&.
+Move cursor one line up\&.

 
 .TP
 
 .TP

-PgUp
+k
+Move cursor one line down\&.
+
+.TP
+PgUp, b, \-

 Move cursor one page up\&.
 
 .TP
 Move cursor one page up\&.
 
 .TP

-PgDown
+PgDown, Space

 Move cursor one page down\&.
 
 .TP
 Move cursor one page down\&.
 
 .TP


@@ -297,8 +342,8 @@ Scroll view one page down\&.
 .SS "Misc"
 
 .TP
 .SS "Misc"
 
 .TP

-q
-Quit
+Q
+Quit\&.

 
 .TP
 r
 
 .TP
 r


@@ -338,7 +383,7 @@ You can tune the interaction with git by making use of the options explained in
 If you are interested only in those revisions that made changes to a specific file (or even several files) list the files like this:
 
 .nf
 If you are interested only in those revisions that made changes to a specific file (or even several files) list the files like this:
 
 .nf

-$ tig log Makefile
+$ tig log Makefile README

 .fi
 
 
 .fi
 
 


@@ -365,14 +410,14 @@ To speed up interaction with git, you can limit the amount of commits to show bo
 If you are only interested in changed that happened between two dates you can use:
 
 .nf
 If you are only interested in changed that happened between two dates you can use:
 
 .nf

-$ tig \-\- \-\-after=May\&.5th \-\-before=2006\-05\-16\&.15:44
+$ tig \-\- \-\-after="May 5th" \-\-before="2006\-05\-16 15:44"

 .fi
 
 .RS
 .Sh "Note"
 
 
 .fi
 
 .RS
 .Sh "Note"
 
 

-The dot ("\&.") is used as a separator instead of a space to avoid having to quote the option value\&. If you prefer use \-\-after="May 5th" instead of \-\-after="May 5th"\&.
+If you want to avoid having to quote dates containing spaces you can use "\&." instead, e\&.g\&. \-\-after=May\&.5th\&.

 
 .RE
 
 
 .RE
 


@@ -435,6 +480,9 @@ Known bugs and problems:
 
 .TP 3
 \(bu
 
 .TP 3
 \(bu

+In it's current state tig is pretty much UTF\-8 only\&.
+.TP
+\(bu

 If the screen width is very small the main view can draw outside the current view causing bad wrapping\&. Same goes for title and status windows\&.
 .LP
 
 If the screen width is very small the main view can draw outside the current view causing bad wrapping\&. Same goes for title and status windows\&.
 .LP
 

diff --git a/tig.1.html b/tig.1.html
index e1d0948cd6ef0ecf3a2f540f86bf6da36741ba8b..c40861648c0f60a5008095b60113b37abd3f7202 100644 (file)
--- a/tig.1.html
+++ b/tig.1.html
@@ -335,6 +335,14 @@ to colorize it.</p>
 </p>\r
 </dd>\r
 <dt>\r
 </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
 --\r
 </dt>\r
 <dd>\r


@@ -496,6 +504,27 @@ TIG_MAIN_CMD
 </div>\r
 <h2>The viewer</h2>\r
 <div class="sectionbody">\r
 </div>\r
 <h2>The viewer</h2>\r
 <div class="sectionbody">\r

+<p>The display consists of a status window on the last line of the screen and\r
+one or more views. The default is to only show one view at the time but it\r
+is possible to split both the main and log view to also show the commit\r
+diff.</p>\r
+<p>If you are in the log view and press <em>Enter</em> when the current line is a\r
+commit line, such as:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>commit 4d55caff4cc89335192f3e566004b4ceef572521</tt></pre>\r
+</div></div>\r
+<p>You will split the view so that the log view is displayed in the top window\r
+and the diff view in the bottom window. You can switch between the two\r
+views by pressing <em>Tab</em>. To maximize the log view again, simply press <em>l</em>.</p>\r
+<h3>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
+you highlight a different commit. Whenever you reopen the diff view it\r
+will be reloaded, if the commit ID changed.</p>\r
+<p>The head ID is used when opening the main and log view to indicate from\r
+what revision to show history.</p>\r
+<h3>Views</h3>\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
 <dl>\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
 <dl>\r


@@ -548,6 +577,14 @@ The help view
 </p>\r
 </dd>\r
 </dl>\r
 </p>\r
 </dd>\r
 </dl>\r

+<h3>Title windows</h3>\r
+<p>Each view has a title window which shows the name of the view, current\r
+commit ID if available, and where the view is positioned:</p>\r
+<div class="literalblock">\r
+<div class="content">\r
+<pre><tt>[main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)</tt></pre>\r
+</div></div>\r
+<p>By default, the title of the current view is highlighted using bold font.</p>\r

 </div>\r
 <h2>KEYS</h2>\r
 <div class="sectionbody">\r
 </div>\r
 <h2>KEYS</h2>\r
 <div class="sectionbody">\r


@@ -594,14 +631,28 @@ h
         Show man page.\r
 </p>\r
 </dd>\r
         Show man page.\r
 </p>\r
 </dd>\r

+</dl>\r
+<h3>View manipulation</h3>\r
+<dl>\r

 <dt>\r
 <dt>\r

-Return\r
+q\r

 </dt>\r
 <dd>\r
 <p>\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
+        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
 </p>\r
 </dd>\r
 <dt>\r


@@ -612,15 +663,16 @@ Tab
         Switch to next view.\r
 </p>\r
 </dd>\r
         Switch to next view.\r
 </p>\r
 </dd>\r

-</dl>\r
-<h3>Cursor navigation</h3>\r
-<dl>\r

 <dt>\r
 Up\r
 </dt>\r
 <dd>\r
 <p>\r
 <dt>\r
 Up\r
 </dt>\r
 <dd>\r
 <p>\r

-        Move cursor one line up.\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
 </p>\r
 </dd>\r
 <dt>\r


@@ -628,30 +680,37 @@ Down
 </dt>\r
 <dd>\r
 <p>\r
 </dt>\r
 <dd>\r
 <p>\r

-        Move cursor one line down.\r
+        Similar to <em>Up</em> but will move down.\r

 </p>\r
 </dd>\r
 </p>\r
 </dd>\r

+</dl>\r
+<h3>Cursor navigation</h3>\r
+<dl>\r

 <dt>\r
 <dt>\r

-k\r
+j\r

 </dt>\r
 <dd>\r
 <p>\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
+        Move cursor one line up.\r

 </p>\r
 </dd>\r
 <dt>\r
 </p>\r
 </dd>\r
 <dt>\r

-j\r
+k\r

 </dt>\r
 <dd>\r
 <p>\r
 </dt>\r
 <dd>\r
 <p>\r

-        Move cursor one line down and enter.\r
+        Move cursor one line down.\r

 </p>\r
 </dd>\r
 <dt>\r
 PgUp\r
 </dt>\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
 <dd>\r
 <p>\r
         Move cursor one page up.\r


@@ -660,6 +719,9 @@ PgUp
 <dt>\r
 PgDown\r
 </dt>\r
 <dt>\r
 PgDown\r
 </dt>\r

+<dt>\r
+Space\r
+</dt>\r

 <dd>\r
 <p>\r
         Move cursor one page down.\r
 <dd>\r
 <p>\r
         Move cursor one page down.\r


@@ -720,11 +782,11 @@ s
 <h3>Misc</h3>\r
 <dl>\r
 <dt>\r
 <h3>Misc</h3>\r
 <dl>\r
 <dt>\r

-q\r
+Q\r

 </dt>\r
 <dd>\r
 <p>\r
 </dt>\r
 <dd>\r
 <p>\r

-        Quit\r
+        Quit.\r

 </p>\r
 </dd>\r
 <dt>\r
 </p>\r
 </dd>\r
 <dt>\r


@@ -791,7 +853,7 @@ variables described in the  <a href="#view-commands">"View commands"</a> section
 specific file (or even several files) list the files like this:</p>\r
 <div class="literalblock">\r
 <div class="content">\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
+<pre><tt>$ tig log Makefile README</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
 </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


@@ -819,16 +881,15 @@ e.g. <tt>--since=1.month</tt> or limit by the number of commits using <tt>-n400<
 you can use:</p>\r
 <div class="literalblock">\r
 <div class="content">\r
 you can use:</p>\r
 <div class="literalblock">\r
 <div class="content">\r

-<pre><tt>$ tig -- --after=May.5th --before=2006-05-16.15:44</tt></pre>\r
+<pre><tt>$ tig -- --after="May 5th" --before="2006-05-16 15:44"</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
 </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">The dot (".") is used as a separator instead of a space to avoid\r
-having to quote the option value. If you prefer use <tt>--after="May 5th"</tt>\r
-instead of <tt>--after="May 5th"</tt>.</td>\r
+<td class="content">If you want to avoid having to quote dates containing spaces you\r
+can use "." instead, e.g. <tt>--after=May.5th</tt>.</td>\r

 </tr></table>\r
 </div>\r
 <h3>Limiting by commit ranges</h3>\r
 </tr></table>\r
 </div>\r
 <h3>Limiting by commit ranges</h3>\r


@@ -885,6 +946,11 @@ can be accomplished using:</p>
 <ul>\r
 <li>\r
 <p>\r
 <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
 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


@@ -927,7 +993,7 @@ gitview(1): git repository browser written using python/gtk.</div></div>
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r
 </div>\r
 <div id="footer">\r
 <div id="footer-text">\r

-Last updated 17-May-2006 18:10:38 CEST\r
+Last updated 21-May-2006 05:05:28 CEST\r

 </div>\r
 </div>\r
 </body>\r
 </div>\r
 </div>\r
 </body>\r

diff --git a/tig.1.txt b/tig.1.txt
index 1d2d1eb1b98d2e5607ee9b266a70670d0c8b08c6..7d92ed6ff17600514cd144c55f4ab19de28a75b2 100644 (file)
--- a/tig.1.txt
+++ b/tig.1.txt
@@ -46,6 +46,9 @@ OPTIONS
 -v, --version::
        Show version and exit.
 
 -v, --version::
        Show version and exit.
 

+-h, --help::
+       Show help message and exit.
+

 \--::
        End of tig(1) options. Useful when specifying command
        options for the main view. Example:
 \--::
        End of tig(1) options. Useful when specifying command
        options for the main view. Example:


@@ -153,7 +156,32 @@ TIG_MAIN_CMD::
 
 The viewer
 ----------
 
 The viewer
 ----------

+The display consists of a status window on the last line of the screen and
+one or more views. The default is to only show one view at the time but it
+is possible to split both the main and log view to also show the commit
+diff.
+
+If you are in the log view and press 'Enter' when the current line is a
+commit line, such as:
+
+       commit 4d55caff4cc89335192f3e566004b4ceef572521
+
+You will split the view so that the log view is displayed in the top window
+and the diff view in the bottom window. You can switch between the two
+views by pressing 'Tab'. To maximize the log view again, simply press 'l'.
+
+Current head and commit ID
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+The viewer keeps track of both what head and commit ID you are currently
+viewing. The commit ID will follow the cursor line and change everytime time
+you highlight a different commit. Whenever you reopen the diff view it
+will be reloaded, if the commit ID changed.
+
+The head ID is used when opening the main and log view to indicate from
+what revision to show history.

 
 

+Views
+~~~~~

 tig(1) presents various 'views' of a repository. Each view is based on output
 from an external command, most often 'git log', 'git diff', or 'git show'.
 
 tig(1) presents various 'views' of a repository. Each view is based on output
 from an external command, most often 'git log', 'git diff', or 'git show'.
 


@@ -180,6 +208,15 @@ The help view::
        Displays the information from the tig(1) man page. For the help view
        to work you need to have the tig(1) man page installed.
 
        Displays the information from the tig(1) man page. For the help view
        to work you need to have the tig(1) man page installed.
 

+Title windows
+~~~~~~~~~~~~~
+Each view has a title window which shows the name of the view, current
+commit ID if available, and where the view is positioned:
+
+       [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
+
+By default, the title of the current view is highlighted using bold font.
+

 KEYS
 ----
 Below the default key bindings are shown.
 KEYS
 ----
 Below the default key bindings are shown.


@@ -196,28 +233,41 @@ p::
        Switch to pager view.
 h::
        Show man page.
        Switch to pager view.
 h::
        Show man page.

-Return::
-       If on a commit line show the commit diff. Additionally, if in
-       main or log view this will split the view. To open the commit
-       diff in full size view either use 'd' or press Return twice.
+
+View manipulation
+~~~~~~~~~~~~~~~~~
+q::
+       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 'Q' to quit all views at once.
+Enter::
+       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.

 Tab::
        Switch to next view.
 Tab::
        Switch to next view.

+Up::
+       This key is "context sensitive" and will move the cursor one
+       line up. However, uf 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.
+Down::
+       Similar to 'Up' but will move down.

 
 Cursor navigation
 ~~~~~~~~~~~~~~~~~
 
 Cursor navigation
 ~~~~~~~~~~~~~~~~~

-Up::
+j::

        Move cursor one line up.
        Move cursor one line up.

-Down::
-       Move cursor one line down.

 k::
 k::

-       Move cursor one line up and enter. When used in the main view
-       this will always show the diff of the current commit in the
-       split diff view.
-j::
-       Move cursor one line down and enter.
+       Move cursor one line down.

 PgUp::
 PgUp::

+b::
+-::

        Move cursor one page up.
 PgDown::
        Move cursor one page up.
 PgDown::

+Space::

        Move cursor one page down.
 Home::
        Jump to first line.
        Move cursor one page down.
 Home::
        Jump to first line.


@@ -237,8 +287,8 @@ s::
 
 Misc
 ~~~~
 
 Misc
 ~~~~

-q::
-       Quit
+Q::
+       Quit.

 r::
        Redraw screen.
 z::
 r::
        Redraw screen.
 z::


@@ -273,7 +323,7 @@ Limit by path name
 If you are interested only in those revisions that made changes to a
 specific file (or even several files) list the files like this:
 
 If you are interested only in those revisions that made changes to a
 specific file (or even several files) list the files like this:
 

-       $ tig log Makefile
+       $ tig log Makefile README

 
 To avoid ambiguity with repository references such as tag name, be sure
 to separate file names from other git options using "\--". So if you
 
 To avoid ambiguity with repository references such as tag name, be sure
 to separate file names from other git options using "\--". So if you


@@ -295,11 +345,10 @@ e.g. `--since=1.month` or limit by the number of commits using `-n400`.
 If you are only interested in changed that happened between two dates
 you can use:
 
 If you are only interested in changed that happened between two dates
 you can use:
 

-       $ tig -- --after=May.5th --before=2006-05-16.15:44
+       $ tig -- --after="May 5th" --before="2006-05-16 15:44"

 
 

-NOTE: The dot (".") is used as a separator instead of a space to avoid
-having to quote the option value. If you prefer use `--after="May 5th"`
-instead of `--after="May 5th"`.
+NOTE: If you want to avoid having to quote dates containing spaces you
+can use "." instead, e.g. `--after=May.5th`.

 
 Limiting by commit ranges
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Limiting by commit ranges
 ~~~~~~~~~~~~~~~~~~~~~~~~~


@@ -354,6 +403,8 @@ BUGS
 ----
 Known bugs and problems:
 
 ----
 Known bugs and problems:
 

+- In it's current state tig is pretty much UTF-8 only.
+

 - If the screen width is very small the main view can draw
 outside the current view causing bad wrapping. Same goes
 for title and status windows.
 - If the screen width is very small the main view can draw
 outside the current view causing bad wrapping. Same goes
 for title and status windows.