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