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>
Shawn O. Pearce committed
Aug 4, 2007 at 02:06 UTC
d5538b418d658d507f7fb9f359b31152a9b5f8e0
1 file changed
+16
Documentation/git.txt
+16
@@ -421,6 +421,22 @@ other
421
to an empty string or to the value "cat", git will not launch
422
a pager.
423
424
+'GIT_SSH'::
425
+ If this environment variable is set then gitlink:git-fetch[1]
426
+ and gitlink:git-push[1] will use this command instead
427
+ of `ssh` when they need to connect to a remote system.
428
+ The 'GIT_SSH' command will be given exactly two arguments:
429
+ the 'username@host' (or just 'host') from the URL and the
430
+ shell command to execute on that remote system.
431
++
432
+To pass options to the program that you want to list in GIT_SSH
433
+you will need to wrap the program and options into a shell script,
434
+then set GIT_SSH to refer to the shell script.
435
++
436
+Usually it is easier to configure any desired options through your
437
+personal `.ssh/config` file. Please consult your ssh documentation
438
+for further details.
439
+
440
'GIT_FLUSH'::
441
If this environment variable is set to "1", then commands such
442
as git-blame (in incremental mode), git-rev-list, git-log,