| blob | e0210abe67be96b367274a553111dbf17fadd3c0 |
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 git-remote-helpers(1) Manual Page
407 </h1>
410 <p>git-remote-helpers -
411 Helper programs to interact with remote repositories
412 </p>
413 </div>
414 </div>
417 <div class="paragraph"><p><em>git remote-<transport></em> <repository> [<URL>]</p></div>
418 </div>
422 but they are invoked by git when it needs to interact with remote
423 repositories git does not support natively. A given helper will
424 implement a subset of the capabilities documented here. When git
425 needs to interact with a repository using a remote helper, it spawns
426 the helper as an independent process, sends commands to the helper’s
427 standard input, and expects results from the helper’s standard
428 output. Because a remote helper runs as an independent process from
429 git, there is no need to re-link git to add a new helper, nor any
430 need to link the helper with the implementation of git.</p></div>
432 use to determine what other commands the helper will accept. Other
433 commands generally concern facilities like discovering and updating
434 remote refs, transporting objects between the object database and
435 the remote repository, and updating the local object store.</p></div>
436 <div class="paragraph"><p>Helpers supporting the <em>fetch</em> capability can discover refs from the
437 remote repository and transfer objects reachable from those refs to
439 transfer local objects to the remote repository and update remote refs.</p></div>
444 </div>
448 arguments. The first argument specifies a remote repository as in git;
449 it is either the name of a configured remote or a URL. The second
450 argument specifies a URL; it is usually of the form
452 <div class="paragraph"><p>When git encounters a URL of the form <em><transport>://<address></em>, where
455 the second argument. If such a URL is encountered directly on the
456 command line, the first argument is the same as the second, and if it
457 is encountered in a configured remote, the first argument is the name
458 of that remote.</p></div>
459 <div class="paragraph"><p>A URL of the form <em><transport>::<address></em> explicitly instructs git to
461 argument. If such a URL is encountered directly on the command line,
463 configured remote, the first argument is the name of that remote.</p></div>
464 <div class="paragraph"><p>Additionally, when a configured remote has <em>remote.<name>.vcs</em> set to
468 </div>
471 <div class="paragraph"><p>Commands are given by the caller on the helper’s standard input, one per line.</p></div>
475 </dt>
476 <dd>
477 <p>
478 Lists the capabilities of the helper, one per line, ending
480 which marks them mandatory for git version using the remote
481 helper to understand (unknown mandatory capability is fatal
482 error).
483 </p>
484 </dd>
487 </dt>
488 <dd>
489 <p>
490 Lists the refs, one per line, in the format "<value> <name>
492 a symref, or "?" to indicate that the helper could not get the
493 value of the ref. A space-separated list of attributes follows
494 the name; unrecognized attributes are ignored. The list ends
495 with a blank line.
496 </p>
497 <div class="paragraph"><p>If <em>push</em> is supported this may be called as <em>list for-push</em>
499 commands to the helper.</p></div>
500 </dd>
503 </dt>
504 <dd>
505 <p>
510 for it). Options should be set before other commands,
511 and may influence the behavior of those commands.
512 </p>
514 </dd>
517 </dt>
518 <dd>
519 <p>
520 Fetches the given object, writing the necessary objects
521 to the database. Fetch commands are sent in a batch, one
522 per line, terminated with a blank line.
523 Outputs a single blank line when all fetch commands in the
524 same batch are complete. Only objects which were reported
525 in the ref list with a sha1 may be fetched this way.
526 </p>
527 <div class="paragraph"><p>Optionally may output a <em>lock <file></em> line indicating a file under
528 GIT_DIR/objects/pack which is keeping a pack until refs can be
529 suitably updated.</p></div>
531 </dd>
534 </dt>
535 <dd>
536 <p>
539 one or more push commands is terminated with a blank line.
540 </p>
541 <div class="paragraph"><p>Zero or more protocol options may be entered after the last <em>push</em>
543 <div class="paragraph"><p>When the push is complete, outputs one or more <em>ok <dst></em> or
545 each pushed ref. The status report output is terminated by
547 style string if it contains an LF.</p></div>
549 </dd>
552 </dt>
553 <dd>
554 <p>
555 Produces a fast-import stream which imports the current value
556 of the named ref. It may additionally import other refs as
557 needed to construct the history efficiently. The script writes
558 to a helper-specific private namespace. The value of the named
559 ref should be written to a location in this namespace derived
560 by applying the refspecs from the "refspec" capability to the
561 name of the ref.
562 </p>
564 system.</p></div>
566 </dd>
569 </dt>
570 <dd>
571 <p>
572 Connects to given service. Standard input and standard output
573 of helper are connected to specified service (git prefix is
575 as service) on remote side. Valid replies to this command are
577 transport support, fall back to dumb transports) and just
579 bother trying to fall back). After line feed terminating the
580 positive (empty) response, the output of service starts. After
581 the connection ends, the remote helper exits.
582 </p>
584 </dd>
585 </dl></div>
587 stderr and exits. The caller should expect that a suitable error
588 message has been printed if the child closes the connection without
589 completing a valid response for the current command.</p></div>
591 capabilities reported by the helper.</p></div>
592 </div>
598 </dt>
601 </dt>
604 </dt>
607 </dt>
610 </dt>
611 <dd>
612 <p>
613 This helper supports the corresponding command with the same name.
614 </p>
615 </dd>
618 </dt>
619 <dd>
620 <p>
621 When using the import command, expect the source ref to have
622 been written to the destination ref. The earliest applicable
623 refspec takes precedence. For example
624 "refs/heads/<strong>:refs/svn/origin/branches/</strong>" means that, after an
625 "import refs/heads/name", the script has written to
626 refs/svn/origin/branches/name. If this capability is used at
627 all, it must cover all refs reported by the list command; if
628 it is not used, it is effectively "<strong>:</strong>"
629 </p>
630 </dd>
631 </dl></div>
632 </div>
638 </dt>
639 <dd>
640 <p>
641 The caller wants to use the ref list to prepare push
642 commands. A helper might chose to acquire the ref list by
643 opening a different type of connection to the destination.
644 </p>
645 </dd>
648 </dt>
649 <dd>
650 <p>
651 This ref is unchanged since the last import or fetch, although
652 the helper cannot necessarily determine what value that produced.
653 </p>
654 </dd>
655 </dl></div>
656 </div>
662 </dt>
663 <dd>
664 <p>
665 Changes the verbosity of messages displayed by the helper.
667 quietly, and the helper produces only error output.
668 1 is the default level of verbosity, and higher values
670 command line.
671 </p>
672 </dd>
675 </dt>
676 <dd>
677 <p>
678 Enables (or disables) progress messages displayed by the
679 transport helper during a command.
680 </p>
681 </dd>
684 </dt>
685 <dd>
686 <p>
687 Deepens the history of a shallow repository.
688 </p>
689 </dd>
692 </dt>
693 <dd>
694 <p>
695 If enabled the helper should automatically fetch annotated
696 tag objects if the object the tag points at was transferred
697 during the fetch command. If the tag is not fetched by
698 the helper a second fetch command will usually be sent to
699 ask for the tag specifically. Some helpers may be able to
700 use this option to avoid a second network connection.
701 </p>
702 </dd>
703 </dl></div>
705 If true, pretend the operation completed successfully,
706 but don’t actually change any repository data. For most
711 </dt>
712 <dd>
713 <p>
714 Sets service path (--upload-pack, --receive-pack etc.) for
715 next connect. Remote helper may support this option, but
716 must not rely on this option being set before
717 connect request occurs.
718 </p>
719 </dd>
720 </dl></div>
721 </div>
725 </div>
729 </div>
733 </div>
734 </div>
735 </body>
736 </html>