| blob | 7b66a7bb4ca13c90c734455d0f48b73b4205c725 |
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 }
129 }
133 }
135 /* Block element titles. */
143 }
146 }
150 }
153 }
156 }
162 }
168 }
176 }
181 }
185 }
189 }
190 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
193 }
202 }
206 }
211 }
217 dl {
220 }
221 dt {
226 }
229 }
233 }
236 }
239 }
242 }
245 }
248 }
255 }
259 }
263 }
264 tfoot {
266 }
269 }
272 }
273 /* Because the table frame attribute is overriden by CSS in most browsers. */
276 }
280 }
284 }
290 }
293 }
296 }
302 }
305 }
309 }
313 }
317 }
321 }
326 }
330 }
340 }
345 }
347 div#toc {
349 }
351 div#toctitle {
358 }
363 }
367 }
371 }
375 }
376 /* Overrides for manpage documents */
377 h1 {
382 }
383 h2 {
385 }
388 }
392 }
394 /* Workarounds for IE6's broken and incomplete CSS2. */
400 }
407 }
413 }
418 }
422 }
426 }
431 }
433 /* IE6 sets dynamically generated links as visited. */
435 </style>
437 /*<![CDATA[*/
441 /////////////////////////////////////////////////////////////////////
442 // Table Of Contents generator
443 /////////////////////////////////////////////////////////////////////
445 /* Author: Mihai Bazon, September 2002
446 * http://students.infoiasi.ro/~mishoo
447 *
448 * Table Of Content generator
449 * Version: 0.4
450 *
451 * Feel free to use this script under the terms of the GNU General Public
452 * License, as long as you do not remove or alter this notice.
453 */
455 /* modified by Troy D. Hanson, September 2006. License: GPL */
456 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
458 // toclevels = 1..4.
468 }
470 }
476 }
481 // Function that scans the DOM tree for header elements (the DOM2
482 // nodeIterator API would be a better technique but not supported by all
483 // browsers).
490 }
492 }
493 }
494 }
497 }
512 }
515 },
518 /////////////////////////////////////////////////////////////////////
519 // Footnotes generator
520 /////////////////////////////////////////////////////////////////////
522 /* Based on footnote generation code from:
523 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
524 */
534 n++;
535 // Use [\s\S] in place of . so multi-line matches work.
536 // Because JavaScript has no s (dotall) regex flag.
547 }
548 }
552 // Process footnoterefs.
561 }
562 }
563 }
564 }
566 }
567 /*]]>*/
568 </script>
569 </head>
570 <body>
572 <h1>
573 git-remote-helpers(1) Manual Page
574 </h1>
577 <p>git-remote-helpers -
578 Helper programs to interact with remote repositories
579 </p>
580 </div>
581 </div>
586 <div class="verseblock-content"><em>git remote-<transport></em> <repository> [<URL>]</div>
588 </div></div>
589 </div>
593 but they are invoked by git when it needs to interact with remote
594 repositories git does not support natively. A given helper will
595 implement a subset of the capabilities documented here. When git
596 needs to interact with a repository using a remote helper, it spawns
597 the helper as an independent process, sends commands to the helper’s
598 standard input, and expects results from the helper’s standard
599 output. Because a remote helper runs as an independent process from
600 git, there is no need to re-link git to add a new helper, nor any
601 need to link the helper with the implementation of git.</p></div>
603 uses to determine what other commands the helper will accept. Those
604 other commands can be used to discover and update remote refs,
605 transport objects between the object database and the remote repository,
606 and update the local object store.</p></div>
611 </div>
616 response to which the remote helper must print a list of the
617 capabilities it supports (see below) followed by a blank line. The
618 response to the capabilities command determines what commands Git uses
619 in the remainder of the command stream.</p></div>
621 (indicated in the documentation of the relevant commands), this blank
622 line is followed by a payload in some other protocol (e.g., the pack
623 protocol), while in others it indicates the end of input.</p></div>
626 The operations a helper supports are declared to git in the response
631 </dt>
632 <dd>
633 <p>
636 case of a shallow clone) that affect how other commands are
637 carried out.
638 </p>
639 </dd>
642 </dt>
643 <dd>
644 <p>
645 For fetching and pushing using git’s native packfile protocol
646 that requires a bidirectional, full-duplex connection.
647 </p>
648 </dd>
651 </dt>
652 <dd>
653 <p>
654 For listing remote refs and pushing specified objects from the
655 local object store to remote refs.
656 </p>
657 </dd>
660 </dt>
661 <dd>
662 <p>
663 For listing remote refs and fetching the associated history to
664 the local object store.
665 </p>
666 </dd>
669 </dt>
670 <dd>
671 <p>
672 For listing remote refs and fetching the associated history as
673 a fast-import stream.
674 </p>
675 </dd>
678 </dt>
679 <dd>
680 <p>
682 fast-import stream to modify refs in a private namespace
683 instead of writing to refs/heads or refs/remotes directly.
685 capability use this.
686 </p>
691 ref.</p></div>
693 applicable refspec takes precedence. The left-hand of refspecs
694 advertised with this capability must cover all refs reported by
697 </dd>
698 </dl></div>
703 </dt>
704 <dd>
705 <p>
708 packfile protocol.
709 </p>
711 </dd>
714 </dt>
715 <dd>
716 <p>
717 Can discover remote refs and push local commits and the
718 history leading up to them to new or existing remote refs.
719 </p>
721 </dd>
722 </dl></div>
723 <div class="paragraph"><p>If a helper advertises both <em>connect</em> and <em>push</em>, git will use
726 <h3 id="_capabilities_for_fetching">Capabilities for Fetching</h3><div style="clear:left"></div>
730 </dt>
731 <dd>
732 <p>
735 packfile protocol.
736 </p>
738 </dd>
741 </dt>
742 <dd>
743 <p>
744 Can discover remote refs and transfer objects reachable from
745 them to the local object store.
746 </p>
748 </dd>
751 </dt>
752 <dd>
753 <p>
754 Can discover remote refs and output objects reachable from
755 them as a stream in fast-import format.
756 </p>
758 </dd>
759 </dl></div>
760 <div class="paragraph"><p>If a helper advertises <em>connect</em>, git will use it if possible and
761 fall back to another capability if the helper requests so when
764 Other frontends may have some other order of preference.</p></div>
768 </dt>
769 <dd>
770 <p>
772 </p>
775 in its capabilities is saying that, when it handles
779 applicable refspec takes precedence. The left-hand of refspecs
780 advertised with this capability must cover all refs reported by
783 </dd>
784 </dl></div>
785 </div>
789 arguments. The first argument specifies a remote repository as in git;
790 it is either the name of a configured remote or a URL. The second
791 argument specifies a URL; it is usually of the form
794 and can be used to determine where to store additional data or from
795 which directory to invoke auxiliary git commands.</p></div>
796 <div class="paragraph"><p>When git encounters a URL of the form <em><transport>://<address></em>, where
799 the second argument. If such a URL is encountered directly on the
800 command line, the first argument is the same as the second, and if it
801 is encountered in a configured remote, the first argument is the name
802 of that remote.</p></div>
803 <div class="paragraph"><p>A URL of the form <em><transport>::<address></em> explicitly instructs git to
805 argument. If such a URL is encountered directly on the command line,
807 configured remote, the first argument is the name of that remote.</p></div>
808 <div class="paragraph"><p>Additionally, when a configured remote has <em>remote.<name>.vcs</em> set to
812 </div>
815 <div class="paragraph"><p>Commands are given by the caller on the helper’s standard input, one per line.</p></div>
819 </dt>
820 <dd>
821 <p>
822 Lists the capabilities of the helper, one per line, ending
824 which marks them mandatory for git version using the remote
825 helper to understand (unknown mandatory capability is fatal
826 error).
827 </p>
828 </dd>
831 </dt>
832 <dd>
833 <p>
834 Lists the refs, one per line, in the format "<value> <name>
836 a symref, or "?" to indicate that the helper could not get the
837 value of the ref. A space-separated list of attributes follows
838 the name; unrecognized attributes are ignored. The list ends
839 with a blank line.
840 </p>
841 <div class="paragraph"><p>If <em>push</em> is supported this may be called as <em>list for-push</em>
843 commands to the helper.</p></div>
844 </dd>
847 </dt>
848 <dd>
849 <p>
854 for it). Options should be set before other commands,
855 and may influence the behavior of those commands.
856 </p>
858 </dd>
861 </dt>
862 <dd>
863 <p>
864 Fetches the given object, writing the necessary objects
865 to the database. Fetch commands are sent in a batch, one
866 per line, terminated with a blank line.
867 Outputs a single blank line when all fetch commands in the
868 same batch are complete. Only objects which were reported
869 in the ref list with a sha1 may be fetched this way.
870 </p>
871 <div class="paragraph"><p>Optionally may output a <em>lock <file></em> line indicating a file under
872 GIT_DIR/objects/pack which is keeping a pack until refs can be
873 suitably updated.</p></div>
875 </dd>
878 </dt>
879 <dd>
880 <p>
885 is followed by a blank line). For example, the following would
891 </p>
894 <pre><tt>push refs/heads/master:refs/heads/master
895 push HEAD:refs/heads/branch
896 \n
897 push +refs/heads/foo:refs/heads/bar
898 \n</tt></pre>
899 </div></div>
900 <div class="paragraph"><p>Zero or more protocol options may be entered after the last <em>push</em>
902 <div class="paragraph"><p>When the push is complete, outputs one or more <em>ok <dst></em> or
904 each pushed ref. The status report output is terminated by
906 style string if it contains an LF.</p></div>
908 </dd>
911 </dt>
912 <dd>
913 <p>
914 Produces a fast-import stream which imports the current value
915 of the named ref. It may additionally import other refs as
916 needed to construct the history efficiently. The script writes
917 to a helper-specific private namespace. The value of the named
918 ref should be written to a location in this namespace derived
919 by applying the refspecs from the "refspec" capability to the
920 name of the ref.
921 </p>
923 system.</p></div>
924 <div class="paragraph"><p>Just like <em>push</em>, a batch sequence of one or more <em>import</em> is
927 command.</p></div>
929 </dd>
932 </dt>
933 <dd>
934 <p>
935 Connects to given service. Standard input and standard output
936 of helper are connected to specified service (git prefix is
938 as service) on remote side. Valid replies to this command are
940 transport support, fall back to dumb transports) and just
942 bother trying to fall back). After line feed terminating the
943 positive (empty) response, the output of service starts. After
944 the connection ends, the remote helper exits.
945 </p>
947 </dd>
948 </dl></div>
950 stderr and exits. The caller should expect that a suitable error
951 message has been printed if the child closes the connection without
952 completing a valid response for the current command.</p></div>
954 capabilities reported by the helper.</p></div>
955 </div>
961 </dt>
962 <dd>
963 <p>
964 The caller wants to use the ref list to prepare push
965 commands. A helper might chose to acquire the ref list by
966 opening a different type of connection to the destination.
967 </p>
968 </dd>
971 </dt>
972 <dd>
973 <p>
974 This ref is unchanged since the last import or fetch, although
975 the helper cannot necessarily determine what value that produced.
976 </p>
977 </dd>
978 </dl></div>
979 </div>
985 </dt>
986 <dd>
987 <p>
988 Changes the verbosity of messages displayed by the helper.
990 quietly, and the helper produces only error output.
991 1 is the default level of verbosity, and higher values
993 command line.
994 </p>
995 </dd>
998 </dt>
999 <dd>
1000 <p>
1001 Enables (or disables) progress messages displayed by the
1002 transport helper during a command.
1003 </p>
1004 </dd>
1007 </dt>
1008 <dd>
1009 <p>
1010 Deepens the history of a shallow repository.
1011 </p>
1012 </dd>
1015 </dt>
1016 <dd>
1017 <p>
1018 If enabled the helper should automatically fetch annotated
1019 tag objects if the object the tag points at was transferred
1020 during the fetch command. If the tag is not fetched by
1021 the helper a second fetch command will usually be sent to
1022 ask for the tag specifically. Some helpers may be able to
1023 use this option to avoid a second network connection.
1024 </p>
1025 </dd>
1026 </dl></div>
1028 If true, pretend the operation completed successfully,
1029 but don’t actually change any repository data. For most
1034 </dt>
1035 <dd>
1036 <p>
1037 Sets service path (--upload-pack, --receive-pack etc.) for
1038 next connect. Remote helper may support this option, but
1039 must not rely on this option being set before
1040 connect request occurs.
1041 </p>
1042 </dd>
1043 </dl></div>
1044 </div>
1048 <div class="paragraph"><p><a href="git-remote-testgit.html">git-remote-testgit(1)</a></p></div>
1049 </div>
1053 </div>
1054 </div>
1059 </div>
1060 </div>
1061 </body>
1062 </html>