Do not show deleted branch when reloading the branch view
[tig.git] / manual.txt
blob8fe2796885f3568ed97b48a3f40aac9709f6cd8d
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 a 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 are 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 unstaged 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 |%(prompt)              |Prompt for the argument value.
165 |=============================================================================
167 [[title-window]]
168 Title Windows
169 ~~~~~~~~~~~~~
171 Each view has a title window which shows the name of the view, current commit
172 ID if available, and where the view is positioned:
174 -----------------------------------------------------------------------------
175 [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
176 -----------------------------------------------------------------------------
178 By default, the title of the current view is highlighted using bold font.  For
179 long loading views (taking over 3 seconds) the time since loading started will
180 be appended:
182 -----------------------------------------------------------------------------
183 [main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s
184 -----------------------------------------------------------------------------
186 [[env-variables]]
187 Environment Variables
188 ---------------------
190 Several options related to the interface with git can be configured via
191 environment options.
193 [[configuration-files]]
194 Configuration Files
195 ~~~~~~~~~~~~~~~~~~~
197 Upon startup, tig first reads the system wide configuration file
198 (`{sysconfdir}/tigrc` by default) and then proceeds to read the user's
199 configuration file (`~/.tigrc` by default). The paths to either of these files
200 can be overridden through the following environment variables:
202 TIGRC_USER::
203         Path of the user configuration file.
205 TIGRC_SYSTEM::
206         Path of the system wide configuration file.
208 [[repo-refs]]
209 Repository References
210 ~~~~~~~~~~~~~~~~~~~~~
212 Commits that are referenced by tags and branch heads will be marked by the
213 reference name surrounded by '[' and ']':
215 -----------------------------------------------------------------------------
216 2006-03-26 19:42 Petr Baudis         | [cogito-0.17.1] Cogito 0.17.1
217 -----------------------------------------------------------------------------
219 If you want to limit what branches are shown, say only show branches named
220 `master` or those which start with the `jf/` prefix, you can do it by setting
221 the following variable:
223 -----------------------------------------------------------------------------
224 $ TIG_LS_REMOTE="git ls-remote . master jf/*" tig
225 -----------------------------------------------------------------------------
227 Or set the variable permanently in your environment.
231 TIG_LS_REMOTE::
233         Set command for retrieving all repository references. The command
234         should output data in the same format as git-ls-remote(1). Defaults
235         to:
236 -----------------------------------------------------------------------------
237 git ls-remote .
238 -----------------------------------------------------------------------------
242 [[diff-options]]
243 Diff options
244 ~~~~~~~~~~~~
246 It is possible to alter how diffs are shown by the diff view. If for example
247 you prefer to have commit and author dates shown as relative dates, use:
249 -----------------------------------------------------------------------------
250 $ TIG_DIFF_OPTS="--relative-date" tig
251 -----------------------------------------------------------------------------
253 Or set the variable permanently in your environment.
255 [[keys]]
256 Default Keybindings
257 -------------------
258 Below the default key bindings are shown.
260 [[view-switching]]
261 View Switching
262 ~~~~~~~~~~~~~~
264 [frame="none",grid="none",cols="2<,8<",options="header"]
265 |=============================================================================
266 |Key    |Action
267 |m      |Switch to main view.
268 |d      |Switch to diff view.
269 |l      |Switch to log view.
270 |p      |Switch to pager view.
271 |t      |Switch to (directory) tree view.
272 |f      |Switch to (file) blob view.
273 |B      |Switch to blame view.
274 |H      |Switch to branch view.
275 |h      |Switch to help view
276 |S      |Switch to status view
277 |c      |Switch to stage view
278 |=============================================================================
280 [[view-manipulation]]
281 View Manipulation
282 ~~~~~~~~~~~~~~~~~
284 [frame="none",grid="none",cols="2<,8<",options="header"]
285 |=============================================================================
286 |Key    |Action
287 |q      |Close view, if multiple views are open it will jump back to the
288         previous view in the view stack. If it is the last open view it
289         will quit. Use 'Q' to quit all views at once.
290 |Enter  |This key is "context sensitive" depending on what view you are
291         currently in. When in log view on a commit line or in the main
292         view, split the view and show the commit diff. In the diff view
293         pressing Enter will simply scroll the view one line down.
294 |Tab    |Switch to next view.
295 |R      |Reload and refresh the current view.
296 |O      |Maximize the current view to fill the whole display.
297 |Up     |This key is "context sensitive" and will move the cursor one
298         line up. However, if you opened a diff view from the main view
299         (split- or full-screen) it will change the cursor to point to
300         the previous commit in the main view and update the diff view
301         to display it.
302 |Down   |Similar to 'Up' but will move down.
303 |,      |Move to parent. In the tree view, this means switch to the parent
304         directory. In the blame view it will load blame for the parent
305         commit. For merges the parent is queried.
306 |=============================================================================
308 [[view-actions]]
309 View Specific Actions
310 ~~~~~~~~~~~~~~~~~~~~~
312 [frame="none",grid="none",cols="2<,8<",options="header"]
313 |=============================================================================
314 |Key    |Action
315 |u      |Update status of file. In the status view, this allows you to add an
316          untracked file or stage changes to a file for next commit (similar to
317          running git-add <filename>). In the stage view, when pressing this on
318          a diff chunk line stages only that chunk for next commit, when not on
319          a diff chunk line all changes in the displayed diff are staged.
320 |M      |Resolve unmerged file by launching git-mergetool(1). Note, to work
321          correctly this might require some initial configuration of your
322          preferred merge tool. See the manpage of git-mergetool(1).
323 |!      |Checkout file with unstaged changes. This will reset the file to
324          contain the content it had at last commit.
325 |Ctrl-u |Stage single diff line.
326 |@      |Move to next chunk in the stage view.
327 |]      |Increase the diff context.
328 |[      |Decrease the diff context.
329 |=============================================================================
331 [[cursor-nav]]
332 Cursor Navigation
333 ~~~~~~~~~~~~~~~~~
335 [frame="none",grid="none",cols="2<,8<",options="header"]
336 |=============================================================================
337 |Key            |Action
338 |k              |Move cursor one line up.
339 |j              |Move cursor one line down.
340 |PgUp,-,a       |Move cursor one page up.
341 |PgDown, Space  |Move cursor one page down.
342 |End            |Jump to last line.
343 |Home           |Jump to first line.
344 |=============================================================================
346 [[view-scrolling]]
347 Scrolling
348 ~~~~~~~~~
350 [frame="none",grid="none",cols="2<,8<",options="header"]
351 |=============================================================================
352 |Key    |Action
353 |Insert |Scroll view one line up.
354 |Delete |Scroll view one line down.
355 |w      |Scroll view one page up.
356 |s      |Scroll view one page down.
357 |Left   |Scroll view one column left.
358 |Right  |Scroll view one column right.
359 |\|     |Scroll view to the first column.
360 |=============================================================================
362 [[searching]]
363 Searching
364 ~~~~~~~~~
366 [frame="none",grid="none",cols="2<,8<",options="header"]
367 |=============================================================================
368 |Key    |Action
369 |/      |Search the view. Opens a prompt for entering search regexp to use.
370 |?      |Search backwards in the view. Also prompts for regexp.
371 |n      |Find next match for the current search regexp.
372 |N      |Find previous match for the current search regexp.
373 |=============================================================================
375 [[misc-keys]]
376 Misc
377 ~~~~
379 [frame="none",grid="none",cols="2<,8<",options="header"]
380 |=============================================================================
381 |Key    |Action
382 |Q      |Quit.
383 |r      |Redraw screen.
384 |z      |Stop all background loading. This can be useful if you use
385          tig in a repository with a long history without limiting
386          the revision log.
387 |v      |Show version.
388 |o      |Open option menu
389 |.      |Toggle line numbers on/off.
390 |D      |Toggle date display on/off/short/relative/local.
391 |A      |Toggle author display on/off/abbreviated.
392 |g      |Toggle revision graph visualization on/off.
393 |~      |Toggle (line) graphics mode
394 |F      |Toggle reference display on/off (tag and branch names).
395 |W      |Toggle ignoring whitespace on/off for diffs
396 |X      |Toggle commit ID display on/off
397 |:      |Open prompt. This allows you to specify what command to run.
398 |e      |Open file in editor.
399 |=============================================================================
401 [[prompt]]
402 Prompt
403 ~~~~~~
405 [frame="none",grid="none",cols="2<,8<",options="header"]
406 |=============================================================================
407 |Key            |Action
408 |:<number>      |Jump to the specific line number, e.g. `:80`.
409 |:<sha>         |Jump to a specific commit, e.g. `:2f12bcc`.
410 |:<x>           |Execute the corresponding key binding, e.g. `:q`.
411 |:!<command>    |Execute a system command in a pager, e.g. `:!git log -p`.
412 |:<action>      |Execute a tig command, e.g. `:edit`.
413 |=============================================================================
415 [[external-commands]]
416 External Commands
417 ~~~~~~~~~~~~~~~~~
419 For more custom needs, external commands provide a way to easily execute
420 a script or program. They are bound to keys and use information from the
421 current browsing state, such as the current commit ID. Tig comes with
422 the following built-in external commands:
424 [frame="none",grid="none",cols="1<,1<,8<",options="header"]
425 |=============================================================================
426 |Keymap |Key    |Action
427 |main   |C      |git cherry-pick %(commit)
428 |status |C      |git commit
429 |generic|G      |git gc
430 |=============================================================================
432 [[refspec]]
433 Revision Specification
434 ----------------------
436 This section describes various ways to specify what revisions to display or
437 otherwise limit the view to. Tig does not itself parse the described
438 revision options so refer to the relevant git man pages for further
439 information. Relevant man pages besides git-log(1) are git-diff(1) and
440 git-rev-list(1).
442 You can tune the interaction with git by making use of the options explained
443 in this section. For example, by configuring the environment variable
444 described in the section on <<diff-options, diff options>>.
446 [[path-limiting]]
447 Limit by Path Name
448 ~~~~~~~~~~~~~~~~~~
450 If you are interested only in those revisions that made changes to a specific
451 file (or even several files) list the files like this:
453 -----------------------------------------------------------------------------
454 $ tig Makefile README
455 -----------------------------------------------------------------------------
457 To avoid ambiguity with tig's subcommands or repository references such as tag
458 names, be sure to separate file names from other git options using "`--`". So
459 if you have a file named 'status' it will clash with the 'status' subcommand,
460 and thus you will have to use:
462 -----------------------------------------------------------------------------
463 $ tig -- status
464 -----------------------------------------------------------------------------
466 [[date-number-limiting]]
467 Limit by Date or Number
468 ~~~~~~~~~~~~~~~~~~~~~~~
470 To speed up interaction with git, you can limit the amount of commits to show
471 both for the log and main view. Either limit by date using e.g.
472 `--since=1.month` or limit by the number of commits using `-n400`.
474 If you are only interested in changes that happened between two dates you can
475 use:
477 -----------------------------------------------------------------------------
478 $ tig --after="May 5th" --before="2006-05-16 15:44"
479 -----------------------------------------------------------------------------
481 NOTE: If you want to avoid having to quote dates containing spaces you can use
482 "." instead, e.g. `--after=May.5th`.
484 [[commit-range-limiting]]
485 Limiting by Commit Ranges
486 ~~~~~~~~~~~~~~~~~~~~~~~~~
488 Alternatively, commits can be limited to a specific range, such as "all
489 commits between 'tag-1.0' and 'tag-2.0'". For example:
491 -----------------------------------------------------------------------------
492 $ tig tag-1.0..tag-2.0
493 -----------------------------------------------------------------------------
495 This way of commit limiting makes it trivial to only browse the commits which
496 haven't been pushed to a remote branch. Assuming 'origin' is your upstream
497 remote branch, using:
499 -----------------------------------------------------------------------------
500 $ tig origin..HEAD
501 -----------------------------------------------------------------------------
503 will list what will be pushed to the remote branch. Optionally, the ending
504 'HEAD' can be left out since it is implied.
506 [[reachability-limiting]]
507 Limiting by Reachability
508 ~~~~~~~~~~~~~~~~~~~~~~~~
510 Git interprets the range specifier "tag-1.0..tag-2.0" as "all commits
511 reachable from 'tag-2.0' but not from 'tag-1.0'".  Where reachability refers
512 to what commits are ancestors (or part of the history) of the branch or tagged
513 revision in question.
515 If you prefer to specify which commit to preview in this way use the
516 following:
518 -----------------------------------------------------------------------------
519 $ tig tag-2.0 ^tag-1.0
520 -----------------------------------------------------------------------------
522 You can think of '^' as a negation operator. Using this alternate syntax, it
523 is possible to further prune commits by specifying multiple branch cut offs.
525 [[refspec-combi]]
526 Combining Revisions Specification
527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
529 Revision options can to some degree be combined, which makes it possible to
530 say "show at most 20 commits from within the last month that changed files
531 under the Documentation/ directory."
533 -----------------------------------------------------------------------------
534 $ tig --since=1.month -n20 -- Documentation/
535 -----------------------------------------------------------------------------
537 [[refspec-all]]
538 Examining All Repository References
539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
541 In some cases, it can be useful to query changes across all references in a
542 repository. An example is to ask "did any line of development in this
543 repository change a particular file within the last week". This can be
544 accomplished using:
546 -----------------------------------------------------------------------------
547 $ tig --all --since=1.week -- Makefile
548 -----------------------------------------------------------------------------
550 include::BUGS[]
552 [[copy-right]]
553 Copyright
554 ---------
556 Copyright (c) 2006-2012 Jonas Fonseca <fonseca@diku.dk>
558 This program is free software; you can redistribute it and/or modify
559 it under the terms of the GNU General Public License as published by
560 the Free Software Foundation; either version 2 of the License, or
561 (at your option) any later version.
563 [[references]]
564 See Also
565 --------
567 Manpages:
569  - manpage:tig[1]
570  - manpage:tigrc[5]
572 Online resources:
574 include::SITES[]