X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/30f15e31dcd7510241f3fd23b61d441122390a87..272818eafff98333c51f1b614704160f265405ed:/manual.txt diff --git a/manual.txt b/manual.txt index b7c3d5a..a199ad1 100644 --- a/manual.txt +++ b/manual.txt @@ -120,6 +120,19 @@ TIG_MAIN_CMD:: the option: `--pretty=raw` since the main view parser expects to read that format. +[[tree-commands]] +Tree Commands +~~~~~~~~~~~~~ + +TIG_TREE_CMD:: + The command used for the tree view. Takes two arguments, the first + is the revision ID and the second is the path of the directory tree, + empty for the root directory. Defaults to "git ls-tree %s %s". + +TIG_BLOB_CMD:: + The command used for the blob view. Takes one argument which is + the blob ID. Defaults to "git cat-file blob %s". + [[viewer]] The Viewer ---------- @@ -144,7 +157,7 @@ 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. @@ -173,6 +186,23 @@ The diff view:: has changed since the last commit, or the commit diff complete with log message, diffstat and diff. +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 status view:: + Displays status of files in the working tree and allows changes to be + staged/unstaged as well as adding of untracked files. + +The stage view:: + Displays diff changes for staged or unstanged files being tracked or + file content of untracked files. + The pager view:: Is used for displaying both input from stdin and output from git commands entered in the internal prompt. @@ -215,7 +245,11 @@ m Switch to main view. d Switch to diff view. l Switch to log view. p Switch to pager view. -h, ? Show man page. +t Switch to (directory) tree view. +f Switch to (file) blob view. +h Switch to help view +S Switch to status view +c Switch to stage view ----------------------------------------------------------------------------- [[view-manipulation]] @@ -233,8 +267,9 @@ Enter This key is "context sensitive" depending on what view you are \ view, split the view and show the commit diff. In the diff view \ pressing Enter will simply scroll the view one line down. Tab Switch to next view. +R Reload and refresh the current view. 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 \ + 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. @@ -270,6 +305,19 @@ w Scroll view one page up. s Scroll view one page down. ----------------------------------------------------------------------------- +[[searching]] +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. +----------------------------------------------------------------------------- + [[misc-keys]] Misc ~~~~ @@ -283,10 +331,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. -n Toggle line numbers on/off. +'.' Toggle line numbers on/off. g Toggle revision graph visualization on/off. ':' 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 ). 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. ----------------------------------------------------------------------------- [[refspec]] @@ -295,7 +348,7 @@ Revision Specification 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). @@ -417,7 +470,7 @@ include::BUGS[] Copyright --------- -Copyright (c) 2006 Jonas Fonseca +Copyright (c) 2006-2007 Jonas Fonseca This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by