| blob | a25f73361e34bcb5b5e15e1fade6618dd28eb033 |
4 <head>
9 /* Debug borders */
11 /*
12 border: 1px solid red;
13 */
14 }
16 body {
18 }
20 a {
23 }
26 }
28 em {
31 }
33 strong {
36 }
38 tt {
40 }
48 }
52 }
53 h2 {
55 }
56 h3 {
58 }
59 h3 + * {
61 }
66 }
68 hr {
70 }
72 p {
75 }
79 }
81 pre {
84 }
86 span#author {
91 }
92 span#email {
93 }
96 }
98 div#footer {
104 }
105 div#footer-text {
108 }
109 div#footer-badges {
112 }
114 div#preamble {
117 }
123 }
127 }
131 }
133 /* Block element titles. */
141 }
144 }
148 }
151 }
154 }
160 }
166 }
171 }
175 }
180 }
183 }
187 }
188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
191 }
200 }
204 }
209 }
215 dl {
218 }
219 dt {
224 }
227 }
231 }
234 }
237 }
240 }
243 }
246 }
253 }
257 }
258 thead {
261 }
262 tfoot {
264 }
267 }
270 }
271 /* Because the table frame attribute is overriden by CSS in most browsers. */
274 }
278 }
282 }
288 }
291 }
294 }
300 }
303 }
307 }
311 }
315 }
317 div#toctitle {
324 }
329 }
333 }
337 }
341 }
342 /* Overrides for manpage documents */
343 h1 {
348 }
349 h2 {
351 }
354 }
358 }
360 /* Workarounds for IE6's broken and incomplete CSS2. */
366 }
373 }
379 }
384 }
388 }
392 }
397 }
399 /* IE6 sets dynamically generated links as visited. */
401 </style>
402 </head>
403 <body>
405 <h1>
406 gitcli(7) Manual Page
407 </h1>
410 <p>gitcli -
411 git command line interface and conventions
412 </p>
413 </div>
414 </div>
418 </div>
421 <div class="paragraph"><p>This manual describes the convention used throughout git CLI.</p></div>
423 "tree-ish", depending on the context and command) and paths as their
424 arguments. Here are the rules:</p></div>
426 <li>
427 <p>
428 Revisions come first and then paths.
430 <tt>v1.0</tt> and <tt>v2.0</tt> are revisions and <tt>arch/x86</tt> and <tt>include/asm-x86</tt>
431 are paths.
432 </p>
433 </li>
434 <li>
435 <p>
436 When an argument can be misunderstood as either a revision or a path,
439 tree. Please show changes between the version I staged in the index
441 between the HEAD commit and the work tree as a whole". You can say
443 </p>
444 </li>
445 <li>
446 <p>
448 out and asking you to disambiguate when ambiguous. E.g. if you have a
451 disambiguate.
452 </p>
453 </li>
454 </ul></div>
455 <div class="paragraph"><p>When writing a script that is expected to handle random user-input, it is
456 a good practice to make it explicit which arguments are which by placing
458 <div class="paragraph"><p>Here are the rules regarding the "flags" that you should follow when you are
459 scripting git:</p></div>
461 <li>
462 <p>
463 it’s preferred to use the non dashed form of git commands, which means that
465 </p>
466 </li>
467 <li>
468 <p>
471 </p>
472 </li>
473 <li>
474 <p>
478 for long options. An option that takes optional option-argument must be
480 </p>
481 </li>
482 <li>
483 <p>
484 when you give a revision parameter to a command, make sure the parameter is
485 not ambiguous with a name of a file in the work tree. E.g. do not write
488 </p>
489 </li>
490 </ul></div>
491 </div>
494 <div class="paragraph"><p>From the git 1.5.4 series and further, many git commands (not all of them at the
495 time of the writing though) come with an enhanced option parser.</p></div>
496 <div class="paragraph"><p>Here is an exhaustive list of the facilities provided by this option parser.</p></div>
498 <div class="paragraph"><p>Commands which have the enhanced option parser activated all understand a
499 couple of magic command line options:</p></div>
502 -h
503 </dt>
504 <dd>
505 <p>
506 gives a pretty printed usage of the command.
507 </p>
510 <pre><tt>$ git describe -h
513 --contains find the tag that comes after the commit
514 --debug debug search strategy on stderr
515 --all use any ref in .git/refs
516 --tags use any tag in .git/refs/tags
519 </div></div>
520 </dd>
522 --help-all
523 </dt>
524 <dd>
525 <p>
526 Some git commands take options that are only used for plumbing or that
527 are deprecated, and such options are hidden from the default usage. This
528 option gives the full list of options.
529 </p>
530 </dd>
531 </dl></div>
533 <div class="paragraph"><p>Options with long option names can be negated by prefixing <tt>--no-</tt>. For
534 example, <tt>git branch</tt> has the option <tt>--track</tt> which is <em>on</em> by default. You
537 <h3 id="_aggregating_short_options">Aggregating short options</h3><div style="clear:left"></div>
538 <div class="paragraph"><p>Commands that support the enhanced option parser allow you to aggregate short
541 <h3 id="_separating_argument_from_the_option">Separating argument from the option</h3><div style="clear:left"></div>
542 <div class="paragraph"><p>You can write the mandatory option parameter to an option as a separate
543 word on the command line. That means that all the following uses work:</p></div>
546 <pre><tt>$ git foo --long-opt=Arg
547 $ git foo --long-opt Arg
548 $ git foo -oArg
549 $ git foo -o Arg</tt></pre>
550 </div></div>
551 <div class="paragraph"><p>However, this is <strong>NOT</strong> allowed for switches with an optional value, where the
555 <pre><tt>$ git describe --abbrev HEAD # correct
556 $ git describe --abbrev=10 HEAD # correct
558 </div></div>
559 </div>
564 options. Sometimes people incorrectly think that, because
565 the index was originally called cache, these two are
567 different things.</p></div>
569 <li>
570 <p>
574 without a commit to specify from which commit to look for
575 strings in, usually works on files in the working tree,
577 the index.
578 </p>
579 </li>
580 <li>
581 <p>
585 merges changes recorded in a stash to the working tree,
587 the index as well.
588 </p>
589 </li>
590 </ul></div>
593 only affects the files in the working tree, but with
596 entries.</p></div>
597 <div class="paragraph"><p>See also <a href="http://marc.info/?l=git&m=116563135620359">http://marc.info/?l=git&m=116563135620359</a> and
598 <a href="http://marc.info/?l=git&m=119150393620273">http://marc.info/?l=git&m=119150393620273</a> for further
599 information.</p></div>
600 </div>
604 </div>
608 </div>
609 </div>
610 </body>
611 </html>