X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/b6607e7e796f5b58d64211c022d3e1af6159bdaa..d79f15772b0489ae3bf77322706016c733a714c9:/manual.txt diff --git a/manual.txt b/manual.txt index efdb079..0ea404b 100644 --- a/manual.txt +++ b/manual.txt @@ -47,11 +47,11 @@ NOTE: If you specify options for the main view, you should not use the `--pretty` option as this option will be set automatically to the format expected by the main view. -Example on how to open the log view and show both author and committer +Example on how to view a commit and show both author and committer information: ----------------------------------------------------------------------------- -$ tig log --pretty=fuller +$ tig show --pretty=fuller ----------------------------------------------------------------------------- See the <> section below for an introduction @@ -210,6 +210,9 @@ The blob view:: Displays the file content or "blob" of data associated with a file name. +The blame view:: + Displays the file content annotated or blamed by commits. + 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. @@ -262,6 +265,7 @@ l Switch to log view. 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 help view S Switch to status view c Switch to stage view @@ -283,6 +287,7 @@ Enter This key is "context sensitive" depending on what view you are \ pressing Enter will simply scroll the view one line down. Tab Switch to next view. R Reload and refresh the current view. +M Maximize the current view to fill the whole display. Up 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 \ @@ -347,7 +352,10 @@ z Stop all background loading. This can be useful if you use \ the revision log. v Show version. '.' 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 \ @@ -399,16 +407,16 @@ If you are interested only in those revisions that made changes to a specific file (or even several files) list the files like this: ----------------------------------------------------------------------------- -$ tig log Makefile README +$ tig Makefile README ----------------------------------------------------------------------------- -To avoid ambiguity with repository references such as tag name, be sure to -separate file names from other git options using "\--". So if you have a file -named 'master' it will clash with the reference named 'master', and thus you -will have to use: +To avoid ambiguity with tig's subcommands or repository references such as tag +name, be sure to separate file names from other git options using "\--". So if +you have a file named 'status' it will clash with the 'status' subcommand, and +thus you will have to use: ----------------------------------------------------------------------------- -$ tig log -- master +$ tig -- status ----------------------------------------------------------------------------- NOTE: For the main view, avoiding ambiguity will in some cases require you to @@ -427,7 +435,7 @@ If you are only interested in changed that happened between two dates you can use: ----------------------------------------------------------------------------- -$ tig -- --after="May 5th" --before="2006-05-16 15:44" +$ tig --after="May 5th" --before="2006-05-16 15:44" ----------------------------------------------------------------------------- NOTE: If you want to avoid having to quote dates containing spaces you can use @@ -441,7 +449,7 @@ Alternatively, commits can be limited to a specific range, such as "all commits between 'tag-1.0' and 'tag-2.0'". For example: ----------------------------------------------------------------------------- -$ tig log tag-1.0..tag-2.0 +$ tig tag-1.0..tag-2.0 ----------------------------------------------------------------------------- This way of commit limiting makes it trivial to only browse the commits which @@ -449,7 +457,7 @@ haven't been pushed to a remote branch. Assuming 'origin' is your upstream remote branch, using: ----------------------------------------------------------------------------- -$ tig log origin..HEAD +$ tig origin..HEAD ----------------------------------------------------------------------------- will list what will be pushed to the remote branch. Optionally, the ending @@ -468,7 +476,7 @@ If you prefer to specify which commit to preview in this way use the following: ----------------------------------------------------------------------------- -$ tig log tag-2.0 ^tag-1.0 +$ tig tag-2.0 ^tag-1.0 ----------------------------------------------------------------------------- You can think of '^' as a negation operator. Using this alternate syntax, it @@ -483,7 +491,7 @@ say "show at most 20 commits from within the last month that changed files under the Documentation/ directory." ----------------------------------------------------------------------------- -$ tig -- --since=1.month -n20 -- Documentation/ +$ tig --since=1.month -n20 -- Documentation/ ----------------------------------------------------------------------------- [[refspec-all]] @@ -496,7 +504,7 @@ repository change a particular file within the last week". This can be accomplished using: ----------------------------------------------------------------------------- -$ tig -- --all --since=1.week -- Makefile +$ tig --all --since=1.week -- Makefile ----------------------------------------------------------------------------- include::BUGS[]