X-Git-Url: https://git.tokkee.org/?p=tig.git;a=blobdiff_plain;f=manual.txt;h=c9b18932fd98705bff238aa1af9b897094f6a16d;hp=f157a09f23e225ce9867e70a71eb5f698529cb28;hb=43fec2264a6cdffc083123ef412d79c95ec44371;hpb=fd73e841d9db03eaddd929bd084adbffaafbc3c2 diff --git a/manual.txt b/manual.txt index f157a09..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 @@ -54,100 +56,10 @@ information: $ 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. - -[[configuration-files]] -Configuration Files -~~~~~~~~~~~~~~~~~~~ - -Upon startup, tig first reads the system wide configuration file -(`{sysconfdir}/tigrc` by default) and then proceeds to read the user's -configuration file (`~/.tigrc` by default). The paths to either of these files -can be overridden through the following environment variables: - -TIGRC_USER:: - Path of the user configuration file. - -TIGRC_SYSTEM:: - Path of the system wide configuration file. - -[[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. - -[[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 ---------- @@ -167,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 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. - [[views]] Views ~~~~~ @@ -213,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. @@ -226,7 +129,39 @@ The pager view:: 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 ~~~~~~~~~~~~~~~~~ -`-------`-------------------------------------------------------------------- -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. ------------------------------------------------------------------------------ +[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 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. ------------------------------------------------------------------------------ +[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` -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). -@ Move to next chunk in the stage view. -',' Move tree view to the parent tree. -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 ~~~~~~~~~~~~~~~~~ -Tig also comes with a few builtin external commands. These are simple shell -commands that are run and can take arguments from the current browsing state, -such as the current commit ID. The default commands are: +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: -`-------`-------------------------------------------------------------------- -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 @@ -397,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. +in this section. For example, by configuring the environment variable +described in the section on <>. [[path-limiting]] Limit by Path Name @@ -412,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: @@ -420,10 +445,6 @@ thus you will have to use: $ 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 ~~~~~~~~~~~~~~~~~~~~~~~ @@ -514,7 +535,7 @@ include::BUGS[] Copyright --------- -Copyright (c) 2006-2008 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 @@ -527,15 +548,9 @@ References and Related Tools Manpages: - - gitlink:tig[1] - - gitlink:tigrc[5] + - manpage:tig[1] + - manpage:tigrc[5] Online resources: include::SITES[] - -Other git repository browsers: - - - gitk(1) - - qgit(1) - - gitview(1)