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