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 <<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
  61 [[env-variables]]
  62 Environment Variables
  63 ---------------------
  64
  65 Several options related to the interface with git can be configured via
  66 environment options.
  67
  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
  83 [[repo-refs]]
  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
  90 -----------------------------------------------------------------------------
  91 2006-03-26 19:42 Petr Baudis         | [cogito-0.17.1] Cogito 0.17.1
  92 -----------------------------------------------------------------------------
  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
  97 -----------------------------------------------------------------------------
  98 $ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig
  99 -----------------------------------------------------------------------------
 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
 115 -----------------------------------------------------------------------------
 116 $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig
 117 -----------------------------------------------------------------------------
 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
 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
 151 [[viewer]]
 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
 162 -----------------------------------------------------------------------------
 163 commit 4d55caff4cc89335192f3e566004b4ceef572521
 164 -----------------------------------------------------------------------------
 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
 170 [[commit-id]]
 171 Current Head and Commit ID
 172 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 173
 174 The viewer keeps track of both what head and commit ID you are currently
 175 viewing. The commit ID will follow the cursor line and change every time
 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
 182 [[views]]
 183 Views
 184 ~~~~~
 185
 186 Various 'views' of a repository is presented. Each view is based on output
 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
 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
 213 The blame view::
 214         Displays the file content annotated or blamed by commits.
 215
 216 The status view::
 217         Displays status of files in the working tree and allows changes to be
 218         staged/unstaged as well as adding of untracked files.
 219
 220 The stage view::
 221         Displays diff changes for staged or unstanged files being tracked or
 222         file content of untracked files.
 223
 224 The pager view::
 225         Is used for displaying both input from stdin and output from git
 226         commands entered in the internal prompt.
 227
 228 The help view::
 229         Displays key binding quick reference.
 230
 231 [[title-window]]
 232 Title Windows
 233 ~~~~~~~~~~~~~
 234
 235 Each view has a title window which shows the name of the view, current commit
 236 ID if available, and where the view is positioned:
 237
 238 -----------------------------------------------------------------------------
 239 [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
 240 -----------------------------------------------------------------------------
 241
 242 By default, the title of the current view is highlighted using bold font.  For
 243 long loading views (taking over 3 seconds) the time since loading started will
 244 be appended:
 245
 246 -----------------------------------------------------------------------------
 247 [main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s
 248 -----------------------------------------------------------------------------
 249
 250 [[keys]]
 251 Default Keybindings
 252 -------------------
 253 Below the default key bindings are shown.
 254
 255 [[view-switching]]
 256 View Switching
 257 ~~~~~~~~~~~~~~
 258
 259 `-------`--------------------------------------------------------------------
 260 Key     Action
 261 -----------------------------------------------------------------------------
 262 m       Switch to main view.
 263 d       Switch to diff view.
 264 l       Switch to log view.
 265 p       Switch to pager view.
 266 t       Switch to (directory) tree view.
 267 f       Switch to (file) blob view.
 268 B       Switch to blame view.
 269 h       Switch to help view
 270 S       Switch to status view
 271 c       Switch to stage view
 272 -----------------------------------------------------------------------------
 273
 274 [[view-manipulation]]
 275 View Manipulation
 276 ~~~~~~~~~~~~~~~~~
 277
 278 `-------`--------------------------------------------------------------------
 279 Key     Action
 280 -----------------------------------------------------------------------------
 281 q       Close view, if multiple views are open it will jump back to the \
 282         previous view in the view stack. If it is the last open view it \
 283         will quit. Use 'Q' to quit all views at once.
 284 Enter   This key is "context sensitive" depending on what view you are \
 285         currently in. When in log view on a commit line or in the main \
 286         view, split the view and show the commit diff. In the diff view \
 287         pressing Enter will simply scroll the view one line down.
 288 Tab     Switch to next view.
 289 R       Reload and refresh the current view.
 290 M       Maximize the current view to fill the whole display.
 291 Up      This key is "context sensitive" and will move the cursor one \
 292         line up. However, if you opened a diff view from the main view \
 293         (split- or full-screen) it will change the cursor to point to \
 294         the previous commit in the main view and update the diff view \
 295         to display it.
 296 Down    Similar to 'Up' but will move down.
 297 -----------------------------------------------------------------------------
 298
 299 [[cursor-nav]]
 300 Cursor Navigation
 301 ~~~~~~~~~~~~~~~~~
 302
 303 `-------`--------------------------------------------------------------------
 304 Key     Action
 305 -----------------------------------------------------------------------------
 306 j       Move cursor one line up.
 307 k       Move cursor one line down.
 308 PgUp,\
 309 -,a     Move cursor one page up.
 310 PgDown  Space   Move cursor one page down.
 311 Home    Jump to first line.
 312 End     Jump to last line.
 313 -----------------------------------------------------------------------------
 314
 315 [[view-scrolling]]
 316 Scrolling
 317 ~~~~~~~~~
 318
 319 `-------`--------------------------------------------------------------------
 320 Key     Action
 321 -----------------------------------------------------------------------------
 322 Insert  Scroll view one line up.
 323 Delete  Scroll view one line down.
 324 w       Scroll view one page up.
 325 s       Scroll view one page down.
 326 -----------------------------------------------------------------------------
 327
 328 [[searching]]
 329 Searching
 330 ~~~~~~~~~
 331
 332 `-------`--------------------------------------------------------------------
 333 Key     Action
 334 -----------------------------------------------------------------------------
 335 /       Search the view. Opens a prompt for entering search regex to use.
 336 ?       Search backwards in the view. Also prompts for regex.
 337 n       Find next match for the current search regex.
 338 N       Find previous match for the current search regex.
 339 -----------------------------------------------------------------------------
 340
 341 [[misc-keys]]
 342 Misc
 343 ~~~~
 344
 345 `-------`--------------------------------------------------------------------
 346 Key     Action
 347 -----------------------------------------------------------------------------
 348 Q       Quit.
 349 r       Redraw screen.
 350 z       Stop all background loading. This can be useful if you use \
 351         tig in a repository with a long history without limiting \
 352         the revision log.
 353 v       Show version.
 354 '.'     Toggle line numbers on/off.
 355 D       Toggle date display on/off.
 356 A       Toggle author display on/off.
 357 g       Toggle revision graph visualization on/off.
 358 F       Toggle reference display on/off (tag and branch names).
 359 ':'     Open prompt. This allows you to specify what git command \
 360         to run. Example `:log -p`
 361 u       Update status of file. In the status view, this allows you to add an \
 362         untracked file or stage changes to a file for next commit (similar to \
 363         running git-add <filename>). In the stage view, when pressing this on \
 364         a diff chunk line stages only that chunk for next commit, when not on \
 365         a diff chunk line all changes in the displayed diff is staged.
 366 M       Resolve unmerged file by launching git-mergetool(1). Note, to work \
 367         correctly this might require some initial configuration of your \
 368         preferred merge tool. See the manpage of git-mergetool(1).
 369 @       Move to next chunk in the stage view.
 370 ','     Move tree view to the parent tree.
 371 e       Open file in editor.
 372 -----------------------------------------------------------------------------
 373
 374 [[external-commands]]
 375 External Commands
 376 ~~~~~~~~~~~~~~~~~
 377
 378 Tig also comes with a few builtin external commands. These are simple shell
 379 commands that are run and can take arguments from the current browsing state,
 380 such as the current commit ID. The default commands are:
 381
 382 `-------`--------------------------------------------------------------------
 383 Key     Action
 384 -----------------------------------------------------------------------------
 385 C       git cherry-pick %(commit)
 386 G       git gc
 387 -----------------------------------------------------------------------------
 388
 389 [[refspec]]
 390 Revision Specification
 391 ----------------------
 392
 393 This section describes various ways to specify what revisions to display or
 394 otherwise limit the view to. Tig does not itself parse the described
 395 revision options so refer to the relevant git man pages for further
 396 information. Relevant man pages besides git-log(1) are git-diff(1) and
 397 git-rev-list(1).
 398
 399 You can tune the interaction with git by making use of the options explained
 400 in this section. For example, by configuring the environment variables
 401 described in the  <<history-commands, "History commands">> section.
 402
 403 [[path-limiting]]
 404 Limit by Path Name
 405 ~~~~~~~~~~~~~~~~~~
 406
 407 If you are interested only in those revisions that made changes to a specific
 408 file (or even several files) list the files like this:
 409
 410 -----------------------------------------------------------------------------
 411 $ tig Makefile README
 412 -----------------------------------------------------------------------------
 413
 414 To avoid ambiguity with tig's subcommands or repository references such as tag
 415 name, be sure to separate file names from other git options using "\--". So if
 416 you have a file named 'status' it will clash with the 'status' subcommand, and
 417 thus you will have to use:
 418
 419 -----------------------------------------------------------------------------
 420 $ tig -- status
 421 -----------------------------------------------------------------------------
 422
 423 NOTE: For the main view, avoiding ambiguity will in some cases require you to
 424 specify two "\--" options. The first will make tig stop option processing
 425 and the latter will be passed to git log.
 426
 427 [[date-number-limiting]]
 428 Limit by Date or Number
 429 ~~~~~~~~~~~~~~~~~~~~~~~
 430
 431 To speed up interaction with git, you can limit the amount of commits to show
 432 both for the log and main view. Either limit by date using e.g.
 433 `--since=1.month` or limit by the number of commits using `-n400`.
 434
 435 If you are only interested in changed that happened between two dates you can
 436 use:
 437
 438 -----------------------------------------------------------------------------
 439 $ tig --after="May 5th" --before="2006-05-16 15:44"
 440 -----------------------------------------------------------------------------
 441
 442 NOTE: If you want to avoid having to quote dates containing spaces you can use
 443 "." instead, e.g. `--after=May.5th`.
 444
 445 [[commit-range-limiting]]
 446 Limiting by Commit Ranges
 447 ~~~~~~~~~~~~~~~~~~~~~~~~~
 448
 449 Alternatively, commits can be limited to a specific range, such as "all
 450 commits between 'tag-1.0' and 'tag-2.0'". For example:
 451
 452 -----------------------------------------------------------------------------
 453 $ tig tag-1.0..tag-2.0
 454 -----------------------------------------------------------------------------
 455
 456 This way of commit limiting makes it trivial to only browse the commits which
 457 haven't been pushed to a remote branch. Assuming 'origin' is your upstream
 458 remote branch, using:
 459
 460 -----------------------------------------------------------------------------
 461 $ tig origin..HEAD
 462 -----------------------------------------------------------------------------
 463
 464 will list what will be pushed to the remote branch. Optionally, the ending
 465 'HEAD' can be left out since it is implied.
 466
 467 [[reachability-limiting]]
 468 Limiting by Reachability
 469 ~~~~~~~~~~~~~~~~~~~~~~~~
 470
 471 Git interprets the range specifier "tag-1.0..tag-2.0" as "all commits
 472 reachable from 'tag-2.0' but not from 'tag-1.0'".  Where reachability refers
 473 to what commits are ancestors (or part of the history) of the branch or tagged
 474 revision in question.
 475
 476 If you prefer to specify which commit to preview in this way use the
 477 following:
 478
 479 -----------------------------------------------------------------------------
 480 $ tig tag-2.0 ^tag-1.0
 481 -----------------------------------------------------------------------------
 482
 483 You can think of '^' as a negation operator. Using this alternate syntax, it
 484 is possible to further prune commits by specifying multiple branch cut offs.
 485
 486 [[refspec-combi]]
 487 Combining Revisions Specification
 488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 489
 490 Revisions options can to some degree be combined, which makes it possible to
 491 say "show at most 20 commits from within the last month that changed files
 492 under the Documentation/ directory."
 493
 494 -----------------------------------------------------------------------------
 495 $ tig --since=1.month -n20 -- Documentation/
 496 -----------------------------------------------------------------------------
 497
 498 [[refspec-all]]
 499 Examining All Repository References
 500 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 501
 502 In some cases, it can be useful to query changes across all references in a
 503 repository. An example is to ask "did any line of development in this
 504 repository change a particular file within the last week". This can be
 505 accomplished using:
 506
 507 -----------------------------------------------------------------------------
 508 $ tig --all --since=1.week -- Makefile
 509 -----------------------------------------------------------------------------
 510
 511 include::BUGS[]
 512
 513 [[copy-right]]
 514 Copyright
 515 ---------
 516
 517 Copyright (c) 2006-2008 Jonas Fonseca <fonseca@diku.dk>
 518
 519 This program is free software; you can redistribute it and/or modify
 520 it under the terms of the GNU General Public License as published by
 521 the Free Software Foundation; either version 2 of the License, or
 522 (at your option) any later version.
 523
 524 [[references]]
 525 References and Related Tools
 526 ----------------------------
 527
 528 Manpages:
 529
 530  - manpage:tig[1]
 531  - manpage:tigrc[5]
 532
 533 Online resources:
 534
 535 include::SITES[]
 536
 537 Other git repository browsers:
 538
 539  - gitk(1)
 540  - qgit(1)
 541  - gitview(1)