diff --git a/tigrc.5.txt b/tigrc.5.txt
index 3ead320ee54e3bc4d05f4526e1ea226cf22595f8..575164e96065515259b817026d12d45c984f5614 100644 (file)
--- a/tigrc.5.txt
+++ b/tigrc.5.txt
Examples:
--------------------------------------------------------------------------
-set show-author = yes # Show author?
+set show-author = abbreviated # Show abbreviated author names.
set show-date = relative # Show relative commit date.
set show-rev-graph = yes # Show revision graph?
set show-refs = yes # Show references?
The following variables can be set:
-'show-author' (bool)::
'show-rev-graph' (bool)::
'show-refs' (bool)::
- Whether to show author, revision graph, and references
- (branches, tags, and remotes) in the main view on start-up. Can all be
- toggled.
+ Whether to show revision graph, and references (branches, tags, and
+ remotes) in the main view on start-up. Can all be toggled.
-'show-date' (bool or "relative" or "short")::
+'show-author' (mixed) ["abbreviated" | "default" | bool]::
+
+ How to display author names. If set to "abbreviated" author initials
+ will be shown. Can be toggled.
+
+'show-date' (mixed) ["relative" | "short" | "default" | bool]::
Whether and how to show date. If set to "relative" a relative date will be
used, e.g. "2 minutes ago". If set to "short" no time information is
names that will be substituted before the command is run. Valid variable names
are:
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-Browsing state variables
-------------------------------------------------------------------------------
-%(head) The currently viewed 'head' ID. Defaults to HEAD
-%(commit) The currently selected commit ID.
-%(blob) The currently selected blob ID.
-%(directory) The current directory path in the tree view; \
- empty for the root directory.
-%(file) The currently selected file.
-%(ref) The reference given to blame or HEAD if undefined.
-------------------------------------------------------------------------------
+.Browsing state variables
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|%(head) |The currently viewed 'head' ID. Defaults to HEAD
+|%(commit) |The currently selected commit ID.
+|%(blob) |The currently selected blob ID.
+|%(branch) |The currently selected branch name.
+|%(directory) |The current directory path in the tree view;
+ empty for the root directory.
+|%(file) |The currently selected file.
+|%(ref) |The reference given to blame or HEAD if undefined.
+|=============================================================================
As an example, the following external command will save the current commit as
a patch file: "!git format-patch -1 %(commit)". If your external command
generic = > !git publish
--------------------------------------------------------------------------
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-View switching:
-------------------------------------------------------------------------------
-view-main Show main view
-view-diff Show diff view
-view-log Show log view
-view-tree Show tree view
-view-blob Show blob view
-view-blame Show blame view
-view-branch Show branch view
-view-status Show status view
-view-stage Show stage view
-view-pager Show pager view
-view-help Show help page
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-View manipulation:
-------------------------------------------------------------------------------
-enter Enter current line and scroll
-next Move to next
-previous Move to previous
-parent Move to parent
-view-next Move focus to next view
-refresh Reload and refresh view
-maximize Maximize the current view
-view-close Close the current view
-quit Close all views and quit
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-View specific actions:
-------------------------------------------------------------------------------
-status-update Update file status
-status-merge Resolve unmerged file
-stage-next Find next chunk to stage
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-Cursor navigation:
-------------------------------------------------------------------------------
-move-up Move cursor one line up
-move-down Move cursor one line down
-move-page-down Move cursor one page down
-move-page-up Move cursor one page up
-move-first-line Move cursor to first line
-move-last-line Move cursor to last line
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-Scrolling:
-------------------------------------------------------------------------------
-scroll-line-up Scroll one line up
-scroll-line-down Scroll one line down
-scroll-page-up Scroll one page up
-scroll-page-down Scroll one page down
-scroll-left Scroll one column left
-scroll-right Scroll one column right
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-Searching:
-------------------------------------------------------------------------------
-search Search the view
-search-back Search backwards in the view
-find-next Find next search match
-find-prev Find previous search match
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-Misc:
-------------------------------------------------------------------------------
-prompt Bring up the prompt
-screen-redraw Redraw the screen
-screen-resize Resize the screen
-show-version Show version information
-stop-loading Stop all loading views
-options Open options menu
-toggle-lineno Toggle line numbers
-toggle-date Toggle date display
-toggle-author Toggle author display
-toggle-rev-graph Toggle revision graph visualization
-toggle-refs Toggle reference display
-edit Open in editor
-none Do nothing
-------------------------------------------------------------------------------
+.View switching
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|view-main |Show main view
+|view-diff |Show diff view
+|view-log |Show log view
+|view-tree |Show tree view
+|view-blob |Show blob view
+|view-blame |Show blame view
+|view-branch |Show branch view
+|view-status |Show status view
+|view-stage |Show stage view
+|view-pager |Show pager view
+|view-help |Show help page
+|=============================================================================
+
+.View manipulation
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|enter |Enter current line and scroll
+|next |Move to next
+|previous |Move to previous
+|parent |Move to parent
+|view-next |Move focus to next view
+|refresh |Reload and refresh view
+|maximize |Maximize the current view
+|view-close |Close the current view
+|quit |Close all views and quit
+|=============================================================================
+
+.View specific actions
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|status-update |Update file status
+|status-merge |Resolve unmerged file
+|stage-next |Find next chunk to stage
+|=============================================================================
+
+.Cursor navigation
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|move-up |Move cursor one line up
+|move-down |Move cursor one line down
+|move-page-down |Move cursor one page down
+|move-page-up |Move cursor one page up
+|move-first-line |Move cursor to first line
+|move-last-line |Move cursor to last line
+|=============================================================================
+
+.Scrolling
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|scroll-line-up |Scroll one line up
+|scroll-line-down |Scroll one line down
+|scroll-page-up |Scroll one page up
+|scroll-page-down |Scroll one page down
+|scroll-left |Scroll one column left
+|scroll-right |Scroll one column right
+|=============================================================================
+
+.Searching
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|search |Search the view
+|search-back |Search backwards in the view
+|find-next |Find next search match
+|find-prev |Find previous search match
+|=============================================================================
+
+.Misc
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|prompt |Bring up the prompt
+|screen-redraw |Redraw the screen
+|screen-resize |Resize the screen
+|show-version |Show version information
+|stop-loading |Stop all loading views
+|options |Open options menu
+|toggle-lineno |Toggle line numbers
+|toggle-date |Toggle date display
+|toggle-author |Toggle author display
+|toggle-rev-graph |Toggle revision graph visualization
+|toggle-refs |Toggle reference display
+|edit |Open in editor
+|none |Do nothing
+|=============================================================================
Color command
that specify the use of the default terminal colors can be controlled by
setting the *default* color option.
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-General:
-------------------------------------------------------------------------------
-default Overwrite default terminal colors (see above).
-cursor The cursor line.
-status The status window showing info messages.
-title-focus The title window for the current view.
-title-blur The title window of any backgrounded view.
-delimiter Delimiter shown for truncated lines.
-line-number Line numbers.
-date The commit date.
-author The commit author.
-mode The file mode holding the permissions and type.
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-Main view colors:
-------------------------------------------------------------------------------
-main-revgraph The revision graph.
-main-commit The commit comment.
-main-head Label of the current branch.
-main-remote Label of a remote.
-main-tracked Label of the remote tracked by the current branch.
-main-tag Label of a signed tag.
-main-local-tag Label of a local tag.
-main-ref Label of any other reference.
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-Status view:
-------------------------------------------------------------------------------
-stat-head The "On branch"-line.
-stat-section Status section titles,
-stat-staged Status flag of staged files.
-stat-unstaged Status flag of unstaged files.
-stat-untracked Status flag of untracked files.
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-Blame view:
-------------------------------------------------------------------------------
-blame-id The commit ID.
-------------------------------------------------------------------------------
-
-ifdef::backend-xhtml11[]
-[frame="none"]
-`-----------------------`-----------------------------------------------------
-endif::backend-xhtml11[]
-Tree view:
-------------------------------------------------------------------------------
-tree-head The "Directory /"-line
-tree-dir The directory name.
-tree-file The file name.
-------------------------------------------------------------------------------
+.General
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|default |Overwrite default terminal colors (see above).
+|cursor |The cursor line.
+|status |The status window showing info messages.
+|title-focus |The title window for the current view.
+|title-blur |The title window of any backgrounded view.
+|delimiter |Delimiter shown for truncated lines.
+|line-number |Line numbers.
+|date |The commit date.
+|author |The commit author.
+|mode |The file mode holding the permissions and type.
+|=============================================================================
+
+.Main view colors
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|main-revgraph |The revision graph.
+|main-commit |The commit comment.
+|main-head |Label of the current branch.
+|main-remote |Label of a remote.
+|main-tracked |Label of the remote tracked by the current branch.
+|main-tag |Label of a signed tag.
+|main-local-tag |Label of a local tag.
+|main-ref |Label of any other reference.
+|=============================================================================
+
+.Status view
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|stat-head |The "On branch"-line.
+|stat-section |Status section titles,
+|stat-staged |Status flag of staged files.
+|stat-unstaged |Status flag of unstaged files.
+|stat-untracked |Status flag of untracked files.
+|=============================================================================
+
+.Blame view
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|blame-id |The commit ID.
+|=============================================================================
+
+.Tree view
+[frame="none",grid="none",cols="25<m,75<"]
+|=============================================================================
+|tree-head |The "Directory /"-line
+|tree-dir |The directory name.
+|tree-file |The file name.
+|=============================================================================
Highlighting
~~~~~~~~~~~~
COPYRIGHT
---------
-Copyright (c) 2006-2009 Jonas Fonseca <fonseca@diku.dk>
+Copyright (c) 2006-2010 Jonas Fonseca <fonseca@diku.dk>
Licensed under the terms of the GNU General Public License.
SEE ALSO
--------
-manpage:tig[1], git-config(1),
+manpage:tig[1], manpage:tigmanual[7], git-config(1),
and the http://jonas.nitro.dk/tig/manual.html[tig manual].