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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 7.0.2" />
   7 <style type="text/css">
   8 /* Debug borders */
   9 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  10 /*
  11   border: 1px solid red;
  12 */
  13 }
  14
  15 body {
  16   margin: 1em 5% 1em 5%;
  17 }
  18
  19 a { color: blue; }
  20 a:visited { color: fuchsia; }
  21
  22 em {
  23   font-style: italic;
  24 }
  25
  26 strong {
  27   font-weight: bold;
  28 }
  29
  30 tt {
  31   color: navy;
  32 }
  33
  34 h1, h2, h3, h4, h5, h6 {
  35   color: #527bbd;
  36   font-family: sans-serif;
  37   margin-top: 1.2em;
  38   margin-bottom: 0.5em;
  39   line-height: 1.3;
  40 }
  41
  42 h1 {
  43   border-bottom: 2px solid silver;
  44 }
  45 h2 {
  46   border-bottom: 2px solid silver;
  47   padding-top: 0.5em;
  48 }
  49
  50 div.sectionbody {
  51   font-family: serif;
  52   margin-left: 0;
  53 }
  54
  55 hr {
  56   border: 1px solid silver;
  57 }
  58
  59 p {
  60   margin-top: 0.5em;
  61   margin-bottom: 0.5em;
  62 }
  63
  64 pre {
  65   padding: 0;
  66   margin: 0;
  67 }
  68
  69 span#author {
  70   color: #527bbd;
  71   font-family: sans-serif;
  72   font-weight: bold;
  73   font-size: 1.2em;
  74 }
  75 span#email {
  76 }
  77 span#revision {
  78   font-family: sans-serif;
  79 }
  80
  81 div#footer {
  82   font-family: sans-serif;
  83   font-size: small;
  84   border-top: 2px solid silver;
  85   padding-top: 0.5em;
  86   margin-top: 4.0em;
  87 }
  88 div#footer-text {
  89   float: left;
  90   padding-bottom: 0.5em;
  91 }
  92 div#footer-badges {
  93   float: right;
  94   padding-bottom: 0.5em;
  95 }
  96
  97 div#preamble,
  98 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
  99 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 100 div.admonitionblock {
 101   margin-right: 10%;
 102   margin-top: 1.5em;
 103   margin-bottom: 1.5em;
 104 }
 105 div.admonitionblock {
 106   margin-top: 2.5em;
 107   margin-bottom: 2.5em;
 108 }
 109
 110 div.content { /* Block element content. */
 111   padding: 0;
 112 }
 113
 114 /* Block element titles. */
 115 div.title, caption.title {
 116   font-family: sans-serif;
 117   font-weight: bold;
 118   text-align: left;
 119   margin-top: 1.0em;
 120   margin-bottom: 0.5em;
 121 }
 122 div.title + * {
 123   margin-top: 0;
 124 }
 125
 126 td div.title:first-child {
 127   margin-top: 0.0em;
 128 }
 129 div.content div.title:first-child {
 130   margin-top: 0.0em;
 131 }
 132 div.content + div.title {
 133   margin-top: 0.0em;
 134 }
 135
 136 div.sidebarblock > div.content {
 137   background: #ffffee;
 138   border: 1px solid silver;
 139   padding: 0.5em;
 140 }
 141
 142 div.listingblock > div.content {
 143   border: 1px solid silver;
 144   background: #f4f4f4;
 145   padding: 0.5em;
 146 }
 147
 148 div.quoteblock > div.content {
 149   padding-left: 2.0em;
 150 }
 151 div.quoteblock .attribution {
 152   text-align: right;
 153 }
 154
 155 div.admonitionblock .icon {
 156   vertical-align: top;
 157   font-size: 1.1em;
 158   font-weight: bold;
 159   text-decoration: underline;
 160   color: #527bbd;
 161   padding-right: 0.5em;
 162 }
 163 div.admonitionblock td.content {
 164   padding-left: 0.5em;
 165   border-left: 2px solid silver;
 166 }
 167
 168 div.exampleblock > div.content {
 169   border-left: 2px solid silver;
 170   padding: 0.5em;
 171 }
 172
 173 div.verseblock div.content {
 174   white-space: pre;
 175 }
 176
 177 div.imageblock div.content { padding-left: 0; }
 178 div.imageblock img { border: 1px solid silver; }
 179 span.image img { border-style: none; }
 180
 181 dl {
 182   margin-top: 0.8em;
 183   margin-bottom: 0.8em;
 184 }
 185 dt {
 186   margin-top: 0.5em;
 187   margin-bottom: 0;
 188   font-style: italic;
 189 }
 190 dd > *:first-child {
 191   margin-top: 0;
 192 }
 193
 194 ul, ol {
 195     list-style-position: outside;
 196 }
 197 ol.olist2 {
 198   list-style-type: lower-alpha;
 199 }
 200
 201 div.tableblock > table {
 202   border-color: #527bbd;
 203   border-width: 3px;
 204 }
 205 thead {
 206   font-family: sans-serif;
 207   font-weight: bold;
 208 }
 209 tfoot {
 210   font-weight: bold;
 211 }
 212
 213 div.hlist {
 214   margin-top: 0.8em;
 215   margin-bottom: 0.8em;
 216 }
 217 td.hlist1 {
 218   vertical-align: top;
 219   font-style: italic;
 220   padding-right: 0.8em;
 221 }
 222 td.hlist2 {
 223   vertical-align: top;
 224 }
 225
 226 @media print {
 227   div#footer-badges { display: none; }
 228 }
 229 include::./stylesheets/xhtml11-manpage.css[]
 230 /* Workarounds for IE6's broken and incomplete CSS2. */
 231
 232 div.sidebar-content {
 233   background: #ffffee;
 234   border: 1px solid silver;
 235   padding: 0.5em;
 236 }
 237 div.sidebar-title, div.image-title {
 238   font-family: sans-serif;
 239   font-weight: bold;
 240   margin-top: 0.0em;
 241   margin-bottom: 0.5em;
 242 }
 243
 244 div.listingblock div.content {
 245   border: 1px solid silver;
 246   background: #f4f4f4;
 247   padding: 0.5em;
 248 }
 249
 250 div.quoteblock-content {
 251   padding-left: 2.0em;
 252 }
 253
 254 div.exampleblock-content {
 255   border-left: 2px solid silver;
 256   padding-left: 0.5em;
 257 }
 258 </style>
 259 <title>TIG(1)</title>
 260 </head>
 261 <body>
 262 <div id="header">
 263 <h1>
 264 TIG(1) Manual Page
 265 </h1>
 266 <h2>NAME</h2>
 267 <div class="sectionbody">
 268 <p>tig -
 269    text-mode interface for git
 270 </p>
 271 </div>
 272 </div>
 273 <h2>SYNOPSIS</h2>
 274 <div class="sectionbody">
 275 <div class="verseblock">
 276 <div class="content">tig [options]
 277 tig [options] [--] [git log options]
 278 tig [options] log  [git log options]
 279 tig [options] diff [git diff options]
 280 tig [options] show [git show options]
 281 tig [options] &lt;    [git command output]</div></div>
 282 </div>
 283 <h2>DESCRIPTION</h2>
 284 <div class="sectionbody">
 285 <p>Browse changes in a git repository. Additionally, tig(1) can also act
 286 as a pager for output of various git commands.</p>
 287 <p>When browsing repositories, tig(1) uses the underlying git commands
 288 to present the user with various views, such as summarized commit log
 289 and showing the commit with the log message, diffstat, and the diff.</p>
 290 <p>Using tig(1) as a pager, it will display input from stdin and try
 291 to colorize it.</p>
 292 </div>
 293 <h2>OPTIONS</h2>
 294 <div class="sectionbody">
 295 <dl>
 296 <dt>
 297 -l
 298 </dt>
 299 <dd>
 300 <p>
 301         Start up in log view using the internal log command.
 302 </p>
 303 </dd>
 304 <dt>
 305 -d
 306 </dt>
 307 <dd>
 308 <p>
 309         Start up in diff view using the internal diff command.
 310 </p>
 311 </dd>
 312 <dt>
 313 -n[INTERVAL], --line-number[=INTERVAL]
 314 </dt>
 315 <dd>
 316 <p>
 317         Prefix line numbers in log and diff view.
 318         Optionally, with interval different than each line.
 319 </p>
 320 </dd>
 321 <dt>
 322 -b[NSPACES], --tab-size[=NSPACES]
 323 </dt>
 324 <dd>
 325 <p>
 326         Set the number of spaces tabs should be expanded to.
 327 </p>
 328 </dd>
 329 <dt>
 330 -v, --version
 331 </dt>
 332 <dd>
 333 <p>
 334         Show version and exit.
 335 </p>
 336 </dd>
 337 <dt>
 338 -h, --help
 339 </dt>
 340 <dd>
 341 <p>
 342         Show help message and exit.
 343 </p>
 344 </dd>
 345 <dt>
 346 --
 347 </dt>
 348 <dd>
 349 <p>
 350         End of tig(1) options. Useful when specifying command
 351         options for the main view. Example:
 352 </p>
 353 <div class="literalblock">
 354 <div class="content">
 355 <pre><tt>$ tig -- --since=1.month</tt></pre>
 356 </div></div>
 357 </dd>
 358 <dt>
 359 log [git log options]
 360 </dt>
 361 <dd>
 362 <p>
 363         Open log view using the given git log options.
 364 </p>
 365 </dd>
 366 <dt>
 367 diff [git diff options]
 368 </dt>
 369 <dd>
 370 <p>
 371         Open diff view using the given git diff options.
 372 </p>
 373 </dd>
 374 <dt>
 375 show [git show options]
 376 </dt>
 377 <dd>
 378 <p>
 379         Open diff view using the given git show options.
 380 </p>
 381 </dd>
 382 <dt>
 383 [git log options]
 384 </dt>
 385 <dd>
 386 <p>
 387         tig(1) will stop the option parsing when the first
 388         command line parameter not starting with "-" is
 389         encountered. All options including this one will be
 390         passed to git log when loading the main view.
 391         This makes it possible to say:
 392 </p>
 393 <div class="literalblock">
 394 <div class="content">
 395 <pre><tt>$ tig tag-1.0..HEAD</tt></pre>
 396 </div></div>
 397 </dd>
 398 </dl>
 399 </div>
 400 <h2>ENVIRONMENT VARIABLES</h2>
 401 <div class="sectionbody">
 402 <dl>
 403 <dt>
 404 TIG_LS_REMOTE
 405 </dt>
 406 <dd>
 407 <p>
 408         Set command for retrieving all repository references. The command
 409         should output data in the same format as git-ls-remote(1).
 410 </p>
 411 </dd>
 412 <dt>
 413 TIG_DIFF_CMD
 414 </dt>
 415 <dd>
 416 <p>
 417         The command used for the diff view. By default, git show is used
 418         as a backend.
 419 </p>
 420 </dd>
 421 <dt>
 422 TIG_LOG_CMD
 423 </dt>
 424 <dd>
 425 <p>
 426         The command used for the log view. If you prefer to have both
 427         author and committer shown in the log view be sure to pass
 428         <tt>--pretty=fuller</tt> to git log.
 429 </p>
 430 </dd>
 431 <dt>
 432 TIG_MAIN_CMD
 433 </dt>
 434 <dd>
 435 <p>
 436         The command used for the main view. Note, you must always specify
 437         the option: <tt>--pretty=raw</tt> since the main view parser expects to
 438         read that format.
 439 </p>
 440 </dd>
 441 </dl>
 442 </div>
 443 <h2>FILES</h2>
 444 <div class="sectionbody">
 445 <dl>
 446 <dt>
 447 <em>~/.tigrc</em>
 448 </dt>
 449 <dd>
 450 <p>
 451         User configuration file. See tigrc(5) for examples.
 452 </p>
 453 </dd>
 454 <dt>
 455 <em>.git/config</em>
 456 </dt>
 457 <dd>
 458 <p>
 459         Repository config file. Read on startup with the help of
 460         git-repo-config(1).
 461 </p>
 462 </dd>
 463 </dl>
 464 </div>
 465 <h2>BUGS</h2>
 466 <div class="sectionbody">
 467 <p>Known bugs and problems:</p>
 468 <ul>
 469 <li>
 470 <p>
 471 In it's current state tig is pretty much UTF-8 only.
 472 </p>
 473 </li>
 474 <li>
 475 <p>
 476 If the screen width is very small the main view can draw
 477    outside the current view causing bad wrapping. Same goes
 478    for title and status windows.
 479 </p>
 480 </li>
 481 <li>
 482 <p>
 483 The cursor can wrap-around on the last line and cause the
 484    window to scroll.
 485 </p>
 486 </li>
 487 <li>
 488 <p>
 489 The prompt doesn't work while loading.
 490 </p>
 491 </li>
 492 </ul>
 493 </div>
 494 <h2>COPYRIGHT</h2>
 495 <div class="sectionbody">
 496 <p>Copyright (c) 2006 Jonas Fonseca &lt;fonseca@diku.dk&gt;</p>
 497 <p>This program is free software; you can redistribute it and/or modify
 498 it under the terms of the GNU General Public License as published by
 499 the Free Software Foundation; either version 2 of the License, or
 500 (at your option) any later version.</p>
 501 </div>
 502 <h2>SEE ALSO</h2>
 503 <div class="sectionbody">
 504 <ul>
 505 <li>
 506 <p>
 507 <a href="http://www.kernel.org/pub/software/scm/git/docs/">git(7)</a>,
 508 </p>
 509 </li>
 510 <li>
 511 <p>
 512 <a href="http://www.kernel.org/pub/software/scm/cogito/docs/">cogito(7)</a>
 513 </p>
 514 </li>
 515 </ul>
 516 <p>Other git repository browsers:</p>
 517 <ul>
 518 <li>
 519 <p>
 520 gitk(1)
 521 </p>
 522 </li>
 523 <li>
 524 <p>
 525 qgit(1)
 526 </p>
 527 </li>
 528 <li>
 529 <p>
 530 gitview(1)
 531 </p>
 532 </li>
 533 </ul>
 534 <p>Sites:</p>
 535 <ul>
 536 <li>
 537 <p>
 538 Homepage: <a href="http://jonas.nitro.dk/tig">http://jonas.nitro.dk/tig</a>
 539 </p>
 540 </li>
 541 <li>
 542 <p>
 543 Releases: <a href="http://jonas.nitro.dk/tig/releases">http://jonas.nitro.dk/tig/releases</a>
 544 </p>
 545 </li>
 546 <li>
 547 <p>
 548 Git URL:  <a href="http://jonas.nitro.dk/tig/tig.git">http://jonas.nitro.dk/tig/tig.git</a>
 549 </p>
 550 </li>
 551 <li>
 552 <p>
 553 Gitweb: <a href="http://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary">http://pasky.or.cz/gitweb.cgi?p=tig.git;a=summary</a>
 554 </p>
 555 </li>
 556 </ul>
 557 </div>
 558 <div id="footer">
 559 <div id="footer-text">
 560 Last updated 29-May-2006 21:46:27 CEST
 561 </div>
 562 </div>
 563 </body>
 564 </html>