]>
Commit | Line | Data |
---|---|---|
7f3ecebf IL |
1 | git-remote-ext(1) |
2 | ================= | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-remote-ext - Bridge smart transport to external command. | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
7791a1d9 | 10 | [verse] |
3b0d2405 | 11 | git remote add <nick> "ext::<command>[ <arguments>...]" |
7f3ecebf IL |
12 | |
13 | DESCRIPTION | |
14 | ----------- | |
3b0d2405 | 15 | This remote helper uses the specified '<command>' to connect |
2de9b711 | 16 | to a remote Git server. |
7f3ecebf | 17 | |
3b0d2405 | 18 | Data written to stdin of the specified '<command>' is assumed |
469bfc96 | 19 | to be sent to a git:// server, git-upload-pack, git-receive-pack |
7f3ecebf | 20 | or git-upload-archive (depending on situation), and data read |
3b0d2405 | 21 | from stdout of <command> is assumed to be received from |
7f3ecebf IL |
22 | the same service. |
23 | ||
469bfc96 | 24 | Command and arguments are separated by an unescaped space. |
7f3ecebf IL |
25 | |
26 | The following sequences have a special meaning: | |
27 | ||
28 | '% ':: | |
29 | Literal space in command or argument. | |
30 | ||
31 | '%%':: | |
32 | Literal percent sign. | |
33 | ||
34 | '%s':: | |
35 | Replaced with name (receive-pack, upload-pack, or | |
2de9b711 | 36 | upload-archive) of the service Git wants to invoke. |
7f3ecebf IL |
37 | |
38 | '%S':: | |
39 | Replaced with long name (git-receive-pack, | |
40 | git-upload-pack, or git-upload-archive) of the service | |
2de9b711 | 41 | Git wants to invoke. |
7f3ecebf | 42 | |
469bfc96 | 43 | '%G' (must be the first characters in an argument):: |
3b0d2405 | 44 | This argument will not be passed to '<command>'. Instead, it |
469bfc96 RW |
45 | will cause the helper to start by sending git:// service requests to |
46 | the remote side with the service field set to an appropriate value and | |
47 | the repository field set to rest of the argument. Default is not to send | |
48 | such a request. | |
7f3ecebf IL |
49 | + |
50 | This is useful if remote side is git:// server accessed over | |
51 | some tunnel. | |
52 | ||
7851b1e6 | 53 | '%V' (must be first characters in argument):: |
3b0d2405 | 54 | This argument will not be passed to '<command>'. Instead it sets |
469bfc96 | 55 | the vhost field in the git:// service request (to rest of the argument). |
7851b1e6 | 56 | Default is not to send vhost in such request (if sent). |
7f3ecebf IL |
57 | |
58 | ENVIRONMENT VARIABLES: | |
59 | ---------------------- | |
60 | ||
61 | GIT_TRANSLOOP_DEBUG:: | |
62 | If set, prints debugging information about various reads/writes. | |
63 | ||
64 | ENVIRONMENT VARIABLES PASSED TO COMMAND: | |
65 | ---------------------------------------- | |
66 | ||
67 | GIT_EXT_SERVICE:: | |
68 | Set to long name (git-upload-pack, etc...) of service helper needs | |
69 | to invoke. | |
70 | ||
71 | GIT_EXT_SERVICE_NOPREFIX:: | |
72 | Set to long name (upload-pack, etc...) of service helper needs | |
73 | to invoke. | |
74 | ||
75 | ||
76 | EXAMPLES: | |
77 | --------- | |
2de9b711 | 78 | This remote helper is transparently used by Git when |
7f3ecebf | 79 | you use commands such as "git fetch <URL>", "git clone <URL>", |
3b0d2405 | 80 | , "git push <URL>" or "git remote add <nick> <URL>", where <URL> |
7f3ecebf IL |
81 | begins with `ext::`. Examples: |
82 | ||
83 | "ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'":: | |
84 | Like host.example:foo/repo, but use /home/foo/.ssh/somekey as | |
85 | keypair and user as user on remote side. This avoids needing to | |
86 | edit .ssh/config. | |
87 | ||
88 | "ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo":: | |
e1c3bf49 | 89 | Represents repository with path /somerepo accessible over |
7f3ecebf IL |
90 | git protocol at abstract namespace address /git-server. |
91 | ||
92 | "ext::git-server-alias foo %G/repo":: | |
93 | Represents a repository with path /repo accessed using the | |
94 | helper program "git-server-alias foo". The path to the | |
95 | repository and type of request are not passed on the command | |
96 | line but as part of the protocol stream, as usual with git:// | |
97 | protocol. | |
98 | ||
99 | "ext::git-server-alias foo %G/repo %Vfoo":: | |
100 | Represents a repository with path /repo accessed using the | |
101 | helper program "git-server-alias foo". The hostname for the | |
102 | remote server passed in the protocol stream will be "foo" | |
2de9b711 | 103 | (this allows multiple virtual Git servers to share a |
7f3ecebf IL |
104 | link-level address). |
105 | ||
106 | "ext::git-server-alias foo %G/repo% with% spaces %Vfoo":: | |
107 | Represents a repository with path '/repo with spaces' accessed | |
108 | using the helper program "git-server-alias foo". The hostname for | |
109 | the remote server passed in the protocol stream will be "foo" | |
2de9b711 | 110 | (this allows multiple virtual Git servers to share a |
7f3ecebf IL |
111 | link-level address). |
112 | ||
113 | "ext::git-ssl foo.example /bar":: | |
114 | Represents a repository accessed using the helper program | |
115 | "git-ssl foo.example /bar". The type of request can be | |
116 | determined by the helper using environment variables (see | |
117 | above). | |
118 | ||
119 | Documentation | |
120 | -------------- | |
2de9b711 | 121 | Documentation by Ilari Liusvaara, Jonathan Nieder and the Git list |
7f3ecebf IL |
122 | <git@vger.kernel.org> |
123 | ||
124 | GIT | |
125 | --- | |
126 | Part of the linkgit:git[1] suite |