Fix typos in the documentation
[git/git.git] / Documentation / git-remote-fd.txt
CommitLineData
3a9ed4bd 1git-remote-fd(1)
7851b1e6 2================
3a9ed4bd
IL
3
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-----------
469bfc96 14This helper uses specified file descriptors to connect to a remote git server.
3a9ed4bd
IL
15This is not meant for end users but for programs and scripts calling git
16fetch, push or archive.
17
469bfc96 18If only <infd> is given, it is assumed to be a bidirectional socket connected
3a9ed4bd
IL
19to remote git server (git-upload-pack, git-receive-pack or
20git-upload-achive). If both <infd> and <outfd> are given, they are assumed
469bfc96 21to be pipes connected to a remote git server (<infd> being the inbound pipe
3a9ed4bd
IL
22and <outfd> being the outbound pipe.
23
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
469bfc96 27<anything> can be any string. It is ignored. It is meant for providing
3a9ed4bd
IL
28information to user in the URL in case that URL is displayed in some
29context.
30
7851b1e6
IL
31ENVIRONMENT VARIABLES
32---------------------
3a9ed4bd
IL
33GIT_TRANSLOOP_DEBUG::
34 If set, prints debugging information about various reads/writes.
35
7851b1e6
IL
36EXAMPLES
37--------
3a9ed4bd
IL
38git fetch fd::17 master::
39 Fetch master, using file descriptor #17 to communicate with
40 git-upload-pack.
41
42git fetch fd::17/foo master::
43 Same as above.
44
45git 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
50git push fd::7,8/bar master::
51 Same as above.
52
53Documentation
54--------------
55Documentation by Ilari Liusvaara and the git list <git@vger.kernel.org>
56
57GIT
58---
59Part of the linkgit:git[1] suite