git-help.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 8.2.5" />
   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 {
  20   color: blue;
  21   text-decoration: underline;
  22 }
  23 a:visited {
  24   color: fuchsia;
  25 }
  26
  27 em {
  28   font-style: italic;
  29 }
  30
  31 strong {
  32   font-weight: bold;
  33 }
  34
  35 tt {
  36   color: navy;
  37 }
  38
  39 h1, h2, h3, h4, h5, h6 {
  40   color: #527bbd;
  41   font-family: sans-serif;
  42   margin-top: 1.2em;
  43   margin-bottom: 0.5em;
  44   line-height: 1.3;
  45 }
  46
  47 h1, h2, h3 {
  48   border-bottom: 2px solid silver;
  49 }
  50 h2 {
  51   padding-top: 0.5em;
  52 }
  53 h3 {
  54   float: left;
  55 }
  56 h3 + * {
  57   clear: left;
  58 }
  59
  60 div.sectionbody {
  61   font-family: serif;
  62   margin-left: 0;
  63 }
  64
  65 hr {
  66   border: 1px solid silver;
  67 }
  68
  69 p {
  70   margin-top: 0.5em;
  71   margin-bottom: 0.5em;
  72 }
  73
  74 pre {
  75   padding: 0;
  76   margin: 0;
  77 }
  78
  79 span#author {
  80   color: #527bbd;
  81   font-family: sans-serif;
  82   font-weight: bold;
  83   font-size: 1.1em;
  84 }
  85 span#email {
  86 }
  87 span#revision {
  88   font-family: sans-serif;
  89 }
  90
  91 div#footer {
  92   font-family: sans-serif;
  93   font-size: small;
  94   border-top: 2px solid silver;
  95   padding-top: 0.5em;
  96   margin-top: 4.0em;
  97 }
  98 div#footer-text {
  99   float: left;
 100   padding-bottom: 0.5em;
 101 }
 102 div#footer-badges {
 103   float: right;
 104   padding-bottom: 0.5em;
 105 }
 106
 107 div#preamble,
 108 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 109 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 110 div.admonitionblock {
 111   margin-right: 10%;
 112   margin-top: 1.5em;
 113   margin-bottom: 1.5em;
 114 }
 115 div.admonitionblock {
 116   margin-top: 2.5em;
 117   margin-bottom: 2.5em;
 118 }
 119
 120 div.content { /* Block element content. */
 121   padding: 0;
 122 }
 123
 124 /* Block element titles. */
 125 div.title, caption.title {
 126   font-family: sans-serif;
 127   font-weight: bold;
 128   text-align: left;
 129   margin-top: 1.0em;
 130   margin-bottom: 0.5em;
 131 }
 132 div.title + * {
 133   margin-top: 0;
 134 }
 135
 136 td div.title:first-child {
 137   margin-top: 0.0em;
 138 }
 139 div.content div.title:first-child {
 140   margin-top: 0.0em;
 141 }
 142 div.content + div.title {
 143   margin-top: 0.0em;
 144 }
 145
 146 div.sidebarblock > div.content {
 147   background: #ffffee;
 148   border: 1px solid silver;
 149   padding: 0.5em;
 150 }
 151
 152 div.listingblock {
 153   margin-right: 0%;
 154 }
 155 div.listingblock > div.content {
 156   border: 1px solid silver;
 157   background: #f4f4f4;
 158   padding: 0.5em;
 159 }
 160
 161 div.quoteblock > div.content {
 162   padding-left: 2.0em;
 163 }
 164
 165 div.attribution {
 166   text-align: right;
 167 }
 168 div.verseblock + div.attribution {
 169   text-align: left;
 170 }
 171
 172 div.admonitionblock .icon {
 173   vertical-align: top;
 174   font-size: 1.1em;
 175   font-weight: bold;
 176   text-decoration: underline;
 177   color: #527bbd;
 178   padding-right: 0.5em;
 179 }
 180 div.admonitionblock td.content {
 181   padding-left: 0.5em;
 182   border-left: 2px solid silver;
 183 }
 184
 185 div.exampleblock > div.content {
 186   border-left: 2px solid silver;
 187   padding: 0.5em;
 188 }
 189
 190 div.verseblock div.content {
 191   white-space: pre;
 192 }
 193
 194 div.imageblock div.content { padding-left: 0; }
 195 div.imageblock img { border: 1px solid silver; }
 196 span.image img { border-style: none; }
 197
 198 dl {
 199   margin-top: 0.8em;
 200   margin-bottom: 0.8em;
 201 }
 202 dt {
 203   margin-top: 0.5em;
 204   margin-bottom: 0;
 205   font-style: italic;
 206 }
 207 dd > *:first-child {
 208   margin-top: 0;
 209 }
 210
 211 ul, ol {
 212     list-style-position: outside;
 213 }
 214 div.olist2 ol {
 215   list-style-type: lower-alpha;
 216 }
 217
 218 div.tableblock > table {
 219   border: 3px solid #527bbd;
 220 }
 221 thead {
 222   font-family: sans-serif;
 223   font-weight: bold;
 224 }
 225 tfoot {
 226   font-weight: bold;
 227 }
 228
 229 div.hlist {
 230   margin-top: 0.8em;
 231   margin-bottom: 0.8em;
 232 }
 233 div.hlist td {
 234   padding-bottom: 5px;
 235 }
 236 td.hlist1 {
 237   vertical-align: top;
 238   font-style: italic;
 239   padding-right: 0.8em;
 240 }
 241 td.hlist2 {
 242   vertical-align: top;
 243 }
 244
 245 @media print {
 246   div#footer-badges { display: none; }
 247 }
 248
 249 div#toctitle {
 250   color: #527bbd;
 251   font-family: sans-serif;
 252   font-size: 1.1em;
 253   font-weight: bold;
 254   margin-top: 1.0em;
 255   margin-bottom: 0.1em;
 256 }
 257
 258 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 259   margin-top: 0;
 260   margin-bottom: 0;
 261 }
 262 div.toclevel2 {
 263   margin-left: 2em;
 264   font-size: 0.9em;
 265 }
 266 div.toclevel3 {
 267   margin-left: 4em;
 268   font-size: 0.9em;
 269 }
 270 div.toclevel4 {
 271   margin-left: 6em;
 272   font-size: 0.9em;
 273 }
 274 include1::./stylesheets/xhtml11-manpage.css[]
 275 /* Workarounds for IE6's broken and incomplete CSS2. */
 276
 277 div.sidebar-content {
 278   background: #ffffee;
 279   border: 1px solid silver;
 280   padding: 0.5em;
 281 }
 282 div.sidebar-title, div.image-title {
 283   font-family: sans-serif;
 284   font-weight: bold;
 285   margin-top: 0.0em;
 286   margin-bottom: 0.5em;
 287 }
 288
 289 div.listingblock div.content {
 290   border: 1px solid silver;
 291   background: #f4f4f4;
 292   padding: 0.5em;
 293 }
 294
 295 div.quoteblock-content {
 296   padding-left: 2.0em;
 297 }
 298
 299 div.exampleblock-content {
 300   border-left: 2px solid silver;
 301   padding-left: 0.5em;
 302 }
 303
 304 /* IE6 sets dynamically generated links as visited. */
 305 div#toc a:visited { color: blue; }
 306 </style>
 307 <title>git-help(1)</title>
 308 </head>
 309 <body>
 310 <div id="header">
 311 <h1>
 312 git-help(1) Manual Page
 313 </h1>
 314 <h2>NAME</h2>
 315 <div class="sectionbody">
 316 <p>git-help -
 317    display help information about git
 318 </p>
 319 </div>
 320 </div>
 321 <h2>SYNOPSIS</h2>
 322 <div class="sectionbody">
 323 <div class="para"><p><em>git help</em> [-a|--all|-i|--info|-m|--man|-w|--web] [COMMAND]</p></div>
 324 </div>
 325 <h2 id="_description">DESCRIPTION</h2>
 326 <div class="sectionbody">
 327 <div class="para"><p>With no options and no COMMAND given, the synopsis of the <em>git</em>
 328 command and a list of the most commonly used git commands are printed
 329 on the standard output.</p></div>
 330 <div class="para"><p>If the option <em>--all</em> or <em>-a</em> is given, then all available commands are
 331 printed on the standard output.</p></div>
 332 <div class="para"><p>If a git command is named, a manual page for that command is brought
 333 up. The <em>man</em> program is used by default for this purpose, but this
 334 can be overridden by other options or configuration variables.</p></div>
 335 <div class="para"><p>Note that <tt>git --help &#8230;</tt> is identical to <tt>git help &#8230;</tt> because the
 336 former is internally converted into the latter.</p></div>
 337 </div>
 338 <h2 id="_options">OPTIONS</h2>
 339 <div class="sectionbody">
 340 <div class="vlist"><dl>
 341 <dt>
 342 -a
 343 </dt>
 344 <dt>
 345 --all
 346 </dt>
 347 <dd>
 348 <p>
 349         Prints all the available commands on the standard output. This
 350         option supersedes any other option.
 351 </p>
 352 </dd>
 353 <dt>
 354 -i
 355 </dt>
 356 <dt>
 357 --info
 358 </dt>
 359 <dd>
 360 <p>
 361         Display manual page for the command in the <em>info</em> format. The
 362         <em>info</em> program will be used for that purpose.
 363 </p>
 364 </dd>
 365 <dt>
 366 -m
 367 </dt>
 368 <dt>
 369 --man
 370 </dt>
 371 <dd>
 372 <p>
 373         Display manual page for the command in the <em>man</em> format. This
 374         option may be used to override a value set in the
 375         <em>help.format</em> configuration variable.
 376 </p>
 377 <div class="para"><p>By default the <em>man</em> program will be used to display the manual page,
 378 but the <em>man.viewer</em> configuration variable may be used to choose
 379 other display programs (see below).</p></div>
 380 </dd>
 381 <dt>
 382 -w
 383 </dt>
 384 <dt>
 385 --web
 386 </dt>
 387 <dd>
 388 <p>
 389         Display manual page for the command in the <em>web</em> (HTML)
 390         format. A web browser will be used for that purpose.
 391 </p>
 392 <div class="para"><p>The web browser can be specified using the configuration variable
 393 <em>help.browser</em>, or <em>web.browser</em> if the former is not set. If none of
 394 these config variables is set, the <em>git web&#45;&#45;browse</em> helper script
 395 (called by <em>git help</em>) will pick a suitable default. See
 396 <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a> for more information about this.</p></div>
 397 </dd>
 398 </dl></div>
 399 </div>
 400 <h2 id="_configuration_variables">CONFIGURATION VARIABLES</h2>
 401 <div class="sectionbody">
 402 <h3 id="_help_format">help.format</h3><div style="clear:left"></div>
 403 <div class="para"><p>If no command line option is passed, the <em>help.format</em> configuration
 404 variable will be checked. The following values are supported for this
 405 variable; they make <em>git help</em> behave as their corresponding command
 406 line option:</p></div>
 407 <div class="ilist"><ul>
 408 <li>
 409 <p>
 410 "man" corresponds to <em>-m|--man</em>,
 411 </p>
 412 </li>
 413 <li>
 414 <p>
 415 "info" corresponds to <em>-i|--info</em>,
 416 </p>
 417 </li>
 418 <li>
 419 <p>
 420 "web" or "html" correspond to <em>-w|--web</em>.
 421 </p>
 422 </li>
 423 </ul></div>
 424 <h3 id="_help_browser_web_browser_and_browser_lt_tool_gt_path">help.browser, web.browser and browser.&lt;tool&gt;.path</h3><div style="clear:left"></div>
 425 <div class="para"><p>The <em>help.browser</em>, <em>web.browser</em> and <em>browser.&lt;tool&gt;.path</em> will also
 426 be checked if the <em>web</em> format is chosen (either by command line
 427 option or configuration variable). See <em>-w|--web</em> in the OPTIONS
 428 section above and <a href="git-web&#45;&#45;browse.html">git-web&#45;&#45;browse(1)</a>.</p></div>
 429 <h3 id="_man_viewer">man.viewer</h3><div style="clear:left"></div>
 430 <div class="para"><p>The <em>man.viewer</em> config variable will be checked if the <em>man</em> format
 431 is chosen. The following values are currently supported:</p></div>
 432 <div class="ilist"><ul>
 433 <li>
 434 <p>
 435 "man": use the <em>man</em> program as usual,
 436 </p>
 437 </li>
 438 <li>
 439 <p>
 440 "woman": use <em>emacsclient</em> to launch the "woman" mode in emacs
 441 (this only works starting with emacsclient versions 22),
 442 </p>
 443 </li>
 444 <li>
 445 <p>
 446 "konqueror": use <em>kfmclient</em> to open the man page in a new konqueror
 447 tab (see <em>Note about konqueror</em> below).
 448 </p>
 449 </li>
 450 </ul></div>
 451 <div class="para"><p>Values for other tools can be used if there is a corresponding
 452 <em>man.&lt;tool&gt;.cmd</em> configuration entry (see below).</p></div>
 453 <div class="para"><p>Multiple values may be given to the <em>man.viewer</em> configuration
 454 variable. Their corresponding programs will be tried in the order
 455 listed in the configuration file.</p></div>
 456 <div class="para"><p>For example, this configuration:</p></div>
 457 <div class="listingblock">
 458 <div class="content">
 459 <pre><tt>        [man]
 460                 viewer = konqueror
 461                 viewer = woman</tt></pre>
 462 </div></div>
 463 <div class="para"><p>will try to use konqueror first. But this may fail (for example if
 464 DISPLAY is not set) and in that case emacs' woman mode will be tried.</p></div>
 465 <div class="para"><p>If everything fails, or if no viewer is configured, the viewer specified
 466 in the GIT_MAN_VIEWER environment variable will be tried.  If that
 467 fails too, the <em>man</em> program will be tried anyway.</p></div>
 468 <h3 id="_man_lt_tool_gt_path">man.&lt;tool&gt;.path</h3><div style="clear:left"></div>
 469 <div class="para"><p>You can explicitly provide a full path to your preferred man viewer by
 470 setting the configuration variable <em>man.&lt;tool&gt;.path</em>. For example, you
 471 can configure the absolute path to konqueror by setting
 472 <em>man.konqueror.path</em>. Otherwise, <em>git help</em> assumes the tool is
 473 available in PATH.</p></div>
 474 <h3 id="_man_lt_tool_gt_cmd">man.&lt;tool&gt;.cmd</h3><div style="clear:left"></div>
 475 <div class="para"><p>When the man viewer, specified by the <em>man.viewer</em> configuration
 476 variables, is not among the supported ones, then the corresponding
 477 <em>man.&lt;tool&gt;.cmd</em> configuration variable will be looked up. If this
 478 variable exists then the specified tool will be treated as a custom
 479 command and a shell eval will be used to run the command with the man
 480 page passed as arguments.</p></div>
 481 <h3 id="_note_about_konqueror">Note about konqueror</h3><div style="clear:left"></div>
 482 <div class="para"><p>When <em>konqueror</em> is specified in the <em>man.viewer</em> configuration
 483 variable, we launch <em>kfmclient</em> to try to open the man page on an
 484 already opened konqueror in a new tab if possible.</p></div>
 485 <div class="para"><p>For consistency, we also try such a trick if <em>man.konqueror.path</em> is
 486 set to something like <em>A_PATH_TO/konqueror</em>. That means we will try to
 487 launch <em>A_PATH_TO/kfmclient</em> instead.</p></div>
 488 <div class="para"><p>If you really want to use <em>konqueror</em>, then you can use something like
 489 the following:</p></div>
 490 <div class="listingblock">
 491 <div class="content">
 492 <pre><tt>        [man]
 493                 viewer = konq
 494
 495         [man "konq"]
 496                 cmd = A_PATH_TO/konqueror</tt></pre>
 497 </div></div>
 498 <h3 id="_note_about_git_config_global">Note about git config --global</h3><div style="clear:left"></div>
 499 <div class="para"><p>Note that all these configuration variables should probably be set
 500 using the <em>--global</em> flag, for example like this:</p></div>
 501 <div class="listingblock">
 502 <div class="content">
 503 <pre><tt>$ git config --global help.format web
 504 $ git config --global web.browser firefox</tt></pre>
 505 </div></div>
 506 <div class="para"><p>as they are probably more user specific than repository specific.
 507 See <a href="git-config.html">git-config(1)</a> for more information about this.</p></div>
 508 </div>
 509 <h2 id="_author">Author</h2>
 510 <div class="sectionbody">
 511 <div class="para"><p>Written by Junio C Hamano &lt;gitster@pobox.com&gt; and the git-list
 512 &lt;git@vger.kernel.org&gt;.</p></div>
 513 </div>
 514 <h2 id="_documentation">Documentation</h2>
 515 <div class="sectionbody">
 516 <div class="para"><p>Initial documentation was part of the <a href="git.html">git(1)</a> man page.
 517 Christian Couder &lt;chriscool@tuxfamily.org&gt; extracted and rewrote it a
 518 little. Maintenance is done by the git-list &lt;git@vger.kernel.org&gt;.</p></div>
 519 </div>
 520 <h2 id="_git">GIT</h2>
 521 <div class="sectionbody">
 522 <div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 523 </div>
 524 <div id="footer">
 525 <div id="footer-text">
 526 Last updated 2010-09-18 23:56:45 UTC
 527 </div>
 528 </div>
 529 </body>
 530 </html>