summaryrefslogtreecommitdiff
path: root/Documentation/urls.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/urls.txt')
-rw-r--r--Documentation/urls.txt38
1 files changed, 38 insertions, 0 deletions
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
new file mode 100644
index 0000000000..b38145faff
--- /dev/null
+++ b/Documentation/urls.txt
@@ -0,0 +1,38 @@
+GIT URLS[[URLS]]
+----------------
+
+One of the following notations can be used
+to name the remote repository:
+
+===============================================================
+- rsync://host.xz/path/to/repo.git/
+- http://host.xz/path/to/repo.git/
+- https://host.xz/path/to/repo.git/
+- git://host.xz/path/to/repo.git/
+- git://host.xz/~user/path/to/repo.git/
+- ssh://{startsb}user@{endsb}host.xz/path/to/repo.git/
+- ssh://{startsb}user@{endsb}host.xz/~user/path/to/repo.git/
+- ssh://{startsb}user@{endsb}host.xz/~/path/to/repo.git
+===============================================================
+
+SSH is the default transport protocol over the network. You can
+optionally specify which user to log-in as, and an alternate,
+scp-like syntax is also supported. Both syntaxes support
+username expansion, as does the native git protocol. The following
+three are identical to the last three above, respectively:
+
+===============================================================
+- {startsb}user@{endsb}host.xz:/path/to/repo.git/
+- {startsb}user@{endsb}host.xz:~user/path/to/repo.git/
+- {startsb}user@{endsb}host.xz:path/to/repo.git
+===============================================================
+
+To sync with a local directory, you can use:
+
+===============================================================
+- /path/to/repo.git/
+- file:///path/to/repo.git/
+===============================================================
+
+They are mostly equivalent, except when cloning. See
+gitlink:git-clone[1] for details.