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