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