git-remote-ext.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
   6 <meta name="generator" content="AsciiDoc 8.4.5" />
   7 <title>git-remote-ext(1)</title>
   8 <style type="text/css">
   9 /* Debug borders */
  10 p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
  11 /*
  12   border: 1px solid red;
  13 */
  14 }
  15
  16 body {
  17   margin: 1em 5% 1em 5%;
  18 }
  19
  20 a {
  21   color: blue;
  22   text-decoration: underline;
  23 }
  24 a:visited {
  25   color: fuchsia;
  26 }
  27
  28 em {
  29   font-style: italic;
  30   color: navy;
  31 }
  32
  33 strong {
  34   font-weight: bold;
  35   color: #083194;
  36 }
  37
  38 tt {
  39   color: navy;
  40 }
  41
  42 h1, h2, h3, h4, h5, h6 {
  43   color: #527bbd;
  44   font-family: sans-serif;
  45   margin-top: 1.2em;
  46   margin-bottom: 0.5em;
  47   line-height: 1.3;
  48 }
  49
  50 h1, h2, h3 {
  51   border-bottom: 2px solid silver;
  52 }
  53 h2 {
  54   padding-top: 0.5em;
  55 }
  56 h3 {
  57   float: left;
  58 }
  59 h3 + * {
  60   clear: left;
  61 }
  62
  63 div.sectionbody {
  64   font-family: serif;
  65   margin-left: 0;
  66 }
  67
  68 hr {
  69   border: 1px solid silver;
  70 }
  71
  72 p {
  73   margin-top: 0.5em;
  74   margin-bottom: 0.5em;
  75 }
  76
  77 ul, ol, li > p {
  78   margin-top: 0;
  79 }
  80
  81 pre {
  82   padding: 0;
  83   margin: 0;
  84 }
  85
  86 span#author {
  87   color: #527bbd;
  88   font-family: sans-serif;
  89   font-weight: bold;
  90   font-size: 1.1em;
  91 }
  92 span#email {
  93 }
  94 span#revnumber, span#revdate, span#revremark {
  95   font-family: sans-serif;
  96 }
  97
  98 div#footer {
  99   font-family: sans-serif;
 100   font-size: small;
 101   border-top: 2px solid silver;
 102   padding-top: 0.5em;
 103   margin-top: 4.0em;
 104 }
 105 div#footer-text {
 106   float: left;
 107   padding-bottom: 0.5em;
 108 }
 109 div#footer-badges {
 110   float: right;
 111   padding-bottom: 0.5em;
 112 }
 113
 114 div#preamble {
 115   margin-top: 1.5em;
 116   margin-bottom: 1.5em;
 117 }
 118 div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
 119 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 120 div.admonitionblock {
 121   margin-top: 1.5em;
 122   margin-bottom: 1.5em;
 123 }
 124 div.admonitionblock {
 125   margin-top: 2.5em;
 126   margin-bottom: 2.5em;
 127 }
 128
 129 div.content { /* Block element content. */
 130   padding: 0;
 131 }
 132
 133 /* Block element titles. */
 134 div.title, caption.title {
 135   color: #527bbd;
 136   font-family: sans-serif;
 137   font-weight: bold;
 138   text-align: left;
 139   margin-top: 1.0em;
 140   margin-bottom: 0.5em;
 141 }
 142 div.title + * {
 143   margin-top: 0;
 144 }
 145
 146 td div.title:first-child {
 147   margin-top: 0.0em;
 148 }
 149 div.content div.title:first-child {
 150   margin-top: 0.0em;
 151 }
 152 div.content + div.title {
 153   margin-top: 0.0em;
 154 }
 155
 156 div.sidebarblock > div.content {
 157   background: #ffffee;
 158   border: 1px solid silver;
 159   padding: 0.5em;
 160 }
 161
 162 div.listingblock > div.content {
 163   border: 1px solid silver;
 164   background: #f4f4f4;
 165   padding: 0.5em;
 166 }
 167
 168 div.quoteblock {
 169   padding-left: 2.0em;
 170   margin-right: 10%;
 171 }
 172 div.quoteblock > div.attribution {
 173   padding-top: 0.5em;
 174   text-align: right;
 175 }
 176
 177 div.verseblock {
 178   padding-left: 2.0em;
 179   margin-right: 10%;
 180 }
 181 div.verseblock > div.content {
 182   white-space: pre;
 183 }
 184 div.verseblock > div.attribution {
 185   padding-top: 0.75em;
 186   text-align: left;
 187 }
 188 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 189 div.verseblock + div.attribution {
 190   text-align: left;
 191 }
 192
 193 div.admonitionblock .icon {
 194   vertical-align: top;
 195   font-size: 1.1em;
 196   font-weight: bold;
 197   text-decoration: underline;
 198   color: #527bbd;
 199   padding-right: 0.5em;
 200 }
 201 div.admonitionblock td.content {
 202   padding-left: 0.5em;
 203   border-left: 2px solid silver;
 204 }
 205
 206 div.exampleblock > div.content {
 207   border-left: 2px solid silver;
 208   padding: 0.5em;
 209 }
 210
 211 div.imageblock div.content { padding-left: 0; }
 212 span.image img { border-style: none; }
 213 a.image:visited { color: white; }
 214
 215 dl {
 216   margin-top: 0.8em;
 217   margin-bottom: 0.8em;
 218 }
 219 dt {
 220   margin-top: 0.5em;
 221   margin-bottom: 0;
 222   font-style: normal;
 223   color: navy;
 224 }
 225 dd > *:first-child {
 226   margin-top: 0.1em;
 227 }
 228
 229 ul, ol {
 230     list-style-position: outside;
 231 }
 232 ol.arabic {
 233   list-style-type: decimal;
 234 }
 235 ol.loweralpha {
 236   list-style-type: lower-alpha;
 237 }
 238 ol.upperalpha {
 239   list-style-type: upper-alpha;
 240 }
 241 ol.lowerroman {
 242   list-style-type: lower-roman;
 243 }
 244 ol.upperroman {
 245   list-style-type: upper-roman;
 246 }
 247
 248 div.compact ul, div.compact ol,
 249 div.compact p, div.compact p,
 250 div.compact div, div.compact div {
 251   margin-top: 0.1em;
 252   margin-bottom: 0.1em;
 253 }
 254
 255 div.tableblock > table {
 256   border: 3px solid #527bbd;
 257 }
 258 thead {
 259   font-family: sans-serif;
 260   font-weight: bold;
 261 }
 262 tfoot {
 263   font-weight: bold;
 264 }
 265 td > div.verse {
 266   white-space: pre;
 267 }
 268 p.table {
 269   margin-top: 0;
 270 }
 271 /* Because the table frame attribute is overriden by CSS in most browsers. */
 272 div.tableblock > table[frame="void"] {
 273   border-style: none;
 274 }
 275 div.tableblock > table[frame="hsides"] {
 276   border-left-style: none;
 277   border-right-style: none;
 278 }
 279 div.tableblock > table[frame="vsides"] {
 280   border-top-style: none;
 281   border-bottom-style: none;
 282 }
 283
 284
 285 div.hdlist {
 286   margin-top: 0.8em;
 287   margin-bottom: 0.8em;
 288 }
 289 div.hdlist tr {
 290   padding-bottom: 15px;
 291 }
 292 dt.hdlist1.strong, td.hdlist1.strong {
 293   font-weight: bold;
 294 }
 295 td.hdlist1 {
 296   vertical-align: top;
 297   font-style: normal;
 298   padding-right: 0.8em;
 299   color: navy;
 300 }
 301 td.hdlist2 {
 302   vertical-align: top;
 303 }
 304 div.hdlist.compact tr {
 305   margin: 0;
 306   padding-bottom: 0;
 307 }
 308
 309 .comment {
 310   background: yellow;
 311 }
 312
 313 @media print {
 314   div#footer-badges { display: none; }
 315 }
 316
 317 div#toctitle {
 318   color: #527bbd;
 319   font-family: sans-serif;
 320   font-size: 1.1em;
 321   font-weight: bold;
 322   margin-top: 1.0em;
 323   margin-bottom: 0.1em;
 324 }
 325
 326 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 327   margin-top: 0;
 328   margin-bottom: 0;
 329 }
 330 div.toclevel2 {
 331   margin-left: 2em;
 332   font-size: 0.9em;
 333 }
 334 div.toclevel3 {
 335   margin-left: 4em;
 336   font-size: 0.9em;
 337 }
 338 div.toclevel4 {
 339   margin-left: 6em;
 340   font-size: 0.9em;
 341 }
 342 /* Overrides for manpage documents */
 343 h1 {
 344   padding-top: 0.5em;
 345   padding-bottom: 0.5em;
 346   border-top: 2px solid silver;
 347   border-bottom: 2px solid silver;
 348 }
 349 h2 {
 350   border-style: none;
 351 }
 352 div.sectionbody {
 353   margin-left: 5%;
 354 }
 355
 356 @media print {
 357   div#toc { display: none; }
 358 }
 359
 360 /* Workarounds for IE6's broken and incomplete CSS2. */
 361
 362 div.sidebar-content {
 363   background: #ffffee;
 364   border: 1px solid silver;
 365   padding: 0.5em;
 366 }
 367 div.sidebar-title, div.image-title {
 368   color: #527bbd;
 369   font-family: sans-serif;
 370   font-weight: bold;
 371   margin-top: 0.0em;
 372   margin-bottom: 0.5em;
 373 }
 374
 375 div.listingblock div.content {
 376   border: 1px solid silver;
 377   background: #f4f4f4;
 378   padding: 0.5em;
 379 }
 380
 381 div.quoteblock-attribution {
 382   padding-top: 0.5em;
 383   text-align: right;
 384 }
 385
 386 div.verseblock-content {
 387   white-space: pre;
 388 }
 389 div.verseblock-attribution {
 390   padding-top: 0.75em;
 391   text-align: left;
 392 }
 393
 394 div.exampleblock-content {
 395   border-left: 2px solid silver;
 396   padding-left: 0.5em;
 397 }
 398
 399 /* IE6 sets dynamically generated links as visited. */
 400 div#toc a:visited { color: blue; }
 401 </style>
 402 </head>
 403 <body>
 404 <div id="header">
 405 <h1>
 406 git-remote-ext(1) Manual Page
 407 </h1>
 408 <h2>NAME</h2>
 409 <div class="sectionbody">
 410 <p>git-remote-ext -
 411    Bridge smart transport to external command.
 412 </p>
 413 </div>
 414 </div>
 415 <h2 id="_synopsis">SYNOPSIS</h2>
 416 <div class="sectionbody">
 417 <div class="verseblock">
 418 <div class="verseblock-content">git remote add &lt;nick&gt; "ext::&lt;command&gt;[ &lt;arguments&gt;&#8230;]"</div>
 419 <div class="verseblock-attribution">
 420 </div></div>
 421 </div>
 422 <h2 id="_description">DESCRIPTION</h2>
 423 <div class="sectionbody">
 424 <div class="paragraph"><p>This remote helper uses the specified <em>&lt;command&gt;</em> to connect
 425 to a remote git server.</p></div>
 426 <div class="paragraph"><p>Data written to stdin of the specified <em>&lt;command&gt;</em> is assumed
 427 to be sent to a git:// server, git-upload-pack, git-receive-pack
 428 or git-upload-archive (depending on situation), and data read
 429 from stdout of &lt;command&gt; is assumed to be received from
 430 the same service.</p></div>
 431 <div class="paragraph"><p>Command and arguments are separated by an unescaped space.</p></div>
 432 <div class="paragraph"><p>The following sequences have a special meaning:</p></div>
 433 <div class="dlist"><dl>
 434 <dt class="hdlist1">
 435 '% '
 436 </dt>
 437 <dd>
 438 <p>
 439         Literal space in command or argument.
 440 </p>
 441 </dd>
 442 <dt class="hdlist1">
 443 <em>%%</em>
 444 </dt>
 445 <dd>
 446 <p>
 447         Literal percent sign.
 448 </p>
 449 </dd>
 450 <dt class="hdlist1">
 451 <em>%s</em>
 452 </dt>
 453 <dd>
 454 <p>
 455         Replaced with name (receive-pack, upload-pack, or
 456         upload-archive) of the service git wants to invoke.
 457 </p>
 458 </dd>
 459 <dt class="hdlist1">
 460 <em>%S</em>
 461 </dt>
 462 <dd>
 463 <p>
 464         Replaced with long name (git-receive-pack,
 465         git-upload-pack, or git-upload-archive) of the service
 466         git wants to invoke.
 467 </p>
 468 </dd>
 469 <dt class="hdlist1">
 470 <em>%G</em> (must be the first characters in an argument)
 471 </dt>
 472 <dd>
 473 <p>
 474         This argument will not be passed to <em>&lt;command&gt;</em>. Instead, it
 475         will cause the helper to start by sending git:// service requests to
 476         the remote side with the service field set to an appropriate value and
 477         the repository field set to rest of the argument. Default is not to send
 478         such a request.
 479 </p>
 480 <div class="paragraph"><p>This is useful if remote side is git:// server accessed over
 481 some tunnel.</p></div>
 482 </dd>
 483 <dt class="hdlist1">
 484 <em>%V</em> (must be first characters in argument)
 485 </dt>
 486 <dd>
 487 <p>
 488         This argument will not be passed to <em>&lt;command&gt;</em>. Instead it sets
 489         the vhost field in the git:// service request (to rest of the argument).
 490         Default is not to send vhost in such request (if sent).
 491 </p>
 492 </dd>
 493 </dl></div>
 494 </div>
 495 <h2 id="_environment_variables">ENVIRONMENT VARIABLES:</h2>
 496 <div class="sectionbody">
 497 <div class="dlist"><dl>
 498 <dt class="hdlist1">
 499 GIT_TRANSLOOP_DEBUG
 500 </dt>
 501 <dd>
 502 <p>
 503         If set, prints debugging information about various reads/writes.
 504 </p>
 505 </dd>
 506 </dl></div>
 507 </div>
 508 <h2 id="_environment_variables_passed_to_command">ENVIRONMENT VARIABLES PASSED TO COMMAND:</h2>
 509 <div class="sectionbody">
 510 <div class="dlist"><dl>
 511 <dt class="hdlist1">
 512 GIT_EXT_SERVICE
 513 </dt>
 514 <dd>
 515 <p>
 516         Set to long name (git-upload-pack, etc&#8230;) of service helper needs
 517         to invoke.
 518 </p>
 519 </dd>
 520 <dt class="hdlist1">
 521 GIT_EXT_SERVICE_NOPREFIX
 522 </dt>
 523 <dd>
 524 <p>
 525         Set to long name (upload-pack, etc&#8230;) of service helper needs
 526         to invoke.
 527 </p>
 528 </dd>
 529 </dl></div>
 530 </div>
 531 <h2 id="_examples">EXAMPLES:</h2>
 532 <div class="sectionbody">
 533 <div class="paragraph"><p>This remote helper is transparently used by git when
 534 you use commands such as "git fetch &lt;URL&gt;", "git clone &lt;URL&gt;",
 535 , "git push &lt;URL&gt;" or "git remote add &lt;nick&gt; &lt;URL&gt;", where &lt;URL&gt;
 536 begins with <tt>ext::</tt>.  Examples:</p></div>
 537 <div class="dlist"><dl>
 538 <dt class="hdlist1">
 539 "ext::ssh -i /home/foo/.ssh/somekey user&#64;host.example %S <em>foo/repo</em>"
 540 </dt>
 541 <dd>
 542 <p>
 543         Like host.example:foo/repo, but use /home/foo/.ssh/somekey as
 544         keypair and user as user on remote side. This avoids needing to
 545         edit .ssh/config.
 546 </p>
 547 </dd>
 548 <dt class="hdlist1">
 549 "ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo"
 550 </dt>
 551 <dd>
 552 <p>
 553         Represents repository with path /somerepo accessable over
 554         git protocol at abstract namespace address /git-server.
 555 </p>
 556 </dd>
 557 <dt class="hdlist1">
 558 "ext::git-server-alias foo %G/repo"
 559 </dt>
 560 <dd>
 561 <p>
 562         Represents a repository with path /repo accessed using the
 563         helper program "git-server-alias foo".  The path to the
 564         repository and type of request are not passed on the command
 565         line but as part of the protocol stream, as usual with git://
 566         protocol.
 567 </p>
 568 </dd>
 569 <dt class="hdlist1">
 570 "ext::git-server-alias foo %G/repo %Vfoo"
 571 </dt>
 572 <dd>
 573 <p>
 574         Represents a repository with path /repo accessed using the
 575         helper program "git-server-alias foo".  The hostname for the
 576         remote server passed in the protocol stream will be "foo"
 577         (this allows multiple virtual git servers to share a
 578         link-level address).
 579 </p>
 580 </dd>
 581 <dt class="hdlist1">
 582 "ext::git-server-alias foo %G/repo% with% spaces %Vfoo"
 583 </dt>
 584 <dd>
 585 <p>
 586         Represents a repository with path <em>/repo with spaces</em> accessed
 587         using the helper program "git-server-alias foo".  The hostname for
 588         the remote server passed in the protocol stream will be "foo"
 589         (this allows multiple virtual git servers to share a
 590         link-level address).
 591 </p>
 592 </dd>
 593 <dt class="hdlist1">
 594 "ext::git-ssl foo.example /bar"
 595 </dt>
 596 <dd>
 597 <p>
 598         Represents a repository accessed using the helper program
 599         "git-ssl foo.example /bar".  The type of request can be
 600         determined by the helper using environment variables (see
 601         above).
 602 </p>
 603 </dd>
 604 </dl></div>
 605 </div>
 606 <h2 id="_documentation">Documentation</h2>
 607 <div class="sectionbody">
 608 <div class="paragraph"><p>Documentation by Ilari Liusvaara, Jonathan Nieder and the git list
 609 &lt;<a href="mailto:git@vger.kernel.org">git@vger.kernel.org</a>&gt;</p></div>
 610 </div>
 611 <h2 id="_git">GIT</h2>
 612 <div class="sectionbody">
 613 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 614 </div>
 615 <div id="footer">
 616 <div id="footer-text">
 617 Last updated 2011-07-23 00:49:30 UTC
 618 </div>
 619 </div>
 620 </body>
 621 </html>