Code

Fix loading of blame data when opened from the tree view
[tig.git] / manual.txt
index 87f949250f165211d9b3d97942e049286192578c..d73e819ed2aab5455514276dac07200aa6576969 100644 (file)
@@ -111,6 +111,9 @@ The blob view::
 The blame view::
        Displays the file content annotated or blamed by commits.
 
+The branch view::
+       Displays the branches in the repository.
+
 The status view::
        Displays status of files in the working tree and allows changes to be
        staged/unstaged as well as adding of untracked files.
@@ -316,6 +319,7 @@ p   Switch to pager view.
 t      Switch to (directory) tree view.
 f      Switch to (file) blob view.
 B      Switch to blame view.
+H      Switch to branch view.
 h      Switch to help view
 S      Switch to status view
 c      Switch to stage view
@@ -345,7 +349,28 @@ Up This key is "context sensitive" and will move the cursor one \
        to display it.
 Down   Similar to 'Up' but will move down.
 ','    Move to parent. In the tree view, this means switch to the parent \
-       directory.
+       directory. In the blame view it will load blame for the parent \
+       commit. For merges the parent is queried.
+-----------------------------------------------------------------------------
+
+[[view-actions]]
+View Specific Actions
+~~~~~~~~~~~~~~~~~~~~~
+
+`-------`--------------------------------------------------------------------
+Key    Action
+-----------------------------------------------------------------------------
+u      Update status of file. In the status view, this allows you to add an \
+       untracked file or stage changes to a file for next commit (similar to \
+       running git-add <filename>). In the stage view, when pressing this on \
+       a diff chunk line stages only that chunk for next commit, when not on \
+       a diff chunk line all changes in the displayed diff is staged.
+M      Resolve unmerged file by launching git-mergetool(1). Note, to work \
+       correctly this might require some initial configuration of your \
+       preferred merge tool. See the manpage of git-mergetool(1).
+!      Checkout file with unstaged changes. This will reset the file to \
+       contain the content it had at last commit.
+@      Move to next chunk in the stage view.
 -----------------------------------------------------------------------------
 
 [[cursor-nav]]
@@ -355,8 +380,8 @@ Cursor Navigation
 `-------`--------------------------------------------------------------------
 Key    Action
 -----------------------------------------------------------------------------
-j      Move cursor one line up.
-k      Move cursor one line down.
+k      Move cursor one line up.
+j      Move cursor one line down.
 PgUp,\
 -,a    Move cursor one page up.
 PgDown Space   Move cursor one page down.
@@ -375,6 +400,8 @@ Insert      Scroll view one line up.
 Delete Scroll view one line down.
 w      Scroll view one page up.
 s      Scroll view one page down.
+Left   Scroll view one column left.
+Right  Scroll view one column right.
 -----------------------------------------------------------------------------
 
 [[searching]]
@@ -384,10 +411,10 @@ 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.
+/      Search the view. Opens a prompt for entering search regexp to use.
+?      Search backwards in the view. Also prompts for regexp.
+n      Find next match for the current search regexp.
+N      Find previous match for the current search regexp.
 -----------------------------------------------------------------------------
 
 [[misc-keys]]
@@ -403,24 +430,15 @@ z Stop all background loading. This can be useful if you use \
        tig in a repository with a long history without limiting \
        the revision log.
 v      Show version.
+o      Open option menu
 '.'    Toggle line numbers on/off.
 D      Toggle date display on/off.
 A      Toggle author display on/off.
 g      Toggle revision graph visualization on/off.
 F      Toggle reference display on/off (tag and branch names).
 ':'    Open prompt. This allows you to specify what git command \
-       to run. Example `:log -p`
-u      Update status of file. In the status view, this allows you to add an \
-       untracked file or stage changes to a file for next commit (similar to \
-       running git-add <filename>). In the stage view, when pressing this on \
-       a diff chunk line stages only that chunk for next commit, when not on \
-       a diff chunk line all changes in the displayed diff is staged.
-M      Resolve unmerged file by launching git-mergetool(1). Note, to work \
-       correctly this might require some initial configuration of your \
-       preferred merge tool. See the manpage of git-mergetool(1).
-!      Checkout file with unstaged changes. This will reset the file to \
-       contain the content it had at last commit.
-@      Move to next chunk in the stage view.
+       to run. Example `:log -p`. You can also use this to jump \
+       to a specific line by typing `:<linenumber>`, e.g. `:80`.
 e      Open file in editor.
 -----------------------------------------------------------------------------
 
@@ -431,13 +449,14 @@ External Commands
 For more custom needs, external commands provide a way to easily execute
 a script or program. They are bound to keys and use information from the
 current browsing state, such as the current commit ID. Tig comes with
-the following builtin external commands:
+the following built-in external commands:
 
-`-------`--------------------------------------------------------------------
-Key    Action
+`-------`-------`------------------------------------------------------------
+Keymap Key     Action
 -----------------------------------------------------------------------------
-C      git cherry-pick %(commit)
-G      git gc
+main   C       git cherry-pick %(commit)
+status C       git commit
+generic        G       git gc
 -----------------------------------------------------------------------------
 
 [[refspec]]
@@ -588,4 +607,3 @@ Other git repository browsers:
 
  - gitk(1)
  - qgit(1)
- - gitview(1)