summaryrefslogtreecommitdiff
path: root/Documentation/git.txt
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2014-12-05 11:39:25 -0800
committerLibravatar Junio C Hamano <gitster@pobox.com>2014-12-05 11:39:25 -0800
commit09d60d785c68c8fa65094ecbe46fbc2a38d0fc1f (patch)
tree44228a921720d7aaf07e214360003a0998ea64bc /Documentation/git.txt
parentMerge branch 'rs/env-array-in-child-process' (diff)
parentgit_connect: set ssh shell command in GIT_SSH_COMMAND (diff)
downloadtgif-09d60d785c68c8fa65094ecbe46fbc2a38d0fc1f.tar.xz
Merge branch 'tq/git-ssh-command'
Allow passing extra set of arguments when ssh is invoked to create an encrypted & authenticated connection by introducing a new environment variable GIT_SSH_COMMAND, whose contents is interpreted by shells. This is not possible with existing GIT_SSH mechanism whose invocation bypasses shells, which was designed more to match what other programs with similar variables did, not necessarily to be more useful. * tq/git-ssh-command: git_connect: set ssh shell command in GIT_SSH_COMMAND
Diffstat (limited to 'Documentation/git.txt')
-rw-r--r--Documentation/git.txt26
1 files changed, 14 insertions, 12 deletions
diff --git a/Documentation/git.txt b/Documentation/git.txt
index afb48d39bb..dd172548f3 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -881,19 +881,21 @@ other
and the `core.editor` option in linkgit:git-config[1].
'GIT_SSH'::
- If this environment variable is set then 'git fetch'
- and 'git push' will use this command instead
- of 'ssh' when they need to connect to a remote system.
- The '$GIT_SSH' command will be given exactly two or
- four arguments: the 'username@host' (or just 'host')
- from the URL and the shell command to execute on that
- remote system, optionally preceded by '-p' (literally) and
- the 'port' from the URL when it specifies something other
- than the default SSH port.
+'GIT_SSH_COMMAND'::
+ If either of these environment variables is set then 'git fetch'
+ and 'git push' will use the specified command instead of 'ssh'
+ when they need to connect to a remote system.
+ The command will be given exactly two or four arguments: the
+ 'username@host' (or just 'host') from the URL and the shell
+ command to execute on that remote system, optionally preceded by
+ '-p' (literally) and the 'port' from the URL when it specifies
+ something other than the default SSH port.
+
-To pass options to the program that you want to list in GIT_SSH
-you will need to wrap the program and options into a shell script,
-then set GIT_SSH to refer to the shell script.
+`$GIT_SSH_COMMAND` takes precedence over `$GIT_SSH`, and is interpreted
+by the shell, which allows additional arguments to be included.
+`$GIT_SSH` on the other hand must be just the path to a program
+(which can be a wrapper shell script, if additional arguments are
+needed).
+
Usually it is easier to configure any desired options through your
personal `.ssh/config` file. Please consult your ssh documentation