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