GIT 1.6.3.1
[git/mingw/4msysgit/kblees.git] / Documentation / urls-remotes.txt
blob41ec7774f481fd2d70492be4ab2b5e0bf887fc0b
1 include::urls.txt[]
3 REMOTES[[REMOTES]]
4 ------------------
6 The name of one of the following can be used instead
7 of a URL as `<repository>` argument:
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.
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.
16 Named remote in configuration file
17 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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:
27 ------------
28         [remote "<name>"]
29                 url = <url>
30                 push = <refspec>
31                 fetch = <refspec>
32 ------------
35 Named file in `$GIT_DIR/remotes`
36 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
38 You can choose to provide the name of a
39 file in `$GIT_DIR/remotes`.  The URL
40 in this file will be used to access the repository.  The refspec
41 in this file will be used as default when you do not
42 provide a refspec on the command line.  This file should have the
43 following format:
45 ------------
46         URL: one of the above URL format
47         Push: <refspec>
48         Pull: <refspec>
50 ------------
52 `Push:` lines are used by 'git-push' and
53 `Pull:` lines are used by 'git-pull' and 'git-fetch'.
54 Multiple `Push:` and `Pull:` lines may
55 be specified for additional branch mappings.
57 Named file in `$GIT_DIR/branches`
58 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
60 You can choose to provide the name of a
61 file in `$GIT_DIR/branches`.
62 The URL in this file will be used to access the repository.
63 This file should have the following format:
66 ------------
67         <url>#<head>
68 ------------
70 `<url>` is required; `#<head>` is optional.
72 Depending on the operation, git will use one of the following
73 refspecs, if you don't provide one on the command line.
74 `<branch>` is the name of this file in `$GIT_DIR/branches` and
75 `<head>` defaults to `master`.
77 git fetch uses:
79 ------------
80         refs/heads/<head>:refs/heads/<branch>
81 ------------
83 git push uses:
85 ------------
86         HEAD:refs/heads/<head>
87 ------------