Fix pager mode by always doing the isatty()
[tig] / tig.1.txt
CommitLineData
c3c24b0b 1tig(1)
8eb62770
JF
2======
3
4NAME
5----
6tig - text-mode interface for git
7
8SYNOPSIS
9--------
10[verse]
77452abc
JF
11tig [options] [revisions] [--] [paths]
12tig show [options] [revisions] [--] [paths]
8a680988 13tig blame [rev] path
77452abc
JF
14tig status
15tig < [git command output]
8eb62770
JF
16
17DESCRIPTION
18-----------
19Browse changes in a git repository. Additionally, tig(1) can also act
20as a pager for output of various git commands.
21
22When browsing repositories, tig(1) uses the underlying git commands
23to present the user with various views, such as summarized commit log
24and showing the commit with the log message, diffstat, and the diff.
25
26Using tig(1) as a pager, it will display input from stdin and try
27to colorize it.
28
29OPTIONS
30-------
31
77452abc
JF
32Command line options recognized by tig include all valid git-log(1) and
33git-diff(1) options, as well as the following subcommands and tig specific
34options. The first command line parameter not starting with "-" is interpreted
35as being either a revision specification or a path and will end the option
36parsing. All following options will be passed untouched to the underlying git
37command.
8eb62770 38
77452abc
JF
39show::
40 Open diff view using the given git show options.
8eb62770 41
8a680988
JF
42blame::
43 Show given file annotated or blamed by commits.
44 Optionally limited from given revision.
45
77452abc 46status::
173d76ea
JF
47 Start up in status view.
48
8eb62770
JF
49-v, --version::
50 Show version and exit.
51
52-h, --help::
53 Show help message and exit.
54
d3e4750b
DV
55EXAMPLES
56--------
57
58Display the current branch:
59-----------------------------------------------------------------------------
60$ tig
61-----------------------------------------------------------------------------
62
63Display one or more specific branches:
64-----------------------------------------------------------------------------
65$ tig test master
66-----------------------------------------------------------------------------
67
68Display all branches:
69-----------------------------------------------------------------------------
77452abc 70$ tig --all
d3e4750b
DV
71-----------------------------------------------------------------------------
72
73Display differences between two branches:
74-----------------------------------------------------------------------------
75$ tig test..master
76-----------------------------------------------------------------------------
77
78Display changes for a single file:
79-----------------------------------------------------------------------------
80$ tig -- README
81-----------------------------------------------------------------------------
82
77452abc
JF
83Display contents of the README file in a specific revision:
84-----------------------------------------------------------------------------
85$ tig show tig-0.8:README
86-----------------------------------------------------------------------------
87
d3e4750b
DV
88Display revisions between two dates for a specific file:
89-----------------------------------------------------------------------------
77452abc 90$ tig --after="2004-01-01" --before="2006-05-16" -- README
d3e4750b
DV
91-----------------------------------------------------------------------------
92
8eb62770
JF
93ENVIRONMENT VARIABLES
94---------------------
c3c24b0b
JF
95
96In addition to environment variables used by git (e.g. GIT_DIR), tig defines
97the following:
98
b6607e7e
DV
99TIGRC_USER::
100 Path of the user configuration file (defaults to `~/.tigrc`).
101
102TIGRC_SYSTEM::
103 Path of the system wide configuration file (defaults to
104 `{sysconfdir}/tigrc`).
105
8eb62770
JF
106TIG_LS_REMOTE::
107 Set command for retrieving all repository references. The command
108 should output data in the same format as git-ls-remote(1).
109
110TIG_DIFF_CMD::
111 The command used for the diff view. By default, git show is used
112 as a backend.
113
114TIG_LOG_CMD::
115 The command used for the log view. If you prefer to have both
116 author and committer shown in the log view be sure to pass
117 `--pretty=fuller` to git log.
118
119TIG_MAIN_CMD::
120 The command used for the main view. Note, you must always specify
121 the option: `--pretty=raw` since the main view parser expects to
122 read that format.
123
e733ee54
JF
124Tree commands
125~~~~~~~~~~~~~
126TIG_TREE_CMD::
127 The command used for the tree view. By default, git-ls-tree(1) is
128 used. The commands should expect first the commit ID and second
129 a path.
598b9e7d 130
e733ee54
JF
131TIG_BLOB_CMD::
132 The command used for the blob view. By default, git-cat-file(1) is
133 used. The command gets the blob ID.
134
8eb62770
JF
135FILES
136-----
137'~/.tigrc'::
511147de 138 User configuration file. See gitlink:tigrc[5] for examples.
8eb62770 139
b6607e7e
DV
140'{sysconfdir}/tigrc'::
141 System wide configuration file.
142
c3c24b0b 143'$GIT_DIR/config'::
f7ffec06 144 Repository config file. Read on start-up with the help of
c3c24b0b 145 git-config(1).
8eb62770
JF
146
147include::BUGS[]
148
149COPYRIGHT
150---------
8a680988 151Copyright (c) 2006-2008 Jonas Fonseca <fonseca@diku.dk>
8eb62770
JF
152
153This program is free software; you can redistribute it and/or modify
154it under the terms of the GNU General Public License as published by
155the Free Software Foundation; either version 2 of the License, or
156(at your option) any later version.
157
158SEE ALSO
159--------
511147de 160
e664e260
JF
161gitlink:tigrc[5], git(7), cogito(7), as well as other git repository browsers:
162gitk(1), qgit(1), gitview(1).
8eb62770 163
e664e260 164Online resources:
8eb62770
JF
165
166include::SITES[]