mdw@git.distorted.org.uk Git - tig/blob - tig.1

   1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
   2 .de Sh \" Subsection
   3 .br
   4 .if t .Sp
   5 .ne 5
   6 .PP
   7 \fB\\$1\fR
   8 .PP
   9 ..
  10 .de Sp \" Vertical space (when we can't use .PP)
  11 .if t .sp .5v
  12 .if n .sp
  13 ..
  14 .de Ip \" List item
  15 .br
  16 .ie \\n(.$>=3 .ne \\$3
  17 .el .ne 3
  18 .IP "\\$1" \\$2
  19 ..
  20 .TH "TIG" 1 "" "" ""
  21 .SH NAME
  22 tig \- text-mode interface for git
  23 .SH "SYNOPSIS"
  24
  25 .nf
  26 tig [options]
  27 tig [options] [\-\-] [git options]
  28 tig [options] log  [git options]
  29 tig [options] diff [git options]
  30 tig [options] show [git options]
  31 tig [options] <    [git command output]
  32 .fi
  33
  34 .SH "DESCRIPTION"
  35
  36
  37 Browse changes in a git repository\&. Additionally, tig(1) can also act as a pager for output of various git commands\&.
  38
  39
  40 When browsing repositories, tig(1) uses the underlying git commands to present the user with various views, such as summarized commit log and showing the commit with the log message, diffstat, and the diff\&.
  41
  42
  43 Using tig(1) as a pager, it will display input from stdin and try to colorize it\&.
  44
  45 .SH "OPTIONS"
  46
  47 .TP
  48 \-l
  49 Start up in log view using the internal log command\&.
  50
  51 .TP
  52 \-d
  53 Start up in diff view using the internal diff command\&.
  54
  55 .TP
  56 \-n[INTERVAL], \-\-line\-number[=INTERVAL]
  57 Prefix line numbers in log and diff view\&. Optionally, with interval different than each line\&.
  58
  59 .TP
  60 \-b[NSPACES], \-\-tab\-size[=NSPACES]
  61 Set the number of spaces tabs should be expanded to\&.
  62
  63 .TP
  64 \-v, \-\-version
  65 Show version and exit\&.
  66
  67 .TP
  68 \-h, \-\-help
  69 Show help message and exit\&.
  70
  71 .TP
  72 \-\-
  73 End of tig(1) options\&. Useful when specifying command options for the main view\&. Example:
  74
  75 .nf
  76 $ tig \-\- \-\-since=1\&.month
  77 .fi
  78
  79 .TP
  80 log
  81 Open log view using the given git log options\&.
  82
  83 .TP
  84 diff
  85 Open diff view using the given git diff options\&.
  86
  87 .TP
  88 show
  89 Open diff view using the given git show options\&.
  90
  91 .TP
  92 [git options]
  93 tig(1) will stop the option parsing when the first command line parameter not starting with "\-" is encountered\&. All options including this one will be passed to git log when loading the main view\&. This makes it possible to say:
  94
  95 .nf
  96 $ tig tag\-1\&.0\&.\&.HEAD
  97 .fi
  98
  99 .SH "ENVIRONMENT VARIABLES"
 100
 101 .TP
 102 TIG_LS_REMOTE
 103 Set command for retrieving all repository references\&. The command should output data in the same format as git\-ls\-remote(1)\&.
 104
 105 .TP
 106 TIG_DIFF_CMD
 107 The command used for the diff view\&. By default, git show is used as a backend\&.
 108
 109 .TP
 110 TIG_LOG_CMD
 111 The command used for the log view\&. If you prefer to have both author and committer shown in the log view be sure to pass \-\-pretty=fuller to git log\&.
 112
 113 .TP
 114 TIG_MAIN_CMD
 115 The command used for the main view\&. Note, you must always specify the option: \-\-pretty=raw since the main view parser expects to read that format\&.
 116
 117 .SS "Tree commands"
 118
 119 .TP
 120 TIG_TREE_CMD
 121 The command used for the tree view\&. By default, git\-ls\-tree(1) is used\&. The commands should expect first the commit ID and second a path\&.
 122
 123 .TP
 124 TIG_BLOB_CMD
 125 The command used for the blob view\&. By default, git\-cat\-file(1) is used\&. The command gets the blob ID\&.
 126
 127 .SH "FILES"
 128
 129 .TP
 130 \fI~/\&.tigrc\fR
 131 User configuration file\&. See \fBtigrc\fR(5) for examples\&.
 132
 133 .TP
 134 \fI\&.git/config\fR
 135 Repository config file\&. Read on start\-up with the help of git\-repo\-config(1)\&.
 136
 137 .SH "BUGS"
 138
 139
 140 Known bugs and problems:
 141
 142 .TP 3
 143 \(bu
 144 Proper locale support: in it's current state tig is pretty much UTF\-8 only\&.
 145 .TP
 146 \(bu
 147 Horizontal scrolling\&.
 148 .LP
 149
 150 .SH "COPYRIGHT"
 151
 152
 153 Copyright (c) 2006 Jonas Fonseca <fonseca@diku\&.dk>
 154
 155
 156 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version\&.
 157
 158 .SH "SEE ALSO"
 159
 160
 161 \fBtigrc\fR(5), git(7), cogito(7), as well as other git repository browsers: gitk(1), qgit(1), gitview(1)\&.
 162
 163
 164 Online resources:
 165
 166 .TP 3
 167 \(bu
 168 Homepage: http://jonas\&.nitro\&.dk/tig: \fIhttp://jonas.nitro.dk/tig\fR
 169 .TP
 170 \(bu
 171 Manual: http://jonas\&.nitro\&.dk/tig/manual\&.html: \fIhttp://jonas.nitro.dk/tig/manual.html\fR
 172 .TP
 173 \(bu
 174 Releases: http://jonas\&.nitro\&.dk/tig/releases: \fIhttp://jonas.nitro.dk/tig/releases\fR
 175 .TP
 176 \(bu
 177 Git URL: http://jonas\&.nitro\&.dk/tig/tig\&.git: \fIhttp://jonas.nitro.dk/tig/tig.git\fR
 178 .TP
 179 \(bu
 180 Gitweb: http://pasky\&.or\&.cz/gitweb\&.cgi?p=tig\&.git;a=summary: \fIhttp://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary\fR
 181 .LP
 182