| blob | 7d541c9dd5cab46dc5b5fa32556e444de73ec9ba |
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
455 <div class="paragraph"><p>When git encounters a URL of the form <em><transport>://<address></em>, where
458 the second argument. If such a URL is encountered directly on the
459 command line, the first argument is the same as the second, and if it
460 is encountered in a configured remote, the first argument is the name
461 of that remote.</p></div>
462 <div class="paragraph"><p>A URL of the form <em><transport>::<address></em> explicitly instructs git to
464 argument. If such a URL is encountered directly on the command line,
466 configured remote, the first argument is the name of that remote.</p></div>
467 <div class="paragraph"><p>Additionally, when a configured remote has <em>remote.<name>.vcs</em> set to
471 </div>
474 <div class="paragraph"><p>Commands are given by the caller on the helper’s standard input, one per line.</p></div>
478 </dt>
479 <dd>
480 <p>
481 Lists the capabilities of the helper, one per line, ending
483 which marks them mandatory for git version using the remote
484 helper to understand (unknown mandatory capability is fatal
485 error).
486 </p>
487 </dd>
490 </dt>
491 <dd>
492 <p>
493 Lists the refs, one per line, in the format "<value> <name>
495 a symref, or "?" to indicate that the helper could not get the
496 value of the ref. A space-separated list of attributes follows
497 the name; unrecognized attributes are ignored. The list ends
498 with a blank line.
499 </p>
500 <div class="paragraph"><p>If <em>push</em> is supported this may be called as <em>list for-push</em>
502 commands to the helper.</p></div>
503 </dd>
506 </dt>
507 <dd>
508 <p>
513 for it). Options should be set before other commands,
514 and may influence the behavior of those commands.
515 </p>
517 </dd>
520 </dt>
521 <dd>
522 <p>
523 Fetches the given object, writing the necessary objects
524 to the database. Fetch commands are sent in a batch, one
525 per line, terminated with a blank line.
526 Outputs a single blank line when all fetch commands in the
527 same batch are complete. Only objects which were reported
528 in the ref list with a sha1 may be fetched this way.
529 </p>
530 <div class="paragraph"><p>Optionally may output a <em>lock <file></em> line indicating a file under
531 GIT_DIR/objects/pack which is keeping a pack until refs can be
532 suitably updated.</p></div>
534 </dd>
537 </dt>
538 <dd>
539 <p>
542 one or more push commands is terminated with a blank line.
543 </p>
544 <div class="paragraph"><p>Zero or more protocol options may be entered after the last <em>push</em>
546 <div class="paragraph"><p>When the push is complete, outputs one or more <em>ok <dst></em> or
548 each pushed ref. The status report output is terminated by
550 style string if it contains an LF.</p></div>
552 </dd>
555 </dt>
556 <dd>
557 <p>
558 Produces a fast-import stream which imports the current value
559 of the named ref. It may additionally import other refs as
560 needed to construct the history efficiently. The script writes
561 to a helper-specific private namespace. The value of the named
562 ref should be written to a location in this namespace derived
563 by applying the refspecs from the "refspec" capability to the
564 name of the ref.
565 </p>
567 system.</p></div>
569 </dd>
572 </dt>
573 <dd>
574 <p>
575 Connects to given service. Standard input and standard output
576 of helper are connected to specified service (git prefix is
578 as service) on remote side. Valid replies to this command are
580 transport support, fall back to dumb transports) and just
582 bother trying to fall back). After line feed terminating the
583 positive (empty) response, the output of service starts. After
584 the connection ends, the remote helper exits.
585 </p>
587 </dd>
588 </dl></div>
590 stderr and exits. The caller should expect that a suitable error
591 message has been printed if the child closes the connection without
592 completing a valid response for the current command.</p></div>
594 capabilities reported by the helper.</p></div>
595 </div>
601 </dt>
604 </dt>
607 </dt>
610 </dt>
613 </dt>
614 <dd>
615 <p>
616 This helper supports the corresponding command with the same name.
617 </p>
618 </dd>
621 </dt>
622 <dd>
623 <p>
624 When using the import command, expect the source ref to have
625 been written to the destination ref. The earliest applicable
626 refspec takes precedence. For example
627 "refs/heads/*:refs/svn/origin/branches/*" means
628 that, after an "import refs/heads/name", the script has written to
629 refs/svn/origin/branches/name. If this capability is used at
630 all, it must cover all refs reported by the list command; if
631 it is not used, it is effectively "*:*"
632 </p>
633 </dd>
634 </dl></div>
635 </div>
641 </dt>
642 <dd>
643 <p>
644 The caller wants to use the ref list to prepare push
645 commands. A helper might chose to acquire the ref list by
646 opening a different type of connection to the destination.
647 </p>
648 </dd>
651 </dt>
652 <dd>
653 <p>
654 This ref is unchanged since the last import or fetch, although
655 the helper cannot necessarily determine what value that produced.
656 </p>
657 </dd>
658 </dl></div>
659 </div>
665 </dt>
666 <dd>
667 <p>
668 Changes the verbosity of messages displayed by the helper.
670 quietly, and the helper produces only error output.
671 1 is the default level of verbosity, and higher values
673 command line.
674 </p>
675 </dd>
678 </dt>
679 <dd>
680 <p>
681 Enables (or disables) progress messages displayed by the
682 transport helper during a command.
683 </p>
684 </dd>
687 </dt>
688 <dd>
689 <p>
690 Deepens the history of a shallow repository.
691 </p>
692 </dd>
695 </dt>
696 <dd>
697 <p>
698 If enabled the helper should automatically fetch annotated
699 tag objects if the object the tag points at was transferred
700 during the fetch command. If the tag is not fetched by
701 the helper a second fetch command will usually be sent to
702 ask for the tag specifically. Some helpers may be able to
703 use this option to avoid a second network connection.
704 </p>
705 </dd>
706 </dl></div>
708 If true, pretend the operation completed successfully,
709 but don’t actually change any repository data. For most
714 </dt>
715 <dd>
716 <p>
717 Sets service path (--upload-pack, --receive-pack etc.) for
718 next connect. Remote helper may support this option, but
719 must not rely on this option being set before
720 connect request occurs.
721 </p>
722 </dd>
723 </dl></div>
724 </div>
728 </div>
732 </div>
736 </div>
737 </div>
738 </body>
739 </html>