Documentation/urls-remotes.txt

   1 include::urls.txt[]
   2
   3 REMOTES[[REMOTES]]
   4 ------------------
   5
   6 The name of one of the following can be used instead
   7 of a URL as `<repository>` argument:
   8
   9 * a remote in the Git configuration file: `$GIT_DIR/config`,
  10 * a file in the `$GIT_DIR/remotes` directory, or
  11 * a file in the `$GIT_DIR/branches` directory.
  12
  13 All of these also allow you to omit the refspec from the command line
  14 because they each contain a refspec which git will use by default.
  15
  16 Named remote in configuration file
  17 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18
  19 You can choose to provide the name of a remote which you had previously
  20 configured using linkgit:git-remote[1], linkgit:git-config[1]
  21 or even by a manual edit to the `$GIT_DIR/config` file.  The URL of
  22 this remote will be used to access the repository.  The refspec
  23 of this remote will be used by default when you do
  24 not provide a refspec on the command line.  The entry in the
  25 config file would appear like this:
  26
  27 ------------
  28         [remote "<name>"]
  29                 url = <URL>
  30                 pushurl = <pushurl>
  31                 push = <refspec>
  32                 fetch = <refspec>
  33 ------------
  34
  35 The `<pushurl>` is used for pushes only. It is optional and defaults
  36 to `<URL>`. Pushing to a remote affects all defined pushurls or to all
  37 defined urls if no pushurls are defined. Fetch, however, will only
  38 fetch from the first defined url if multiple urls are defined.
  39
  40 Named file in `$GIT_DIR/remotes`
  41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42
  43 You can choose to provide the name of a
  44 file in `$GIT_DIR/remotes`.  The URL
  45 in this file will be used to access the repository.  The refspec
  46 in this file will be used as default when you do not
  47 provide a refspec on the command line.  This file should have the
  48 following format:
  49
  50 ------------
  51         URL: one of the above URL format
  52         Push: <refspec>
  53         Pull: <refspec>
  54
  55 ------------
  56
  57 `Push:` lines are used by 'git push' and
  58 `Pull:` lines are used by 'git pull' and 'git fetch'.
  59 Multiple `Push:` and `Pull:` lines may
  60 be specified for additional branch mappings.
  61
  62 Named file in `$GIT_DIR/branches`
  63 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  64
  65 You can choose to provide the name of a
  66 file in `$GIT_DIR/branches`.
  67 The URL in this file will be used to access the repository.
  68 This file should have the following format:
  69
  70
  71 ------------
  72         <URL>#<head>
  73 ------------
  74
  75 `<URL>` is required; `#<head>` is optional.
  76
  77 Depending on the operation, git will use one of the following
  78 refspecs, if you don't provide one on the command line.
  79 `<branch>` is the name of this file in `$GIT_DIR/branches` and
  80 `<head>` defaults to `master`.
  81
  82 git fetch uses:
  83
  84 ------------
  85         refs/heads/<head>:refs/heads/<branch>
  86 ------------
  87
  88 git push uses:
  89
  90 ------------
  91         HEAD:refs/heads/<head>
  92 ------------
  93
  94
  95
  96