X-Git-Url: https://git.tokkee.org/?p=tig.git;a=blobdiff_plain;f=manual.txt;h=ffea349d2537fa66f80f914c4e57473db63f64b1;hp=637b85c1883f2ca7c08ad1e994ad4b3e072b587b;hb=8869ebf96178755c9c88e011db35048b93647ae2;hpb=9783cb122811aef23966400e91cdab30108fc540 diff --git a/manual.txt b/manual.txt index 637b85c..ffea349 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 @@ -12,6 +14,8 @@ the user with various views, such as summarized commit log and showing the commit with the log message, diffstat, and the diff. ifndef::backend-docbook[] +*Table of Contents* + include::manual.toc[] endif::backend-docbook[] @@ -45,79 +49,17 @@ 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 -to revision options supported by the git commands. For details on specific git +See the section on <> for an introduction to +revision options supported by the git commands. For details on specific git command options, refer to the man page of the command in question. -[[env-variables]] -Environment Variables ---------------------- - -Several options related to the interface with git can be configured via -environment options. - -[[repo-refs]] -Repository References -~~~~~~~~~~~~~~~~~~~~~ - -Commits that are referenced by tags and branch heads will be marked by the -reference name surrounded by '[' and ']': - ------------------------------------------------------------------------------ -2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1 ------------------------------------------------------------------------------ - -If you want to filter out certain directories under `.git/refs/`, say `tmp` -you can do it by setting the following variable: - ------------------------------------------------------------------------------ -$ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig ------------------------------------------------------------------------------ - -Or set the variable permanently in your environment. - -TIG_LS_REMOTE:: - Set command for retrieving all repository references. The command - should output data in the same format as git-ls-remote(1). - -[[history-commands]] -History Commands -~~~~~~~~~~~~~~~~ - -It is possible to alter which commands are used for the different views. If -for example you prefer commits in the main view to be sorted by date and only -show 500 commits, use: - ------------------------------------------------------------------------------ -$ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig ------------------------------------------------------------------------------ - -Or set the variable permanently in your environment. - -Notice, how `%s` is used to specify the commit reference. There can be a -maximum of 5 `%s` ref specifications. - -TIG_DIFF_CMD:: - The command used for the diff view. By default, git show is used - as a backend. - -TIG_LOG_CMD:: - The command used for the log view. If you prefer to have both - author and committer shown in the log view be sure to pass - `--pretty=fuller` to git log. - -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. - [[viewer]] The Viewer ---------- @@ -137,18 +79,6 @@ You will split the view so that the log view is displayed in the top window 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'. -[[commit-id]] -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 -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 -revision to show history. - [[views]] Views ~~~~~ @@ -171,12 +101,67 @@ 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 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. + +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. The help view:: - Displays key binding quick reference. + Displays a quick reference of key bindings. + +[[commit-id]] +Browsing State and User-defined Commands +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +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 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 revision to show history. + +Some of the commands used or provided by tig can be configured. This goes for +some of the <> as well as the +<>. These user-defined commands can use +arguments that refer to the current browsing state by using one of the +following variables. + +.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. +|============================================================================= [[cursor-nav]] Cursor Navigation ~~~~~~~~~~~~~~~~~ -j:: - Move cursor one line up. -k:: - Move cursor one line down. -PgUp:: -b:: --:: - 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 ~~~~~~~~~ -Insert:: - Scroll view one line up. -Delete:: - Scroll view one line down. -w:: - Scroll view one page up. -s:: - Scroll view one page down. + +[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 +~~~~~~~~~ + +[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 ~~~~ -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. -n:: - 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 + +[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. +|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 +~~~~~~~~~~~~~~~~~ + +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 built-in external commands: + +[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 @@ -299,13 +416,13 @@ 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). 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. +in this section. For example, by configuring the environment variable +described in the section on <>. [[path-limiting]] Limit by Path Name @@ -315,22 +432,18 @@ 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 -specify two "\--" options. The first will make tig stop option processing -and the latter will be passed to git log. - [[date-number-limiting]] Limit by Date or Number ~~~~~~~~~~~~~~~~~~~~~~~ @@ -343,7 +456,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 @@ -357,7 +470,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 @@ -365,7 +478,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 @@ -384,7 +497,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 @@ -399,7 +512,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]] @@ -412,7 +525,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[] @@ -421,7 +534,7 @@ include::BUGS[] Copyright --------- -Copyright (c) 2006 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 @@ -434,20 +547,9 @@ References and Related Tools Manpages: - - gitlink:tig[1] - - gitlink:tigrc[5] + - manpage:tig[1] + - manpage:tigrc[5] Online resources: include::SITES[] - -Git porcelains: - - - link:http://www.kernel.org/pub/software/scm/git/docs/[git], - - link:http://www.kernel.org/pub/software/scm/cogito/docs/[Cogito] - -Other git repository browsers: - - - gitk(1) - - qgit(1) - - gitview(1)