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