X-Git-Url: https://git.tokkee.org/?p=tig.git;a=blobdiff_plain;f=manual.txt;h=c9b18932fd98705bff238aa1af9b897094f6a16d;hp=b6c4db56d4500fc8589450aba1a067d0119207ea;hb=HEAD;hpb=16bda3aa4443fe29a3310bc682cfe9aad9ae54b5 diff --git a/manual.txt b/manual.txt index b6c4db5..c9b1893 100644 --- a/manual.txt +++ b/manual.txt @@ -1,6 +1,8 @@ +ifndef::doctype-manpage[] The tig Manual ============== Jonas Fonseca +endif::doctype-manpage[] This is the manual for tig, the ncurses-based text-mode interface for git. Tig allows you to browse changes in a git repository and can additionally act @@ -44,7 +46,7 @@ given command and all will be shell quoted before they are passed to the shell. 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 +`--pretty` option as this option will be set automatically to the format expected by the main view. Example on how to view a commit and show both author and committer @@ -111,6 +113,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. @@ -142,17 +147,21 @@ some of the <> as well as the arguments that refer to the current browsing state by using one of the following variables. -`-----------------------`----------------------------------------------------- -Browsing state variables ------------------------------------------------------------------------------- -%(head) The currently viewed 'head' ID. Defaults to HEAD -%(commit) The currently selected commit ID. -%(blob) The currently selected blob ID. -%(directory) The current directory path in the tree view; \ - empty for the root directory. -%(file) The currently selected file. -%(ref) The reference given to blame or HEAD if undefined. ------------------------------------------------------------------------------- +.Browsing state variables +[frame="none",grid="none",cols="25). 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. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|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 ). 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]] Cursor Navigation ~~~~~~~~~~~~~~~~~ -`-------`-------------------------------------------------------------------- -Key Action ------------------------------------------------------------------------------ -j Move cursor one line up. -k Move cursor one line down. -PgUp,\ --,a Move cursor one page up. -PgDown Space Move cursor one page down. -Home Jump to first line. -End Jump to last line. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|Key |Action +|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. +|End |Jump to last line. +|Home |Jump to first line. +|============================================================================= [[view-scrolling]] Scrolling ~~~~~~~~~ -`-------`-------------------------------------------------------------------- -Key Action ------------------------------------------------------------------------------ -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. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|Key |Action +|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. +|\| |Scroll view to the first column. +|============================================================================= [[searching]] Searching ~~~~~~~~~ -`-------`-------------------------------------------------------------------- -Key Action ------------------------------------------------------------------------------ -/ 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. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|Key |Action +|/ |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]] Misc ~~~~ -`-------`-------------------------------------------------------------------- -Key Action ------------------------------------------------------------------------------ -Q Quit. -r Redraw screen. -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. -'.' 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` -e Open file in editor. ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="2<,8<",options="header"] +|============================================================================= +|Key |Action +|Q |Quit. +|r |Redraw screen. +|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/short/relative/local. +|A |Toggle author display on/off/abbreviated. +|g |Toggle revision graph visualization on/off. +|~ |Toggle (line) graphics mode +|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`. You can also use this to jump + to a specific line by typing `:`, e.g. `:80`. +|e |Open file in editor. +|============================================================================= [[external-commands]] External Commands @@ -445,12 +403,13 @@ 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 built-in external commands: -`-------`-------------------------------------------------------------------- -Key Action ------------------------------------------------------------------------------ -C git cherry-pick %(commit) -G git gc ------------------------------------------------------------------------------ +[frame="none",grid="none",cols="1<,1<,8<",options="header"] +|============================================================================= +|Keymap |Key |Action +|main |C |git cherry-pick %(commit) +|status |C |git commit +|generic|G |git gc +|============================================================================= [[refspec]] Revision Specification @@ -463,8 +422,8 @@ 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 -in this section. For example, by configuring the environment variables -described in the section on <>. +in this section. For example, by configuring the environment variable +described in the section on <>. [[path-limiting]] Limit by Path Name @@ -478,7 +437,7 @@ $ tig Makefile README ----------------------------------------------------------------------------- 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 +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: @@ -492,7 +451,7 @@ Limit by Date or Number To speed up interaction with git, you can limit the amount of commits to show both for the log and main view. Either limit by date using e.g. -`\--since=1.month` or limit by the number of commits using `-n400`. +`--since=1.month` or limit by the number of commits using `-n400`. If you are only interested in changed that happened between two dates you can use: @@ -502,7 +461,7 @@ $ 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 -"." instead, e.g. `\--after=May.5th`. +"." instead, e.g. `--after=May.5th`. [[commit-range-limiting]] Limiting by Commit Ranges @@ -576,7 +535,7 @@ include::BUGS[] Copyright --------- -Copyright (c) 2006-2009 Jonas Fonseca +Copyright (c) 2006-2010 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 @@ -595,8 +554,3 @@ Manpages: Online resources: include::SITES[] - -Other git repository browsers: - - - gitk(1) - - qgit(1)