abc49441be7a86e25a2b09d98f7de2ddcf0b0bb2
[git/git.git] / Documentation / git-remote-fd.txt
1 git-remote-fd(1)
2 ================
3
4 NAME
5 ----
6 git-remote-fd - Reflect smart transport stream back to caller
7
8 SYNOPSIS
9 --------
10 "fd::<infd>[,<outfd>][/<anything>]" (as URL)
11
12 DESCRIPTION
13 -----------
14 This helper uses specified file descriptors to connect to remote git server.
15 This is not meant for end users but for programs and scripts calling git
16 fetch, push or archive.
17
18 If only <infd> is given, it is assumed to be bidirectional socket connected
19 to remote git server (git-upload-pack, git-receive-pack or
20 git-upload-achive). If both <infd> and <outfd> are given, they are assumed
21 to be pipes connected to remote git server (<infd> being the inbound pipe
22 and <outfd> being the outbound pipe.
23
24 It is assumed that any handshaking procedures have already been completed
25 (such as sending service request for git://) before this helper is started.
26
27 <anything> can be any string. It is ignored. It is meant for provoding
28 information to user in the URL in case that URL is displayed in some
29 context.
30
31 ENVIRONMENT VARIABLES
32 ---------------------
33 GIT_TRANSLOOP_DEBUG::
34 If set, prints debugging information about various reads/writes.
35
36 EXAMPLES
37 --------
38 git fetch fd::17 master::
39 Fetch master, using file descriptor #17 to communicate with
40 git-upload-pack.
41
42 git fetch fd::17/foo master::
43 Same as above.
44
45 git push fd::7,8 master (as URL)::
46 Push master, using file descriptor #7 to read data from
47 git-receive-pack and file descriptor #8 to write data to
48 same service.
49
50 git push fd::7,8/bar master::
51 Same as above.
52
53 Documentation
54 --------------
55 Documentation by Ilari Liusvaara and the git list <git@vger.kernel.org>
56
57 GIT
58 ---
59 Part of the linkgit:git[1] suite