mdw@git.distorted.org.uk 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]
  12 tig [options] [--] [git options]
  13 tig [options] log  [git options]
  14 tig [options] diff [git options]
  15 tig [options] show [git options]
  16 tig [options] <    [git command output]
  17
  18 DESCRIPTION
  19 -----------
  20 Browse changes in a git repository. Additionally, tig(1) can also act
  21 as a pager for output of various git commands.
  22
  23 When browsing repositories, tig(1) uses the underlying git commands
  24 to present the user with various views, such as summarized commit log
  25 and showing the commit with the log message, diffstat, and the diff.
  26
  27 Using tig(1) as a pager, it will display input from stdin and try
  28 to colorize it.
  29
  30 OPTIONS
  31 -------
  32
  33 -l::
  34         Start up in log view using the internal log command.
  35
  36 -d::
  37         Start up in diff view using the internal diff command.
  38
  39 -S::
  40         Start up in status view.
  41
  42 -n[INTERVAL], --line-number[=INTERVAL]::
  43         Prefix line numbers in log and diff view.
  44         Optionally, with interval different than each line.
  45
  46 -b[NSPACES], --tab-size[=NSPACES]::
  47         Set the number of spaces tabs should be expanded to.
  48
  49 -v, --version::
  50         Show version and exit.
  51
  52 -h, --help::
  53         Show help message and exit.
  54
  55 \--::
  56         End of tig(1) options. Useful when specifying command
  57         options for the main view. Example:
  58
  59                 $ tig -- --since=1.month
  60
  61 log::
  62         Open log view using the given git log options.
  63
  64 diff::
  65         Open diff view using the given git diff options.
  66
  67 show::
  68         Open diff view using the given git show options.
  69
  70 [git options]::
  71         tig(1) will stop the option parsing when the first
  72         command line parameter not starting with "-" is
  73         encountered. All options including this one will be
  74         passed to git log when loading the main view.
  75         This makes it possible to say:
  76
  77         $ tig tag-1.0..HEAD
  78
  79 ENVIRONMENT VARIABLES
  80 ---------------------
  81 TIG_LS_REMOTE::
  82         Set command for retrieving all repository references. The command
  83         should output data in the same format as git-ls-remote(1).
  84
  85 TIG_DIFF_CMD::
  86         The command used for the diff view. By default, git show is used
  87         as a backend.
  88
  89 TIG_LOG_CMD::
  90         The command used for the log view. If you prefer to have both
  91         author and committer shown in the log view be sure to pass
  92         `--pretty=fuller` to git log.
  93
  94 TIG_MAIN_CMD::
  95         The command used for the main view. Note, you must always specify
  96         the option: `--pretty=raw` since the main view parser expects to
  97         read that format.
  98
  99 Tree commands
 100 ~~~~~~~~~~~~~
 101 TIG_TREE_CMD::
 102     The command used for the tree view. By default, git-ls-tree(1) is
 103     used. The commands should expect first the commit ID and second
 104     a path.
 105
 106 TIG_BLOB_CMD::
 107     The command used for the blob view. By default, git-cat-file(1) is
 108     used. The command gets the blob ID.
 109
 110 FILES
 111 -----
 112 '~/.tigrc'::
 113         User configuration file. See gitlink:tigrc[5] for examples.
 114
 115 '.git/config'::
 116         Repository config file. Read on start-up with the help of
 117         git-repo-config(1).
 118
 119 include::BUGS[]
 120
 121 COPYRIGHT
 122 ---------
 123 Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
 124
 125 This program is free software; you can redistribute it and/or modify
 126 it under the terms of the GNU General Public License as published by
 127 the Free Software Foundation; either version 2 of the License, or
 128 (at your option) any later version.
 129
 130 SEE ALSO
 131 --------
 132
 133 gitlink:tigrc[5], git(7), cogito(7), as well as other git repository browsers:
 134 gitk(1), qgit(1), gitview(1).
 135
 136 Online resources:
 137
 138 include::SITES[]