]>
Commit | Line | Data |
---|---|---|
215a7ad1 JH |
1 | git-send-email(1) |
2 | ================= | |
479cec96 RA |
3 | |
4 | NAME | |
5 | ---- | |
215a7ad1 | 6 | git-send-email - Send a collection of patches as emails |
479cec96 RA |
7 | |
8 | ||
9 | SYNOPSIS | |
10 | -------- | |
215a7ad1 | 11 | 'git-send-email' [options] <file|directory> [... file|directory] |
479cec96 RA |
12 | |
13 | ||
14 | ||
15 | DESCRIPTION | |
16 | ----------- | |
17 | Takes the patches given on the command line and emails them out. | |
18 | ||
19 | The header of the email is configurable by command line options. If not | |
20 | specified on the command line, the user will be prompted with a ReadLine | |
21 | enabled interface to provide the necessary information. | |
22 | ||
df8baa42 JF |
23 | OPTIONS |
24 | ------- | |
479cec96 RA |
25 | The options available are: |
26 | ||
79ee555b EB |
27 | --bcc:: |
28 | Specify a "Bcc:" value for each email. | |
5ef1f8d4 SV |
29 | + |
30 | The --bcc option must be repeated for each user you want on the bcc list. | |
79ee555b | 31 | |
da140f8b RA |
32 | --cc:: |
33 | Specify a starting "Cc:" value for each email. | |
5ef1f8d4 SV |
34 | + |
35 | The --cc option must be repeated for each user you want on the cc list. | |
79ee555b | 36 | |
324a8bd0 JP |
37 | --cc-cmd:: |
38 | Specify a command to execute once per patch file which | |
39 | should generate patch file specific "Cc:" entries. | |
40 | Output of this command must be single email address per line. | |
41 | Default is the value of 'sendemail.cccmd' configuration value. | |
42 | ||
2718435b RA |
43 | --chain-reply-to, --no-chain-reply-to:: |
44 | If this is set, each email will be sent as a reply to the previous | |
45 | email sent. If disabled with "--no-chain-reply-to", all emails after | |
46 | the first will be sent as replies to the first email sent. When using | |
47 | this, it is recommended that the first file given be an overview of the | |
48 | entire patch series. | |
4a62d3f5 AK |
49 | Default is the value of the 'sendemail.chainreplyto' configuration |
50 | value; if that is unspecified, default to --chain-reply-to. | |
2718435b RA |
51 | |
52 | --compose:: | |
ef0c2abf AR |
53 | Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an |
54 | introductory message for the patch series. | |
479cec96 | 55 | |
df8baa42 | 56 | --from:: |
479cec96 RA |
57 | Specify the sender of the emails. This will default to |
58 | the value GIT_COMMITTER_IDENT, as returned by "git-var -l". | |
59 | The user will still be prompted to confirm this entry. | |
60 | ||
df8baa42 | 61 | --in-reply-to:: |
479cec96 | 62 | Specify the contents of the first In-Reply-To header. |
928a5590 | 63 | Subsequent emails will refer to the previous email |
f9e320c3 RA |
64 | instead of this if --chain-reply-to is set (the default) |
65 | Only necessary if --compose is also set. If --compose | |
66 | is not set, this will be prompted for. | |
479cec96 | 67 | |
5483c71d AR |
68 | --signed-off-by-cc, --no-signed-off-by-cc:: |
69 | If this is set, add emails found in Signed-off-by: or Cc: lines to the | |
70 | cc list. | |
e63b58ba | 71 | Default is the value of 'sendemail.signedoffcc' configuration value; |
5483c71d | 72 | if that is unspecified, default to --signed-off-by-cc. |
a985d595 | 73 | |
2718435b RA |
74 | --quiet:: |
75 | Make git-send-email less verbose. One line per email should be | |
76 | all that is output. | |
a6d62cdd | 77 | |
34cc60ce DS |
78 | --identity:: |
79 | A configuration identity. When given, causes values in the | |
80 | 'sendemail.<identity>' subsection to take precedence over | |
81 | values in the 'sendemail' section. The default identity is | |
82 | the value of 'sendemail.identity'. | |
83 | ||
df8baa42 | 84 | --smtp-server:: |
928a5590 JA |
85 | If set, specifies the outgoing SMTP server to use (e.g. |
86 | `smtp.example.com` or a raw IP address). Alternatively it can | |
87 | specify a full pathname of a sendmail-like program instead; | |
6dcfa306 SV |
88 | the program must support the `-i` option. Default value can |
89 | be specified by the 'sendemail.smtpserver' configuration | |
90 | option; the built-in default is `/usr/sbin/sendmail` or | |
91 | `/usr/lib/sendmail` if such program is available, or | |
92 | `localhost` otherwise. | |
a6d62cdd | 93 | |
44b2476a JH |
94 | --smtp-server-port:: |
95 | Specifies a port different from the default port (SMTP | |
96 | servers typically listen to smtp port 25 and ssmtp port | |
97 | 465). | |
98 | ||
34cc60ce DS |
99 | --smtp-user, --smtp-pass:: |
100 | Username and password for SMTP-AUTH. Defaults are the values of | |
101 | the configuration values 'sendemail.smtpuser' and | |
102 | 'sendemail.smtppass', but see also 'sendemail.identity'. | |
103 | If not set, authentication is not attempted. | |
104 | ||
105 | --smtp-ssl:: | |
106 | If set, connects to the SMTP server using SSL. | |
107 | Default is the value of the 'sendemail.smtpssl' configuration value; | |
108 | if that is unspecified, does not use SSL. | |
109 | ||
2718435b | 110 | --subject:: |
a6080a0a | 111 | Specify the initial subject of the email thread. |
2718435b RA |
112 | Only necessary if --compose is also set. If --compose |
113 | is not set, this will be prompted for. | |
114 | ||
5483c71d | 115 | --suppress-from, --no-suppress-from:: |
620bb245 | 116 | If this is set, do not add the From: address to the cc: list. |
5483c71d | 117 | Default is the value of 'sendemail.suppressfrom' configuration value; |
2be7fcb4 | 118 | if that is unspecified, default to --no-suppress-from. |
a985d595 | 119 | |
5483c71d | 120 | --thread, --no-thread:: |
e46f7a0e | 121 | If this is set, the In-Reply-To header will be set on each email sent. |
5483c71d | 122 | If disabled with "--no-thread", no emails will have the In-Reply-To |
e46f7a0e | 123 | header set. |
5483c71d AR |
124 | Default is the value of the 'sendemail.thread' configuration value; |
125 | if that is unspecified, default to --thread. | |
e46f7a0e | 126 | |
03044a98 RJ |
127 | --dry-run:: |
128 | Do everything except actually send the emails. | |
129 | ||
130 | --envelope-sender:: | |
131 | Specify the envelope sender used to send the emails. | |
132 | This is useful if your default address is not the address that is | |
133 | subscribed to a list. If you use the sendmail binary, you must have | |
134 | suitable privileges for the -f parameter. | |
135 | ||
2718435b RA |
136 | --to:: |
137 | Specify the primary recipient of the emails generated. | |
138 | Generally, this will be the upstream maintainer of the | |
139 | project involved. | |
5ef1f8d4 SV |
140 | + |
141 | The --to option must be repeated for each user you want on the to list. | |
79ee555b | 142 | |
a6d62cdd | 143 | |
fc095242 AK |
144 | CONFIGURATION |
145 | ------------- | |
34cc60ce DS |
146 | sendemail.identity:: |
147 | The default configuration identity. When specified, | |
148 | 'sendemail.<identity>.<item>' will have higher precedence than | |
149 | 'sendemail.<item>'. This is useful to declare multiple SMTP | |
150 | identities and to hoist sensitive authentication information | |
151 | out of the repository and into the global configuation file. | |
152 | ||
fc095242 AK |
153 | sendemail.aliasesfile:: |
154 | To avoid typing long email addresses, point this to one or more | |
155 | email aliases files. You must also supply 'sendemail.aliasfiletype'. | |
156 | ||
157 | sendemail.aliasfiletype:: | |
158 | Format of the file(s) specified in sendemail.aliasesfile. Must be | |
159 | one of 'mutt', 'mailrc', 'pine', or 'gnus'. | |
160 | ||
2db9b49c MV |
161 | sendemail.to:: |
162 | Email address (or alias) to always send to. | |
163 | ||
324a8bd0 JP |
164 | sendemail.cccmd:: |
165 | Command to execute to generate per patch file specific "Cc:"s. | |
166 | ||
4a62d3f5 AK |
167 | sendemail.bcc:: |
168 | Email address (or alias) to always bcc. | |
169 | ||
170 | sendemail.chainreplyto:: | |
171 | Boolean value specifying the default to the '--chain_reply_to' | |
172 | parameter. | |
173 | ||
fc095242 | 174 | sendemail.smtpserver:: |
34cc60ce DS |
175 | Default SMTP server to use. |
176 | ||
177 | sendemail.smtpuser:: | |
178 | Default SMTP-AUTH username. | |
179 | ||
180 | sendemail.smtppass:: | |
181 | Default SMTP-AUTH password. | |
182 | ||
183 | sendemail.smtpssl:: | |
184 | Boolean value specifying the default to the '--smtp-ssl' parameter. | |
fc095242 | 185 | |
479cec96 RA |
186 | Author |
187 | ------ | |
188 | Written by Ryan Anderson <ryan@michonline.com> | |
189 | ||
215a7ad1 | 190 | git-send-email is originally based upon |
479cec96 RA |
191 | send_lots_of_email.pl by Greg Kroah-Hartman. |
192 | ||
193 | Documentation | |
194 | -------------- | |
195 | Documentation by Ryan Anderson | |
196 | ||
197 | GIT | |
198 | --- | |
a7154e91 | 199 | Part of the gitlink:git[7] suite |