aboutsummaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorShawn O. Pearce <spearce@spearce.org>2007-08-04 02:06:52 -0400
committerJunio C Hamano <gitster@pobox.com>2007-08-04 01:55:08 -0700
commitd5538b418d658d507f7fb9f359b31152a9b5f8e0 (patch)
tree23da698e1bb6c5fc11fffe2412f37b56d9ab100c /Documentation
parent2ec39edad9c3be74b5fed5ab5c122493e6a53c66 (diff)
downloadgit-d5538b418d658d507f7fb9f359b31152a9b5f8e0.tar.gz
git-d5538b418d658d507f7fb9f359b31152a9b5f8e0.tar.xz
Document GIT_SSH environment variable alongside other variables
The GIT_SSH environment variable has survived for quite a while without being documented, but has been mentioned on list and on my day-job repositories can only be accessed via magic supplied through the wonderous hack that is GIT_SSH. Advertising it alongside other "low level magic" such as GIT_PAGER and GIT_MERGE_VERBOSITY will certainly help others who need to spread their own pixie dust to make things work. Signed-off-by: Shawn O. Pearce <spearce@spearce.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 4c4d1746e..18f8b6a0a 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -421,6 +421,22 @@ other
to an empty string or to the value "cat", git will not launch
a pager.
+'GIT_SSH'::
+ If this environment variable is set then gitlink:git-fetch[1]
+ and gitlink:git-push[1] 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 arguments:
+ the 'username@host' (or just 'host') from the URL and the
+ shell command to execute on that remote system.
++
+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.
++
+Usually it is easier to configure any desired options through your
+personal `.ssh/config` file. Please consult your ssh documentation
+for further details.
+
'GIT_FLUSH'::
If this environment variable is set to "1", then commands such
as git-blame (in incremental mode), git-rev-list, git-log,