Google Git
Sign in
chromium / external / gitster / git-htmldocs / b60308af319f44ed4baa08874c979cf9d8e7cc66 / . / urls.txt
blob: 745f9677d005b522f52496339abd5afc4267a815 [file] [log] [blame]
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]1GIT URLS[[URLS]]
2----------------
3
4One of the following notations can be used
5to name the remote repository:
6
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/
Junio C Hamano7ccb9fd2006-07-15 01:38:40[diff] [blame]13- ssh://{startsb}user@{endsb}host.xz/path/to/repo.git/
14- ssh://{startsb}user@{endsb}host.xz/~user/path/to/repo.git/
15- ssh://{startsb}user@{endsb}host.xz/~/path/to/repo.git
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]16===============================================================
17
Junio C Hamano7ccb9fd2006-07-15 01:38:40[diff] [blame]18SSH is the default transport protocol. You can optionally specify
19which user to log-in as, and an alternate, scp-like syntax is also
20supported. Both syntaxes support username expansion,
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]21as does the native git protocol. The following three are
22identical to the last three above, respectively:
23
24===============================================================
Junio C Hamano7ccb9fd2006-07-15 01:38:40[diff] [blame]25- {startsb}user@{endsb}host.xz:/path/to/repo.git/
26- {startsb}user@{endsb}host.xz:~user/path/to/repo.git/
27- {startsb}user@{endsb}host.xz:path/to/repo.git
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]28===============================================================
29
30To sync with a local directory, use:
31
32===============================================================
33- /path/to/repo.git/
34===============================================================
35
36REMOTES
37-------
38
39In addition to the above, as a short-hand, the name of a
40file in `$GIT_DIR/remotes` directory can be given; the
41named file should be in the following format:
42
Junio C Hamano1caaf472006-12-31 08:29:35[diff] [blame]43------------
Junio C Hamanod3361ad2007-01-01 03:20:24[diff] [blame]44URL: one of the above URL format
45Push: <refspec>
46Pull: <refspec>
47
Junio C Hamano1caaf472006-12-31 08:29:35[diff] [blame]48------------
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]49
50Then such a short-hand is specified in place of
51<repository> without <refspec> parameters on the command
52line, <refspec> specified on `Push:` lines or `Pull:`
53lines are used for `git-push` and `git-fetch`/`git-pull`,
Junio C Hamano51c2ab02006-07-09 20:38:54[diff] [blame]54respectively. Multiple `Push:` and `Pull:` lines may
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]55be specified for additional branch mappings.
56
Junio C Hamano249572f2006-10-24 05:44:08[diff] [blame]57Or, equivalently, in the `$GIT_DIR/config` (note the use
58of `fetch` instead of `Pull:`):
59
Junio C Hamano1caaf472006-12-31 08:29:35[diff] [blame]60------------
Junio C Hamanod3361ad2007-01-01 03:20:24[diff] [blame]61[remote "<remote>"]
62url = <url>
63push = <refspec>
64fetch = <refspec>
65
Junio C Hamano1caaf472006-12-31 08:29:35[diff] [blame]66------------
Junio C Hamano249572f2006-10-24 05:44:08[diff] [blame]67
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]68The name of a file in `$GIT_DIR/branches` directory can be
69specified as an older notation short-hand; the named
70file should contain a single line, a URL in one of the
71above formats, optionally followed by a hash `#` and the
72name of remote head (URL fragment notation).
73`$GIT_DIR/branches/<remote>` file that stores a <url>
74without the fragment is equivalent to have this in the
75corresponding file in the `$GIT_DIR/remotes/` directory.
76
Junio C Hamano1caaf472006-12-31 08:29:35[diff] [blame]77------------
Junio C Hamanod3361ad2007-01-01 03:20:24[diff] [blame]78URL: <url>
79Pull: refs/heads/master:<remote>
Junio C Hamano1caaf472006-12-31 08:29:35[diff] [blame]80
Junio C Hamanod3361ad2007-01-01 03:20:24[diff] [blame]81------------
Junio C Hamano40f2f8d2006-02-07 08:04:39[diff] [blame]82
83while having `<url>#<head>` is equivalent to
84
Junio C Hamano1caaf472006-12-31 08:29:35[diff] [blame]85------------
Junio C Hamanod3361ad2007-01-01 03:20:24[diff] [blame]86URL: <url>
87Pull: refs/heads/<head>:<remote>
Junio C Hamano1caaf472006-12-31 08:29:35[diff] [blame]88------------