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  [options] [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(1) options.
  41
  42 blame::
  43         Show given file annotated by commits.
  44         Takes zero or more git-blame(1) options.
  45         Optionally limited from given revision.
  46
  47 status::
  48         Start up in status view.
  49
  50 +<number>::
  51     Show the first view with line <number> visible and selected.
  52
  53 -v, --version::
  54         Show version and exit.
  55
  56 -h, --help::
  57         Show help message and exit.
  58
  59 EXAMPLES
  60 --------
  61
  62 Display the current branch:
  63 -----------------------------------------------------------------------------
  64 $ tig
  65 -----------------------------------------------------------------------------
  66
  67 Display one or more specific branches:
  68 -----------------------------------------------------------------------------
  69 $ tig test master
  70 -----------------------------------------------------------------------------
  71
  72 Display all branches:
  73 -----------------------------------------------------------------------------
  74 $ tig --all
  75 -----------------------------------------------------------------------------
  76
  77 Display differences between two branches:
  78 -----------------------------------------------------------------------------
  79 $ tig test..master
  80 -----------------------------------------------------------------------------
  81
  82 Display changes for a single file:
  83 -----------------------------------------------------------------------------
  84 $ tig -- README
  85 -----------------------------------------------------------------------------
  86
  87 Display contents of the README file in a specific revision:
  88 -----------------------------------------------------------------------------
  89 $ tig show tig-0.8:README
  90 -----------------------------------------------------------------------------
  91
  92 Display revisions between two dates for a specific file:
  93 -----------------------------------------------------------------------------
  94 $ tig --after="2004-01-01" --before="2006-05-16" -- README
  95 -----------------------------------------------------------------------------
  96
  97 Blame file with copy detection enabled:
  98 -----------------------------------------------------------------------------
  99 $ tig blame -C README
 100 -----------------------------------------------------------------------------
 101
 102 ENVIRONMENT VARIABLES
 103 ---------------------
 104
 105 In addition to environment variables used by git (e.g. GIT_DIR), tig defines
 106 the ones below. The command related environment variables have access to the
 107 internal state of tig via replacement variables, such as `%(commit)` and
 108 `%(blob)`. See manpage:tigrc[5] for a full list.
 109
 110 TIGRC_USER::
 111         Path of the user configuration file (defaults to `~/.tigrc`).
 112
 113 TIGRC_SYSTEM::
 114         Path of the system wide configuration file (defaults to
 115         `{sysconfdir}/tigrc`).
 116
 117 TIG_LS_REMOTE::
 118         Set command for retrieving all repository references. The command
 119         should output data in the same format as git-ls-remote(1).
 120
 121 TIG_DIFF_OPTS::
 122         The diff options to use in the diff view. The diff view uses
 123         git-show(1) for formatting and always passes --patch-with-stat.
 124
 125 TIG_TRACE::
 126         Path for trace file where information about git commands are logged.
 127
 128 FILES
 129 -----
 130 '~/.tigrc'::
 131         User configuration file. See manpage:tigrc[5] for examples.
 132
 133 '{sysconfdir}/tigrc'::
 134         System wide configuration file.
 135
 136 '$GIT_DIR/config'::
 137 '~/.gitconfig::
 138 '{sysconfdir}/etc/gitconfig::
 139         Git configuration files. Read on start-up with the help of
 140         git-config(1).
 141
 142 include::BUGS[]
 143
 144 COPYRIGHT
 145 ---------
 146 Copyright (c) 2006-2012 Jonas Fonseca <fonseca@diku.dk>
 147
 148 This program is free software; you can redistribute it and/or modify
 149 it under the terms of the GNU General Public License as published by
 150 the Free Software Foundation; either version 2 of the License, or
 151 (at your option) any later version.
 152
 153 SEE ALSO
 154 --------
 155
 156 manpage:tigrc[5], manpage:tigmanual[7], git(7), gitk(1)
 157
 158 Online resources:
 159
 160 include::SITES[]