blob: 1dd2648a7904bb73c626019e9ab66e0db009ecf5 [file] [log] [blame]
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +03001git-remote-fd(1)
Ilari Liusvaara7851b1e2010-11-17 09:15:34 -08002================
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +03003
4NAME
5----
6git-remote-fd - Reflect smart transport stream back to caller
7
8SYNOPSIS
9--------
10"fd::<infd>[,<outfd>][/<anything>]" (as URL)
11
12DESCRIPTION
13-----------
Thomas Ackermann2de9b712013-01-21 20:17:53 +010014This helper uses specified file descriptors to connect to a remote Git server.
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030015This is not meant for end users but for programs and scripts calling git
Elijah Newren4d542682023-10-08 06:45:24 +000016fetch, push, or archive.
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030017
Ralf Wildenhues469bfc92011-01-03 20:03:34 +010018If only <infd> is given, it is assumed to be a bidirectional socket connected
Elijah Newren4d542682023-10-08 06:45:24 +000019to a remote Git server (git-upload-pack, git-receive-pack, or
Ville Skyttä2e3a16b2016-08-09 11:53:38 +030020git-upload-archive). If both <infd> and <outfd> are given, they are assumed
Thomas Ackermann2de9b712013-01-21 20:17:53 +010021to be pipes connected to a remote Git server (<infd> being the inbound pipe
Elijah Newren5fbcdb22023-10-08 06:45:27 +000022and <outfd> being the outbound pipe).
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030023
24It is assumed that any handshaking procedures have already been completed
25(such as sending service request for git://) before this helper is started.
26
Ralf Wildenhues469bfc92011-01-03 20:03:34 +010027<anything> can be any string. It is ignored. It is meant for providing
Elijah Newren0a4f0512023-10-08 06:45:17 +000028information to the user in the URL in case that URL is displayed in some
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030029context.
30
Ilari Liusvaara7851b1e2010-11-17 09:15:34 -080031ENVIRONMENT VARIABLES
32---------------------
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030033GIT_TRANSLOOP_DEBUG::
34 If set, prints debugging information about various reads/writes.
35
Ilari Liusvaara7851b1e2010-11-17 09:15:34 -080036EXAMPLES
37--------
Jeff King5d2fc912011-08-03 20:13:29 -060038`git fetch fd::17 master`::
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030039 Fetch master, using file descriptor #17 to communicate with
40 git-upload-pack.
41
Jeff King5d2fc912011-08-03 20:13:29 -060042`git fetch fd::17/foo master`::
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030043 Same as above.
44
Jeff King5d2fc912011-08-03 20:13:29 -060045`git push fd::7,8 master (as URL)`::
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030046 Push master, using file descriptor #7 to read data from
47 git-receive-pack and file descriptor #8 to write data to
Elijah Newren0a4f0512023-10-08 06:45:17 +000048 the same service.
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030049
Jeff King5d2fc912011-08-03 20:13:29 -060050`git push fd::7,8/bar master`::
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030051 Same as above.
52
Max Horn26726712014-11-11 21:17:07 +010053SEE ALSO
54--------
Johannes Schindelin439cc742019-03-25 14:41:36 -070055linkgit:gitremote-helpers[7]
Max Horn26726712014-11-11 21:17:07 +010056
Ilari Liusvaara3a9ed4b2010-10-12 19:39:42 +030057GIT
58---
59Part of the linkgit:git[1] suite