| blob | 863d5a4cbffb4f79e79cb2394ac9bea452c2670b |
4 <head>
8 /* Debug borders */
10 /*
11 border: 1px solid red;
12 */
13 }
15 body {
17 }
19 a {
22 }
25 }
27 em {
29 }
31 strong {
33 }
35 tt {
37 }
45 }
49 }
50 h2 {
52 }
53 h3 {
55 }
56 h3 + * {
58 }
63 }
65 hr {
67 }
69 p {
72 }
74 pre {
77 }
79 span#author {
84 }
85 span#email {
86 }
87 span#revision {
89 }
91 div#footer {
97 }
98 div#footer-text {
101 }
102 div#footer-badges {
105 }
107 div#preamble,
114 }
118 }
122 }
124 /* Block element titles. */
131 }
134 }
138 }
141 }
144 }
150 }
154 }
159 }
163 }
167 }
170 }
179 }
183 }
188 }
192 }
198 dl {
201 }
202 dt {
206 }
209 }
213 }
216 }
220 }
221 thead {
224 }
225 tfoot {
227 }
232 }
235 }
240 }
243 }
247 }
249 div#toctitle {
256 }
261 }
265 }
269 }
273 }
275 /* Workarounds for IE6's broken and incomplete CSS2. */
281 }
287 }
293 }
297 }
302 }
304 /* IE6 sets dynamically generated links as visited. */
306 </style>
308 </head>
309 <body>
311 <h1>
312 git-remote-helpers(1) Manual Page
313 </h1>
316 <p>git-remote-helpers -
317 Helper programs to interact with remote repositories
318 </p>
319 </div>
320 </div>
323 <div class="para"><p><em>git remote-<transport></em> <repository> [<URL>]</p></div>
324 </div>
328 but they are invoked by git when it needs to interact with remote
329 repositories git does not support natively. A given helper will
330 implement a subset of the capabilities documented here. When git
331 needs to interact with a repository using a remote helper, it spawns
332 the helper as an independent process, sends commands to the helper's
333 standard input, and expects results from the helper's standard
334 output. Because a remote helper runs as an independent process from
335 git, there is no need to re-link git to add a new helper, nor any
336 need to link the helper with the implementation of git.</p></div>
338 use to determine what other commands the helper will accept. Other
339 commands generally concern facilities like discovering and updating
340 remote refs, transporting objects between the object database and
341 the remote repository, and updating the local object store.</p></div>
342 <div class="para"><p>Helpers supporting the <em>fetch</em> capability can discover refs from the
343 remote repository and transfer objects reachable from those refs to
345 transfer local objects to the remote repository and update remote refs.</p></div>
350 </div>
354 arguments. The first argument specifies a remote repository as in git;
355 it is either the name of a configured remote or a URL. The second
356 argument specifies a URL; it is usually of the form
358 <div class="para"><p>When git encounters a URL of the form <em><transport>://<address></em>, where
361 the second argument. If such a URL is encountered directly on the
362 command line, the first argument is the same as the second, and if it
363 is encountered in a configured remote, the first argument is the name
364 of that remote.</p></div>
365 <div class="para"><p>A URL of the form <em><transport>::<address></em> explicitly instructs git to
367 argument. If such a URL is encountered directly on the command line,
369 configured remote, the first argument is the name of that remote.</p></div>
370 <div class="para"><p>Additionally, when a configured remote has <em>remote.<name>.vcs</em> set to
374 </div>
377 <div class="para"><p>Commands are given by the caller on the helper's standard input, one per line.</p></div>
379 <dt>
381 </dt>
382 <dd>
383 <p>
384 Lists the capabilities of the helper, one per line, ending
386 which marks them mandatory for git version using the remote
387 helper to understand (unknown mandatory capability is fatal
388 error).
389 </p>
390 </dd>
391 <dt>
393 </dt>
394 <dd>
395 <p>
396 Lists the refs, one per line, in the format "<value> <name>
398 a symref, or "?" to indicate that the helper could not get the
399 value of the ref. A space-separated list of attributes follows
400 the name; unrecognized attributes are ignored. The list ends
401 with a blank line.
402 </p>
405 commands to the helper.</p></div>
406 </dd>
407 <dt>
409 </dt>
410 <dd>
411 <p>
416 for it). Options should be set before other commands,
417 and may influence the behavior of those commands.
418 </p>
420 </dd>
421 <dt>
423 </dt>
424 <dd>
425 <p>
426 Fetches the given object, writing the necessary objects
427 to the database. Fetch commands are sent in a batch, one
428 per line, terminated with a blank line.
429 Outputs a single blank line when all fetch commands in the
430 same batch are complete. Only objects which were reported
431 in the ref list with a sha1 may be fetched this way.
432 </p>
433 <div class="para"><p>Optionally may output a <em>lock <file></em> line indicating a file under
434 GIT_DIR/objects/pack which is keeping a pack until refs can be
435 suitably updated.</p></div>
437 </dd>
438 <dt>
440 </dt>
441 <dd>
442 <p>
445 one or more push commands is terminated with a blank line.
446 </p>
448 command, before the batch's terminating blank line.</p></div>
451 each pushed ref. The status report output is terminated by
453 style string if it contains an LF.</p></div>
455 </dd>
456 <dt>
458 </dt>
459 <dd>
460 <p>
461 Produces a fast-import stream which imports the current value
462 of the named ref. It may additionally import other refs as
463 needed to construct the history efficiently. The script writes
464 to a helper-specific private namespace. The value of the named
465 ref should be written to a location in this namespace derived
466 by applying the refspecs from the "refspec" capability to the
467 name of the ref.
468 </p>
470 system.</p></div>
472 </dd>
473 <dt>
475 </dt>
476 <dd>
477 <p>
478 Connects to given service. Standard input and standard output
479 of helper are connected to specified service (git prefix is
481 as service) on remote side. Valid replies to this command are
483 transport support, fall back to dumb transports) and just
484 exiting with error message printed (can't connect, don't
485 bother trying to fall back). After line feed terminating the
486 positive (empty) response, the output of service starts. After
487 the connection ends, the remote helper exits.
488 </p>
490 </dd>
491 </dl></div>
493 stderr and exits. The caller should expect that a suitable error
494 message has been printed if the child closes the connection without
495 completing a valid response for the current command.</p></div>
497 capabilities reported by the helper.</p></div>
498 </div>
502 <dt>
504 </dt>
505 <dt>
507 </dt>
508 <dt>
510 </dt>
511 <dt>
513 </dt>
514 <dt>
516 </dt>
517 <dd>
518 <p>
519 This helper supports the corresponding command with the same name.
520 </p>
521 </dd>
522 <dt>
524 </dt>
525 <dd>
526 <p>
527 When using the import command, expect the source ref to have
528 been written to the destination ref. The earliest applicable
529 refspec takes precedence. For example
530 "refs/heads/<strong>:refs/svn/origin/branches/</strong>" means that, after an
531 "import refs/heads/name", the script has written to
532 refs/svn/origin/branches/name. If this capability is used at
533 all, it must cover all refs reported by the list command; if
534 it is not used, it is effectively "<strong>:</strong>"
535 </p>
536 </dd>
537 </dl></div>
538 </div>
542 <dt>
544 </dt>
545 <dd>
546 <p>
547 The caller wants to use the ref list to prepare push
548 commands. A helper might chose to acquire the ref list by
549 opening a different type of connection to the destination.
550 </p>
551 </dd>
552 <dt>
554 </dt>
555 <dd>
556 <p>
557 This ref is unchanged since the last import or fetch, although
558 the helper cannot necessarily determine what value that produced.
559 </p>
560 </dd>
561 </dl></div>
562 </div>
566 <dt>
568 </dt>
569 <dd>
570 <p>
571 Changes the verbosity of messages displayed by the helper.
572 A value of 0 for N means that processes operate
573 quietly, and the helper produces only error output.
574 1 is the default level of verbosity, and higher values
575 of N correspond to the number of -v flags passed on the
576 command line.
577 </p>
578 </dd>
579 <dt>
581 </dt>
582 <dd>
583 <p>
584 Enables (or disables) progress messages displayed by the
585 transport helper during a command.
586 </p>
587 </dd>
588 <dt>
590 </dt>
591 <dd>
592 <p>
593 Deepens the history of a shallow repository.
594 </p>
595 </dd>
596 <dt>
598 </dt>
599 <dd>
600 <p>
601 If enabled the helper should automatically fetch annotated
602 tag objects if the object the tag points at was transferred
603 during the fetch command. If the tag is not fetched by
604 the helper a second fetch command will usually be sent to
605 ask for the tag specifically. Some helpers may be able to
606 use this option to avoid a second network connection.
607 </p>
608 </dd>
609 </dl></div>
611 If true, pretend the operation completed successfully,
612 but don't actually change any repository data. For most
615 <dt>
617 </dt>
618 <dd>
619 <p>
620 Sets service path (--upload-pack, --receive-pack etc.) for
621 next connect. Remote helper may support this option, but
622 must not rely on this option being set before
623 connect request occurs.
624 </p>
625 </dd>
626 </dl></div>
627 </div>
631 </div>
635 </div>
639 </div>
643 </div>
644 </div>
645 </body>
646 </html>