| blob | 85bf0804295fe4e3c877c05a0dbfb564148ab773 |
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>
418 <div class="verseblock-content"><em>git remote-<transport></em> <repository> [<URL>]</div>
420 </div></div>
421 </div>
425 but they are invoked by git when it needs to interact with remote
426 repositories git does not support natively. A given helper will
427 implement a subset of the capabilities documented here. When git
428 needs to interact with a repository using a remote helper, it spawns
429 the helper as an independent process, sends commands to the helper’s
430 standard input, and expects results from the helper’s standard
431 output. Because a remote helper runs as an independent process from
432 git, there is no need to re-link git to add a new helper, nor any
433 need to link the helper with the implementation of git.</p></div>
435 use to determine what other commands the helper will accept. Other
436 commands generally concern facilities like discovering and updating
437 remote refs, transporting objects between the object database and
438 the remote repository, and updating the local object store.</p></div>
439 <div class="paragraph"><p>Helpers supporting the <em>fetch</em> capability can discover refs from the
440 remote repository and transfer objects reachable from those refs to
442 transfer local objects to the remote repository and update remote refs.</p></div>
447 </div>
451 arguments. The first argument specifies a remote repository as in git;
452 it is either the name of a configured remote or a URL. The second
453 argument specifies a URL; it is usually of the form
456 and can be used to determine where to store additional data or from
457 which directory to invoke auxiliary git commands.</p></div>
458 <div class="paragraph"><p>When git encounters a URL of the form <em><transport>://<address></em>, where
461 the second argument. If such a URL is encountered directly on the
462 command line, the first argument is the same as the second, and if it
463 is encountered in a configured remote, the first argument is the name
464 of that remote.</p></div>
465 <div class="paragraph"><p>A URL of the form <em><transport>::<address></em> explicitly instructs git to
467 argument. If such a URL is encountered directly on the command line,
469 configured remote, the first argument is the name of that remote.</p></div>
470 <div class="paragraph"><p>Additionally, when a configured remote has <em>remote.<name>.vcs</em> set to
474 </div>
477 <div class="paragraph"><p>Commands are given by the caller on the helper’s standard input, one per line.</p></div>
481 </dt>
482 <dd>
483 <p>
484 Lists the capabilities of the helper, one per line, ending
486 which marks them mandatory for git version using the remote
487 helper to understand (unknown mandatory capability is fatal
488 error).
489 </p>
490 </dd>
493 </dt>
494 <dd>
495 <p>
496 Lists the refs, one per line, in the format "<value> <name>
498 a symref, or "?" to indicate that the helper could not get the
499 value of the ref. A space-separated list of attributes follows
500 the name; unrecognized attributes are ignored. The list ends
501 with a blank line.
502 </p>
503 <div class="paragraph"><p>If <em>push</em> is supported this may be called as <em>list for-push</em>
505 commands to the helper.</p></div>
506 </dd>
509 </dt>
510 <dd>
511 <p>
516 for it). Options should be set before other commands,
517 and may influence the behavior of those commands.
518 </p>
520 </dd>
523 </dt>
524 <dd>
525 <p>
526 Fetches the given object, writing the necessary objects
527 to the database. Fetch commands are sent in a batch, one
528 per line, terminated with a blank line.
529 Outputs a single blank line when all fetch commands in the
530 same batch are complete. Only objects which were reported
531 in the ref list with a sha1 may be fetched this way.
532 </p>
533 <div class="paragraph"><p>Optionally may output a <em>lock <file></em> line indicating a file under
534 GIT_DIR/objects/pack which is keeping a pack until refs can be
535 suitably updated.</p></div>
537 </dd>
540 </dt>
541 <dd>
542 <p>
545 one or more push commands is terminated with a blank line.
546 </p>
547 <div class="paragraph"><p>Zero or more protocol options may be entered after the last <em>push</em>
549 <div class="paragraph"><p>When the push is complete, outputs one or more <em>ok <dst></em> or
551 each pushed ref. The status report output is terminated by
553 style string if it contains an LF.</p></div>
555 </dd>
558 </dt>
559 <dd>
560 <p>
561 Produces a fast-import stream which imports the current value
562 of the named ref. It may additionally import other refs as
563 needed to construct the history efficiently. The script writes
564 to a helper-specific private namespace. The value of the named
565 ref should be written to a location in this namespace derived
566 by applying the refspecs from the "refspec" capability to the
567 name of the ref.
568 </p>
570 system.</p></div>
572 </dd>
575 </dt>
576 <dd>
577 <p>
578 Connects to given service. Standard input and standard output
579 of helper are connected to specified service (git prefix is
581 as service) on remote side. Valid replies to this command are
583 transport support, fall back to dumb transports) and just
585 bother trying to fall back). After line feed terminating the
586 positive (empty) response, the output of service starts. After
587 the connection ends, the remote helper exits.
588 </p>
590 </dd>
591 </dl></div>
593 stderr and exits. The caller should expect that a suitable error
594 message has been printed if the child closes the connection without
595 completing a valid response for the current command.</p></div>
597 capabilities reported by the helper.</p></div>
598 </div>
604 </dt>
607 </dt>
610 </dt>
613 </dt>
616 </dt>
617 <dd>
618 <p>
619 This helper supports the corresponding command with the same name.
620 </p>
621 </dd>
624 </dt>
625 <dd>
626 <p>
627 When using the import command, expect the source ref to have
628 been written to the destination ref. The earliest applicable
629 refspec takes precedence. For example
630 "refs/heads/*:refs/svn/origin/branches/*" means
631 that, after an "import refs/heads/name", the script has written to
632 refs/svn/origin/branches/name. If this capability is used at
633 all, it must cover all refs reported by the list command; if
634 it is not used, it is effectively "*:*"
635 </p>
636 </dd>
637 </dl></div>
638 </div>
644 </dt>
645 <dd>
646 <p>
647 The caller wants to use the ref list to prepare push
648 commands. A helper might chose to acquire the ref list by
649 opening a different type of connection to the destination.
650 </p>
651 </dd>
654 </dt>
655 <dd>
656 <p>
657 This ref is unchanged since the last import or fetch, although
658 the helper cannot necessarily determine what value that produced.
659 </p>
660 </dd>
661 </dl></div>
662 </div>
668 </dt>
669 <dd>
670 <p>
671 Changes the verbosity of messages displayed by the helper.
673 quietly, and the helper produces only error output.
674 1 is the default level of verbosity, and higher values
676 command line.
677 </p>
678 </dd>
681 </dt>
682 <dd>
683 <p>
684 Enables (or disables) progress messages displayed by the
685 transport helper during a command.
686 </p>
687 </dd>
690 </dt>
691 <dd>
692 <p>
693 Deepens the history of a shallow repository.
694 </p>
695 </dd>
698 </dt>
699 <dd>
700 <p>
701 If enabled the helper should automatically fetch annotated
702 tag objects if the object the tag points at was transferred
703 during the fetch command. If the tag is not fetched by
704 the helper a second fetch command will usually be sent to
705 ask for the tag specifically. Some helpers may be able to
706 use this option to avoid a second network connection.
707 </p>
708 </dd>
709 </dl></div>
711 If true, pretend the operation completed successfully,
712 but don’t actually change any repository data. For most
717 </dt>
718 <dd>
719 <p>
720 Sets service path (--upload-pack, --receive-pack etc.) for
721 next connect. Remote helper may support this option, but
722 must not rely on this option being set before
723 connect request occurs.
724 </p>
725 </dd>
726 </dl></div>
727 </div>
731 </div>
735 </div>
739 </div>
740 </div>
741 </body>
742 </html>