utf8_length: add reserve flag for reserving a trailing character
[tig] / tigrc.5.txt
index d0ad8b4..f7d7bed 100644 (file)
@@ -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,16 @@ 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 per tab
-       set encoding = "UTF-8"          # Commit encoding
+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
 --------------------------------------------------------------------------
 
 The type of variables are either bool, int, and string.
@@ -97,25 +97,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 unto current branch
+bind generic C !git cherry-pick %(commit)
 --------------------------------------------------------------------------
 
 Keys are mapped by first searching the keybindings for the current view, then
@@ -246,6 +246,7 @@ toggle-lineno               Toggle line numbers
 toggle-rev-graph       Toggle revision graph visualization
 status-update          Update file status
 status-merge           Resolve unmerged file
+tree-parent            Switch to parent directory in tree view
 edit                   Open in editor
 ------------------------------------------------------------------------------
 
@@ -255,26 +256,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::
@@ -295,12 +298,21 @@ Attribute 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.
@@ -324,16 +336,13 @@ 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-ref*, *main-remote*, *main-revgraph*
 
 --
 
 Highlighting
 ~~~~~~~~~~~~
 
-The colors and attributes for text that is not highlighted can be controlled
-by changing the *default* color option.
-
 --
 
 Diff markup::
@@ -357,7 +366,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::
 
@@ -372,6 +382,18 @@ 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