<h2>SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<div class="content"><strong>color</strong> <em>fgcolor</em> <em>bgcolor</em> <em>[attributes]</em></div></div>\r
+<div class="content"><strong>set</strong> variable <strong>=</strong> value\r
+<strong>bind</strong> keymap key action\r
+<strong>color</strong> area fgcolor bgcolor [attributes]</div></div>\r
</div>\r
<h2>DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<p>You can permanently set an option by putting it in the <tt>~/.tigrc</tt> file.\r
-The file consists of a series of <em>commands</em>. Each\r
-line of the file may contain only one command.</p>\r
-<p>The hash mark (<em>#</em>), or semi-colon (<em>;</em>) is used as a <em>comment</em> character.\r
-All text after the comment character to the end of the line is ignored.\r
-You can use comments to annotate your initialization file.</p>\r
+<p>You can permanently set an option by putting it in the <tt>~/.tigrc</tt> file. The\r
+file consists of a series of <em>commands</em>. Each line of the file may contain\r
+only one command.</p>\r
+<p>The hash mark (<em>#</em>) is used as a <em>comment</em> character. All text after the\r
+comment character to the end of the line is ignored. You can use comments to\r
+annotate your initialization file.</p>\r
</div>\r
-<h2>Color options</h2>\r
+<h2>Set command</h2>\r
<div class="sectionbody">\r
-<p>Color options control highlighting and the user interface styles.\r
-If your terminal supports color, these commands can be used to assign\r
-foreground/backgound combinations to certain areas. Optionally, an\r
-attribute can be given as the last parameter. The syntax is:</p>\r
+<p>A few selective variables can be configured via the set command. The syntax\r
+is:</p>\r
+<div class="verseblock">\r
+<div class="content"> <strong>set</strong> variables <strong>=</strong> value</div></div>\r
+<p>Examples:</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt> set show-rev-graph = yes # Show revision graph?\r
+ set line-number-interval = 5 # Interval between line numbers\r
+ set tab-size = 8 # Number of spaces pr tab\r
+ set encoding = "UTF-8" # Commit encoding</tt></pre>\r
+</div></div>\r
+<p>The type of variables are either bool, int, and string.</p>\r
+<dl>\r
+<dt>\r
+Valid bool values\r
+</dt>\r
+<dd>\r
+<p>\r
+ To set a bool variable to true use either "1", "true", or "yes".\r
+ Any other value will set the variable to false.\r
+</p>\r
+</dd>\r
+<dt>\r
+Valid int values\r
+</dt>\r
+<dd>\r
+<p>\r
+ A non-negative integer.\r
+</p>\r
+</dd>\r
+<dt>\r
+Valid string values\r
+</dt>\r
+<dd>\r
+<p>\r
+ A string of characters. Optionally, use either ' or " as delimiters.\r
+</p>\r
+</dd>\r
+</dl>\r
+<h3>Variables</h3>\r
+<p>The following variables can be set:</p>\r
+<dl>\r
+<dt>\r
+<em>show-rev-graph</em> (bool)\r
+</dt>\r
+<dd>\r
+<p>\r
+ Show revision graph in the main view on startup. Can be toggled with\r
+ <em>g</em>.\r
+</p>\r
+</dd>\r
+<dt>\r
+<em>line-number-interval</em> (int)\r
+</dt>\r
+<dd>\r
+<p>\r
+ Interval between line numbers. Note, you have to toggle on line\r
+ numbering with <em>n</em> or the <tt>-n</tt> command line option. The default is to\r
+ number every line.\r
+</p>\r
+</dd>\r
+<dt>\r
+<em>tab-size</em> (int)\r
+</dt>\r
+<dd>\r
+<p>\r
+ Number of spaces per tab. The default is 8 spaces.\r
+</p>\r
+</dd>\r
+<dt>\r
+<em>commit-encoding</em> (string)\r
+</dt>\r
+<dd>\r
+<p>\r
+ The encoding used for commits. The default is UTF-8. Not this option\r
+ is shadowed by the "i18n.commitencoding" option in <tt>.git/config</tt>.\r
+</p>\r
+</dd>\r
+</dl>\r
+</div>\r
+<h2>Bind command</h2>\r
+<div class="sectionbody">\r
+<p>Using bind commands keys can be mapped to an action when pressed in a given\r
+key map. The syntax is:</p>\r
+<div class="verseblock">\r
+<div class="content"> <strong>bind</strong> <em>keymap</em> <em>key</em> <em>action</em></div></div>\r
+<p>Examples:</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt> # A few keybindings\r
+ bind main w scroll-line-up\r
+ bind main s scroll-line-down\r
+ bind main space enter\r
+ bind diff a previous\r
+ bind diff d next\r
+ bind diff b move-first-line</tt></pre>\r
+</div></div>\r
+<p>Keys are mapped by first searching the keybindings for the current view, then\r
+the keybindings for the <strong>generic</strong> keymap, and last the default keybindings.\r
+Thus, the view keybindings shaddow the generic keybindings which shaddow the\r
+built-in keybindings.</p>\r
+<dl>\r
+<dt>\r
+Keymaps\r
+</dt>\r
+<dd>\r
+<p>\r
+Valid keymaps are: <strong>main</strong>, <strong>diff</strong>, <strong>log</strong>, <strong>help</strong>, <strong>pager</strong>, and <strong>generic</strong>. Use\r
+<strong>generic</strong> to set key mapping in all keymaps.\r
+</p>\r
+</dd>\r
+<dt>\r
+Key values\r
+</dt>\r
+<dd>\r
+<p>\r
+Key values should never be quoted. Use either the ASCII value or one of the\r
+following symbolic key names. Symbolic key names are case insensitive, Use\r
+<strong>Hash</strong> to bind to the <tt>#</tt> key, since the hash mark is used as a comment\r
+character.\r
+</p>\r
+<p><strong>Enter</strong>, <strong>Space</strong>, <strong>Backspace</strong>, <strong>Tab</strong>, <strong>Escape</strong>, <strong>Left</strong>, <strong>Right</strong>, <strong>Up</strong>, <strong>Down</strong>,\r
+<strong>Insert</strong>, <strong>Delete</strong>, <strong>Hash</strong>, <strong>Home</strong>, <strong>End</strong>, <strong>PageUp</strong>, <strong>PageDown</strong>, <strong>F1</strong>, <strong>F2</strong>, <strong>F3</strong>,\r
+<strong>F4</strong>, <strong>F5</strong>, <strong>F6</strong>, <strong>F7</strong>, <strong>F8</strong>, <strong>F9</strong>, <strong>F10</strong>, <strong>F11</strong>, <strong>F12</strong>.</p>\r
+</dd>\r
+<dt>\r
+Action names\r
+</dt>\r
+<dd>\r
+<p>\r
+Valid action names are described below. Note, all names are\r
+case-insensitive, and you may use <em>-</em>, <em>_</em>, and <em>.</em> interchangeably,\r
+e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.\r
+</p>\r
+</dd>\r
+</dl>\r
+<h3>Actions</h3>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="void"\r
+cellspacing="0" cellpadding="4">\r
+<col width="274" />\r
+<col width="617" />\r
+<thead>\r
+ <tr>\r
+ <th align="left">\r
+ View switching::\r
+ </th>\r
+ <th align="left">\r
+ \r
+ </th>\r
+ </tr>\r
+</thead>\r
+<tbody valign="top">\r
+ <tr>\r
+ <td align="left">\r
+ view-main\r
+ </td>\r
+ <td align="left">\r
+ Show main view\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ view-diff\r
+ </td>\r
+ <td align="left">\r
+ Show diff view\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ view-log\r
+ </td>\r
+ <td align="left">\r
+ Show log view\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ view-help\r
+ </td>\r
+ <td align="left">\r
+ Show help page\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ view-pager\r
+ </td>\r
+ <td align="left">\r
+ Show pager view\r
+ </td>\r
+ </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="void"\r
+cellspacing="0" cellpadding="4">\r
+<col width="274" />\r
+<col width="617" />\r
+<thead>\r
+ <tr>\r
+ <th align="left">\r
+ View manipulation::\r
+ </th>\r
+ <th align="left">\r
+ \r
+ </th>\r
+ </tr>\r
+</thead>\r
+<tbody valign="top">\r
+ <tr>\r
+ <td align="left">\r
+ enter\r
+ </td>\r
+ <td align="left">\r
+ Enter current line and scroll\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ next\r
+ </td>\r
+ <td align="left">\r
+ Move to next\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ previous\r
+ </td>\r
+ <td align="left">\r
+ Move to previous\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ view-next\r
+ </td>\r
+ <td align="left">\r
+ Move focus to next view\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ view-close\r
+ </td>\r
+ <td align="left">\r
+ Close the current view\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ quit\r
+ </td>\r
+ <td align="left">\r
+ Close all views and quit\r
+ </td>\r
+ </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="void"\r
+cellspacing="0" cellpadding="4">\r
+<col width="274" />\r
+<col width="617" />\r
+<thead>\r
+ <tr>\r
+ <th align="left">\r
+ Cursor navigation::\r
+ </th>\r
+ <th align="left">\r
+ \r
+ </th>\r
+ </tr>\r
+</thead>\r
+<tbody valign="top">\r
+ <tr>\r
+ <td align="left">\r
+ move-up\r
+ </td>\r
+ <td align="left">\r
+ Move cursor one line up\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ move-down\r
+ </td>\r
+ <td align="left">\r
+ Move cursor one line down\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ move-page_down\r
+ </td>\r
+ <td align="left">\r
+ Move cursor one page down\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ move-page_up\r
+ </td>\r
+ <td align="left">\r
+ Move cursor one page up\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ move-first_line\r
+ </td>\r
+ <td align="left">\r
+ Move cursor to first line\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ move-last_line\r
+ </td>\r
+ <td align="left">\r
+ Move cursor to last line\r
+ </td>\r
+ </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="void"\r
+cellspacing="0" cellpadding="4">\r
+<col width="274" />\r
+<col width="617" />\r
+<thead>\r
+ <tr>\r
+ <th align="left">\r
+ Scrolling::\r
+ </th>\r
+ <th align="left">\r
+ \r
+ </th>\r
+ </tr>\r
+</thead>\r
+<tbody valign="top">\r
+ <tr>\r
+ <td align="left">\r
+ scroll-line_up\r
+ </td>\r
+ <td align="left">\r
+ Scroll one line up\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ scroll-line_down\r
+ </td>\r
+ <td align="left">\r
+ Scroll one line down\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ scroll-page_up\r
+ </td>\r
+ <td align="left">\r
+ Scroll one page up\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ scroll-page_down\r
+ </td>\r
+ <td align="left">\r
+ Scroll one page down\r
+ </td>\r
+ </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+<div class="tableblock">\r
+<table rules="none"\r
+frame="void"\r
+cellspacing="0" cellpadding="4">\r
+<col width="274" />\r
+<col width="617" />\r
+<thead>\r
+ <tr>\r
+ <th align="left">\r
+ Misc::\r
+ </th>\r
+ <th align="left">\r
+ \r
+ </th>\r
+ </tr>\r
+</thead>\r
+<tbody valign="top">\r
+ <tr>\r
+ <td align="left">\r
+ prompt\r
+ </td>\r
+ <td align="left">\r
+ Bring up the prompt\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ screen-update\r
+ </td>\r
+ <td align="left">\r
+ Update the screen\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ screen-redraw\r
+ </td>\r
+ <td align="left">\r
+ Redraw the screen\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ screen-resize\r
+ </td>\r
+ <td align="left">\r
+ Resize the screen\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ show-version\r
+ </td>\r
+ <td align="left">\r
+ Show version information\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ stop-loading\r
+ </td>\r
+ <td align="left">\r
+ Stop all loading views\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ toggle-lineno\r
+ </td>\r
+ <td align="left">\r
+ Toggle line numbers\r
+ </td>\r
+ </tr>\r
+ <tr>\r
+ <td align="left">\r
+ toggle-rev_graph\r
+ </td>\r
+ <td align="left">\r
+ Toggle revision graph visualization\r
+ </td>\r
+ </tr>\r
+</tbody>\r
+</table>\r
+</div>\r
+</div>\r
+<h2>Color command</h2>\r
+<div class="sectionbody">\r
+<p>Color commands control highlighting and the user interface styles. If your\r
+terminal supports color, these commands can be used to assign foreground and\r
+backgound combinations to certain areas. Optionally, an attribute can be given\r
+as the last parameter. The syntax is:</p>\r
<div class="verseblock">\r
<div class="content"> <strong>color</strong> <em>area</em> <em>fgcolor</em> <em>bgcolor</em> <em>[attributes]</em></div></div>\r
-<p>Valid colors include: <strong>white</strong>, <strong>black</strong>, <strong>green</strong>, <strong>magenta</strong>, <strong>blue</strong>, <strong>cyan</strong>,\r
-<strong>yellow</strong>, <strong>red</strong>, <strong>default</strong>. Use <strong>default</strong> to refer to the default terminal\r
-colors.</p>\r
-<p>Valid attributes include: <strong>normal</strong>, <strong>blink</strong>, <strong>bold</strong>, <strong>dim</strong>, <strong>reverse</strong>, <strong>standout</strong>,\r
-and <strong>underline</strong>. Note, not all attributes may be supported by the terminal.</p>\r
-<p>Valid area names are described below. Note, all names are case-insensitive,\r
-and you may use <em>-</em>, <em>_</em>, and <em>.</em> interchangeably. So "Diff-Header",\r
-"DIFF_HEADER", and "diff.header" are the same.</p>\r
-<h3>Diff markup</h3>\r
-<p>Options concerning diff start, chunks and lines added and deleted.</p>\r
+<p>Examples:</p>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt> # Diff colors\r
+ color diff-header yellow default\r
+ color diff-index blue default\r
+ color diff-chunk magenta default\r
+ # A strange looking cursor line\r
+ color cursor red default underline\r
+ # UI colors\r
+ color title-blur white blue\r
+ color title-focus white blue bold</tt></pre>\r
+</div></div>\r
+<dl>\r
+<dt>\r
+Area names\r
+</dt>\r
+<dd>\r
+<p>\r
+ Valid area names are described below. Note, all names are\r
+ case-insensitive, and you may use <em>-</em>, <em>_</em>, and <em>.</em> interchangeably,\r
+ e.g. "Diff-Header", "DIFF_HEADER", and "diff.header" are the same.\r
+</p>\r
+</dd>\r
+<dt>\r
+Color names\r
+</dt>\r
+<dd>\r
+<p>\r
+ Valid colors include: <strong>white</strong>, <strong>black</strong>, <strong>green</strong>, <strong>magenta</strong>, <strong>blue</strong>,\r
+ <strong>cyan</strong>, <strong>yellow</strong>, <strong>red</strong>, <strong>default</strong>. Use <strong>default</strong> to refer to the\r
+ default terminal colors.\r
+</p>\r
+</dd>\r
+<dt>\r
+Attribute names\r
+</dt>\r
+<dd>\r
+<p>\r
+ Valid attributes include: <strong>normal</strong>, <strong>blink</strong>, <strong>bold</strong>, <strong>dim</strong>, <strong>reverse</strong>,\r
+ <strong>standout</strong>, and <strong>underline</strong>. Note, not all attributes may be supported\r
+ by the terminal.\r
+</p>\r
+</dd>\r
+</dl>\r
+<h3>UI colors</h3>\r
+<dl>\r
+<dt>\r
+Status window colors\r
+</dt>\r
+<dd>\r
+<p>\r
+Appearance of the bottom window showing info messages.\r
+</p>\r
+<p><strong>status</strong></p>\r
+</dd>\r
+<dt>\r
+Title window colors\r
+</dt>\r
+<dd>\r
+<p>\r
+Appearence of the title windows when they are attached\r
+to any backgrounded windows and the current window.\r
+</p>\r
+<p><strong>title-blur</strong>, <strong>title-focus</strong></p>\r
+</dd>\r
+<dt>\r
+Cursor line colors\r
+</dt>\r
+<dd>\r
+<p>\r
+<strong>cursor</strong>\r
+</p>\r
+</dd>\r
+<dt>\r
+Main view specific\r
+</dt>\r
+<dd>\r
+<p>\r
+Appearance of the various columns in the main view, including the <em>~</em> used for\r
+delimiting long author names and labels for tag and branch references.\r
+</p>\r
+<p><strong>main-date</strong>, <strong>main-author</strong>, <strong>main-commit</strong>, <strong>main-delim</strong>, <strong>main-tag</strong>,\r
+<strong>main-ref</strong></p>\r
+</dd>\r
+</dl>\r
+<h3>Highlighting</h3>\r
+<p>The colors and attributes for text that is not highlighted can be controlled\r
+by changing the <strong>default</strong> color option.</p>\r
+<dl>\r
+<dt>\r
+Diff markup\r
+</dt>\r
+<dd>\r
+<p>\r
+Options concerning diff start, chunks and lines added and deleted.\r
+</p>\r
<p><strong>diff-header</strong>, <strong>diff-chunk</strong>, <strong>diff-add</strong>, <strong>diff-del</strong></p>\r
-<h3>Enhanced git diff markup</h3>\r
-<p>Extra diff information emitted by the git diff machinery, such as mode\r
-changes, rename detection, and similarity.</p>\r
+</dd>\r
+<dt>\r
+Enhanced git diff markup\r
+</dt>\r
+<dd>\r
+<p>\r
+Extra diff information emitted by the git diff machinery, such as mode\r
+changes, rename detection, and similarity.\r
+</p>\r
<p><strong>diff-oldmode</strong>, <strong>diff-newmode</strong>, <strong>diff-copy-from</strong>, <strong>diff-copy-to</strong>,\r
<strong>diff-rename-from</strong>, <strong>diff-rename-to</strong>, <strong>diff-similarity</strong> <strong>diff-dissimilarity</strong>\r
<strong>diff-tree</strong>, <strong>diff-index</strong></p>\r
-<h3>Pretty print commit headers</h3>\r
-<p>Commit diffs and the revision logs are usually formatted using pretty\r
-printed headers , unless <tt>--pretty=raw</tt> was given. This includes lines,\r
-such as merge info, commit ID, and author and comitter date.</p>\r
+</dd>\r
+<dt>\r
+Pretty print commit headers\r
+</dt>\r
+<dd>\r
+<p>\r
+Commit diffs and the revision logs are usually formatted using pretty printed\r
+headers , unless <tt>--pretty=raw</tt> was given. This includes lines, such as merge\r
+info, commit ID, and author and comitter date.\r
+</p>\r
<p><strong>pp-author</strong>, <strong>pp-commit</strong>, <strong>pp-merge</strong>, <strong>pp-date</strong>, <strong>pp-adate</strong>, <strong>pp-cdate</strong></p>\r
-<h3>Raw commit header</h3>\r
-<p>Usually shown when <tt>--pretty=raw</tt> is given, however <em>commit</em> is pretty\r
-much omnipresent.</p>\r
+</dd>\r
+<dt>\r
+Raw commit header\r
+</dt>\r
+<dd>\r
+<p>\r
+Usually shown when <tt>--pretty=raw</tt> is given, however <em>commit</em> is pretty much\r
+omnipresent.\r
+</p>\r
<p><strong>commit</strong>, <strong>parent</strong>, <strong>tree</strong>, <strong>author</strong>, <strong>committer</strong></p>\r
-<h3>Commit message</h3>\r
-<p>For now only <tt>Signed-off-by lines</tt> are colorized.</p>\r
+</dd>\r
+<dt>\r
+Commit message\r
+</dt>\r
+<dd>\r
+<p>\r
+For now only <tt>Signed-off-by</tt> lines are colorized.\r
+</p>\r
<p><strong>signoff</strong></p>\r
-<h3>UI colors</h3>\r
-<p>Colors for text not matching any of the above: <strong>default</strong></p>\r
-<p>Status window colors: <strong>status</strong></p>\r
-<p>Title window colors: <strong>title-blur</strong>, <strong>title-focus</strong></p>\r
-<p>Cursor line colors: <strong>cursor</strong></p>\r
-<p>Main view specific: <strong>main-date</strong>, <strong>main-author</strong>, <strong>main-commit</strong>, <strong>main-delim</strong>,\r
-<strong>main-tag</strong>, <strong>main-ref</strong></p>\r
+</dd>\r
+</dl>\r
</div>\r
-<h2>EXAMPLES</h2>\r
+<h2>COPYRIGHT</h2>\r
<div class="sectionbody">\r
-<p>Some sample options:</p>\r
-<div class="exampleblock">\r
-<div class="exampleblock-content">\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><tt># Diff colors\r
-color diff-header yellow default\r
-color diff-index blue default\r
-color diff-chunk magenta default\r
-# UI colors\r
-color title-blur white blue\r
-color title-focus white blue bold</tt></pre>\r
-</div></div>\r
-</div></div>\r
+<p>Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk></p>\r
+<p>Licensed under the terms of the GNU General Public License.</p>\r
</div>\r
<h2>SEE ALSO</h2>\r
<div class="sectionbody">\r
-<p>tig(1)</p>\r
+<p><a href="tig.1.html">tig(1)</a> and the <a href="http://jonas.nitro.dk/tig/tig.html">tig manual</a>.</p>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
-Last updated 29-May-2006 21:46:30 CEST\r
+Last updated 14-Jun-2006 22:28:50 CEST\r
</div>\r
</div>\r
</body>\r
~mdw / tig / blobdiff