Documentation/urls.txt

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