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 log options]
  28 tig [options] log  [git log options]
  29 tig [options] diff [git diff options]
  30 tig [options] show [git show 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 [git log options]
  81 Open log view using the given git log options\&.
  82
  83 .TP
  84 diff [git diff options]
  85 Open diff view using the given git diff options\&.
  86
  87 .TP
  88 show [git show options]
  89 Open diff view using the given git show options\&.
  90
  91 .TP
  92 [git log 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 .SH "FILES"
 118
 119 .TP
 120 \fI~/\&.tigrc\fR
 121 User configuration file\&. See tigrc(5) for examples\&.
 122
 123 .TP
 124 \fI\&.git/config\fR
 125 Repository config file\&. Read on startup with the help of git\-repo\-config(1)\&.
 126
 127 .SH "BUGS"
 128
 129
 130 Known bugs and problems:
 131
 132 .TP 3
 133 \(bu
 134 In it's current state tig is pretty much UTF\-8 only\&.
 135 .TP
 136 \(bu
 137 If the screen width is very small the main view can draw outside the current view causing bad wrapping\&. Same goes for title and status windows\&.
 138 .TP
 139 \(bu
 140 The cursor can wrap\-around on the last line and cause the window to scroll\&.
 141 .TP
 142 \(bu
 143 The prompt doesn't work while loading\&.
 144 .LP
 145
 146 .SH "COPYRIGHT"
 147
 148
 149 Copyright (c) 2006 Jonas Fonseca <fonseca@diku\&.dk>
 150
 151
 152 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\&.
 153
 154 .SH "SEE ALSO"
 155
 156 .TP 3
 157 \(bu
 158  git(7): \fIhttp://www.kernel.org/pub/software/scm/git/docs/\fR,
 159 .TP
 160 \(bu
 161  cogito(7): \fIhttp://www.kernel.org/pub/software/scm/cogito/docs/\fR
 162 .LP
 163
 164
 165 Other git repository browsers:
 166
 167 .TP 3
 168 \(bu
 169 gitk(1)
 170 .TP
 171 \(bu
 172 qgit(1)
 173 .TP
 174 \(bu
 175 gitview(1)
 176 .LP
 177
 178
 179 Sites:
 180
 181 .TP 3
 182 \(bu
 183 Homepage: http://jonas\&.nitro\&.dk/tig: \fIhttp://jonas.nitro.dk/tig\fR
 184 .TP
 185 \(bu
 186 Releases: http://jonas\&.nitro\&.dk/tig/releases: \fIhttp://jonas.nitro.dk/tig/releases\fR
 187 .TP
 188 \(bu
 189 Git URL: http://jonas\&.nitro\&.dk/tig/tig\&.git: \fIhttp://jonas.nitro.dk/tig/tig.git\fR
 190 .TP
 191 \(bu
 192 Gitweb: http://pasky\&.or\&.cz/gitweb\&.cgi?p=tig\&.git;a=summary: \fIhttp://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary\fR
 193 .LP
 194