Code

Added color option main-revgraph to color the revision graph.
[tig.git] / tigrc.5.txt
index 7c49c59c086d1db219f5d1b93b5715543dbcd8fb..521880b1051d799edac06008ade61e56e2b3dece 100644 (file)
@@ -44,7 +44,7 @@ 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 tab-size = 8                # Number of spaces per tab
        set encoding = "UTF-8"          # Commit encoding
 --------------------------------------------------------------------------
 
@@ -70,7 +70,7 @@ The following variables can be set:
 
 'show-rev-graph' (bool)::
 
-       Show revision graph in the main view on startup. Can be toggled with
+       Show revision graph in the main view on start-up. Can be toggled with
        'g'.
 
 'line-number-interval' (int)::
@@ -112,19 +112,23 @@ Examples:
        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)
 --------------------------------------------------------------------------
 
 Keys are mapped by first searching the keybindings for the current view, then
 the keybindings for the *generic* keymap, and last the default keybindings.
-Thus, the view keybindings shaddow the generic keybindings which shaddow the
+Thus, the view keybindings shadow the generic keybindings which Shadow the
 built-in keybindings.
 
 --
 
 Keymaps::
 
-Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, and *generic*.  Use
-*generic* to set key mapping in all keymaps.
+Valid keymaps are: *main*, *diff*, *log*, *help*, *pager*, *status*, *stage*,
+and *generic*.  Use *generic* to set key mapping in all keymaps.
 
 Key values::
 
@@ -148,6 +152,14 @@ e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
 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)".
+
+As an example, the following external command will save the current commit as
+a patch file: "!git format-patch %(commit)^..%(commit)".
+
 ifdef::backend-xhtml11[]
 [frame="none"]
 `-----------------------`-----------------------------------------------------
@@ -157,8 +169,12 @@ View switching:
 view-main              Show main view
 view-diff              Show diff view
 view-log               Show log view
-view-help              Show help page
+view-tree              Show tree view
+view-blob              Show blob view
+view-status            Show status view
+view-stage             Show stage view
 view-pager             Show pager view
+view-help              Show help page
 ------------------------------------------------------------------------------
 
 ifdef::backend-xhtml11[]
@@ -171,6 +187,7 @@ enter                       Enter current line and scroll
 next                   Move to next
 previous               Move to previous
 view-next              Move focus to next view
+refresh                        Reload and refresh view
 view-close             Close the current view
 quit                   Close all views and quit
 ------------------------------------------------------------------------------
@@ -183,10 +200,10 @@ 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
+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[]
@@ -195,10 +212,22 @@ ifdef::backend-xhtml11[]
 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-line-up         Scroll one line up
+scroll-line-down       Scroll one line down
+scroll-page-eup                Scroll one page up
+scroll-page-down       Scroll one page down
+------------------------------------------------------------------------------
+
+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[]
@@ -214,7 +243,10 @@ screen-resize              Resize the screen
 show-version           Show version information
 stop-loading           Stop all loading views
 toggle-lineno          Toggle line numbers
-toggle-rev_graph       Toggle revision graph visualization
+toggle-rev-graph       Toggle revision graph visualization
+status-update          Update file status
+status-merge           Resolve unmerged file
+edit                   Open in editor
 ------------------------------------------------------------------------------
 
 
@@ -223,7 +255,7 @@ 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
-backgound combinations to certain areas. Optionally, an attribute can be given
+background combinations to certain areas. Optionally, an attribute can be given
 as the last parameter. The syntax is:
 
 [verse]
@@ -277,7 +309,7 @@ Appearance of the bottom window showing info messages.
 
 Title window colors::
 
-Appearence of the title windows when they are attached
+Appearance of the title windows when they are attached
 to any backgrounded windows and the current window.
 
 *title-blur*, *title-focus*
@@ -292,7 +324,7 @@ Appearance of the various columns in the main view, including the '~' used for
 delimiting long author names and labels for tag and branch references.
 
 *main-date*, *main-author*, *main-commit*, *main-delim*, *main-tag*,
-*main-ref*
+*main-ref*, *main-remote*, *main-revgraph*
 
 --
 
@@ -316,16 +348,17 @@ 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::
 
 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 comitter date.
+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::
 
@@ -340,11 +373,23 @@ 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*
+
+Status markup::
+
+Colors used in the status view.
+
+*stat-section*, *stat-none*, *stat-staged*, *stat-unstaged*, *stat-untracked*
+
 --
 
 COPYRIGHT
 ---------
-Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
+Copyright (c) 2006-2007 Jonas Fonseca <fonseca@diku.dk>
 
 Licensed under the terms of the GNU General Public License.