\-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:
.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
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"
h
Show man page\&.
+.SS "View manipulation"
+
.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\&.
-.SS "Cursor navigation"
-
.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
-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
-Move cursor one line down and enter\&.
+Move cursor one line up\&.
.TP
-PgUp
+k
+Move cursor one line down\&.
+
+.TP
+PgUp, b, \-
Move cursor one page up\&.
.TP
-PgDown
+PgDown, Space
Move cursor one page down\&.
.TP
.SS "Misc"
.TP
-q
-Quit
+Q
+Quit\&.
.TP
r
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
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"
-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
.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
</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
</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>\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
Show man page.\r
</p>\r
</dd>\r
+</dl>\r
+<h3>View manipulation</h3>\r
+<dl>\r
<dt>\r
-Return\r
+q\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
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
- 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
</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
+</dl>\r
+<h3>Cursor navigation</h3>\r
+<dl>\r
<dt>\r
-k\r
+j\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
-j\r
+k\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
+<dt>\r
+b\r
+</dt>\r
+<dt>\r
+-\r
+</dt>\r
<dd>\r
<p>\r
Move cursor one page up.\r
<dt>\r
PgDown\r
</dt>\r
+<dt>\r
+Space\r
+</dt>\r
<dd>\r
<p>\r
Move cursor one page down.\r
<h3>Misc</h3>\r
<dl>\r
<dt>\r
-q\r
+Q\r
</dt>\r
<dd>\r
<p>\r
- Quit\r
+ Quit.\r
</p>\r
</dd>\r
<dt>\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
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
-<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
<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
</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
-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:
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'.
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.
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.
+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
~~~~~~~~~~~~~~~~~
-Up::
+j::
Move cursor one line up.
-Down::
- Move cursor one line down.
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::
+b::
+-::
Move cursor one page up.
PgDown::
+Space::
Move cursor one page down.
Home::
Jump to first line.
Misc
~~~~
-q::
- Quit
+Q::
+ Quit.
r::
Redraw screen.
z::
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
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
~~~~~~~~~~~~~~~~~~~~~~~~~
----
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.
~mdw / tig / commitdiff