doc/tig.1.adoc

   1 tig(1)
   2 ======
   3 :docext: adoc
   4 :sysconfdir: /etc
   5
   6 NAME
   7 ----
   8 tig - text-mode interface for Git
   9
  10 SYNOPSIS
  11 --------
  12 [verse]
  13 _______________________________________________________________________
  14 tig        [options] [revisions] [--] [paths]
  15 tig log    [options] [revisions] [--] [paths]
  16 tig show   [options] [revisions] [--] [paths]
  17 tig blame  [options] [rev] [--] path
  18 tig grep   [options] [pattern]
  19 tig stash
  20 tig status
  21 tig <      [Git command output]
  22 _______________________________________________________________________
  23
  24 DESCRIPTION
  25 -----------
  26
  27 Tig is an ncurses-based text-mode interface for git(1). It functions
  28 mainly as a Git repository browser, but can also assist in staging
  29 changes for commit at chunk level and act as a pager for output from
  30 various Git commands.
  31
  32 OPTIONS
  33 -------
  34
  35 Command line options recognized by Tig include all valid git-log(1) and
  36 git-diff(1) options, as well as the following subcommands and Tig specific
  37 options. The first command line parameter not starting with "-" is interpreted
  38 as being either a revision specification or a path and will end the option
  39 parsing. All additional options will be passed to the underlying Git command.
  40
  41 show::
  42         Open diff view using the given git-show(1) options.
  43
  44 blame::
  45         Show given file annotated by commits.
  46         Takes zero or more git-blame(1) options.
  47         Optionally limited from given revision.
  48
  49 status::
  50         Start up in status view.
  51
  52 log::
  53         Start up in log view, displaying git-log(1) output.
  54
  55 stash::
  56         Start up in stash view.
  57
  58 grep::
  59         Open the grep view. Supports the same options as git-grep(1).
  60
  61 +<number>::
  62     Show the first view with line <number> visible and selected.
  63
  64 -v, --version::
  65         Show version and exit.
  66
  67 -h, --help::
  68         Show help message and exit.
  69
  70 PAGER MODE
  71 ----------
  72
  73 Tig enters pager mode when input is provided via stdin and supports the
  74 following subcommands and options:
  75
  76 --
  77
  78  - When the 'show' subcommand is specified and the '--stdin' option is given,
  79    stdin is assumed to be a list of commit IDs and will be forwarded to the diff
  80    view's underlying git-show(1) command. For example:
  81
  82 -----------------------------------------------------------------------------
  83 $ git rev-list --author=vivien HEAD | tig show --stdin
  84 -----------------------------------------------------------------------------
  85
  86  - When '--stdin' is given, stdin is assumed to be a list of commit IDs
  87    and will be forwarded to the main view's underlying git-log(1)
  88    command. For example:
  89
  90 -----------------------------------------------------------------------------
  91 $ tig --no-walk --stdin < cherry-picks.txt
  92 -----------------------------------------------------------------------------
  93
  94  - When '--pretty=raw' is given, stdin is assumed to be a "pretty=raw"
  95    formatted output similar to that of git-log(1). For example:
  96
  97 -----------------------------------------------------------------------------
  98 $ git reflog --pretty=raw | tig --pretty=raw
  99 -----------------------------------------------------------------------------
 100
 101 --
 102
 103 When no subcommands nor options are given, the pager view will be used for
 104 displaying the Git command input given on stdin. The pager view assumes the
 105 input is either from git-log(1) or git-diff(1) and will highlight it similar to
 106 the log and diff views. For example:
 107
 108 -----------------------------------------------------------------------------
 109 $ git log -Schange -p --raw | tig
 110 -----------------------------------------------------------------------------
 111
 112 EXAMPLES
 113 --------
 114
 115 Display the list of commits for the current branch:
 116 -----------------------------------------------------------------------------
 117 $ tig
 118 -----------------------------------------------------------------------------
 119
 120 Display commits from one or more branches:
 121 -----------------------------------------------------------------------------
 122 $ tig test master
 123 -----------------------------------------------------------------------------
 124
 125 Display all branches:
 126 -----------------------------------------------------------------------------
 127 $ tig --all
 128 -----------------------------------------------------------------------------
 129
 130 Display differences between two branches:
 131 -----------------------------------------------------------------------------
 132 $ tig test..master
 133 -----------------------------------------------------------------------------
 134
 135 Display changes for sub-module versions:
 136 -----------------------------------------------------------------------------
 137 $ tig --submodule
 138 -----------------------------------------------------------------------------
 139
 140 Display changes for a single file:
 141 -----------------------------------------------------------------------------
 142 $ tig -- README
 143 -----------------------------------------------------------------------------
 144
 145 Display contents of the README file in a specific revision:
 146 -----------------------------------------------------------------------------
 147 $ tig show tig-0.8:README
 148 -----------------------------------------------------------------------------
 149
 150 Display revisions between two dates for a specific file:
 151 -----------------------------------------------------------------------------
 152 $ tig --after="2004-01-01" --before="2006-05-16" -- README
 153 -----------------------------------------------------------------------------
 154
 155 Blame file with copy detection enabled:
 156 -----------------------------------------------------------------------------
 157 $ tig blame -C README
 158 -----------------------------------------------------------------------------
 159
 160 Display the list of stashes:
 161 -----------------------------------------------------------------------------
 162 $ tig stash
 163 -----------------------------------------------------------------------------
 164
 165 Grep all files for lines containing `DEFINE_ENUM`:
 166 -----------------------------------------------------------------------------
 167 $ tig grep -p DEFINE_ENUM
 168 -----------------------------------------------------------------------------
 169
 170 ENVIRONMENT VARIABLES
 171 ---------------------
 172
 173 In addition to environment variables used by Git (e.g. GIT_DIR), Tig defines
 174 the ones below. The command related environment variables have access to the
 175 internal state of Tig via replacement variables, such as `%(commit)` and
 176 `%(blob)`.
 177 ifdef::version[]
 178 See manpage:tigrc[5] for a full list.
 179 endif::version[]
 180 ifndef::version[]
 181 See link:tigrc.5.{docext}[tigrc(5)] for a full list.
 182 endif::version[]
 183
 184 TIGRC_USER::
 185         Path of the user configuration file (defaults to `~/.tigrc`).
 186
 187 TIGRC_SYSTEM::
 188         Path of the system wide configuration file (defaults to
 189         `{sysconfdir}/tigrc`). Define to empty string to use built-in
 190         configuration.
 191
 192 TIG_LS_REMOTE::
 193         Set command for retrieving all repository references. The command
 194         should output data in the same format as git-ls-remote(1).
 195
 196 TIG_DIFF_OPTS::
 197         The diff options to use in the diff view. The diff view uses
 198         git-show(1) for formatting and always passes --patch-with-stat.  You
 199         may also set the `diff-options` setting in the configuration file.
 200
 201 TIG_TRACE::
 202         Path for trace file where information about Git commands are logged.
 203
 204 FILES
 205 -----
 206 '~/.tigrc'::
 207         User configuration file. See manpage:tigrc[5] for examples.
 208
 209 '{sysconfdir}/tigrc'::
 210         System wide configuration file.
 211
 212 '$GIT_DIR/config'::
 213 '~/.gitconfig::
 214 '{sysconfdir}/gitconfig::
 215         Git configuration files. Read on start-up with the help of
 216         git-config(1).
 217
 218 BUGS
 219 ----
 220
 221 Please visit Tig's http://jonas.nitro.dk/tig[home page] or
 222 https://github.com/jonas/tig[main Git repository] for information about
 223 new releases and how to report bugs or feature request.
 224
 225 COPYRIGHT
 226 ---------
 227 Copyright (c) 2006-2014 Jonas Fonseca <jonas.fonseca@gmail.com>
 228
 229 This program is free software; you can redistribute it and/or modify
 230 it under the terms of the GNU General Public License as published by
 231 the Free Software Foundation; either version 2 of the License, or
 232 (at your option) any later version.
 233
 234 SEE ALSO
 235 --------
 236 ifndef::backend-docbook[]
 237 link:tigrc.5.{docext}[tigrc(5)],
 238 link:manual.{docext}[the Tig manual],
 239 endif::backend-docbook[]
 240 ifdef::backend-docbook[]
 241 manpage:tigrc[5],
 242 manpage:tigmanual[7],
 243 endif::backend-docbook[]
 244 git(7)