Code

Clear the view after 1 second during updates where reading takes long
[tig.git] / tigrc.5.txt
index 8256a54f112541e342f21454acc98492e2679da5..7c1daece455d3bae71bbd034d17d7e87c6c4d31a 100644 (file)
@@ -47,6 +47,8 @@ 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
@@ -81,6 +83,14 @@ The following variables can be set:
        (branches, tags, and remotes) in the main view on start-up. Can all be
        toggled.
 
+'author-width' (int)::
+
+       Width of the author column.
+
+'line-graphics' (bool)::
+
+       Whether to use graphic characters for line drawing.
+
 'line-number-interval' (int)::
 
        Interval between line numbers. Note, you have to toggle on line
@@ -122,7 +132,7 @@ bind diff b move-first-line
 bind main Q none
 # An external command to update from upstream
 bind generic F !git fetch
-# Cherry-pick current commit unto current branch
+# Cherry-pick current commit onto current branch
 bind generic C !git cherry-pick %(commit)
 --------------------------------------------------------------------------
 
@@ -163,10 +173,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"]
@@ -197,6 +222,7 @@ next                        Move to next
 previous               Move to previous
 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
 ------------------------------------------------------------------------------
@@ -258,6 +284,7 @@ toggle-rev-graph    Toggle revision graph visualization
 toggle-refs            Toggle reference display
 status-update          Update file status
 status-merge           Resolve unmerged file
+stage-next             Find next chunk to stage
 tree-parent            Switch to parent directory in tree view
 edit                   Open in editor
 ------------------------------------------------------------------------------
@@ -302,7 +329,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::
 
@@ -313,55 +341,64 @@ Attribute names::
 UI colors
 ~~~~~~~~~
 
---
-
-Default terminal colors::
-
 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.
 
-Use the *default* color to use the colors configured for the terminal. This is
-the default and recommended if you are using a terminal with a transparent
-background.
-
-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*
-
-Cursor line colors::
-
-*cursor*
-
-Color of delimiter shown for truncated lines::
-
-*main-delim*
-
-Main view specific::
-
-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-tag*,
-*main-local-tag*, *main-ref*, *main-remote*, *main-head*, *main-revgraph*
-
-Blame view colors::
+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.
+------------------------------------------------------------------------------
 
-The colors used for the blame view are similar to those in the main view.
-The commit ID color can be colored using *blame-id*.
+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.
+------------------------------------------------------------------------------
 
-*blame-date*, *blame-author*, *blame-commit*, *blame-id*, *blame-lineno*
+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
 ~~~~~~~~~~~~
@@ -411,22 +448,14 @@ Colors for information of the tree view.
 
 *tree-dir*, *tree-file*
 
-Status markup::
-
-Colors used in the status view for coloring the "On branch"-line, sections,
-"no file" lines and the various file status groups.
-
-*stat-head*, *stat-section*, *stat-none*, *stat-staged*, *stat-unstaged*,
-*stat-untracked*
-
 --
 
 COPYRIGHT
 ---------
-Copyright (c) 2006-2007 Jonas Fonseca <fonseca@diku.dk>
+Copyright (c) 2006-2008 Jonas Fonseca <fonseca@diku.dk>
 
 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].