tigrc(5): minor fixes and improvements from wip/run-command
[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 the <<external-commands, external commands>>. These user-defined commands can
141 use arguments that refer to the current browsing state by using one of the
142 following variables.
143
144 `-----------------------`-----------------------------------------------------
145 Browsing state variables
146 ------------------------------------------------------------------------------
147 %(head)                 The currently viewed 'head' ID. Defaults to HEAD
148 %(commit)               The currently selected commit ID.
149 %(blob)                 The currently selected blob ID.
150 ------------------------------------------------------------------------------
151
152 [[title-window]]
153 Title Windows
154 ~~~~~~~~~~~~~
155
156 Each view has a title window which shows the name of the view, current commit
157 ID if available, and where the view is positioned:
158
159 -----------------------------------------------------------------------------
160 [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
161 -----------------------------------------------------------------------------
162
163 By default, the title of the current view is highlighted using bold font.  For
164 long loading views (taking over 3 seconds) the time since loading started will
165 be appended:
166
167 -----------------------------------------------------------------------------
168 [main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s
169 -----------------------------------------------------------------------------
170
171 [[env-variables]]
172 Environment Variables
173 ---------------------
174
175 Several options related to the interface with git can be configured via
176 environment options.
177
178 [[configuration-files]]
179 Configuration Files
180 ~~~~~~~~~~~~~~~~~~~
181
182 Upon startup, tig first reads the system wide configuration file
183 (`{sysconfdir}/tigrc` by default) and then proceeds to read the user's
184 configuration file (`~/.tigrc` by default). The paths to either of these files
185 can be overridden through the following environment variables:
186
187 TIGRC_USER::
188         Path of the user configuration file.
189
190 TIGRC_SYSTEM::
191         Path of the system wide configuration file.
192
193 [[repo-refs]]
194 Repository References
195 ~~~~~~~~~~~~~~~~~~~~~
196
197 Commits that are referenced by tags and branch heads will be marked by the
198 reference name surrounded by '[' and ']':
199
200 -----------------------------------------------------------------------------
201 2006-03-26 19:42 Petr Baudis         | [cogito-0.17.1] Cogito 0.17.1
202 -----------------------------------------------------------------------------
203
204 If you want to filter what branches gets shown, say limit to only show
205 branches named `master` or which starts with the `jf/` prefix, you can
206 do it by setting the following variable:
207
208 -----------------------------------------------------------------------------
209 $ TIG_LS_REMOTE="git ls-remote . master jf/*" tig
210 -----------------------------------------------------------------------------
211
212 Or set the variable permanently in your environment.
213
214 --
215
216 TIG_LS_REMOTE::
217
218         Set command for retrieving all repository references. The command
219         should output data in the same format as git-ls-remote(1). Defaults
220         to:
221 -----------------------------------------------------------------------------
222 git ls-remote .
223 -----------------------------------------------------------------------------
224
225 --
226
227 [[history-commands]]
228 History Commands
229 ~~~~~~~~~~~~~~~~
230
231 It is possible to alter which commands are used for the different views.  If
232 for example you prefer commits in the main view to be sorted by date and only
233 show 500 commits, use:
234
235 -----------------------------------------------------------------------------
236 $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
237 -----------------------------------------------------------------------------
238
239 Or set the variable permanently in your environment.
240
241 Notice, how `%s` is used to specify the commit reference. There can be a
242 maximum of 5 `%s` ref specifications.
243
244 --
245
246 TIG_DIFF_CMD::
247
248         The command used for the diff view. Defaults to:
249 -----------------------------------------------------------------------------
250 git show --pretty=fuller --no-color --root 
251          --patch-with-stat --find-copies-harder -C %s
252 -----------------------------------------------------------------------------
253
254 TIG_LOG_CMD::
255
256         The command used for the log view. If you prefer to have both
257         author and committer shown in the log view be sure to pass
258         `\--pretty=fuller` to git log. Defaults to:
259 -----------------------------------------------------------------------------
260 git log --no-color --cc --stat -n100 %s
261 -----------------------------------------------------------------------------
262
263 TIG_MAIN_CMD::
264
265         The command used for the main view. Note, you must always specify
266         the option: `\--pretty=raw` since the main view parser expects to
267         read that format.
268 -----------------------------------------------------------------------------
269 git log --no-color --pretty=raw --parents --topo-order %s
270 -----------------------------------------------------------------------------
271
272 --
273
274 [[tree-commands]]
275 Tree Commands
276 ~~~~~~~~~~~~~
277
278 --
279
280 TIG_TREE_CMD::
281
282         The command used for the tree view. Takes two arguments, the first is
283         the revision ID and the second is the path of the directory tree,
284         empty for the root directory. Defaults to:
285 -----------------------------------------------------------------------------
286 git ls-tree %s %s
287 -----------------------------------------------------------------------------
288
289 TIG_BLOB_CMD::
290
291         The command used for the blob view. Takes one argument which is the
292         blob ID. Defaults to:
293 -----------------------------------------------------------------------------
294 git cat-file blob %s
295 -----------------------------------------------------------------------------
296
297 --
298
299 [[keys]]
300 Default Keybindings
301 -------------------
302 Below the default key bindings are shown.
303
304 [[view-switching]]
305 View Switching
306 ~~~~~~~~~~~~~~
307
308 `-------`--------------------------------------------------------------------
309 Key     Action
310 -----------------------------------------------------------------------------
311 m       Switch to main view.
312 d       Switch to diff view.
313 l       Switch to log view.
314 p       Switch to pager view.
315 t       Switch to (directory) tree view.
316 f       Switch to (file) blob view.
317 B       Switch to blame view.
318 h       Switch to help view
319 S       Switch to status view
320 c       Switch to stage view
321 -----------------------------------------------------------------------------
322
323 [[view-manipulation]]
324 View Manipulation
325 ~~~~~~~~~~~~~~~~~
326
327 `-------`--------------------------------------------------------------------
328 Key     Action
329 -----------------------------------------------------------------------------
330 q       Close view, if multiple views are open it will jump back to the \
331         previous view in the view stack. If it is the last open view it \
332         will quit. Use 'Q' to quit all views at once.
333 Enter   This key is "context sensitive" depending on what view you are \
334         currently in. When in log view on a commit line or in the main \
335         view, split the view and show the commit diff. In the diff view \
336         pressing Enter will simply scroll the view one line down.
337 Tab     Switch to next view.
338 R       Reload and refresh the current view.
339 M       Maximize the current view to fill the whole display.
340 Up      This key is "context sensitive" and will move the cursor one \
341         line up. However, if you opened a diff view from the main view \
342         (split- or full-screen) it will change the cursor to point to \
343         the previous commit in the main view and update the diff view \
344         to display it.
345 Down    Similar to 'Up' but will move down.
346 -----------------------------------------------------------------------------
347
348 [[cursor-nav]]
349 Cursor Navigation
350 ~~~~~~~~~~~~~~~~~
351
352 `-------`--------------------------------------------------------------------
353 Key     Action
354 -----------------------------------------------------------------------------
355 j       Move cursor one line up.
356 k       Move cursor one line down.
357 PgUp,\
358 -,a     Move cursor one page up.
359 PgDown  Space   Move cursor one page down.
360 Home    Jump to first line.
361 End     Jump to last line.
362 -----------------------------------------------------------------------------
363
364 [[view-scrolling]]
365 Scrolling
366 ~~~~~~~~~
367
368 `-------`--------------------------------------------------------------------
369 Key     Action
370 -----------------------------------------------------------------------------
371 Insert  Scroll view one line up.
372 Delete  Scroll view one line down.
373 w       Scroll view one page up.
374 s       Scroll view one page down.
375 -----------------------------------------------------------------------------
376
377 [[searching]]
378 Searching
379 ~~~~~~~~~
380
381 `-------`--------------------------------------------------------------------
382 Key     Action
383 -----------------------------------------------------------------------------
384 /       Search the view. Opens a prompt for entering search regex to use.
385 ?       Search backwards in the view. Also prompts for regex.
386 n       Find next match for the current search regex.
387 N       Find previous match for the current search regex.
388 -----------------------------------------------------------------------------
389
390 [[misc-keys]]
391 Misc
392 ~~~~
393
394 `-------`--------------------------------------------------------------------
395 Key     Action
396 -----------------------------------------------------------------------------
397 Q       Quit.
398 r       Redraw screen.
399 z       Stop all background loading. This can be useful if you use \
400         tig in a repository with a long history without limiting \
401         the revision log.
402 v       Show version.
403 '.'     Toggle line numbers on/off.
404 D       Toggle date display on/off.
405 A       Toggle author display on/off.
406 g       Toggle revision graph visualization on/off.
407 F       Toggle reference display on/off (tag and branch names).
408 ':'     Open prompt. This allows you to specify what git command \
409         to run. Example `:log -p`
410 u       Update status of file. In the status view, this allows you to add an \
411         untracked file or stage changes to a file for next commit (similar to \
412         running git-add <filename>). In the stage view, when pressing this on \
413         a diff chunk line stages only that chunk for next commit, when not on \
414         a diff chunk line all changes in the displayed diff is staged.
415 M       Resolve unmerged file by launching git-mergetool(1). Note, to work \
416         correctly this might require some initial configuration of your \
417         preferred merge tool. See the manpage of git-mergetool(1).
418 !       Checkout file with unstaged changes. This will reset the file to \
419         contain the content it had at last commit.
420 @       Move to next chunk in the stage view.
421 ','     Move tree view to the parent tree.
422 e       Open file in editor.
423 -----------------------------------------------------------------------------
424
425 [[external-commands]]
426 External Commands
427 ~~~~~~~~~~~~~~~~~
428
429 For more custom needs, external commands provide a way to easily execute
430 a script or program. They are bound to keys and use information from the
431 current browsing state, such as the current commit ID. Tig comes with
432 the following builtin external commands:
433
434 `-------`--------------------------------------------------------------------
435 Key     Action
436 -----------------------------------------------------------------------------
437 C       git cherry-pick %(commit)
438 G       git gc
439 -----------------------------------------------------------------------------
440
441 [[refspec]]
442 Revision Specification
443 ----------------------
444
445 This section describes various ways to specify what revisions to display or
446 otherwise limit the view to. Tig does not itself parse the described
447 revision options so refer to the relevant git man pages for further
448 information. Relevant man pages besides git-log(1) are git-diff(1) and
449 git-rev-list(1).
450
451 You can tune the interaction with git by making use of the options explained
452 in this section. For example, by configuring the environment variables
453 described in the section on <<history-commands, history commands>>.
454
455 [[path-limiting]]
456 Limit by Path Name
457 ~~~~~~~~~~~~~~~~~~
458
459 If you are interested only in those revisions that made changes to a specific
460 file (or even several files) list the files like this:
461
462 -----------------------------------------------------------------------------
463 $ tig Makefile README
464 -----------------------------------------------------------------------------
465
466 To avoid ambiguity with tig's subcommands or repository references such as tag
467 name, be sure to separate file names from other git options using "\--". So if
468 you have a file named 'status' it will clash with the 'status' subcommand, and
469 thus you will have to use:
470
471 -----------------------------------------------------------------------------
472 $ tig -- status
473 -----------------------------------------------------------------------------
474
475 [[date-number-limiting]]
476 Limit by Date or Number
477 ~~~~~~~~~~~~~~~~~~~~~~~
478
479 To speed up interaction with git, you can limit the amount of commits to show
480 both for the log and main view. Either limit by date using e.g.
481 `\--since=1.month` or limit by the number of commits using `-n400`.
482
483 If you are only interested in changed that happened between two dates you can
484 use:
485
486 -----------------------------------------------------------------------------
487 $ tig --after="May 5th" --before="2006-05-16 15:44"
488 -----------------------------------------------------------------------------
489
490 NOTE: If you want to avoid having to quote dates containing spaces you can use
491 "." instead, e.g. `\--after=May.5th`.
492
493 [[commit-range-limiting]]
494 Limiting by Commit Ranges
495 ~~~~~~~~~~~~~~~~~~~~~~~~~
496
497 Alternatively, commits can be limited to a specific range, such as "all
498 commits between 'tag-1.0' and 'tag-2.0'". For example:
499
500 -----------------------------------------------------------------------------
501 $ tig tag-1.0..tag-2.0
502 -----------------------------------------------------------------------------
503
504 This way of commit limiting makes it trivial to only browse the commits which
505 haven't been pushed to a remote branch. Assuming 'origin' is your upstream
506 remote branch, using:
507
508 -----------------------------------------------------------------------------
509 $ tig origin..HEAD
510 -----------------------------------------------------------------------------
511
512 will list what will be pushed to the remote branch. Optionally, the ending
513 'HEAD' can be left out since it is implied.
514
515 [[reachability-limiting]]
516 Limiting by Reachability
517 ~~~~~~~~~~~~~~~~~~~~~~~~
518
519 Git interprets the range specifier "tag-1.0..tag-2.0" as "all commits
520 reachable from 'tag-2.0' but not from 'tag-1.0'".  Where reachability refers
521 to what commits are ancestors (or part of the history) of the branch or tagged
522 revision in question.
523
524 If you prefer to specify which commit to preview in this way use the
525 following:
526
527 -----------------------------------------------------------------------------
528 $ tig tag-2.0 ^tag-1.0
529 -----------------------------------------------------------------------------
530
531 You can think of '^' as a negation operator. Using this alternate syntax, it
532 is possible to further prune commits by specifying multiple branch cut offs.
533
534 [[refspec-combi]]
535 Combining Revisions Specification
536 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
537
538 Revisions options can to some degree be combined, which makes it possible to
539 say "show at most 20 commits from within the last month that changed files
540 under the Documentation/ directory."
541
542 -----------------------------------------------------------------------------
543 $ tig --since=1.month -n20 -- Documentation/
544 -----------------------------------------------------------------------------
545
546 [[refspec-all]]
547 Examining All Repository References
548 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
549
550 In some cases, it can be useful to query changes across all references in a
551 repository. An example is to ask "did any line of development in this
552 repository change a particular file within the last week". This can be
553 accomplished using:
554
555 -----------------------------------------------------------------------------
556 $ tig --all --since=1.week -- Makefile
557 -----------------------------------------------------------------------------
558
559 include::BUGS[]
560
561 [[copy-right]]
562 Copyright
563 ---------
564
565 Copyright (c) 2006-2008 Jonas Fonseca <fonseca@diku.dk>
566
567 This program is free software; you can redistribute it and/or modify
568 it under the terms of the GNU General Public License as published by
569 the Free Software Foundation; either version 2 of the License, or
570 (at your option) any later version.
571
572 [[references]]
573 References and Related Tools
574 ----------------------------
575
576 Manpages:
577
578  - manpage:tig[1]
579  - manpage:tigrc[5]
580
581 Online resources:
582
583 include::SITES[]
584
585 Other git repository browsers:
586
587  - gitk(1)
588  - qgit(1)
589  - gitview(1)