From af4c75a274ce4a06f0bc069dc94820a4b700e8bc Mon Sep 17 00:00:00 2001 From: Jonas Fonseca Date: Mon, 18 Sep 2006 18:24:55 +0200 Subject: [PATCH] Sync docs --- manual.html | 119 ++++++++++++++++++++++++++++++++++++++++++++++++++--------- tig.1 | 35 +++++++++++------- tig.1.html | 54 +++++++++++++++++---------- tigrc.5 | 40 +++++++++++--------- tigrc.5.html | 66 +++++++++++++++++++++------------ 5 files changed, 221 insertions(+), 93 deletions(-) diff --git a/manual.html b/manual.html index 0bf8c90..2ee686d 100644 --- a/manual.html +++ b/manual.html @@ -355,6 +355,11 @@ commit with the log message, diffstat, and the diff.

Scrolling

+
  • +

    +Searching +

    +
  • @@ -530,7 +535,7 @@ and the diff view in the bottom window. You can switch between the two views by pressing Tab. To maximize the log view again, simply press l.

    3.1. Current Head and Commit ID

    The viewer keeps track of both what head and commit ID you are currently -viewing. The commit ID will follow the cursor line and change everytime time +viewing. The commit ID will follow the cursor line and change every time you highlight a different commit. Whenever you reopen the diff view it will be reloaded, if the commit ID changed.

    The head ID is used when opening the main and log view to indicate from what @@ -570,6 +575,25 @@ The diff view

    +The tree view +
    +
    +

    + Lists directory trees associated with the current revision allowing + subdirectories to be descended or ascended and file blobs to be + viewed. +

    +
    +
    +The blob view +
    +
    +

    + Displays the file content or "blob" of data associated with a file + name. +

    +
    +
    The pager view
    @@ -657,7 +681,23 @@ cellspacing="0" cellpadding="4"> - h, ? + t + + + Switch to (directory) tree view. + + + + + f + + + Switch to (file) blob view. + + + + + h Show man page. @@ -713,7 +753,7 @@ cellspacing="0" cellpadding="4"> Up - This key is "context sensitive" and will move the cursor one line up. However, uf you opened a diff view from the main view (split- or full-screen) it will change the cursor to point to the previous commit in the main view and update the diff view to display it. + This key is "context sensitive" and will move the cursor one line up. However, if you opened a diff view from the main view (split- or full-screen) it will change the cursor to point to the previous commit in the main view and update the diff view to display it. @@ -849,7 +889,60 @@ cellspacing="0" cellpadding="4"> -

    4.5. Misc

    +

    4.5. Searching

    +
    + +++ + + + + + + + + + + + + + + + + + + + + + + + +
    + Key + + Action +
    + / + + Search the view. Opens a prompt for entering search regex to use. +
    + ? + + Search backwards in the view. Also prompts for regex. +
    + n + + Find next match for the current search regex. +
    + N + + Find previous match for the current search regex. +
    +
    +

    4.6. Misc

    + + + + @@ -483,6 +493,14 @@ cellspacing="0" cellpadding="4"> Show pager view + + + +
    - n + . Toggle line numbers on/off. @@ -931,7 +1024,7 @@ cellspacing="0" cellpadding="4">

    This section describes various ways to specify what revisions to display or otherwise limit the view to. Tig does not itself parse the described -revision options so refer to the relevant git man pages for futher +revision options so refer to the relevant git man pages for further information. Relevant man pages besides git-log(1) are git-diff(1) and git-rev-list(1).

    You can tune the interaction with git by making use of the options explained @@ -1034,20 +1127,12 @@ accomplished using:

    • -In it's current state tig is pretty much UTF-8 only. -

      -
      • -
    • -

      -If the screen width is very small the main view can draw - outside the current view causing bad wrapping. Same goes - for title and status windows. +Proper locale support: in it's current state tig is pretty much UTF-8 only.

    • -The cursor can wrap-around on the last line and cause the - window to scroll. +Horizontal scrolling.

    @@ -1137,7 +1222,7 @@ gitview(1)
    diff --git a/tig.1 b/tig.1 index 87fc73d..e8f7262 100644 --- a/tig.1 +++ b/tig.1 @@ -24,10 +24,10 @@ tig \- text-mode interface for git .nf tig [options] -tig [options] [\-\-] [git log options] -tig [options] log [git log options] -tig [options] diff [git diff options] -tig [options] show [git show options] +tig [options] [\-\-] [git options] +tig [options] log [git options] +tig [options] diff [git options] +tig [options] show [git options] tig [options] < [git command output] .fi @@ -77,19 +77,19 @@ $ tig \-\- \-\-since=1\&.month .fi .TP -log [git log options] +log Open log view using the given git log options\&. .TP -diff [git diff options] +diff Open diff view using the given git diff options\&. .TP -show [git show options] +show Open diff view using the given git show options\&. .TP -[git log options] +[git options] tig(1) will stop the option parsing when the first command line parameter not starting with "\-" is encountered\&. All options including this one will be passed to git log when loading the main view\&. This makes it possible to say: .nf @@ -114,6 +114,16 @@ The command used for the log view\&. If you prefer to have both author and commi TIG_MAIN_CMD The command used for the main view\&. Note, you must always specify the option: \-\-pretty=raw since the main view parser expects to read that format\&. +.SS "Tree commands" + +.TP +TIG_TREE_CMD +The command used for the tree view\&. By default, git\-ls\-tree(1) is used\&. The commands should expect first the commit ID and second a path\&. + +.TP +TIG_BLOB_CMD +The command used for the blob view\&. By default, git\-cat\-file(1) is used\&. The command gets the blob ID\&. + .SH "FILES" .TP @@ -122,7 +132,7 @@ User configuration file\&. See \fBtigrc\fR(5) for examples\&. .TP \fI\&.git/config\fR -Repository config file\&. Read on startup with the help of git\-repo\-config(1)\&. +Repository config file\&. Read on start\-up with the help of git\-repo\-config(1)\&. .SH "BUGS" @@ -131,13 +141,10 @@ Known bugs and problems: .TP 3 \(bu -In it's current state tig is pretty much UTF\-8 only\&. -.TP -\(bu -If the screen width is very small the main view can draw outside the current view causing bad wrapping\&. Same goes for title and status windows\&. +Proper locale support: in it's current state tig is pretty much UTF\-8 only\&. .TP \(bu -The cursor can wrap\-around on the last line and cause the window to scroll\&. +Horizontal scrolling\&. .LP .SH "COPYRIGHT" diff --git a/tig.1.html b/tig.1.html index 58c6f89..06ded8c 100644 --- a/tig.1.html +++ b/tig.1.html @@ -274,10 +274,10 @@ TIG(1) Manual Page
    tig [options] -tig [options] [--] [git log options] -tig [options] log [git log options] -tig [options] diff [git diff options] -tig [options] show [git show options] +tig [options] [--] [git options] +tig [options] log [git options] +tig [options] diff [git options] +tig [options] show [git options] tig [options] < [git command output]

    DESCRIPTION

    @@ -356,7 +356,7 @@ to colorize it.

    -log [git log options] +log

    @@ -364,7 +364,7 @@ log [git log options]

    -diff [git diff options] +diff

    @@ -372,7 +372,7 @@ diff [git diff options]

    -show [git show options] +show

    @@ -380,7 +380,7 @@ show [git show options]

    -[git log options] +[git options]

    @@ -439,6 +439,28 @@ TIG_MAIN_CMD

    +

    Tree commands

    +
    +
    +TIG_TREE_CMD +
    +
    +

    + The command used for the tree view. By default, git-ls-tree(1) is + used. The commands should expect first the commit ID and second + a path. +

    +
    +
    +TIG_BLOB_CMD +
    +
    +

    + The command used for the blob view. By default, git-cat-file(1) is + used. The command gets the blob ID. +

    +
    +

    FILES

    @@ -456,7 +478,7 @@ TIG_MAIN_CMD

    - Repository config file. Read on startup with the help of + Repository config file. Read on start-up with the help of git-repo-config(1).

    @@ -468,20 +490,12 @@ TIG_MAIN_CMD

    • -In it's current state tig is pretty much UTF-8 only. -

      -
      • -
    • -

      -If the screen width is very small the main view can draw - outside the current view causing bad wrapping. Same goes - for title and status windows. +Proper locale support: in it's current state tig is pretty much UTF-8 only.

    • -The cursor can wrap-around on the last line and cause the - window to scroll. +Horizontal scrolling.

    @@ -529,7 +543,7 @@ Gitweb: http://pasky
    diff --git a/tigrc.5 b/tigrc.5 index f42db7d..7e7d7e9 100644 --- a/tigrc.5 +++ b/tigrc.5 @@ -77,7 +77,7 @@ The following variables can be set: .TP \fIshow\-rev\-graph\fR (bool) -Show revision graph in the main view on startup\&. Can be toggled with \fIg\fR\&. +Show revision graph in the main view on start\-up\&. Can be toggled with \fIg\fR\&. .TP \fIline\-number\-interval\fR (int) @@ -111,10 +111,12 @@ Examples: bind diff a previous bind diff d next bind diff b move\-first\-line + # 'unbind' the default quit key binding + bind main Q none .fi -Keys are mapped by first searching the keybindings for the current view, then the keybindings for the \fIgeneric\fR keymap, and last the default keybindings\&. Thus, the view keybindings shaddow the generic keybindings which shaddow the built\-in keybindings\&. +Keys are mapped by first searching the keybindings for the current view, then the keybindings for the \fIgeneric\fR keymap, and last the default keybindings\&. Thus, the view keybindings shadow the generic keybindings which Shadow the built\-in keybindings\&. .TP Keymaps @@ -139,8 +141,10 @@ 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\-pager Show pager view +view\-help Show help page .fi @@ -161,40 +165,40 @@ Cursor navigation: .nf 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 .fi Scrolling: .nf -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 .fi Misc: .nf +none Do nothing 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 -toggle\-rev_graph Toggle revision graph visualization +toggle\-rev\-graph Toggle revision graph visualization .fi .SH "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 as the last parameter\&. The syntax is: +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: .nf \fIcolor\fR \fIarea\fR \fIfgcolor\fR \fIbgcolor\fR \fI[attributes]\fR @@ -237,7 +241,7 @@ Appearance of the bottom window showing info messages\&. .TP Title window colors -Appearence of the title windows when they are attached to any backgrounded windows and the current window\&. +Appearance of the title windows when they are attached to any backgrounded windows and the current window\&. \fItitle\-blur\fR, \fItitle\-focus\fR @@ -270,7 +274,7 @@ Extra diff information emitted by the git diff machinery, such as mode changes, .TP 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\&. +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\&. \fIpp\-author\fR, \fIpp\-commit\fR, \fIpp\-merge\fR, \fIpp\-date\fR, \fIpp\-adate\fR, \fIpp\-cdate\fR @@ -282,9 +286,9 @@ Usually shown when \-\-pretty=raw is given, however \fIcommit\fR is pretty much .TP Commit message -For now only Signed\-off\-by lines are colorized\&. +For now only Signed\-off\-by and Acked\-by lines are colorized\&. -\fIsignoff\fR +\fIsignoff\fR, \fIacked\fR .SH "COPYRIGHT" diff --git a/tigrc.5.html b/tigrc.5.html index a1d273e..57f387a 100644 --- a/tigrc.5.html +++ b/tigrc.5.html @@ -336,7 +336,7 @@ Valid string values

    - 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.

    @@ -384,11 +384,13 @@ key map. The syntax is:

    bind main space enter bind diff a previous bind diff d next - bind diff b move-first-line + bind diff b move-first-line + # 'unbind' the default quit key binding + bind main Q none

    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.

    @@ -469,10 +471,18 @@ cellspacing="0" cellpadding="4">
    - view-help + view-tree - Show help page + Show tree view +
    + view-blob + + Show blob view
    + view-help + + Show help page +
    @@ -589,7 +607,7 @@ cellspacing="0" cellpadding="4"> - move-page_down + move-page-down Move cursor one page down @@ -597,7 +615,7 @@ cellspacing="0" cellpadding="4"> - move-page_up + move-page-up Move cursor one page up @@ -605,7 +623,7 @@ cellspacing="0" cellpadding="4"> - move-first_line + move-first-line Move cursor to first line @@ -613,7 +631,7 @@ cellspacing="0" cellpadding="4"> - move-last_line + move-last-line Move cursor to last line @@ -641,7 +659,7 @@ cellspacing="0" cellpadding="4"> - scroll-line_up + scroll-line-up Scroll one line up @@ -649,7 +667,7 @@ cellspacing="0" cellpadding="4"> - scroll-line_down + scroll-line-down Scroll one line down @@ -657,7 +675,7 @@ cellspacing="0" cellpadding="4"> - scroll-page_up + scroll-page-eup Scroll one page up @@ -665,7 +683,7 @@ cellspacing="0" cellpadding="4"> - scroll-page_down + scroll-page-down Scroll one page down @@ -693,18 +711,18 @@ cellspacing="0" cellpadding="4"> - prompt + none - Bring up the prompt + Do nothing - screen-update + prompt - Update the screen + Bring up the prompt @@ -749,7 +767,7 @@ cellspacing="0" cellpadding="4"> - toggle-rev_graph + toggle-rev-graph Toggle revision graph visualization @@ -763,7 +781,7 @@ cellspacing="0" cellpadding="4">

    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:

    color area fgcolor bgcolor [attributes]
    @@ -828,7 +846,7 @@ 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

    @@ -885,7 +903,7 @@ 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

    @@ -904,9 +922,9 @@ Commit message

    -For now only Signed-off-by lines are colorized. +For now only Signed-off-by and Acked-by lines are colorized.

    -

    signoff

    +

    signoff, acked

    @@ -921,7 +939,7 @@ For now only Signed-off-by lines are colorized. -- 2.11.0