1 tig(1)
2 ======
4 NAME
5 ----
6 tig - text-mode interface for git
8 SYNOPSIS
9 --------
10 [verse]
11 tig [options] [revisions] [--] [paths]
12 tig show [options] [revisions] [--] [paths]
13 tig blame [rev] path
14 tig status
15 tig < [git command output]
17 DESCRIPTION
18 -----------
19 Browse changes in a git repository. Additionally, tig(1) can also act
20 as a pager for output of various git commands.
22 When browsing repositories, tig(1) uses the underlying git commands
23 to present the user with various views, such as summarized commit log
24 and showing the commit with the log message, diffstat, and the diff.
26 Using tig(1) as a pager, it will display input from stdin and try
27 to colorize it.
29 OPTIONS
30 -------
32 Command line options recognized by tig include all valid git-log(1) and
33 git-diff(1) options, as well as the following subcommands and tig specific
34 options. The first command line parameter not starting with "-" is interpreted
35 as being either a revision specification or a path and will end the option
36 parsing. All following options will be passed untouched to the underlying git
37 command.
39 show::
40 Open diff view using the given git show options.
42 blame::
43 Show given file annotated or blamed by commits.
44 Optionally limited from given revision.
46 status::
47 Start up in status view.
49 -v, --version::
50 Show version and exit.
52 -h, --help::
53 Show help message and exit.
55 EXAMPLES
56 --------
58 Display the current branch:
59 -----------------------------------------------------------------------------
60 $ tig
61 -----------------------------------------------------------------------------
63 Display one or more specific branches:
64 -----------------------------------------------------------------------------
65 $ tig test master
66 -----------------------------------------------------------------------------
68 Display all branches:
69 -----------------------------------------------------------------------------
70 $ tig --all
71 -----------------------------------------------------------------------------
73 Display differences between two branches:
74 -----------------------------------------------------------------------------
75 $ tig test..master
76 -----------------------------------------------------------------------------
78 Display changes for a single file:
79 -----------------------------------------------------------------------------
80 $ tig -- README
81 -----------------------------------------------------------------------------
83 Display contents of the README file in a specific revision:
84 -----------------------------------------------------------------------------
85 $ tig show tig-0.8:README
86 -----------------------------------------------------------------------------
88 Display revisions between two dates for a specific file:
89 -----------------------------------------------------------------------------
90 $ tig --after="2004-01-01" --before="2006-05-16" -- README
91 -----------------------------------------------------------------------------
93 ENVIRONMENT VARIABLES
94 ---------------------
96 In addition to environment variables used by git (e.g. GIT_DIR), tig defines
97 the ones below. The command related environment variables have access to the
98 internal state of tig via replacement variables, such as `%(commit)` and
99 `%(blob)`. See manpage:tigrc[5] for a full list.
101 TIGRC_USER::
102 Path of the user configuration file (defaults to `~/.tigrc`).
104 TIGRC_SYSTEM::
105 Path of the system wide configuration file (defaults to
106 `{sysconfdir}/tigrc`).
108 TIG_LS_REMOTE::
109 Set command for retrieving all repository references. The command
110 should output data in the same format as git-ls-remote(1).
112 TIG_DIFF_OPTS::
113 The diff options to use in the diff view. The diff view uses
114 git-show(1) for formatting and always passes --patch-with-stat,
115 --find-copies-harder, and -C.
117 FILES
118 -----
119 '~/.tigrc'::
120 User configuration file. See manpage:tigrc[5] for examples.
122 '{sysconfdir}/tigrc'::
123 System wide configuration file.
125 '$GIT_DIR/config'::
126 '~/.gitconfig::
127 '{sysconfdir}/etc/gitconfig::
128 Git configuration files. Read on start-up with the help of
129 git-config(1).
131 include::BUGS[]
133 COPYRIGHT
134 ---------
135 Copyright (c) 2006-2010 Jonas Fonseca <fonseca@diku.dk>
137 This program is free software; you can redistribute it and/or modify
138 it under the terms of the GNU General Public License as published by
139 the Free Software Foundation; either version 2 of the License, or
140 (at your option) any later version.
142 SEE ALSO
143 --------
145 manpage:tigrc[5], manpage:tigmanual[7], git(7), gitk(1)
147 Online resources:
149 include::SITES[]