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 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
 217 The stage view::
 218         Displays diff changes for staged or unstanged files being tracked or
 219         file content of untracked files.
 220
 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::
 226         Displays key binding quick reference.
 227
 228 [[title-window]]
 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
 235 -----------------------------------------------------------------------------
 236 [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%)
 237 -----------------------------------------------------------------------------
 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
 243 -----------------------------------------------------------------------------
 244 [main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s
 245 -----------------------------------------------------------------------------
 246
 247 [[keys]]
 248 Default Keybindings
 249 -------------------
 250 Below the default key bindings are shown.
 251
 252 [[view-switching]]
 253 View Switching
 254 ~~~~~~~~~~~~~~
 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.
 263 t       Switch to (directory) tree view.
 264 f       Switch to (file) blob view.
 265 h       Switch to help view
 266 S       Switch to status view
 267 c       Switch to stage view
 268 -----------------------------------------------------------------------------
 269
 270 [[view-manipulation]]
 271 View Manipulation
 272 ~~~~~~~~~~~~~~~~~
 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 \
 279         will quit. Use 'Q' to quit all views at once.
 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 \
 283         pressing Enter will simply scroll the view one line down.
 284 Tab     Switch to next view.
 285 R       Reload and refresh the current view.
 286 Up      This key is "context sensitive" and will move the cursor one \
 287         line up. However, if you opened a diff view from the main view \
 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 \
 290         to display it.
 291 Down    Similar to 'Up' but will move down.
 292 -----------------------------------------------------------------------------
 293
 294 [[cursor-nav]]
 295 Cursor Navigation
 296 ~~~~~~~~~~~~~~~~~
 297
 298 `-------`--------------------------------------------------------------------
 299 Key     Action
 300 -----------------------------------------------------------------------------
 301 j       Move cursor one line up.
 302 k       Move cursor one line down.
 303 PgUp,\
 304 -,a     Move cursor one page up.
 305 PgDown  Space   Move cursor one page down.
 306 Home    Jump to first line.
 307 End     Jump to last line.
 308 -----------------------------------------------------------------------------
 309
 310 [[view-scrolling]]
 311 Scrolling
 312 ~~~~~~~~~
 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 -----------------------------------------------------------------------------
 322
 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
 336 [[misc-keys]]
 337 Misc
 338 ~~~~
 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 \
 347         the revision log.
 348 v       Show version.
 349 '.'     Toggle line numbers on/off.
 350 D       Toggle date display on/off.
 351 A       Toggle author display on/off.
 352 g       Toggle revision graph visualization on/off.
 353 F       Toggle reference display on/off (tag and branch names).
 354 ':'     Open prompt. This allows you to specify what git command \
 355         to run. Example `:log -p`
 356 u       Update status of file. In the status view, this allows you to add an \
 357         untracked file or stage changes to a file for next commit (similar to \
 358         running git-add <filename>). In the stage view, when pressing this on \
 359         a diff chunk line stages only that chunk for next commit, when not on \
 360         a diff chunk line all changes in the displayed diff is staged.
 361 M       Resolve unmerged file by launching git-mergetool(1). Note, to work \
 362         correctly this might require some initial configuration of your \
 363         preferred merge tool. See the manpage of git-mergetool(1).
 364 ','     Move tree view to the parent tree.
 365 e       Open file in editor.
 366 -----------------------------------------------------------------------------
 367
 368 [[external-commands]]
 369 External Commands
 370 ~~~~~~~~~~~~~~~~~
 371
 372 Tig also comes with a few builtin external commands. These are simple shell
 373 commands that are run and can take arguments from the current browsing state,
 374 such as the current commit ID. The default commands are:
 375
 376 `-------`--------------------------------------------------------------------
 377 Key     Action
 378 -----------------------------------------------------------------------------
 379 C       git cherry-pick %(commit)
 380 G       git gc
 381 -----------------------------------------------------------------------------
 382
 383 [[refspec]]
 384 Revision Specification
 385 ----------------------
 386
 387 This section describes various ways to specify what revisions to display or
 388 otherwise limit the view to. Tig does not itself parse the described
 389 revision options so refer to the relevant git man pages for further
 390 information. Relevant man pages besides git-log(1) are git-diff(1) and
 391 git-rev-list(1).
 392
 393 You can tune the interaction with git by making use of the options explained
 394 in this section. For example, by configuring the environment variables
 395 described in the  <<history-commands, "History commands">> section.
 396
 397 [[path-limiting]]
 398 Limit by Path Name
 399 ~~~~~~~~~~~~~~~~~~
 400
 401 If you are interested only in those revisions that made changes to a specific
 402 file (or even several files) list the files like this:
 403
 404 -----------------------------------------------------------------------------
 405 $ tig Makefile README
 406 -----------------------------------------------------------------------------
 407
 408 To avoid ambiguity with tig's subcommands or repository references such as tag
 409 name, be sure to separate file names from other git options using "\--". So if
 410 you have a file named 'status' it will clash with the 'status' subcommand, and
 411 thus you will have to use:
 412
 413 -----------------------------------------------------------------------------
 414 $ tig -- status
 415 -----------------------------------------------------------------------------
 416
 417 NOTE: For the main view, avoiding ambiguity will in some cases require you to
 418 specify two "\--" options. The first will make tig stop option processing
 419 and the latter will be passed to git log.
 420
 421 [[date-number-limiting]]
 422 Limit by Date or Number
 423 ~~~~~~~~~~~~~~~~~~~~~~~
 424
 425 To speed up interaction with git, you can limit the amount of commits to show
 426 both for the log and main view. Either limit by date using e.g.
 427 `--since=1.month` or limit by the number of commits using `-n400`.
 428
 429 If you are only interested in changed that happened between two dates you can
 430 use:
 431
 432 -----------------------------------------------------------------------------
 433 $ tig --after="May 5th" --before="2006-05-16 15:44"
 434 -----------------------------------------------------------------------------
 435
 436 NOTE: If you want to avoid having to quote dates containing spaces you can use
 437 "." instead, e.g. `--after=May.5th`.
 438
 439 [[commit-range-limiting]]
 440 Limiting by Commit Ranges
 441 ~~~~~~~~~~~~~~~~~~~~~~~~~
 442
 443 Alternatively, commits can be limited to a specific range, such as "all
 444 commits between 'tag-1.0' and 'tag-2.0'". For example:
 445
 446 -----------------------------------------------------------------------------
 447 $ tig tag-1.0..tag-2.0
 448 -----------------------------------------------------------------------------
 449
 450 This way of commit limiting makes it trivial to only browse the commits which
 451 haven't been pushed to a remote branch. Assuming 'origin' is your upstream
 452 remote branch, using:
 453
 454 -----------------------------------------------------------------------------
 455 $ tig origin..HEAD
 456 -----------------------------------------------------------------------------
 457
 458 will list what will be pushed to the remote branch. Optionally, the ending
 459 'HEAD' can be left out since it is implied.
 460
 461 [[reachability-limiting]]
 462 Limiting by Reachability
 463 ~~~~~~~~~~~~~~~~~~~~~~~~
 464
 465 Git interprets the range specifier "tag-1.0..tag-2.0" as "all commits
 466 reachable from 'tag-2.0' but not from 'tag-1.0'".  Where reachability refers
 467 to what commits are ancestors (or part of the history) of the branch or tagged
 468 revision in question.
 469
 470 If you prefer to specify which commit to preview in this way use the
 471 following:
 472
 473 -----------------------------------------------------------------------------
 474 $ tig tag-2.0 ^tag-1.0
 475 -----------------------------------------------------------------------------
 476
 477 You can think of '^' as a negation operator. Using this alternate syntax, it
 478 is possible to further prune commits by specifying multiple branch cut offs.
 479
 480 [[refspec-combi]]
 481 Combining Revisions Specification
 482 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 483
 484 Revisions options can to some degree be combined, which makes it possible to
 485 say "show at most 20 commits from within the last month that changed files
 486 under the Documentation/ directory."
 487
 488 -----------------------------------------------------------------------------
 489 $ tig --since=1.month -n20 -- Documentation/
 490 -----------------------------------------------------------------------------
 491
 492 [[refspec-all]]
 493 Examining All Repository References
 494 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 495
 496 In some cases, it can be useful to query changes across all references in a
 497 repository. An example is to ask "did any line of development in this
 498 repository change a particular file within the last week". This can be
 499 accomplished using:
 500
 501 -----------------------------------------------------------------------------
 502 $ tig --all --since=1.week -- Makefile
 503 -----------------------------------------------------------------------------
 504
 505 include::BUGS[]
 506
 507 [[copy-right]]
 508 Copyright
 509 ---------
 510
 511 Copyright (c) 2006-2007 Jonas Fonseca <fonseca@diku.dk>
 512
 513 This program is free software; you can redistribute it and/or modify
 514 it under the terms of the GNU General Public License as published by
 515 the Free Software Foundation; either version 2 of the License, or
 516 (at your option) any later version.
 517
 518 [[references]]
 519 References and Related Tools
 520 ----------------------------
 521
 522 Manpages:
 523
 524  - gitlink:tig[1]
 525  - gitlink:tigrc[5]
 526
 527 Online resources:
 528
 529 include::SITES[]
 530
 531 Other git repository browsers:
 532
 533  - gitk(1)
 534  - qgit(1)
 535  - gitview(1)