Restructure documentation for git-merge-base.
[gitweb.git] / Documentation / git-remote-ext.txt
index 8fb260b54b072bfd79ebf037967173994f0f2c5f..68263a6a538b3d4659ca9dc0afd2253170143fb6 100644 (file)
@@ -7,20 +7,20 @@ git-remote-ext - Bridge smart transport to external command.
 
 SYNOPSIS
 --------
-git remote add nick "ext::<command>[ <arguments>...]"
+git remote add <nick> "ext::<command>[ <arguments>...]"
 
 DESCRIPTION
 -----------
-This remote helper uses the specified 'program' to connect
+This remote helper uses the specified '<command>' to connect
 to a remote git server.
 
-Data written to stdin of this specified 'program' is assumed
-to be sent to git:// server, git-upload-pack, git-receive-pack
+Data written to stdin of the specified '<command>' is assumed
+to be sent to git:// server, git-upload-pack, git-receive-pack
 or git-upload-archive (depending on situation), and data read
-from stdout of this program is assumed to be received from
+from stdout of <command> is assumed to be received from
 the same service.
 
-Command and arguments are separated by unescaped space.
+Command and arguments are separated by an unescaped space.
 
 The following sequences have a special meaning:
 
@@ -39,20 +39,20 @@ The following sequences have a special meaning:
        git-upload-pack, or git-upload-archive) of the service
        git wants to invoke.
 
-'%G<repository>' (as argument)::
-       This argument will not be passed to 'program'. Instead, it
-       will cause helper to start by sending git:// service request to
-       remote side with service field set to approiate value and
-       repository field set to <repository>. Default is not to send
-       such request.
+'%G' (must be the first characters in an argument)::
+       This argument will not be passed to '<command>'. Instead, it
+       will cause the helper to start by sending git:// service requests to
+       the remote side with the service field set to an appropriate value and
+       the repository field set to rest of the argument. Default is not to send
+       such request.
 +
 This is useful if remote side is git:// server accessed over
 some tunnel.
 
-'%V<host>' (as argument)::
-       This argument will not be passed to 'program'. Instead it sets
-       the vhost field in git:// service request. Default is not to
-       send vhost in such request (if sent).
+'%V' (must be first characters in argument)::
+       This argument will not be passed to '<command>'. Instead it sets
+       the vhost field in the git:// service request (to rest of the argument).
+       Default is not to send vhost in such request (if sent).
 
 ENVIRONMENT VARIABLES:
 ----------------------
@@ -76,7 +76,7 @@ EXAMPLES:
 ---------
 This remote helper is transparently used by git when
 you use commands such as "git fetch <URL>", "git clone <URL>",
-, "git push <URL>" or "git remote add nick <URL>", where <URL>
+, "git push <URL>" or "git remote add <nick> <URL>", where <URL>
 begins with `ext::`.  Examples:
 
 "ext::ssh -i /home/foo/.ssh/somekey user&#64;host.example %S 'foo/repo'"::