Reformat the state variable list (opt_*)
[tig] / tig.1.txt
CommitLineData
8eb62770
JF
1TIG(1)
2======
3
4NAME
5----
6tig - text-mode interface for git
7
8SYNOPSIS
9--------
10[verse]
11tig [options]
12tig [options] [--] [git log options]
13tig [options] log [git log options]
14tig [options] diff [git diff options]
15tig [options] show [git show options]
16tig [options] < [git command output]
17
18DESCRIPTION
19-----------
20Browse changes in a git repository. Additionally, tig(1) can also act
21as a pager for output of various git commands.
22
23When browsing repositories, tig(1) uses the underlying git commands
24to present the user with various views, such as summarized commit log
25and showing the commit with the log message, diffstat, and the diff.
26
27Using tig(1) as a pager, it will display input from stdin and try
28to colorize it.
29
30OPTIONS
31-------
32
33-l::
34 Start up in log view using the internal log command.
35
36-d::
37 Start up in diff view using the internal diff command.
38
39-n[INTERVAL], --line-number[=INTERVAL]::
40 Prefix line numbers in log and diff view.
41 Optionally, with interval different than each line.
42
43-b[NSPACES], --tab-size[=NSPACES]::
44 Set the number of spaces tabs should be expanded to.
45
46-v, --version::
47 Show version and exit.
48
49-h, --help::
50 Show help message and exit.
51
52\--::
53 End of tig(1) options. Useful when specifying command
54 options for the main view. Example:
55
56 $ tig -- --since=1.month
57
58log [git log options]::
59 Open log view using the given git log options.
60
61diff [git diff options]::
62 Open diff view using the given git diff options.
63
64show [git show options]::
65 Open diff view using the given git show options.
66
67[git log options]::
68 tig(1) will stop the option parsing when the first
69 command line parameter not starting with "-" is
70 encountered. All options including this one will be
71 passed to git log when loading the main view.
72 This makes it possible to say:
73
74 $ tig tag-1.0..HEAD
75
76ENVIRONMENT VARIABLES
77---------------------
78TIG_LS_REMOTE::
79 Set command for retrieving all repository references. The command
80 should output data in the same format as git-ls-remote(1).
81
82TIG_DIFF_CMD::
83 The command used for the diff view. By default, git show is used
84 as a backend.
85
86TIG_LOG_CMD::
87 The command used for the log view. If you prefer to have both
88 author and committer shown in the log view be sure to pass
89 `--pretty=fuller` to git log.
90
91TIG_MAIN_CMD::
92 The command used for the main view. Note, you must always specify
93 the option: `--pretty=raw` since the main view parser expects to
94 read that format.
95
96FILES
97-----
98'~/.tigrc'::
511147de 99 User configuration file. See gitlink:tigrc[5] for examples.
8eb62770
JF
100
101'.git/config'::
102 Repository config file. Read on startup with the help of
103 git-repo-config(1).
104
105include::BUGS[]
106
107COPYRIGHT
108---------
109Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
110
111This program is free software; you can redistribute it and/or modify
112it under the terms of the GNU General Public License as published by
113the Free Software Foundation; either version 2 of the License, or
114(at your option) any later version.
115
116SEE ALSO
117--------
511147de 118
e664e260
JF
119gitlink:tigrc[5], git(7), cogito(7), as well as other git repository browsers:
120gitk(1), qgit(1), gitview(1).
8eb62770 121
e664e260 122Online resources:
8eb62770
JF
123
124include::SITES[]