1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
10 .de Sp \" Vertical space (when we can't use .PP)
16 .ie \\n(.$>=3 .ne \\$3
22 tig \- text-mode interface for git
27 tig [options] [\-\-] [git log options]
28 tig [options] log [git log options]
29 tig [options] diff [git diff options]
30 tig [options] show [git show options]
31 tig [options] < [git command output]
37 Browse changes in a git repository\&. Additionally, tig(1) can also act as a pager for output of various git commands\&.
40 When browsing repositories, tig(1) uses the underlying git commands to present the user with various views, such as summarized commit log and showing the commit with the log message, diffstat, and the diff\&.
43 Using tig(1) as a pager, it will display input from stdin and try to colorize it\&.
49 Start up in log view using the internal log command\&.
53 Start up in diff view using the internal diff command\&.
56 \-n[INTERVAL], \-\-line\-number[=INTERVAL]
57 Prefix line numbers in log and diff view\&. Optionally, with interval different than each line\&.
60 \-t[NSPACES], \-\-tab\-size[=NSPACES]
61 Set the number of spaces tabs should be expanded to\&.
65 Show version and exit\&.
69 Show help message and exit\&.
73 End of tig(1) options\&. Useful when specifying command options for the main view\&. Example:
76 $ tig \-\- \-\-since=1\&.month
81 Open log view using the given git log options\&.
84 diff [git diff options]
85 Open diff view using the given git diff options\&.
88 show [git show options]
89 Open diff view using the given git show options\&.
93 tig(1) will stop the option parsing when the first command line parameter not starting with "\-" is encountered\&. All options including this one will be passed to git log when loading the main view\&. This makes it possible to say:
96 $ tig tag\-1\&.0\&.\&.HEAD
102 If stdin is a pipe, any log or diff options will be ignored and the pager view will be opened loading data from stdin\&. The pager mode can be used for colorizing output from various git commands\&.
105 Example on how to colorize the output of git\-show(1):
111 .SS "Git command options"
114 All git command options specified on the command line will be passed to the given command and all will be shell quoted before they are passed to the shell\&.
120 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\&.
125 Example on how to open the log view and show both author and committer information:
128 $ tig log \-\-pretty=fuller
132 See the "Specifying revisions" section below 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\&.
134 .SH "ENVIRONMENT VARIABLES"
137 Several options related to the interface with git can be configured via environment options\&.
139 .SS "Repository references"
142 Commits that are referenced by tags and branch heads will be marked by the reference name surrounded by \fI[\fR and \fI]\fR:
145 2006\-03\-26 19:42 Petr Baudis | [cogito\-0\&.17\&.1] Cogito 0\&.17\&.1
149 If you want to filter out certain directories under \&.git/refs/, say tmp you can do it by setting the following variable:
152 $ TIG_LS_REMOTE="git ls\-remote \&. | sed /\\/tmp\\//d" tig
156 Or set the variable permanently in your environment\&.
160 Set command for retrieving all repository references\&. The command should output data in the same format as git\-ls\-remote(1)\&.
165 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:
168 $ TIG_MAIN_CMD="git log \-\-date\-order \-n500 \-\-pretty=raw %s" tig
172 Or set the variable permanently in your environment\&.
175 Notice, how %s is used to specify the commit reference\&. There can be a maximum of 5 %s ref specifications\&.
179 The command used for the diff view\&. By default, git show is used as a backend\&.
183 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\&.
187 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\&.
192 The display consists of a status window on the last line of the screen and one or more views\&. The default is to only show one view at the time but it is possible to split both the main and log view to also show the commit diff\&.
195 If you are in the log view and press \fIEnter\fR when the current line is a commit line, such as:
198 commit 4d55caff4cc89335192f3e566004b4ceef572521
202 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 \fITab\fR\&. To maximize the log view again, simply press \fIl\fR\&.
204 .SS "Current head and commit ID"
207 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\&.
210 The head ID is used when opening the main and log view to indicate from what revision to show history\&.
215 tig(1) presents various \fIviews\fR of a repository\&. Each view is based on output from an external command, most often \fIgit log\fR, \fIgit diff\fR, or \fIgit show\fR\&.
219 Is the default view, and it shows a one line summary of each commit in the chosen list of revisions\&. The summary includes commit date, author, and the first line of the log message\&. Additionally, any repository references, such as tags, will be shown\&.
223 Presents a more rich view of the revision log showing the whole log message and the diffstat\&.
227 Shows either the diff of the current working tree, that is, what has changed since the last commit, or the commit diff complete with log message, diffstat and diff\&.
231 Is used for displaying both input from stdin and output from git commands entered in the internal prompt\&.
235 Displays the information from the tig(1) man page\&. For the help view to work you need to have the tig(1) man page installed\&.
240 Each view has a title window which shows the name of the view, current commit ID if available, and where the view is positioned:
243 [main] c622eefaa485995320bc743431bae0d497b1d875 \- commit 1 of 61 (1%)
247 By default, the title of the current view is highlighted using bold font\&.
252 Below the default key bindings are shown\&.
258 Switch to main view\&.
262 Switch to diff view\&.
266 Switch to log view\&.
270 Switch to pager view\&.
276 .SS "View manipulation"
280 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 \fIQ\fR to quit all views at once\&.
284 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\&.
288 Switch to next view\&.
292 This key is "context sensitive" and will move the cursor one line up\&. However, uf 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\&.
296 Similar to \fIUp\fR but will move down\&.
298 .SS "Cursor navigation"
302 Move cursor one line up\&.
306 Move cursor one line down\&.
310 Move cursor one page up\&.
314 Move cursor one page down\&.
318 Jump to first line\&.
328 Scroll view one line up\&.
332 Scroll view one line down\&.
336 Scroll view one page up\&.
340 Scroll view one page down\&.
354 Stop all background loading\&. This can be useful if you use tig(1) in a repository with a long history without limiting the revision log\&.
362 Toggle line numbers on/off\&.
366 Open prompt\&. This allows you to specify what git command to run\&. Example:
372 .SH "REVISION SPECIFICATION"
375 This section describes various ways to specify what revisions to display or otherwise limit the view to\&. tig(1) does not itself parse the described revision options so refer to the relevant git man pages for futher information\&. Relevant man pages besides git\-log(1) are git\-diff(1) and git\-rev\-list(1)\&.
378 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 "View commands" section\&.
380 .SS "Limit by path name"
383 If you are interested only in those revisions that made changes to a specific file (or even several files) list the files like this:
386 $ tig log Makefile README
390 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 \fImaster\fR it will clash with the reference named \fImaster\fR, and thus you will have to use:
393 $ tig log \-\- master
400 For the main view, avoiding ambiguity will in some cases require you to specify two "\-\-" options\&. The first will make tig(1) stop option processing and the latter will be passed to git log\&.
404 .SS "Limit by date or number"
407 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\&.
410 If you are only interested in changed that happened between two dates you can use:
413 $ tig \-\- \-\-after="May 5th" \-\-before="2006\-05\-16 15:44"
420 If you want to avoid having to quote dates containing spaces you can use "\&." instead, e\&.g\&. \-\-after=May\&.5th\&.
424 .SS "Limiting by commit ranges"
427 Alternatively, commits can be limited to a specific range, such as "all commits between \fItag\-1\&.0\fR and \fItag\-2\&.0\fR"\&. For example:
430 $ tig log tag\-1\&.0\&.\&.tag\-2\&.0
434 This way of commit limiting makes it trivial to only browse the commits which haven't been pushed to a remote branch\&. Assuming \fIorigin\fR is your upstream remote branch, using:
437 $ tig log origin\&.\&.HEAD
441 will list what will be pushed to the remote branch\&. Optionally, the ending \fIHEAD\fR can be left out since it is implied\&.
443 .SS "Limiting by reachability"
446 Git interprets the range specifier "tag\-1\&.0\&.\&.tag\-2\&.0" as "all commits reachable from \fItag\-2\&.0\fR but not from \fItag\-1\&.0\fR"\&. Where reachability refers to what commits are ancestors (or part of the history) of the branch or tagged revision in question\&.
449 If you prefer to specify which commit to preview in this way use the following:
452 $ tig log tag\-2\&.0 ^tag\-1\&.0
456 You can think of \fI^\fR as a negation operator\&. Using this alternate syntax, it is possible to further prune commits by specifying multiple branch cut offs\&.
458 .SS "Combining revisions specification"
461 Revisions options can to some degree be combined, which makes it possible to say "show at most 20 commits from within the last month that changed files under the Documentation/ directory\&."
464 $ tig \-\- \-\-since=1\&.month \-n20 \-\- Documentation/
467 .SS "Examining all repository references"
470 In some cases, it can be useful to query changes across all references in a repository\&. An example is to ask "did any line of development in this repository change a particular file within the last week"\&. This can be accomplished using:
473 $ tig \-\- \-\-all \-\-since=1\&.week \-\- Makefile
479 Known bugs and problems:
483 In it's current state tig is pretty much UTF\-8 only\&.
486 If the screen width is very small the main view can draw outside the current view causing bad wrapping\&. Same goes for title and status windows\&.
492 Features that should be explored\&.
505 Copyright (c) Jonas Fonseca <fonseca@diku\&.dk>, 2006
508 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 the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&.
513 git(7): \fIhttp://www.kernel.org/pub/software/scm/git/docs/\fR,
514 cogito(7): \fIhttp://www.kernel.org/pub/software/scm/cogito/docs/\fR
515 gitk(1): git repository browser written using tcl/tk,
516 qgit(1): git repository browser written using c++/Qt,
517 gitview(1): git repository browser written using python/gtk\&.