Merge branch 'jl/doc-submodule-update-checkout'
[gitweb.git] / Documentation / git-remote-ext.txt
index 2d65cfefd5d2aeaafcbc0bb6e6705f8379b2f826..cd0bb77e4a07453c54378b8f2db813ba354a68ef 100644 (file)
@@ -7,17 +7,18 @@ git-remote-ext - Bridge smart transport to external command.
 
 SYNOPSIS
 --------
-git remote add nick "ext::<command>[ <arguments>...]"
+[verse]
+git remote add <nick> "ext::<command>[ <arguments>...]"
 
 DESCRIPTION
 -----------
-This remote helper uses the specified 'program' to connect
-to a remote git server.
+This remote helper uses the specified '<command>' to connect
+to a remote Git server.
 
-Data written to stdin of this specified 'program' is assumed
+Data written to stdin of the specified '<command>' is assumed
 to be sent to a 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 an unescaped space.
@@ -32,15 +33,15 @@ The following sequences have a special meaning:
 
 '%s'::
        Replaced with name (receive-pack, upload-pack, or
-       upload-archive) of the service git wants to invoke.
+       upload-archive) of the service Git wants to invoke.
 
 '%S'::
        Replaced with long name (git-receive-pack,
        git-upload-pack, or git-upload-archive) of the service
-       git wants to invoke.
+       Git wants to invoke.
 
 '%G' (must be the first characters in an argument)::
-       This argument will not be passed to 'program'. Instead, it
+       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
@@ -50,7 +51,7 @@ This is useful if remote side is git:// server accessed over
 some tunnel.
 
 '%V' (must be first characters in argument)::
-       This argument will not be passed to 'program'. Instead it sets
+       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).
 
@@ -74,9 +75,9 @@ GIT_EXT_SERVICE_NOPREFIX::
 
 EXAMPLES:
 ---------
-This remote helper is transparently used by git when
+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'"::
@@ -85,7 +86,7 @@ begins with `ext::`.  Examples:
        edit .ssh/config.
 
 "ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo"::
-       Represents repository with path /somerepo accessable over
+       Represents repository with path /somerepo accessible over
        git protocol at abstract namespace address /git-server.
 
 "ext::git-server-alias foo %G/repo"::
@@ -99,14 +100,14 @@ begins with `ext::`.  Examples:
        Represents a repository with path /repo accessed using the
        helper program "git-server-alias foo".  The hostname for the
        remote server passed in the protocol stream will be "foo"
-       (this allows multiple virtual git servers to share a
+       (this allows multiple virtual Git servers to share a
        link-level address).
 
 "ext::git-server-alias foo %G/repo% with% spaces %Vfoo"::
        Represents a repository with path '/repo with spaces' accessed
        using the helper program "git-server-alias foo".  The hostname for
        the remote server passed in the protocol stream will be "foo"
-       (this allows multiple virtual git servers to share a
+       (this allows multiple virtual Git servers to share a
        link-level address).
 
 "ext::git-ssl foo.example /bar"::
@@ -115,11 +116,6 @@ begins with `ext::`.  Examples:
        determined by the helper using environment variables (see
        above).
 
-Documentation
---------------
-Documentation by Ilari Liusvaara, Jonathan Nieder and the git list
-<git@vger.kernel.org>
-
 GIT
 ---
 Part of the linkgit:git[1] suite