submodule: Document the details of the command line syntax
[alt-git.git] / Documentation / urls.txt
blob81ac17f32a0587e3d2d41eb8ee89dd85e13f1802
1 GIT URLS[[URLS]]
2 ----------------
4 One of the following notations can be used
5 to name the remote repository:
7 ===============================================================
8 - rsync://host.xz/path/to/repo.git/
9 - http://host.xz/path/to/repo.git/
10 - https://host.xz/path/to/repo.git/
11 - git://host.xz/path/to/repo.git/
12 - git://host.xz/~user/path/to/repo.git/
13 - ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/path/to/repo.git/
14 - ssh://{startsb}user@{endsb}host.xz/path/to/repo.git/
15 - ssh://{startsb}user@{endsb}host.xz/~user/path/to/repo.git/
16 - ssh://{startsb}user@{endsb}host.xz/~/path/to/repo.git
17 ===============================================================
19 SSH is the default transport protocol over the network.  You can
20 optionally specify which user to log-in as, and an alternate,
21 scp-like syntax is also supported.  Both syntaxes support
22 username expansion, as does the native git protocol, but
23 only the former supports port specification. The following
24 three are identical to the last three above, respectively:
26 ===============================================================
27 - {startsb}user@{endsb}host.xz:/path/to/repo.git/
28 - {startsb}user@{endsb}host.xz:~user/path/to/repo.git/
29 - {startsb}user@{endsb}host.xz:path/to/repo.git
30 ===============================================================
32 To sync with a local directory, you can use:
34 ===============================================================
35 - /path/to/repo.git/
36 - file:///path/to/repo.git/
37 ===============================================================
39 ifndef::git-clone[]
40 They are mostly equivalent, except when cloning.  See
41 linkgit:git-clone[1] for details.
42 endif::git-clone[]
44 ifdef::git-clone[]
45 They are equivalent, except the former implies --local option.
46 endif::git-clone[]