utf8_length: add reserve flag for reserving a trailing character

[tig] / tigrc.5.txt

diff --git a/tigrc.5.txt b/tigrc.5.txt
index 3b4b7a2..f7d7bed 100644 (file)
--- a/tigrc.5.txt
+++ b/tigrc.5.txt
@@ -10,9 +10,9 @@ SYNOPSIS
 --------
 [verse]
 .............................................................................
 --------
 [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]
 ..............................................................................
 
 [verse]
 ..............................................................................

-       *set* variables *=* value
+*set* variables *=* value

 ..............................................................................
 
 Examples:
 
 --------------------------------------------------------------------------
 ..............................................................................
 
 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-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.
 --------------------------------------------------------------------------
 
 The type of variables are either bool, int, and string.


@@ -70,7 +70,7 @@ The following variables can be set:
 
 'show-rev-graph' (bool)::
 
 
 '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)::
        'g'.
 
 'line-number-interval' (int)::


@@ -97,32 +97,38 @@ key map. The syntax is:
 
 [verse]
 ..............................................................................
 
 [verse]
 ..............................................................................

-       *bind* 'keymap' 'key' 'action'
+*bind* 'keymap' 'key' 'action'

 ..............................................................................
 
 Examples:
 
 --------------------------------------------------------------------------
 ..............................................................................
 
 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
+# 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
 the keybindings for the *generic* keymap, and last the default keybindings.
 --------------------------------------------------------------------------
 
 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::
 
 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::
 
 
 Key values::
 


@@ -146,6 +152,14 @@ e.g. "view-main", "View.Main", and "VIEW_MAIN" are the same.
 Actions
 ~~~~~~~
 
 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"]
 `-----------------------`-----------------------------------------------------
 ifdef::backend-xhtml11[]
 [frame="none"]
 `-----------------------`-----------------------------------------------------


@@ -155,8 +169,12 @@ View switching:
 view-main              Show main view
 view-diff              Show diff view
 view-log               Show log view
 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-pager             Show pager view

+view-help              Show help page

 ------------------------------------------------------------------------------
 
 ifdef::backend-xhtml11[]
 ------------------------------------------------------------------------------
 
 ifdef::backend-xhtml11[]


@@ -169,6 +187,7 @@ enter                       Enter current line and scroll
 next                   Move to next
 previous               Move to previous
 view-next              Move focus to next view
 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
 ------------------------------------------------------------------------------
 view-close             Close the current view
 quit                   Close all views and quit
 ------------------------------------------------------------------------------


@@ -181,10 +200,10 @@ Cursor navigation:
 ------------------------------------------------------------------------------
 move-up                        Move cursor one line up
 move-down              Move cursor one line down
 ------------------------------------------------------------------------------
 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[]
 ------------------------------------------------------------------------------
 
 ifdef::backend-xhtml11[]


@@ -193,10 +212,22 @@ ifdef::backend-xhtml11[]
 endif::backend-xhtml11[]
 Scrolling:
 ------------------------------------------------------------------------------
 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[]
 ------------------------------------------------------------------------------
 
 ifdef::backend-xhtml11[]


@@ -205,14 +236,18 @@ ifdef::backend-xhtml11[]
 endif::backend-xhtml11[]
 Misc:
 ------------------------------------------------------------------------------
 endif::backend-xhtml11[]
 Misc:
 ------------------------------------------------------------------------------

+none                   Do nothing

 prompt                 Bring up the prompt
 prompt                 Bring up the prompt

-screen-update          Update the screen

 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
 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-rev_graph       Toggle revision graph visualization
+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

 ------------------------------------------------------------------------------
 
 
 ------------------------------------------------------------------------------
 
 


@@ -221,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
 
 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
-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]
 ..............................................................................
 
 [verse]
 ..............................................................................

-       *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
+*color* 'area' 'fgcolor' 'bgcolor' '[attributes]'

 ..............................................................................
 
 Examples:
 
 ------------------------------------------------------------------------------
 ..............................................................................
 
 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::
 ------------------------------------------------------------------------------
 
 Area names::


@@ -261,12 +298,21 @@ Attribute names::
        *standout*, and *underline*. Note, not all attributes may be supported
        by the terminal.
 
        *standout*, and *underline*. Note, not all attributes may be supported
        by the terminal.
 

-

 UI colors
 ~~~~~~~~~
 
 --
 
 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 window colors::
 
 Appearance of the bottom window showing info messages.


@@ -275,7 +321,7 @@ Appearance of the bottom window showing info messages.
 
 Title window colors::
 
 
 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*
 to any backgrounded windows and the current window.
 
 *title-blur*, *title-focus*


@@ -290,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*,
 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*

 
 --
 
 Highlighting
 ~~~~~~~~~~~~
 
 
 --
 
 Highlighting
 ~~~~~~~~~~~~
 

-The colors and attributes for text that is not highlighted can be controlled
-by changing the *default* color option.
-

 --
 
 Diff markup::
 --
 
 Diff markup::


@@ -314,16 +357,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*,
 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
 *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::
 
 
 Raw commit header::
 


@@ -334,15 +378,27 @@ omnipresent.
 
 Commit message::
 
 
 Commit message::
 

-For now only `Signed-off-by` lines are colorized.
+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.

 
 

-*signoff*
+*stat-section*, *stat-none*, *stat-staged*, *stat-unstaged*, *stat-untracked*

 
 --
 
 COPYRIGHT
 ---------
 
 --
 
 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.
 
 
 Licensed under the terms of the GNU General Public License.