updated git doc
[TortoiseGit.git] / doc / source / en / TortoiseGit / git_doc / git-remote-fd.xml
blob9b1b71e7c1c24d12a73640a80658388b775b0eb5
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-remote-fd(1)">\r
5 <articleinfo>\r
6     <title>git-remote-fd(1)</title>\r
7 <indexterm>\r
8 <primary>git-remote-fd(1)</primary>\r
9 </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-remote-fd - Reflect smart transport stream back to caller</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara>"fd::&lt;infd&gt;[,&lt;outfd&gt;][/&lt;anything&gt;]" (as URL)</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>This helper uses specified file descriptors to connect to a remote git server.\r
22 This is not meant for end users but for programs and scripts calling git\r
23 fetch, push or archive.</simpara>\r
24 <simpara>If only &lt;infd&gt; is given, it is assumed to be a bidirectional socket connected\r
25 to remote git server (git-upload-pack, git-receive-pack or\r
26 git-upload-achive). If both &lt;infd&gt; and &lt;outfd&gt; are given, they are assumed\r
27 to be pipes connected to a remote git server (&lt;infd&gt; being the inbound pipe\r
28 and &lt;outfd&gt; being the outbound pipe.</simpara>\r
29 <simpara>It is assumed that any handshaking procedures have already been completed\r
30 (such as sending service request for git://) before this helper is started.</simpara>\r
31 <simpara>&lt;anything&gt; can be any string. It is ignored. It is meant for providing\r
32 information to user in the URL in case that URL is displayed in some\r
33 context.</simpara>\r
34 </simplesect>\r
35 <simplesect id="_environment_variables">\r
36 <title>ENVIRONMENT VARIABLES</title>\r
37 <variablelist>\r
38 <varlistentry>\r
39 <term>\r
40 GIT_TRANSLOOP_DEBUG\r
41 </term>\r
42 <listitem>\r
43 <simpara>\r
44         If set, prints debugging information about various reads/writes.\r
45 </simpara>\r
46 </listitem>\r
47 </varlistentry>\r
48 </variablelist>\r
49 </simplesect>\r
50 <simplesect id="_examples">\r
51 <title>EXAMPLES</title>\r
52 <variablelist>\r
53 <varlistentry>\r
54 <term>\r
55 <emphasis>git fetch fd::17 master</emphasis>\r
56 </term>\r
57 <listitem>\r
58 <simpara>\r
59         Fetch master, using file descriptor #17 to communicate with\r
60         git-upload-pack.\r
61 </simpara>\r
62 </listitem>\r
63 </varlistentry>\r
64 <varlistentry>\r
65 <term>\r
66 <emphasis>git fetch fd::17/foo master</emphasis>\r
67 </term>\r
68 <listitem>\r
69 <simpara>\r
70         Same as above.\r
71 </simpara>\r
72 </listitem>\r
73 </varlistentry>\r
74 <varlistentry>\r
75 <term>\r
76 <emphasis>git push fd::7,8 master (as URL)</emphasis>\r
77 </term>\r
78 <listitem>\r
79 <simpara>\r
80         Push master, using file descriptor #7 to read data from\r
81         git-receive-pack and file descriptor #8 to write data to\r
82         same service.\r
83 </simpara>\r
84 </listitem>\r
85 </varlistentry>\r
86 <varlistentry>\r
87 <term>\r
88 <emphasis>git push fd::7,8/bar master</emphasis>\r
89 </term>\r
90 <listitem>\r
91 <simpara>\r
92         Same as above.\r
93 </simpara>\r
94 </listitem>\r
95 </varlistentry>\r
96 </variablelist>\r
97 </simplesect>\r
98 <simplesect id="_documentation">\r
99 <title>Documentation</title>\r
100 <simpara>Documentation by Ilari Liusvaara and the git list &lt;<ulink url="mailto:git@vger.kernel.org">git@vger.kernel.org</ulink>&gt;</simpara>\r
101 </simplesect>\r
102 <simplesect id="_git">\r
103 <title>GIT</title>\r
104 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
105 </simplesect>\r
106 </article>\r