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