X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=tigrc.5.txt;h=1120a8642b6c817f833db9ef91f258729fdb5b8a;hb=c147a4d920aa68dd292b7d7d78a4b341910851e2;hp=bfb122396b29ea2a3d9a2086ac3daf3d05d52bf2;hpb=9eb14b72b27aedbd14b99332b22bb48651812204;p=tig.git diff --git a/tigrc.5.txt b/tigrc.5.txt index bfb1223..1120a86 100644 --- a/tigrc.5.txt +++ b/tigrc.5.txt @@ -10,9 +10,9 @@ SYNOPSIS -------- [verse] ............................................................................. -*set* variable *=* value -*bind* keymap key action -*color* area fgcolor bgcolor [attributes] +*set* 'variable' *=* 'value' +*bind* 'keymap' 'key' 'action' +*color* 'area' 'fgcolor' 'bgcolor' '[attributes]' ............................................................................. @@ -36,16 +36,22 @@ is: [verse] .............................................................................. - *set* variables *=* value +*set* variables *=* value .............................................................................. Examples: -------------------------------------------------------------------------- - set show-rev-graph = yes # Show revision graph? - set line-number-interval = 5 # Interval between line numbers - set tab-size = 8 # Number of spaces pr tab - set encoding = "UTF-8" # Commit encoding +set show-author = yes # Show author? +set show-date = yes # Show commit date? +set show-rev-graph = yes # Show revision graph? +set show-refs = yes # Show references? +set show-line-numbers = no # Show line numbers? +set author-width = 10 # Set width of the author column +set line-graphics = no # Disable graphics characters +set line-number-interval = 5 # Interval between line numbers +set tab-size = 8 # Number of spaces per tab +set encoding = "UTF-8" # Commit encoding -------------------------------------------------------------------------- The type of variables are either bool, int, and string. @@ -68,10 +74,23 @@ Variables The following variables can be set: +'show-author' (bool):: +'show-date' (bool):: 'show-rev-graph' (bool):: +'show-refs' (bool):: - Show revision graph in the main view on start-up. Can be toggled with - 'g'. + Whether to show author, date, revision graph, and references + (branches, tags, and remotes) in the main view on start-up. Can all be + toggled. + +'author-width' (int):: + + Width of the author column. When set to 5 or below, the author name + will be abbreviated to the author's initials. + +'line-graphics' (bool):: + + Whether to use graphic characters for line drawing. 'line-number-interval' (int):: @@ -97,25 +116,25 @@ key map. The syntax is: [verse] .............................................................................. - *bind* 'keymap' 'key' 'action' +*bind* 'keymap' 'key' 'action' .............................................................................. Examples: -------------------------------------------------------------------------- - # A few keybindings - bind main w scroll-line-up - bind main s scroll-line-down - bind main space enter - bind diff a previous - bind diff d next - bind diff b move-first-line - # 'unbind' the default quit key binding - bind main Q none - # An external command to update from upstream - bind generic F !git fetch - # Cherry-pick current commit unto current branch - bind generic C !git cherry-pick %(commit) +# A few keybindings +bind main w scroll-line-up +bind main s scroll-line-down +bind main space enter +bind diff a previous +bind diff d next +bind diff b move-first-line +# 'unbind' the default quit key binding +bind main Q none +# An external command to update from upstream +bind generic F !git fetch +# Cherry-pick current commit onto current branch +bind generic C !git cherry-pick %(commit) -------------------------------------------------------------------------- Keys are mapped by first searching the keybindings for the current view, then @@ -155,10 +174,25 @@ Actions Apart from the action names listed below, all actions starting with a '!' will be available as an external command. External commands can contain variable names that will be substituted before the command is run. Valid variable names -are "%(head)", "%(commit)", and "%(blob)". +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. +------------------------------------------------------------------------------ As an example, the following external command will save the current commit as -a patch file: "!git format-patch %(commit)^..%(commit)". +a patch file: "!git format-patch -1 %(commit)". ifdef::backend-xhtml11[] [frame="none"] @@ -171,6 +205,7 @@ 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-status Show status view view-stage Show stage view view-pager Show pager view @@ -186,12 +221,25 @@ 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"] `-----------------------`----------------------------------------------------- @@ -236,18 +284,18 @@ ifdef::backend-xhtml11[] endif::backend-xhtml11[] Misc: ------------------------------------------------------------------------------ -none Do nothing 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 toggle-lineno Toggle line numbers +toggle-date Toggle date display +toggle-author Toggle author display toggle-rev-graph Toggle revision graph visualization -status-update Update file status -status-merge Resolve unmerged file +toggle-refs Toggle reference display edit Open in editor -cherry-pick Cherry-pick commit to current branch +none Do nothing ------------------------------------------------------------------------------ @@ -256,26 +304,28 @@ Color command Color commands control highlighting and the user interface styles. If your terminal supports color, these commands can be used to assign foreground and -background combinations to certain areas. Optionally, an attribute can be given -as the last parameter. The syntax is: +background combinations to certain areas. Optionally, an attribute can be +given as the last parameter. The syntax is: [verse] .............................................................................. - *color* 'area' 'fgcolor' 'bgcolor' '[attributes]' +*color* 'area' 'fgcolor' 'bgcolor' '[attributes]' .............................................................................. Examples: ------------------------------------------------------------------------------ - # Diff colors - color diff-header yellow default - color diff-index blue default - color diff-chunk magenta default - # A strange looking cursor line - color cursor red default underline - # UI colors - color title-blur white blue - color title-focus white blue bold +# Overwrite the default terminal colors to white on black. +color default white black +# Diff colors +color diff-header yellow default +color diff-index blue default +color diff-chunk magenta default +# A strange looking cursor line +color cursor red default underline +# UI colors +color title-blur white blue +color title-focus white blue bold ------------------------------------------------------------------------------ Area names:: @@ -288,7 +338,8 @@ Color names:: Valid colors include: *white*, *black*, *green*, *magenta*, *blue*, *cyan*, *yellow*, *red*, *default*. Use *default* to refer to the - default terminal colors. + default terminal colors. This is recommended for background colors + if you are using a terminal with a transparent background. Attribute names:: @@ -296,45 +347,71 @@ Attribute names:: *standout*, and *underline*. Note, not all attributes may be supported by the terminal. - UI colors ~~~~~~~~~ --- - -Status window colors:: - -Appearance of the bottom window showing info messages. - -*status* - -Title window colors:: - -Appearance of the title windows when they are attached -to any backgrounded windows and the current window. - -*title-blur*, *title-focus* +The colors and attributes to be used for the text that is not highlighted or +that specify the use of the default terminal colors can be controlled by +setting the *default* color option. -Cursor line colors:: - -*cursor* - -Main view specific:: +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. +------------------------------------------------------------------------------ -Appearance of the various columns in the main view, including the '~' used for -delimiting long author names and labels for tag and branch references. +ifdef::backend-xhtml11[] +[frame="none"] +`-----------------------`----------------------------------------------------- +endif::backend-xhtml11[] +Main view colors: +------------------------------------------------------------------------------ +main-author The commit author. +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. +------------------------------------------------------------------------------ -*main-date*, *main-author*, *main-commit*, *main-delim*, *main-tag*, -*main-ref*, *main-remote* +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. +------------------------------------------------------------------------------ Highlighting ~~~~~~~~~~~~ -The colors and attributes for text that is not highlighted can be controlled -by changing the *default* color option. - -- Diff markup:: @@ -349,7 +426,7 @@ Extra diff information emitted by the git diff machinery, such as mode changes, rename detection, and similarity. *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*, -*diff-rename-from*, *diff-rename-to*, *diff-similarity* *diff-dissimilarity* +*diff-rename-from*, *diff-rename-to*, *diff-similarity*, *diff-dissimilarity* *diff-tree*, *diff-index* Pretty print commit headers:: @@ -358,7 +435,8 @@ Commit diffs and the revision logs are usually formatted using pretty printed headers , unless `--pretty=raw` was given. This includes lines, such as merge info, commit ID, and author and committer date. -*pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate* +*pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*, +*pp-refs* Raw commit header:: @@ -373,14 +451,20 @@ For now only `Signed-off-by` and `Acked-by` lines are colorized. *signoff*, *acked* +Tree markup:: + +Colors for information of the tree view. + +*tree-dir*, *tree-file* + -- COPYRIGHT --------- -Copyright (c) 2006-2007 Jonas Fonseca +Copyright (c) 2006-2009 Jonas Fonseca Licensed under the terms of the GNU General Public License. SEE ALSO -------- -gitlink:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual]. +manpage:tig[1] and the http://jonas.nitro.dk/tig/manual.html[tig manual].