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