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