X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=tigrc.5.txt;h=1464492c17fc4ca293f09811c7e387ea99b1ad04;hb=cbc5ebaaf7f082f334d06d770efddd37dea91e7f;hp=711c6a48e91632bf4294c1ab830e8173675e8571;hpb=fa41280ad285af9c866c49f8db6e60817729d912;p=tig.git diff --git a/tigrc.5.txt b/tigrc.5.txt index 711c6a4..1464492 100644 --- a/tigrc.5.txt +++ b/tigrc.5.txt @@ -41,7 +41,7 @@ is: 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? @@ -49,6 +49,7 @@ set show-line-numbers = no # Show line numbers? set line-number-interval = 5 # Interval between line numbers set commit-encoding = "UTF-8" # Commit encoding set horizontal-scroll = 33% # Scroll 33% of the view width +set blame-options = -C -C -C # Blame lines from other files -------------------------------------------------------------------------- Or in the git configuration files: @@ -86,28 +87,26 @@ Variables The following variables can be set: -'show-author' (bool):: -'show-rev-graph' (bool):: -'show-refs' (bool):: +'author-width' (int):: - Whether to show author, revision graph, and references - (branches, tags, and remotes) in the main view on start-up. Can all be - toggled. + Width of the author column. When set to 5 or below, the author name + will be abbreviated to the author's initials. -'show-date' (bool or "relative" or "short"):: +'blame-options' (string):: - 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 - shown. Can be toggled. + A space separated string of extra blame options. Can be used for + telling git-blame(1) how to detect the origin of lines. The value + is ignored when tig is started in blame mode and given blame options + on the command line. -'author-width' (int):: +'commit-encoding' (string):: - Width of the author column. When set to 5 or below, the author name - will be abbreviated to the author's initials. + The encoding used for commits. The default is UTF-8. Note this option + is shadowed by the "i18n.commitencoding" option in `.git/config`. -'line-graphics' (bool):: +'line-graphics' (mixed) [ "ascii" | "default" | "utf-8" | bool]:: - Whether to use graphic characters for line drawing. + What type of character graphics for line drawing. 'line-number-interval' (int):: @@ -115,10 +114,6 @@ The following variables can be set: numbering with 'n' or the `-n` command line option. The default is to number every line. -'tab-size' (int):: - - Number of spaces per tab. The default is 8 spaces. - 'horizontal-scroll' (mixed):: Interval to scroll horizontally in each step. Can be specified either @@ -127,6 +122,27 @@ The following variables can be set: always ensured that at least one column is scrolled. The default is to scroll '50%' of the view width. +'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" | "local" | 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 + shown. If set to "local", localtime(3) is used. Can be toggled. + +'show-refs' (bool):: + + Whether to show references (branches, tags, and remotes) in the main + view on start-up. Can be toggled. + +'show-rev-graph' (bool):: + + Whether to show revision graph in the main view on start-up. + Can be toggled. See also line-graphics options. + 'split-view-height' (mixed):: Height of the lower view in a split view. Can be specified either as @@ -135,10 +151,14 @@ The following variables can be set: smaller of the views is at least four rows high. The default is a view height of '66%'. -'commit-encoding' (string):: +'status-untracked-dirs' (bool):: - The encoding used for commits. The default is UTF-8. Not this option - is shadowed by the "i18n.commitencoding" option in `.git/config`. + Show untracked directories contents in the status view (analog to + `git ls-files --directory` option. On by default. + +'tab-size' (int):: + + Number of spaces per tab. The default is 8 spaces. Bind command ------------ @@ -219,10 +239,14 @@ are: |%(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. +|%(revargs) |The revision arguments passed on the command line. +|%(fileargs) |The file arguments passed on the command line. +|%(diffargs) |The diff options passed on the command line. |============================================================================= As an example, the following external command will save the current commit as @@ -297,6 +321,7 @@ put in either the .gitconfig or .git/config file: |scroll-line-down |Scroll one line down |scroll-page-up |Scroll one page up |scroll-page-down |Scroll one page down +|scroll-first-col |Scroll to the first column |scroll-left |Scroll one column left |scroll-right |Scroll one column right |============================================================================= @@ -323,6 +348,7 @@ put in either the .gitconfig or .git/config file: |toggle-date |Toggle date display |toggle-author |Toggle author display |toggle-rev-graph |Toggle revision graph visualization +|toggle-graphic |Toggle (line) graphics mode |toggle-refs |Toggle reference display |edit |Open in editor |none |Do nothing @@ -483,9 +509,9 @@ omnipresent. Commit message:: -For now only `Signed-off-by` and `Acked-by` lines are colorized. +`Signed-off-by`, `Acked-by`, `Reviewed-by` and `Tested-by` lines are colorized. -*signoff*, *acked* +*signoff*, *acked*, *reviewed*, *tested* Tree markup:: @@ -497,11 +523,11 @@ Colors for information of the tree view. COPYRIGHT --------- -Copyright (c) 2006-2009 Jonas Fonseca +Copyright (c) 2006-2010 Jonas Fonseca 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].