Merge with master

[tig] / tig.1

.\"Generated by db2man.xsl. Don't modify this, modify the source.
.de Sh \" Subsection
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.TH "TIG" 1 "" "" ""
.SH NAME
tig \- text-mode interface for git
.SH "SYNOPSIS"

.nf
tig [options]
tig [options] [\-\-] [git log options]
tig [options] log  [git log options]
tig [options] diff [git diff options]
tig [options] show [git show options]
tig [options] <    [git command output]
.fi

.SH "DESCRIPTION"


Browse changes in a git repository\&. Additionally, tig(1) can also act as a pager for output of various git commands\&.


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\&.


Using tig(1) as a pager, it will display input from stdin and try to colorize it\&.

.SH "OPTIONS"

.TP
\-l
Start up in log view using the internal log command\&.

.TP
\-d
Start up in diff view using the internal diff command\&.

.TP
\-n[INTERVAL], \-\-line\-number[=INTERVAL]
Prefix line numbers in log and diff view\&. Optionally, with interval different than each line\&.

.TP
\-b[NSPACES], \-\-tab\-size[=NSPACES]
Set the number of spaces tabs should be expanded to\&.

.TP
\-v, \-\-version
Show version and exit\&.

.TP
\-h, \-\-help
Show help message and exit\&.

.TP
\-\-
End of tig(1) options\&. Useful when specifying command options for the main view\&. Example:

.nf
$ tig \-\- \-\-since=1\&.month
.fi

.TP
log [git log options]
Open log view using the given git log options\&.

.TP
diff [git diff options]
Open diff view using the given git diff options\&.

.TP
show [git show options]
Open diff view using the given git show options\&.

.TP
[git log options]
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:

.nf
$ tig tag\-1\&.0\&.\&.HEAD
.fi

.SH "ENVIRONMENT VARIABLES"

.TP
TIG_LS_REMOTE
Set command for retrieving all repository references\&. The command should output data in the same format as git\-ls\-remote(1)\&.

.TP
TIG_DIFF_CMD
The command used for the diff view\&. By default, git show is used as a backend\&.

.TP
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\&.

.TP
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\&.

.SH "FILES"

.TP
\fI~/\&.tigrc\fR
User configuration file\&. See tigrc(5) for examples\&.

.TP
\fI\&.git/config\fR
Repository config file\&. Read on startup with the help of git\-repo\-config(1)\&.

.SH "BUGS"


Known bugs and problems:

.TP 3
\(bu
In it's current state tig is pretty much UTF\-8 only\&.
.TP
\(bu
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\&.
.TP
\(bu
The cursor can wrap\-around on the last line and cause the window to scroll\&.
.TP
\(bu
The prompt doesn't work while loading\&.
.LP

.SH "COPYRIGHT"


Copyright (c) 2006 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 the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&.

.SH "SEE ALSO"

.TP 3
\(bu
 git(7): \fIhttp://www.kernel.org/pub/software/scm/git/docs/\fR,
.TP
\(bu
 cogito(7): \fIhttp://www.kernel.org/pub/software/scm/cogito/docs/\fR 
.LP


Other git repository browsers:

.TP 3
\(bu
gitk(1)
.TP
\(bu
qgit(1)
.TP
\(bu
gitview(1)
.LP


Sites:

.TP 3
\(bu
Homepage: http://jonas\&.nitro\&.dk/tig: \fIhttp://jonas.nitro.dk/tig\fR 
.TP
\(bu
Releases: http://jonas\&.nitro\&.dk/tig/releases: \fIhttp://jonas.nitro.dk/tig/releases\fR 
.TP
\(bu
Git URL: http://jonas\&.nitro\&.dk/tig/tig\&.git: \fIhttp://jonas.nitro.dk/tig/tig.git\fR 
.TP
\(bu
Gitweb: http://pasky\&.or\&.cz/gitweb\&.cgi?p=tig\&.git;a=summary: \fIhttp://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary\fR 
.LP