user-manual: replace init-db by init
[git/repo.git] / Documentation / git-send-pack.txt
blob5376f685486c6f19cbe6ea3b8391cac5b50c593b
1 git-send-pack(1)
2 ================
4 NAME
5 ----
6 git-send-pack - Push missing objects packed
9 SYNOPSIS
10 --------
11 'git-send-pack' [--all] [--force] [--exec=<git-receive-pack>] [<host>:]<directory> [<ref>...]
13 DESCRIPTION
14 -----------
15 Invokes 'git-receive-pack' on a possibly remote repository, and
16 updates it from the current repository, sending named refs.
19 OPTIONS
20 -------
21 --exec=<git-receive-pack>::
22         Path to the 'git-receive-pack' program on the remote
23         end.  Sometimes useful when pushing to a remote
24         repository over ssh, and you do not have the program in
25         a directory on the default $PATH.
27 --all::
28         Instead of explicitly specifying which refs to update,
29         update all refs that locally exist.
31 --force::
32         Usually, the command refuses to update a remote ref that
33         is not an ancestor of the local ref used to overwrite it.
34         This flag disables the check.  What this means is that
35         the remote repository can lose commits; use it with
36         care.
38 <host>::
39         A remote host to house the repository.  When this
40         part is specified, 'git-receive-pack' is invoked via
41         ssh.
43 <directory>::
44         The repository to update.
46 <ref>...::
47         The remote refs to update.
50 Specifying the Refs
51 -------------------
53 There are three ways to specify which refs to update on the
54 remote end.
56 With '--all' flag, all refs that exist locally are transferred to
57 the remote side.  You cannot specify any '<ref>' if you use
58 this flag.
60 Without '--all' and without any '<ref>', the refs that exist
61 both on the local side and on the remote side are updated.
63 When one or more '<ref>' are specified explicitly, it can be either a
64 single pattern, or a pair of such pattern separated by a colon
65 ":" (this means that a ref name cannot have a colon in it).  A
66 single pattern '<name>' is just a shorthand for '<name>:<name>'.
68 Each pattern pair consists of the source side (before the colon)
69 and the destination side (after the colon).  The ref to be
70 pushed is determined by finding a match that matches the source
71 side, and where it is pushed is determined by using the
72 destination side.
74  - It is an error if <src> does not match exactly one of the
75    local refs.
77  - It is an error if <dst> matches more than one remote refs.
79  - If <dst> does not match any remote ref, either
81    * it has to start with "refs/"; <dst> is used as the
82      destination literally in this case.
84    * <src> == <dst> and the ref that matched the <src> must not
85      exist in the set of remote refs; the ref matched <src>
86      locally is used as the name of the destination.
88 Without '--force', the <src> ref is stored at the remote only if
89 <dst> does not exist, or <dst> is a proper subset (i.e. an
90 ancestor) of <src>.  This check, known as "fast forward check",
91 is performed in order to avoid accidentally overwriting the
92 remote ref and lose other peoples' commits from there.
94 With '--force', the fast forward check is disabled for all refs.
96 Optionally, a <ref> parameter can be prefixed with a plus '+' sign
97 to disable the fast-forward check only on that ref.
100 Author
101 ------
102 Written by Linus Torvalds <torvalds@osdl.org>
104 Documentation
105 --------------
106 Documentation by Junio C Hamano.
110 Part of the gitlink:git[7] suite