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