diff --git a/tigrc.5.txt b/tigrc.5.txt
index f62a0077256fc44185679f54d85662e88d702aee..b6fe7eb3e0e2460d0a93e5102960658b18b50f9b 100644 (file)
--- a/tigrc.5.txt
+++ b/tigrc.5.txt
--------
[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]'
.............................................................................
[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 per 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 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.
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.
'line-number-interval' (int)::
[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 unto current branch
+bind generic C !git cherry-pick %(commit)
--------------------------------------------------------------------------
Keys are mapped by first searching the keybindings for the current view, then
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
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
+toggle-refs Toggle reference display
status-update Update file status
status-merge Resolve unmerged file
tree-parent Switch to parent directory in tree view
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::
*standout*, and *underline*. Note, not all attributes may be supported
by the terminal.
-
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.
@@ -325,16 +348,20 @@ 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-remote*, *main-revgraph*
+*main-local-tag*, *main-ref*, *main-remote*, *main-head*, *main-revgraph*
+
+Blame view colors::
+
+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*.
+
+*blame-date*, *blame-author*, *blame-commit*, *blame-id*, *blame-lineno*
--
Highlighting
~~~~~~~~~~~~
-The colors and attributes for text that is not highlighted can be controlled
-by changing the *default* color option.
-
--
Diff markup::