mdw@git.distorted.org.uk Git - tig/blob - tigrc.5.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>tigrc(5)</title>
 260 </head>
 261 <body>
 262 <div id="header">
 263 <h1>
 264 tigrc(5) Manual Page
 265 </h1>
 266 <h2>NAME</h2>
 267 <div class="sectionbody">
 268 <p>tigrc -
 269    tig user configuration file
 270 </p>
 271 </div>
 272 </div>
 273 <h2>SYNOPSIS</h2>
 274 <div class="sectionbody">
 275 <div class="verseblock">
 276 <div class="content"><strong>color</strong> <em>fgcolor</em> <em>bgcolor</em> <em>[attributes]</em></div></div>
 277 </div>
 278 <h2>DESCRIPTION</h2>
 279 <div class="sectionbody">
 280 <p>You can permanently set an option by putting it in the <tt>~/.tigrc</tt> file.
 281 The file consists of a series of <em>commands</em>.  Each
 282 line of the file may contain only one command.</p>
 283 <p>The hash mark (<em>#</em>), or semi-colon (<em>;</em>) is used as a <em>comment</em> character.
 284 All text after the comment character to the end of the line is ignored.
 285 You can use comments to annotate your initialization file.</p>
 286 </div>
 287 <h2>Color options</h2>
 288 <div class="sectionbody">
 289 <p>Color options control highlighting and the user interface styles.
 290 If  your terminal supports color, these commands can be used to assign
 291 foreground/backgound combinations to certain areas. Optionally, an
 292 attribute can be given as the last parameter. The syntax is:</p>
 293 <div class="verseblock">
 294 <div class="content">        <strong>color</strong> <em>area</em> <em>fgcolor</em> <em>bgcolor</em> <em>[attributes]</em></div></div>
 295 <p>Valid colors include: <strong>white</strong>, <strong>black</strong>, <strong>green</strong>, <strong>magenta</strong>, <strong>blue</strong>, <strong>cyan</strong>,
 296 <strong>yellow</strong>, <strong>red</strong>, <strong>default</strong>. Use <strong>default</strong> to refer to the default terminal
 297 colors.</p>
 298 <p>Valid attributes include: <strong>normal</strong>, <strong>blink</strong>, <strong>bold</strong>, <strong>dim</strong>, <strong>reverse</strong>, <strong>standout</strong>,
 299 and <strong>underline</strong>. Note, not all attributes may be supported by the terminal.</p>
 300 <p>Valid area names are described below. Note, all names are case-insensitive,
 301 and you may use <em>-</em>, <em>_</em>, and <em>.</em> interchangeably. So "Diff-Header",
 302 "DIFF_HEADER", and "diff.header" are the same.</p>
 303 <h3>Diff markup</h3>
 304 <p>Options concerning diff start, chunks and lines added and deleted.</p>
 305 <p><strong>diff-header</strong>, <strong>diff-chunk</strong>, <strong>diff-add</strong>, <strong>diff-del</strong></p>
 306 <h3>Enhanced git diff markup</h3>
 307 <p>Extra diff information emitted by the git diff machinery, such as mode
 308 changes, rename detection, and similarity.</p>
 309 <p><strong>diff-oldmode</strong>, <strong>diff-newmode</strong>, <strong>diff-copy-from</strong>, <strong>diff-copy-to</strong>,
 310 <strong>diff-rename-from</strong>, <strong>diff-rename-to</strong>, <strong>diff-similarity</strong> <strong>diff-dissimilarity</strong>
 311 <strong>diff-tree</strong>, <strong>diff-index</strong></p>
 312 <h3>Pretty print commit headers</h3>
 313 <p>Commit diffs and the revision logs are usually formatted using pretty
 314 printed headers , unless <tt>--pretty=raw</tt> was given. This includes lines,
 315 such as merge info, commit ID, and author and comitter date.</p>
 316 <p><strong>pp-author</strong>, <strong>pp-commit</strong>, <strong>pp-merge</strong>, <strong>pp-date</strong>, <strong>pp-adate</strong>, <strong>pp-cdate</strong></p>
 317 <h3>Raw commit header</h3>
 318 <p>Usually shown when <tt>--pretty=raw</tt> is given, however <em>commit</em> is pretty
 319 much omnipresent.</p>
 320 <p><strong>commit</strong>, <strong>parent</strong>, <strong>tree</strong>, <strong>author</strong>, <strong>committer</strong></p>
 321 <h3>Commit message</h3>
 322 <p>For now only <tt>Signed-off-by lines</tt> are colorized.</p>
 323 <p><strong>signoff</strong></p>
 324 <h3>UI colors</h3>
 325 <p>Colors for text not matching any of the above: <strong>default</strong></p>
 326 <p>Status window colors: <strong>status</strong></p>
 327 <p>Title window colors: <strong>title-blur</strong>, <strong>title-focus</strong></p>
 328 <p>Cursor line colors: <strong>cursor</strong></p>
 329 <p>Main view specific: <strong>main-date</strong>, <strong>main-author</strong>, <strong>main-commit</strong>, <strong>main-delim</strong>,
 330 <strong>main-tag</strong>, <strong>main-ref</strong></p>
 331 </div>
 332 <h2>EXAMPLES</h2>
 333 <div class="sectionbody">
 334 <p>Some sample options:</p>
 335 <div class="exampleblock">
 336 <div class="exampleblock-content">
 337 <div class="literalblock">
 338 <div class="content">
 339 <pre><tt># Diff colors
 340 color diff-header       yellow  default
 341 color diff-index        blue    default
 342 color diff-chunk        magenta default
 343 # UI colors
 344 color title-blur        white   blue
 345 color title-focus       white   blue    bold</tt></pre>
 346 </div></div>
 347 </div></div>
 348 </div>
 349 <h2>SEE ALSO</h2>
 350 <div class="sectionbody">
 351 <p>tig(1)</p>
 352 </div>
 353 <div id="footer">
 354 <div id="footer-text">
 355 Last updated 29-May-2006 21:46:30 CEST
 356 </div>
 357 </div>
 358 </body>
 359 </html>