Support cherry-picking commits in main view to current branch
[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]
a389e944
JF
12tig [options] [--] [git options]
13tig [options] log [git options]
14tig [options] diff [git options]
15tig [options] show [git options]
8eb62770
JF
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
173d76ea
JF
39-S::
40 Start up in status view.
41
8eb62770
JF
42-n[INTERVAL], --line-number[=INTERVAL]::
43 Prefix line numbers in log and diff view.
44 Optionally, with interval different than each line.
45
46-b[NSPACES], --tab-size[=NSPACES]::
47 Set the number of spaces tabs should be expanded to.
48
49-v, --version::
50 Show version and exit.
51
52-h, --help::
53 Show help message and exit.
54
55\--::
56 End of tig(1) options. Useful when specifying command
57 options for the main view. Example:
58
59 $ tig -- --since=1.month
60
a389e944 61log::
8eb62770
JF
62 Open log view using the given git log options.
63
a389e944 64diff::
8eb62770
JF
65 Open diff view using the given git diff options.
66
a389e944 67show::
8eb62770
JF
68 Open diff view using the given git show options.
69
a389e944 70[git options]::
8eb62770
JF
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:
76
77 $ tig tag-1.0..HEAD
78
79ENVIRONMENT VARIABLES
80---------------------
81TIG_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).
84
226da94b
JF
85TIG_CHERRY_PICK::
86 Set command for cherry-picking a commit. The command should expect
87 a commit SHA as its final argument.
88
8eb62770
JF
89TIG_DIFF_CMD::
90 The command used for the diff view. By default, git show is used
91 as a backend.
92
93TIG_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.
97
98TIG_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.
102
e733ee54
JF
103Tree commands
104~~~~~~~~~~~~~
105TIG_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.
109
110TIG_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.
113
8eb62770
JF
114FILES
115-----
116'~/.tigrc'::
511147de 117 User configuration file. See gitlink:tigrc[5] for examples.
8eb62770
JF
118
119'.git/config'::
f7ffec06 120 Repository config file. Read on start-up with the help of
8eb62770
JF
121 git-repo-config(1).
122
123include::BUGS[]
124
125COPYRIGHT
126---------
f9a044a4 127Copyright (c) 2006-2007 Jonas Fonseca <fonseca@diku.dk>
8eb62770
JF
128
129This program is free software; you can redistribute it and/or modify
130it under the terms of the GNU General Public License as published by
131the Free Software Foundation; either version 2 of the License, or
132(at your option) any later version.
133
134SEE ALSO
135--------
511147de 136
e664e260
JF
137gitlink:tigrc[5], git(7), cogito(7), as well as other git repository browsers:
138gitk(1), qgit(1), gitview(1).
8eb62770 139
e664e260 140Online resources:
8eb62770
JF
141
142include::SITES[]