tig.1.txt

   1 tig(1)
   2 ======
   3
   4 NAME
   5 ----
   6 tig - text-mode interface for git
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 tig        [options] [revisions] [--] [paths]
  12 tig show   [options] [revisions] [--] [paths]
  13 tig blame  [rev] path
  14 tig status
  15 tig <      [git command output]
  16
  17 DESCRIPTION
  18 -----------
  19 Browse changes in a git repository. Additionally, tig(1) can also act
  20 as a pager for output of various git commands.
  21
  22 When browsing repositories, tig(1) uses the underlying git commands
  23 to present the user with various views, such as summarized commit log
  24 and showing the commit with the log message, diffstat, and the diff.
  25
  26 Using tig(1) as a pager, it will display input from stdin and try
  27 to colorize it.
  28
  29 OPTIONS
  30 -------
  31
  32 Command line options recognized by tig include all valid git-log(1) and
  33 git-diff(1) options, as well as the following subcommands and tig specific
  34 options. The first command line parameter not starting with "-" is interpreted
  35 as being either a revision specification or a path and will end the option
  36 parsing. All following options will be passed untouched to the underlying git
  37 command.
  38
  39 show::
  40         Open diff view using the given git show options.
  41
  42 blame::
  43         Show given file annotated or blamed by commits.
  44         Optionally limited from given revision.
  45
  46 status::
  47         Start up in status view.
  48
  49 -v, --version::
  50         Show version and exit.
  51
  52 -h, --help::
  53         Show help message and exit.
  54
  55 EXAMPLES
  56 --------
  57
  58 Display the current branch:
  59 -----------------------------------------------------------------------------
  60 $ tig
  61 -----------------------------------------------------------------------------
  62
  63 Display one or more specific branches:
  64 -----------------------------------------------------------------------------
  65 $ tig test master
  66 -----------------------------------------------------------------------------
  67
  68 Display all branches:
  69 -----------------------------------------------------------------------------
  70 $ tig --all
  71 -----------------------------------------------------------------------------
  72
  73 Display differences between two branches:
  74 -----------------------------------------------------------------------------
  75 $ tig test..master
  76 -----------------------------------------------------------------------------
  77
  78 Display changes for a single file:
  79 -----------------------------------------------------------------------------
  80 $ tig -- README
  81 -----------------------------------------------------------------------------
  82
  83 Display contents of the README file in a specific revision:
  84 -----------------------------------------------------------------------------
  85 $ tig show tig-0.8:README
  86 -----------------------------------------------------------------------------
  87
  88 Display revisions between two dates for a specific file:
  89 -----------------------------------------------------------------------------
  90 $ tig --after="2004-01-01" --before="2006-05-16" -- README
  91 -----------------------------------------------------------------------------
  92
  93 ENVIRONMENT VARIABLES
  94 ---------------------
  95
  96 In addition to environment variables used by git (e.g. GIT_DIR), tig defines
  97 the ones below. The command related environment variables have access to the
  98 internal state of tig via replacement variabls, such as `%(commit)` and
  99 `%(blob)`. See manpage:tigrc[5] for a full list.
 100
 101 TIGRC_USER::
 102         Path of the user configuration file (defaults to `~/.tigrc`).
 103
 104 TIGRC_SYSTEM::
 105         Path of the system wide configuration file (defaults to
 106         `{sysconfdir}/tigrc`).
 107
 108 TIG_LS_REMOTE::
 109         Set command for retrieving all repository references. The command
 110         should output data in the same format as git-ls-remote(1).
 111
 112 TIG_DIFF_CMD::
 113         The command used for the diff view. By default, git show is used
 114         as a backend.
 115
 116 TIG_LOG_CMD::
 117         The command used for the log view. If you prefer to have both
 118         author and committer shown in the log view be sure to pass
 119         `--pretty=fuller` to git log.
 120
 121 TIG_MAIN_CMD::
 122         The command used for the main view. Note, you must always specify
 123         the option: `--pretty=raw` since the main view parser expects to
 124         read that format.
 125
 126 Tree commands
 127 ~~~~~~~~~~~~~
 128 TIG_TREE_CMD::
 129     The command used for the tree view. By default, git-ls-tree(1) is
 130     used. The commands should expect first the commit ID and second
 131     a path.
 132
 133 TIG_BLOB_CMD::
 134     The command used for the blob view. By default, git-cat-file(1) is
 135     used. The command gets the blob ID.
 136
 137 FILES
 138 -----
 139 '~/.tigrc'::
 140         User configuration file. See manpage:tigrc[5] for examples.
 141
 142 '{sysconfdir}/tigrc'::
 143         System wide configuration file.
 144
 145 '$GIT_DIR/config'::
 146         Repository config file. Read on start-up with the help of
 147         git-config(1).
 148
 149 include::BUGS[]
 150
 151 COPYRIGHT
 152 ---------
 153 Copyright (c) 2006-2009 Jonas Fonseca <fonseca@diku.dk>
 154
 155 This program is free software; you can redistribute it and/or modify
 156 it under the terms of the GNU General Public License as published by
 157 the Free Software Foundation; either version 2 of the License, or
 158 (at your option) any later version.
 159
 160 SEE ALSO
 161 --------
 162
 163 manpage:tigrc[5], git(7), cogito(7), as well as other git repository browsers:
 164 gitk(1), qgit(1), gitview(1).
 165
 166 Online resources:
 167
 168 include::SITES[]