builtin/send-pack.c: use parse_options API
[git] / Documentation / git-send-pack.txt
1 git-send-pack(1)
2 ================
3
4 NAME
5 ----
6 git-send-pack - Push objects over Git protocol to another repository
7
8
9 SYNOPSIS
10 --------
11 [verse]
12 'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>]
13                 [--verbose] [--thin] [--atomic] [--signed]
14                 [<host>:]<directory> [<ref>...]
15
16 DESCRIPTION
17 -----------
18 Usually you would want to use 'git push', which is a
19 higher-level wrapper of this command, instead. See linkgit:git-push[1].
20
21 Invokes 'git-receive-pack' on a possibly remote repository, and
22 updates it from the current repository, sending named refs.
23
24
25 OPTIONS
26 -------
27 --receive-pack=<git-receive-pack>::
28         Path to the 'git-receive-pack' program on the remote
29         end.  Sometimes useful when pushing to a remote
30         repository over ssh, and you do not have the program in
31         a directory on the default $PATH.
32
33 --exec=<git-receive-pack>::
34         Same as --receive-pack=<git-receive-pack>.
35
36 --all::
37         Instead of explicitly specifying which refs to update,
38         update all heads that locally exist.
39
40 --stdin::
41         Take the list of refs from stdin, one per line. If there
42         are refs specified on the command line in addition to this
43         option, then the refs from stdin are processed after those
44         on the command line.
45 +
46 If '--stateless-rpc' is specified together with this option then
47 the list of refs must be in packet format (pkt-line). Each ref must
48 be in a separate packet, and the list must end with a flush packet.
49
50 --dry-run::
51         Do everything except actually send the updates.
52
53 --force::
54         Usually, the command refuses to update a remote ref that
55         is not an ancestor of the local ref used to overwrite it.
56         This flag disables the check.  What this means is that
57         the remote repository can lose commits; use it with
58         care.
59
60 --verbose::
61         Run verbosely.
62
63 --thin::
64         Send a "thin" pack, which records objects in deltified form based
65         on objects not included in the pack to reduce network traffic.
66
67 --atomic::
68         Use an atomic transaction for updating the refs. If any of the refs
69         fails to update then the entire push will fail without changing any
70         refs.
71
72 --signed::
73         GPG-sign the push request to update refs on the receiving
74         side, to allow it to be checked by the hooks and/or be
75         logged.  See linkgit:git-receive-pack[1] for the details
76         on the receiving end.  If the attempt to sign with `gpg` fails,
77         or if the server does not support signed pushes, the push will
78         fail.
79
80 <host>::
81         A remote host to house the repository.  When this
82         part is specified, 'git-receive-pack' is invoked via
83         ssh.
84
85 <directory>::
86         The repository to update.
87
88 <ref>...::
89         The remote refs to update.
90
91
92 Specifying the Refs
93 -------------------
94
95 There are three ways to specify which refs to update on the
96 remote end.
97
98 With '--all' flag, all refs that exist locally are transferred to
99 the remote side.  You cannot specify any '<ref>' if you use
100 this flag.
101
102 Without '--all' and without any '<ref>', the heads that exist
103 both on the local side and on the remote side are updated.
104
105 When one or more '<ref>' are specified explicitly (whether on the
106 command line or via `--stdin`), it can be either a
107 single pattern, or a pair of such pattern separated by a colon
108 ":" (this means that a ref name cannot have a colon in it).  A
109 single pattern '<name>' is just a shorthand for '<name>:<name>'.
110
111 Each pattern pair consists of the source side (before the colon)
112 and the destination side (after the colon).  The ref to be
113 pushed is determined by finding a match that matches the source
114 side, and where it is pushed is determined by using the
115 destination side. The rules used to match a ref are the same
116 rules used by 'git rev-parse' to resolve a symbolic ref
117 name. See linkgit:git-rev-parse[1].
118
119  - It is an error if <src> does not match exactly one of the
120    local refs.
121
122  - It is an error if <dst> matches more than one remote refs.
123
124  - If <dst> does not match any remote ref, either
125
126    * it has to start with "refs/"; <dst> is used as the
127      destination literally in this case.
128
129    * <src> == <dst> and the ref that matched the <src> must not
130      exist in the set of remote refs; the ref matched <src>
131      locally is used as the name of the destination.
132
133 Without '--force', the <src> ref is stored at the remote only if
134 <dst> does not exist, or <dst> is a proper subset (i.e. an
135 ancestor) of <src>.  This check, known as "fast-forward check",
136 is performed in order to avoid accidentally overwriting the
137 remote ref and lose other peoples' commits from there.
138
139 With '--force', the fast-forward check is disabled for all refs.
140
141 Optionally, a <ref> parameter can be prefixed with a plus '+' sign
142 to disable the fast-forward check only on that ref.
143
144 GIT
145 ---
146 Part of the linkgit:git[1] suite