f6a13d5d56a520eb0b4c3487551037b4b41e456a
1 ifndef::doctype-manpage[]
2 The tig Manual
3 ==============
4 Jonas Fonseca <fonseca@diku.dk>
5 endif::doctype-manpage[]
7 This is the manual for tig, the ncurses-based text-mode interface for git.
8 Tig allows you to browse changes in a git repository and can additionally act
9 as a pager for output of various git commands. When used as a pager, it will
10 display input from stdin and colorize it.
12 When browsing repositories, tig uses the underlying git commands to present
13 the user with various views, such as summarized commit log and showing the
14 commit with the log message, diffstat, and the diff.
16 ifndef::backend-docbook[]
17 *Table of Contents*
19 include::manual.toc[]
20 endif::backend-docbook[]
22 [[calling-conventions]]
23 Calling Conventions
24 -------------------
26 [[pager-mode]]
27 Pager Mode
28 ~~~~~~~~~~
30 If stdin is a pipe, any log or diff options will be ignored and the pager view
31 will be opened loading data from stdin. The pager mode can be used for
32 colorizing output from various git commands.
34 Example on how to colorize the output of git-show(1):
36 -----------------------------------------------------------------------------
37 $ git show | tig
38 -----------------------------------------------------------------------------
40 [[cmd-options]]
41 Git Command Options
42 ~~~~~~~~~~~~~~~~~~~
44 All git command options specified on the command line will be passed to the
45 given command and all will be shell quoted before they are passed to the
46 shell.
48 NOTE: If you specify options for the main view, you should not use the
49 `--pretty` option as this option will be set automatically to the format
50 expected by the main view.
52 Example on how to view a commit and show both author and committer
53 information:
55 -----------------------------------------------------------------------------
56 $ tig show --pretty=fuller
57 -----------------------------------------------------------------------------
59 See the section on <<refspec, specifying revisions>> for an introduction to
60 revision options supported by the git commands. For details on specific git
61 command options, refer to the man page of the command in question.
63 [[viewer]]
64 The Viewer
65 ----------
67 The display consists of a status window on the last line of the screen and one
68 or more views. The default is to only show one view at the time but it is
69 possible to split both the main and log view to also show the commit diff.
71 If you are in the log view and press 'Enter' when the current line is a commit
72 line, such as:
74 -----------------------------------------------------------------------------
75 commit 4d55caff4cc89335192f3e566004b4ceef572521
76 -----------------------------------------------------------------------------
78 You will split the view so that the log view is displayed in the top window
79 and the diff view in the bottom window. You can switch between the two views
80 by pressing 'Tab'. To maximize the log view again, simply press 'l'.
82 [[views]]
83 Views
84 ~~~~~
86 Various 'views' of a repository is presented. Each view is based on output
87 from an external command, most often 'git log', 'git diff', or 'git show'.
89 The main view::
90 Is the default view, and it shows a one line summary of each commit
91 in the chosen list of revisions. The summary includes commit date,
92 author, and the first line of the log message. Additionally, any
93 repository references, such as tags, will be shown.
95 The log view::
96 Presents a more rich view of the revision log showing the whole log
97 message and the diffstat.
99 The diff view::
100 Shows either the diff of the current working tree, that is, what
101 has changed since the last commit, or the commit diff complete
102 with log message, diffstat and diff.
104 The tree view::
105 Lists directory trees associated with the current revision allowing
106 subdirectories to be descended or ascended and file blobs to be
107 viewed.
109 The blob view::
110 Displays the file content or "blob" of data associated with a file
111 name.
113 The blame view::
114 Displays the file content annotated or blamed by commits.
116 The branch view::
117 Displays the branches in the repository.
119 The status view::
120 Displays status of files in the working tree and allows changes to be
121 staged/unstaged as well as adding of untracked files.
123 The stage view::
124 Displays diff changes for staged or unstanged files being tracked or
125 file content of untracked files.
127 The pager view::
128 Is used for displaying both input from stdin and output from git
129 commands entered in the internal prompt.
131 The help view::
132 Displays a quick reference of key bindings.
134 [[commit-id]]
135 Browsing State and User-defined Commands
136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138 The viewer keeps track of both what head and commit ID you are currently
139 viewing. The commit ID will follow the cursor line and change every time you
140 highlight a different commit. Whenever you reopen the diff view it will be
141 reloaded, if the commit ID changed. The head ID is used when opening the main
142 and log view to indicate from what revision to show history.
144 Some of the commands used or provided by tig can be configured. This goes for
145 some of the <<env-variables, environment variables>> as well as the
146 <<external-commands, external commands>>. These user-defined commands can use
147 arguments that refer to the current browsing state by using one of the
148 following variables.
150 .Browsing state variables
151 [frame="none",grid="none",cols="25<m,75<"]
152 |=============================================================================
153 |%(head) |The currently viewed 'head' ID. Defaults to HEAD
154 |%(commit) |The currently selected commit ID.
155 |%(blob) |The currently selected blob ID.
156 |%(branch) |The currently selected branch name.
157 |%(directory) |The current directory path in the tree view;
158 empty for the root directory.
159 |%(file) |The currently selected file.
160 |%(ref) |The reference given to blame or HEAD if undefined.
161 |%(revargs) |The revision arguments passed on the command line.
162 |%(fileargs) |The file arguments passed on the command line.
163 |%(diffargs) |The diff options passed on the command line.
164 |=============================================================================
166 [[title-window]]
167 Title Windows
168 ~~~~~~~~~~~~~
170 Each view has a title window which shows the name of the view, current commit
171 ID if available, and where the view is positioned:
173 -----------------------------------------------------------------------------
174 [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
175 -----------------------------------------------------------------------------
177 By default, the title of the current view is highlighted using bold font. For
178 long loading views (taking over 3 seconds) the time since loading started will
179 be appended:
181 -----------------------------------------------------------------------------
182 [main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s
183 -----------------------------------------------------------------------------
185 [[env-variables]]
186 Environment Variables
187 ---------------------
189 Several options related to the interface with git can be configured via
190 environment options.
192 [[configuration-files]]
193 Configuration Files
194 ~~~~~~~~~~~~~~~~~~~
196 Upon startup, tig first reads the system wide configuration file
197 (`{sysconfdir}/tigrc` by default) and then proceeds to read the user's
198 configuration file (`~/.tigrc` by default). The paths to either of these files
199 can be overridden through the following environment variables:
201 TIGRC_USER::
202 Path of the user configuration file.
204 TIGRC_SYSTEM::
205 Path of the system wide configuration file.
207 [[repo-refs]]
208 Repository References
209 ~~~~~~~~~~~~~~~~~~~~~
211 Commits that are referenced by tags and branch heads will be marked by the
212 reference name surrounded by '[' and ']':
214 -----------------------------------------------------------------------------
215 2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1
216 -----------------------------------------------------------------------------
218 If you want to filter what branches gets shown, say limit to only show
219 branches named `master` or which starts with the `jf/` prefix, you can
220 do it by setting the following variable:
222 -----------------------------------------------------------------------------
223 $ TIG_LS_REMOTE="git ls-remote . master jf/*" tig
224 -----------------------------------------------------------------------------
226 Or set the variable permanently in your environment.
228 --
230 TIG_LS_REMOTE::
232 Set command for retrieving all repository references. The command
233 should output data in the same format as git-ls-remote(1). Defaults
234 to:
235 -----------------------------------------------------------------------------
236 git ls-remote .
237 -----------------------------------------------------------------------------
239 --
241 [[diff-options]]
242 Diff options
243 ~~~~~~~~~~~~
245 It is possible to alter how diffs are shown by the diff view. If for example
246 you prefer to have commit and author dates shown as relative dates, use:
248 -----------------------------------------------------------------------------
249 $ TIG_DIFF_OPTS="--relative-date" tig
250 -----------------------------------------------------------------------------
252 Or set the variable permanently in your environment.
254 [[keys]]
255 Default Keybindings
256 -------------------
257 Below the default key bindings are shown.
259 [[view-switching]]
260 View Switching
261 ~~~~~~~~~~~~~~
263 [frame="none",grid="none",cols="2<,8<",options="header"]
264 |=============================================================================
265 |Key |Action
266 |m |Switch to main view.
267 |d |Switch to diff view.
268 |l |Switch to log view.
269 |p |Switch to pager view.
270 |t |Switch to (directory) tree view.
271 |f |Switch to (file) blob view.
272 |B |Switch to blame view.
273 |H |Switch to branch view.
274 |h |Switch to help view
275 |S |Switch to status view
276 |c |Switch to stage view
277 |=============================================================================
279 [[view-manipulation]]
280 View Manipulation
281 ~~~~~~~~~~~~~~~~~
283 [frame="none",grid="none",cols="2<,8<",options="header"]
284 |=============================================================================
285 |Key |Action
286 |q |Close view, if multiple views are open it will jump back to the
287 previous view in the view stack. If it is the last open view it
288 will quit. Use 'Q' to quit all views at once.
289 |Enter |This key is "context sensitive" depending on what view you are
290 currently in. When in log view on a commit line or in the main
291 view, split the view and show the commit diff. In the diff view
292 pressing Enter will simply scroll the view one line down.
293 |Tab |Switch to next view.
294 |R |Reload and refresh the current view.
295 |M |Maximize the current view to fill the whole display.
296 |Up |This key is "context sensitive" and will move the cursor one
297 line up. However, if you opened a diff view from the main view
298 (split- or full-screen) it will change the cursor to point to
299 the previous commit in the main view and update the diff view
300 to display it.
301 |Down |Similar to 'Up' but will move down.
302 |, |Move to parent. In the tree view, this means switch to the parent
303 directory. In the blame view it will load blame for the parent
304 commit. For merges the parent is queried.
305 |=============================================================================
307 [[view-actions]]
308 View Specific Actions
309 ~~~~~~~~~~~~~~~~~~~~~
311 [frame="none",grid="none",cols="2<,8<",options="header"]
312 |=============================================================================
313 |Key |Action
314 |u |Update status of file. In the status view, this allows you to add an
315 untracked file or stage changes to a file for next commit (similar to
316 running git-add <filename>). In the stage view, when pressing this on
317 a diff chunk line stages only that chunk for next commit, when not on
318 a diff chunk line all changes in the displayed diff is staged.
319 |M |Resolve unmerged file by launching git-mergetool(1). Note, to work
320 correctly this might require some initial configuration of your
321 preferred merge tool. See the manpage of git-mergetool(1).
322 |! |Checkout file with unstaged changes. This will reset the file to
323 contain the content it had at last commit.
324 |@ |Move to next chunk in the stage view.
325 |=============================================================================
327 [[cursor-nav]]
328 Cursor Navigation
329 ~~~~~~~~~~~~~~~~~
331 [frame="none",grid="none",cols="2<,8<",options="header"]
332 |=============================================================================
333 |Key |Action
334 |k |Move cursor one line up.
335 |j |Move cursor one line down.
336 |PgUp,-,a |Move cursor one page up.
337 |PgDown, Space |Move cursor one page down.
338 |End |Jump to last line.
339 |Home |Jump to first line.
340 |=============================================================================
342 [[view-scrolling]]
343 Scrolling
344 ~~~~~~~~~
346 [frame="none",grid="none",cols="2<,8<",options="header"]
347 |=============================================================================
348 |Key |Action
349 |Insert |Scroll view one line up.
350 |Delete |Scroll view one line down.
351 |w |Scroll view one page up.
352 |s |Scroll view one page down.
353 |Left |Scroll view one column left.
354 |Right |Scroll view one column right.
355 |=============================================================================
357 [[searching]]
358 Searching
359 ~~~~~~~~~
361 [frame="none",grid="none",cols="2<,8<",options="header"]
362 |=============================================================================
363 |Key |Action
364 |/ |Search the view. Opens a prompt for entering search regexp to use.
365 |? |Search backwards in the view. Also prompts for regexp.
366 |n |Find next match for the current search regexp.
367 |N |Find previous match for the current search regexp.
368 |=============================================================================
370 [[misc-keys]]
371 Misc
372 ~~~~
374 [frame="none",grid="none",cols="2<,8<",options="header"]
375 |=============================================================================
376 |Key |Action
377 |Q |Quit.
378 |r |Redraw screen.
379 |z |Stop all background loading. This can be useful if you use
380 tig in a repository with a long history without limiting
381 the revision log.
382 |v |Show version.
383 |o |Open option menu
384 |. |Toggle line numbers on/off.
385 |D |Toggle date display on/off/short/relative/local.
386 |A |Toggle author display on/off/abbreviated.
387 |g |Toggle revision graph visualization on/off.
388 |F |Toggle reference display on/off (tag and branch names).
389 |: |Open prompt. This allows you to specify what git command
390 to run. Example `:log -p`. You can also use this to jump
391 to a specific line by typing `:<linenumber>`, e.g. `:80`.
392 |e |Open file in editor.
393 |=============================================================================
395 [[external-commands]]
396 External Commands
397 ~~~~~~~~~~~~~~~~~
399 For more custom needs, external commands provide a way to easily execute
400 a script or program. They are bound to keys and use information from the
401 current browsing state, such as the current commit ID. Tig comes with
402 the following built-in external commands:
404 [frame="none",grid="none",cols="1<,1<,8<",options="header"]
405 |=============================================================================
406 |Keymap |Key |Action
407 |main |C |git cherry-pick %(commit)
408 |status |C |git commit
409 |generic|G |git gc
410 |=============================================================================
412 [[refspec]]
413 Revision Specification
414 ----------------------
416 This section describes various ways to specify what revisions to display or
417 otherwise limit the view to. Tig does not itself parse the described
418 revision options so refer to the relevant git man pages for further
419 information. Relevant man pages besides git-log(1) are git-diff(1) and
420 git-rev-list(1).
422 You can tune the interaction with git by making use of the options explained
423 in this section. For example, by configuring the environment variable
424 described in the section on <<diff-options, diff options>>.
426 [[path-limiting]]
427 Limit by Path Name
428 ~~~~~~~~~~~~~~~~~~
430 If you are interested only in those revisions that made changes to a specific
431 file (or even several files) list the files like this:
433 -----------------------------------------------------------------------------
434 $ tig Makefile README
435 -----------------------------------------------------------------------------
437 To avoid ambiguity with tig's subcommands or repository references such as tag
438 name, be sure to separate file names from other git options using "`--`". So if
439 you have a file named 'status' it will clash with the 'status' subcommand, and
440 thus you will have to use:
442 -----------------------------------------------------------------------------
443 $ tig -- status
444 -----------------------------------------------------------------------------
446 [[date-number-limiting]]
447 Limit by Date or Number
448 ~~~~~~~~~~~~~~~~~~~~~~~
450 To speed up interaction with git, you can limit the amount of commits to show
451 both for the log and main view. Either limit by date using e.g.
452 `--since=1.month` or limit by the number of commits using `-n400`.
454 If you are only interested in changed that happened between two dates you can
455 use:
457 -----------------------------------------------------------------------------
458 $ tig --after="May 5th" --before="2006-05-16 15:44"
459 -----------------------------------------------------------------------------
461 NOTE: If you want to avoid having to quote dates containing spaces you can use
462 "." instead, e.g. `--after=May.5th`.
464 [[commit-range-limiting]]
465 Limiting by Commit Ranges
466 ~~~~~~~~~~~~~~~~~~~~~~~~~
468 Alternatively, commits can be limited to a specific range, such as "all
469 commits between 'tag-1.0' and 'tag-2.0'". For example:
471 -----------------------------------------------------------------------------
472 $ tig tag-1.0..tag-2.0
473 -----------------------------------------------------------------------------
475 This way of commit limiting makes it trivial to only browse the commits which
476 haven't been pushed to a remote branch. Assuming 'origin' is your upstream
477 remote branch, using:
479 -----------------------------------------------------------------------------
480 $ tig origin..HEAD
481 -----------------------------------------------------------------------------
483 will list what will be pushed to the remote branch. Optionally, the ending
484 'HEAD' can be left out since it is implied.
486 [[reachability-limiting]]
487 Limiting by Reachability
488 ~~~~~~~~~~~~~~~~~~~~~~~~
490 Git interprets the range specifier "tag-1.0..tag-2.0" as "all commits
491 reachable from 'tag-2.0' but not from 'tag-1.0'". Where reachability refers
492 to what commits are ancestors (or part of the history) of the branch or tagged
493 revision in question.
495 If you prefer to specify which commit to preview in this way use the
496 following:
498 -----------------------------------------------------------------------------
499 $ tig tag-2.0 ^tag-1.0
500 -----------------------------------------------------------------------------
502 You can think of '^' as a negation operator. Using this alternate syntax, it
503 is possible to further prune commits by specifying multiple branch cut offs.
505 [[refspec-combi]]
506 Combining Revisions Specification
507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
509 Revisions options can to some degree be combined, which makes it possible to
510 say "show at most 20 commits from within the last month that changed files
511 under the Documentation/ directory."
513 -----------------------------------------------------------------------------
514 $ tig --since=1.month -n20 -- Documentation/
515 -----------------------------------------------------------------------------
517 [[refspec-all]]
518 Examining All Repository References
519 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
521 In some cases, it can be useful to query changes across all references in a
522 repository. An example is to ask "did any line of development in this
523 repository change a particular file within the last week". This can be
524 accomplished using:
526 -----------------------------------------------------------------------------
527 $ tig --all --since=1.week -- Makefile
528 -----------------------------------------------------------------------------
530 include::BUGS[]
532 [[copy-right]]
533 Copyright
534 ---------
536 Copyright (c) 2006-2010 Jonas Fonseca <fonseca@diku.dk>
538 This program is free software; you can redistribute it and/or modify
539 it under the terms of the GNU General Public License as published by
540 the Free Software Foundation; either version 2 of the License, or
541 (at your option) any later version.
543 [[references]]
544 References and Related Tools
545 ----------------------------
547 Manpages:
549 - manpage:tig[1]
550 - manpage:tigrc[5]
552 Online resources:
554 include::SITES[]