![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
diff --git a/manual.txt b/manual.txt
index a199ad15ce73d8dddbb48dc78d2c5dad41456cff..c9b18932fd98705bff238aa1af9b897094f6a16d 100644 (file)
--- a/manual.txt
+++ b/manual.txt
+ifndef::doctype-manpage[]
The tig Manual
==============
Jonas Fonseca <fonseca@diku.dk>
+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
`--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 <<refspec, "Specifying revisions">> section below for an introduction
-to revision options supported by the git commands. For details on specific git
+See the section on <<refspec, specifying revisions>> 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.
-
-[[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
----------
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
~~~~~
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.
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 <<env-variables, environment variables>> as well as the
+<<external-commands, external commands>>. 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<m,75<"]
+|=============================================================================
+|%(head) |The currently viewed 'head' ID. Defaults to HEAD
+|%(commit) |The currently selected commit ID.
+|%(blob) |The currently selected blob ID.
+|%(branch) |The currently selected branch name.
+|%(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.
+|%(revargs) |The revision arguments passed on the command line.
+|%(fileargs) |The file arguments passed on the command line.
+|%(diffargs) |The diff options passed on the command line.
+|=============================================================================
[[title-window]]
Title Windows
[main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s
-----------------------------------------------------------------------------
+[[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 what branches gets shown, say limit to only show
+branches named `master` or which starts with the `jf/` prefix, you can
+do it by setting the following variable:
+
+-----------------------------------------------------------------------------
+$ TIG_LS_REMOTE="git ls-remote . master jf/*" 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). Defaults
+ to:
+-----------------------------------------------------------------------------
+git ls-remote .
+-----------------------------------------------------------------------------
+
+--
+
+[[diff-options]]
+Diff options
+~~~~~~~~~~~~
+
+It is possible to alter how diffs are shown by the diff view. If for example
+you prefer to have commit and author dates shown as relative dates, use:
+
+-----------------------------------------------------------------------------
+$ TIG_DIFF_OPTS="--relative-date" tig
+-----------------------------------------------------------------------------
+
+Or set the variable permanently in your environment.
+
[[keys]]
Default Keybindings
-------------------
View Switching
~~~~~~~~~~~~~~
-`-------`--------------------------------------------------------------------
-Key Action
------------------------------------------------------------------------------
-m Switch to main view.
-d Switch to diff view.
-l Switch to log view.
-p Switch to pager view.
-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
------------------------------------------------------------------------------
+[frame="none",grid="none",cols="2<,8<",options="header"]
+|=============================================================================
+|Key |Action
+|m |Switch to main view.
+|d |Switch to diff view.
+|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 branch view.
+|h |Switch to help view
+|S |Switch to status view
+|c |Switch to stage view
+|=============================================================================
[[view-manipulation]]
View Manipulation
~~~~~~~~~~~~~~~~~
-`-------`--------------------------------------------------------------------
-Key Action
------------------------------------------------------------------------------
-q Close view, if multiple views are open it will jump back to the \
- previous view in the view stack. If it is the last open view it \
+[frame="none",grid="none",cols="2<,8<",options="header"]
+|=============================================================================
+|Key |Action
+|q |Close view, if multiple views are open it will jump back to the
+ previous view in the view stack. If it is the last open view it
will quit. Use 'Q' to quit all views at once.
-Enter This key is "context sensitive" depending on what view you are \
- currently in. When in log view on a commit line or in the main \
- view, split the view and show the commit diff. In the diff view \
+|Enter |This key is "context sensitive" depending on what view you are
+ currently in. When in log view on a commit line or in the main
+ 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, 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 \
+|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
+ the previous commit in the main view and update the diff view
to display it.
-Down Similar to 'Up' but will move down.
------------------------------------------------------------------------------
+|Down |Similar to 'Up' but will move down.
+|, |Move to parent. In the tree view, this means switch to the parent
+ directory. In the blame view it will load blame for the parent
+ commit. For merges the parent is queried.
+|=============================================================================
+
+[[view-actions]]
+View Specific Actions
+~~~~~~~~~~~~~~~~~~~~~
+
+[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 <filename>). 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.
-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 <filename>). 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.
------------------------------------------------------------------------------
+[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 `:<linenumber>`, 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
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 <<history-commands, "History commands">> section.
+in this section. For example, by configuring the environment variable
+described in the section on <<diff-options, diff options>>.
[[path-limiting]]
Limit by Path Name
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
~~~~~~~~~~~~~~~~~~~~~~~
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
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
remote branch, using:
-----------------------------------------------------------------------------
-$ tig log origin..HEAD
+$ tig origin..HEAD
-----------------------------------------------------------------------------
will list what will be pushed to the remote branch. Optionally, the ending
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
under the Documentation/ directory."
-----------------------------------------------------------------------------
-$ tig -- --since=1.month -n20 -- Documentation/
+$ tig --since=1.month -n20 -- Documentation/
-----------------------------------------------------------------------------
[[refspec-all]]
accomplished using:
-----------------------------------------------------------------------------
-$ tig -- --all --since=1.week -- Makefile
+$ tig --all --since=1.week -- Makefile
-----------------------------------------------------------------------------
include::BUGS[]
Copyright
---------
-Copyright (c) 2006-2007 Jonas Fonseca <fonseca@diku.dk>
+Copyright (c) 2006-2010 Jonas Fonseca <fonseca@diku.dk>
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
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)