Google Git
Sign in
chromium / external / gitster / git-htmldocs / 8fddeedee69740f179e74fef731c8022dcbee70b / . / git-send-email.html
blob: d90433b9d4b1d1f789ac377a9d6dc3e63e8d1a87 [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]6<meta name="generator" content="AsciiDoc 8.2.5" />
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]7<style type="text/css">
8/* Debug borders */
9p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
10/*
11 border: 1px solid red;
12*/
13}
14
15body {
16 margin: 1em 5% 1em 5%;
17}
18
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]19a {
20 color: blue;
21 text-decoration: underline;
22}
23a:visited {
24 color: fuchsia;
25}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]26
27em {
28 font-style: italic;
29}
30
31strong {
32 font-weight: bold;
33}
34
35tt {
36 color: navy;
37}
38
39h1, h2, h3, h4, h5, h6 {
40 color: #527bbd;
41 font-family: sans-serif;
42 margin-top: 1.2em;
43 margin-bottom: 0.5em;
44 line-height: 1.3;
45}
46
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]47h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]48 border-bottom: 2px solid silver;
49}
50h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 padding-top: 0.5em;
52}
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]53h3 {
54 float: left;
55}
56h3 + * {
57 clear: left;
58}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]59
60div.sectionbody {
61 font-family: serif;
62 margin-left: 0;
63}
64
65hr {
66 border: 1px solid silver;
67}
68
69p {
70 margin-top: 0.5em;
71 margin-bottom: 0.5em;
72}
73
74pre {
75 padding: 0;
76 margin: 0;
77}
78
79span#author {
80 color: #527bbd;
81 font-family: sans-serif;
82 font-weight: bold;
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]83 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]84}
85span#email {
86}
87span#revision {
88 font-family: sans-serif;
89}
90
91div#footer {
92 font-family: sans-serif;
93 font-size: small;
94 border-top: 2px solid silver;
95 padding-top: 0.5em;
96 margin-top: 4.0em;
97}
98div#footer-text {
99 float: left;
100 padding-bottom: 0.5em;
101}
102div#footer-badges {
103 float: right;
104 padding-bottom: 0.5em;
105}
106
107div#preamble,
108div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
109div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
110div.admonitionblock {
111 margin-right: 10%;
112 margin-top: 1.5em;
113 margin-bottom: 1.5em;
114}
115div.admonitionblock {
116 margin-top: 2.5em;
117 margin-bottom: 2.5em;
118}
119
120div.content { /* Block element content. */
121 padding: 0;
122}
123
124/* Block element titles. */
125div.title, caption.title {
126 font-family: sans-serif;
127 font-weight: bold;
128 text-align: left;
129 margin-top: 1.0em;
130 margin-bottom: 0.5em;
131}
132div.title + * {
133 margin-top: 0;
134}
135
136td div.title:first-child {
137 margin-top: 0.0em;
138}
139div.content div.title:first-child {
140 margin-top: 0.0em;
141}
142div.content + div.title {
143 margin-top: 0.0em;
144}
145
146div.sidebarblock > div.content {
147 background: #ffffee;
148 border: 1px solid silver;
149 padding: 0.5em;
150}
151
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]152div.listingblock {
153 margin-right: 0%;
154}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]155div.listingblock > div.content {
156 border: 1px solid silver;
157 background: #f4f4f4;
158 padding: 0.5em;
159}
160
161div.quoteblock > div.content {
162 padding-left: 2.0em;
163}
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]164
165div.attribution {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]166 text-align: right;
167}
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]168div.verseblock + div.attribution {
169 text-align: left;
170}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]171
172div.admonitionblock .icon {
173 vertical-align: top;
174 font-size: 1.1em;
175 font-weight: bold;
176 text-decoration: underline;
177 color: #527bbd;
178 padding-right: 0.5em;
179}
180div.admonitionblock td.content {
181 padding-left: 0.5em;
182 border-left: 2px solid silver;
183}
184
185div.exampleblock > div.content {
186 border-left: 2px solid silver;
187 padding: 0.5em;
188}
189
190div.verseblock div.content {
191 white-space: pre;
192}
193
194div.imageblock div.content { padding-left: 0; }
195div.imageblock img { border: 1px solid silver; }
196span.image img { border-style: none; }
197
198dl {
199 margin-top: 0.8em;
200 margin-bottom: 0.8em;
201}
202dt {
203 margin-top: 0.5em;
204 margin-bottom: 0;
205 font-style: italic;
206}
207dd > *:first-child {
208 margin-top: 0;
209}
210
211ul, ol {
212 list-style-position: outside;
213}
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]214div.olist2 ol {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]215 list-style-type: lower-alpha;
216}
217
218div.tableblock > table {
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]219 border: 3px solid #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]220}
221thead {
222 font-family: sans-serif;
223 font-weight: bold;
224}
225tfoot {
226 font-weight: bold;
227}
228
229div.hlist {
230 margin-top: 0.8em;
231 margin-bottom: 0.8em;
232}
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]233div.hlist td {
234 padding-bottom: 5px;
235}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]236td.hlist1 {
237 vertical-align: top;
238 font-style: italic;
239 padding-right: 0.8em;
240}
241td.hlist2 {
242 vertical-align: top;
243}
244
245@media print {
246 div#footer-badges { display: none; }
247}
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]248
249div#toctitle {
250 color: #527bbd;
251 font-family: sans-serif;
252 font-size: 1.1em;
253 font-weight: bold;
254 margin-top: 1.0em;
255 margin-bottom: 0.1em;
256}
257
258div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
259 margin-top: 0;
260 margin-bottom: 0;
261}
262div.toclevel2 {
263 margin-left: 2em;
264 font-size: 0.9em;
265}
266div.toclevel3 {
267 margin-left: 4em;
268 font-size: 0.9em;
269}
270div.toclevel4 {
271 margin-left: 6em;
272 font-size: 0.9em;
273}
274include1::./stylesheets/xhtml11-manpage.css[]
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]275/* Workarounds for IE6's broken and incomplete CSS2. */
276
277div.sidebar-content {
278 background: #ffffee;
279 border: 1px solid silver;
280 padding: 0.5em;
281}
282div.sidebar-title, div.image-title {
283 font-family: sans-serif;
284 font-weight: bold;
285 margin-top: 0.0em;
286 margin-bottom: 0.5em;
287}
288
289div.listingblock div.content {
290 border: 1px solid silver;
291 background: #f4f4f4;
292 padding: 0.5em;
293}
294
295div.quoteblock-content {
296 padding-left: 2.0em;
297}
298
299div.exampleblock-content {
300 border-left: 2px solid silver;
301 padding-left: 0.5em;
302}
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]303
304/* IE6 sets dynamically generated links as visited. */
305div#toc a:visited { color: blue; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]306</style>
307<title>git-send-email(1)</title>
308</head>
309<body>
310<div id="header">
311<h1>
312git-send-email(1) Manual Page
313</h1>
314<h2>NAME</h2>
315<div class="sectionbody">
316<p>git-send-email -
317 Send a collection of patches as emails
318</p>
319</div>
320</div>
321<h2>SYNOPSIS</h2>
322<div class="sectionbody">
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]323<div class="para"><p><em>git send-email</em> [options] &lt;file|directory|rev-list options&gt;&#8230;</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]324</div>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]325<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]326<div class="sectionbody">
Junio C Hamanob95b43d2009-06-12 08:57:28[diff] [blame]327<div class="para"><p>Takes the patches given on the command line and emails them out.
328Patches can be specified as files, directories (which will send all
329files in the directory), or directly as a revision list. In the
330last case, any format accepted by <a href="git-format-patch.html">git-format-patch(1)</a> can
331be passed to git send-email.</p></div>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]332<div class="para"><p>The header of the email is configurable by command line options. If not
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]333specified on the command line, the user will be prompted with a ReadLine
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]334enabled interface to provide the necessary information.</p></div>
Junio C Hamanoa6455f62009-02-20 08:33:08[diff] [blame]335<div class="para"><p>There are two formats accepted for patch files:</p></div>
336<div class="olist"><ol>
337<li>
338<p>
339mbox format files
340</p>
341<div class="para"><p>This is what <a href="git-format-patch.html">git-format-patch(1)</a> generates. Most headers and MIME
342formatting are ignored.</p></div>
343</li>
344<li>
345<p>
346The original format used by Greg Kroah-Hartman's <em>send_lots_of_email.pl</em>
347script
348</p>
349<div class="para"><p>This format expects the first line of the file to contain the "Cc:" value
350and the "Subject:" of the message as the second line.</p></div>
351</li>
352</ol></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]353</div>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]354<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]355<div class="sectionbody">
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]356<h3 id="_composing">Composing</h3><div style="clear:left"></div>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]357<div class="vlist"><dl>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]358<dt>
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]359--annotate
360</dt>
361<dd>
362<p>
363 Review and edit each patch you're about to send. See the
364 CONFIGURATION section for <em>sendemail.multiedit</em>.
365</p>
366</dd>
367<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]368--bcc=&lt;address&gt;
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]369</dt>
370<dd>
371<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]372 Specify a "Bcc:" value for each email. Default is the value of
373 <em>sendemail.bcc</em>.
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]374</p>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]375<div class="para"><p>The --bcc option must be repeated for each user you want on the bcc list.</p></div>
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]376</dd>
377<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]378--cc=&lt;address&gt;
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]379</dt>
380<dd>
381<p>
382 Specify a starting "Cc:" value for each email.
Junio C Hamano1d40ee82009-01-07 10:14:16[diff] [blame]383 Default is the value of <em>sendemail.cc</em>.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]384</p>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]385<div class="para"><p>The --cc option must be repeated for each user you want on the cc list.</p></div>
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]386</dd>
387<dt>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]388--compose
389</dt>
390<dd>
391<p>
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]392 Invoke a text editor (see GIT_EDITOR in <a href="git-var.html">git-var(1)</a>)
393 to edit an introductory message for the patch series.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]394</p>
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]395<div class="para"><p>When <em>--compose</em> is used, git send-email will use the From, Subject, and
396In-Reply-To headers specified in the message. If the body of the message
397(what you type after the headers and a blank line) only contains blank
398(or GIT: prefixed) lines the summary won't be sent, but From, Subject,
399and In-Reply-To headers will be used unless they are removed.</p></div>
400<div class="para"><p>Missing From or In-Reply-To headers will be prompted for.</p></div>
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]401<div class="para"><p>See the CONFIGURATION section for <em>sendemail.multiedit</em>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]402</dd>
403<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]404--from=&lt;address&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]405</dt>
406<dd>
407<p>
Junio C Hamano7ae18252009-05-23 09:53:32[diff] [blame]408 Specify the sender of the emails. If not specified on the command line,
409 the value of the <em>sendemail.from</em> configuration option is used. If
410 neither the command line option nor <em>sendemail.from</em> are set, then the
411 user will be prompted for the value. The default for the prompt will be
412 the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
413 set, as returned by "git var -l".
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]414</p>
415</dd>
416<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]417--in-reply-to=&lt;identifier&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]418</dt>
419<dd>
420<p>
421 Specify the contents of the first In-Reply-To header.
422 Subsequent emails will refer to the previous email
423 instead of this if --chain-reply-to is set (the default)
424 Only necessary if --compose is also set. If --compose
425 is not set, this will be prompted for.
426</p>
427</dd>
428<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]429--subject=&lt;string&gt;
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]430</dt>
431<dd>
432<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]433 Specify the initial subject of the email thread.
434 Only necessary if --compose is also set. If --compose
435 is not set, this will be prompted for.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]436</p>
437</dd>
438<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]439--to=&lt;address&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]440</dt>
441<dd>
442<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]443 Specify the primary recipient of the emails generated. Generally, this
444 will be the upstream maintainer of the project involved. Default is the
445 value of the <em>sendemail.to</em> configuration value; if that is unspecified,
446 this will be prompted for.
447</p>
448<div class="para"><p>The --to option must be repeated for each user you want on the to list.</p></div>
449</dd>
450</dl></div>
451<h3 id="_sending">Sending</h3><div style="clear:left"></div>
452<div class="vlist"><dl>
453<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]454--envelope-sender=&lt;address&gt;
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]455</dt>
456<dd>
457<p>
458 Specify the envelope sender used to send the emails.
459 This is useful if your default address is not the address that is
460 subscribed to a list. If you use the sendmail binary, you must have
461 suitable privileges for the -f parameter. Default is the value of
462 the <em>sendemail.envelopesender</em> configuration variable; if that is
463 unspecified, choosing the envelope sender is left to your MTA.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]464</p>
465</dd>
466<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]467--smtp-encryption=&lt;encryption&gt;
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]468</dt>
469<dd>
470<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]471 Specify the encryption to use, either <em>ssl</em> or <em>tls</em>. Any other
472 value reverts to plain SMTP. Default is the value of
473 <em>sendemail.smtpencryption</em>.
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]474</p>
475</dd>
476<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]477--smtp-pass[=&lt;password&gt;]
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]478</dt>
479<dd>
480<p>
481 Password for SMTP-AUTH. The argument is optional: If no
482 argument is specified, then the empty string is used as
483 the password. Default is the value of <em>sendemail.smtppass</em>,
484 however <em>--smtp-pass</em> always overrides this value.
485</p>
486<div class="para"><p>Furthermore, passwords need not be specified in configuration files
487or on the command line. If a username has been specified (with
488<em>--smtp-user</em> or a <em>sendemail.smtpuser</em>), but no password has been
489specified (with <em>--smtp-pass</em> or <em>sendemail.smtppass</em>), then the
490user is prompted for a password while the input is masked for privacy.</p></div>
491</dd>
492<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]493--smtp-server=&lt;host&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]494</dt>
495<dd>
496<p>
Junio C Hamanob63afff2007-05-01 03:05:55[diff] [blame]497 If set, specifies the outgoing SMTP server to use (e.g.
498 <tt>smtp.example.com</tt> or a raw IP address). Alternatively it can
499 specify a full pathname of a sendmail-like program instead;
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]500 the program must support the <tt>-i</tt> option. Default value can
501 be specified by the <em>sendemail.smtpserver</em> configuration
502 option; the built-in default is <tt>/usr/sbin/sendmail</tt> or
503 <tt>/usr/lib/sendmail</tt> if such program is available, or
504 <tt>localhost</tt> otherwise.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]505</p>
506</dd>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]507<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]508--smtp-server-port=&lt;port&gt;
Junio C Hamano4fd58d42007-09-30 00:51:14[diff] [blame]509</dt>
510<dd>
511<p>
512 Specifies a port different from the default port (SMTP
Junio C Hamanobacccda2009-08-03 08:07:12[diff] [blame]513 servers typically listen to smtp port 25, but may also listen to
514 submission port 587, or the common SSL smtp port 465);
515 symbolic port names (e.g. "submission" instead of 587)
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]516 are also accepted. The port can also be set with the
517 <em>sendemail.smtpserverport</em> configuration variable.
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]518</p>
519</dd>
520<dt>
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]521--smtp-ssl
522</dt>
523<dd>
524<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]525 Legacy alias for <em>--smtp-encryption ssl</em>.
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]526</p>
527</dd>
528<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]529--smtp-user=&lt;user&gt;
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]530</dt>
531<dd>
532<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]533 Username for SMTP-AUTH. Default is the value of <em>sendemail.smtpuser</em>;
534 if a username is not specified (with <em>--smtp-user</em> or <em>sendemail.smtpuser</em>),
535 then authentication is not attempted.
536</p>
537</dd>
538</dl></div>
539<h3 id="_automating">Automating</h3><div style="clear:left"></div>
540<div class="vlist"><dl>
541<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]542--cc-cmd=&lt;command&gt;
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]543</dt>
544<dd>
545<p>
546 Specify a command to execute once per patch file which
547 should generate patch file specific "Cc:" entries.
548 Output of this command must be single email address per line.
549 Default is the value of <em>sendemail.cccmd</em> configuration value.
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]550</p>
551</dd>
552<dt>
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]553--[no-]chain-reply-to
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]554</dt>
555<dd>
556<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]557 If this is set, each email will be sent as a reply to the previous
558 email sent. If disabled with "--no-chain-reply-to", all emails after
559 the first will be sent as replies to the first email sent. When using
560 this, it is recommended that the first file given be an overview of the
561 entire patch series. Default is the value of the <em>sendemail.chainreplyto</em>
562 configuration value; if that is unspecified, default to --chain-reply-to.
563</p>
564</dd>
565<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]566--identity=&lt;identity&gt;
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]567</dt>
568<dd>
569<p>
570 A configuration identity. When given, causes values in the
571 <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
572 values in the <em>sendemail</em> section. The default identity is
573 the value of <em>sendemail.identity</em>.
574</p>
575</dd>
576<dt>
577--[no-]signed-off-by-cc
578</dt>
579<dd>
580<p>
581 If this is set, add emails found in Signed-off-by: or Cc: lines to the
582 cc list. Default is the value of <em>sendemail.signedoffbycc</em> configuration
583 value; if that is unspecified, default to --signed-off-by-cc.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]584</p>
585</dd>
586<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]587--suppress-cc=&lt;category&gt;
Junio C Hamano9c334152008-02-12 03:18:52[diff] [blame]588</dt>
589<dd>
590<p>
591 Specify an additional category of recipients to suppress the
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]592 auto-cc of:
Junio C Hamano9c334152008-02-12 03:18:52[diff] [blame]593</p>
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]594<div class="ilist"><ul>
595<li>
596<p>
597<em>author</em> will avoid including the patch author
598</p>
599</li>
600<li>
601<p>
602<em>self</em> will avoid including the sender
603</p>
604</li>
605<li>
606<p>
607<em>cc</em> will avoid including anyone mentioned in Cc lines in the patch header
608 except for self (use <em>self</em> for that).
609</p>
610</li>
611<li>
612<p>
Junio C Hamano0e88f3e2009-06-21 08:03:25[diff] [blame]613<em>bodycc</em> will avoid including anyone mentioned in Cc lines in the
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]614 patch body (commit message) except for self (use <em>self</em> for that).
615</p>
616</li>
617<li>
618<p>
619<em>sob</em> will avoid including anyone mentioned in Signed-off-by lines except
620 for self (use <em>self</em> for that).
621</p>
622</li>
623<li>
624<p>
625<em>cccmd</em> will avoid running the --cc-cmd.
626</p>
627</li>
628<li>
629<p>
Junio C Hamano0e88f3e2009-06-21 08:03:25[diff] [blame]630<em>body</em> is equivalent to <em>sob</em> + <em>bodycc</em>
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]631</p>
632</li>
633<li>
634<p>
635<em>all</em> will suppress all auto cc values.
636</p>
637</li>
638</ul></div>
639<div class="para"><p>Default is the value of <em>sendemail.suppresscc</em> configuration value; if
640that is unspecified, default to <em>self</em> if --suppress-from is
641specified, as well as <em>body</em> if --no-signed-off-cc is specified.</p></div>
Junio C Hamano9c334152008-02-12 03:18:52[diff] [blame]642</dd>
643<dt>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]644--[no-]suppress-from
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]645</dt>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]646<dd>
647<p>
648 If this is set, do not add the From: address to the cc: list.
649 Default is the value of <em>sendemail.suppressfrom</em> configuration
650 value; if that is unspecified, default to --no-suppress-from.
651</p>
652</dd>
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]653<dt>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]654--[no-]thread
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]655</dt>
656<dd>
657<p>
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]658 If this is set, the In-Reply-To and References headers will be
659 added to each email sent. Whether each mail refers to the
660 previous email (<tt>deep</tt> threading per <em>git format-patch</em>
661 wording) or to the first email (<tt>shallow</tt> threading) is
662 governed by "--[no-]chain-reply-to".
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]663</p>
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]664<div class="para"><p>If disabled with "--no-thread", those headers will not be added
665(unless specified with --in-reply-to). Default is the value of the
666<em>sendemail.thread</em> configuration value; if that is unspecified,
667default to --thread.</p></div>
668<div class="para"><p>It is up to the user to ensure that no In-Reply-To header already
669exists when <em>git send-email</em> is asked to add it (especially note that
670<em>git format-patch</em> can be configured to do the threading itself).
671Failure to do so may not produce the expected result in the
672recipient's MUA.</p></div>
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]673</dd>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]674</dl></div>
675<h3 id="_administering">Administering</h3><div style="clear:left"></div>
676<div class="vlist"><dl>
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]677<dt>
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]678--confirm=&lt;mode&gt;
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]679</dt>
680<dd>
681<p>
682 Confirm just before sending:
683</p>
684<div class="ilist"><ul>
685<li>
686<p>
687<em>always</em> will always confirm before sending
688</p>
689</li>
690<li>
691<p>
692<em>never</em> will never confirm before sending
693</p>
694</li>
695<li>
696<p>
697<em>cc</em> will confirm before sending when send-email has automatically
698 added addresses from the patch to the Cc list
699</p>
700</li>
701<li>
702<p>
703<em>compose</em> will confirm before sending the first message when using --compose.
704</p>
705</li>
706<li>
707<p>
708<em>auto</em> is equivalent to <em>cc</em> + <em>compose</em>
709</p>
710</li>
711</ul></div>
712<div class="para"><p>Default is the value of <em>sendemail.confirm</em> configuration value; if that
713is unspecified, default to <em>auto</em> unless any of the suppress options
714have been specified, in which case default to <em>compose</em>.</p></div>
715</dd>
716<dt>
Junio C Hamano45889b42007-04-26 07:20:04[diff] [blame]717--dry-run
718</dt>
719<dd>
720<p>
721 Do everything except actually send the emails.
722</p>
723</dd>
724<dt>
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]725--[no-]format-patch
726</dt>
727<dd>
728<p>
729 When an argument may be understood either as a reference or as a file name,
730 choose to understand it as a format-patch argument (<em>--format-patch</em>)
731 or as a file name (<em>--no-format-patch</em>). By default, when such a conflict
732 occurs, git send-email will fail.
733</p>
734</dd>
735<dt>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]736--quiet
Junio C Hamano45889b42007-04-26 07:20:04[diff] [blame]737</dt>
738<dd>
739<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]740 Make git-send-email less verbose. One line per email should be
741 all that is output.
Junio C Hamano45889b42007-04-26 07:20:04[diff] [blame]742</p>
743</dd>
744<dt>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]745--[no-]validate
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]746</dt>
747<dd>
748<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]749 Perform sanity checks on patches.
750 Currently, validation means the following:
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]751</p>
Junio C Hamano2fa431b2008-12-28 01:26:23[diff] [blame]752<div class="ilist"><ul>
753<li>
754<p>
755Warn of patches that contain lines longer than 998 characters; this
756 is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
757</p>
758</li>
759</ul></div>
760<div class="para"><p>Default is the value of <em>sendemail.validate</em>; if this is not set,
761default to <em>--validate</em>.</p></div>
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]762</dd>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]763</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]764</div>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]765<h2 id="_configuration">CONFIGURATION</h2>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]766<div class="sectionbody">
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]767<div class="vlist"><dl>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]768<dt>
769sendemail.aliasesfile
770</dt>
771<dd>
772<p>
773 To avoid typing long email addresses, point this to one or more
774 email aliases files. You must also supply <em>sendemail.aliasfiletype</em>.
775</p>
776</dd>
777<dt>
778sendemail.aliasfiletype
779</dt>
780<dd>
781<p>
782 Format of the file(s) specified in sendemail.aliasesfile. Must be
Junio C Hamano07738342009-04-23 03:06:56[diff] [blame]783 one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, or <em>gnus</em>.
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]784</p>
785</dd>
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]786<dt>
787sendemail.multiedit
788</dt>
789<dd>
790<p>
791 If true (default), a single editor instance will be spawned to edit
792 files you have to edit (patches when <em>--annotate</em> is used, and the
793 summary when <em>--compose</em> is used). If false, files will be edited one
794 after the other, spawning a new editor each time.
795</p>
796</dd>
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]797<dt>
798sendemail.confirm
799</dt>
800<dd>
801<p>
802 Sets the default for whether to confirm before sending. Must be
803 one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <em>--confirm</em>
804 in the previous section for the meaning of these values.
805</p>
806</dd>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]807</dl></div>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]808</div>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]809<h2 id="_author">Author</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]810<div class="sectionbody">
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]811<div class="para"><p>Written by Ryan Anderson &lt;ryan@michonline.com&gt;</p></div>
812<div class="para"><p>git-send-email is originally based upon
813send_lots_of_email.pl by Greg Kroah-Hartman.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]814</div>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]815<h2 id="_documentation">Documentation</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]816<div class="sectionbody">
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]817<div class="para"><p>Documentation by Ryan Anderson</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]818</div>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]819<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]820<div class="sectionbody">
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]821<div class="para"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]822</div>
823<div id="footer">
824<div id="footer-text">
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]825Last updated 2009-11-21 17:36:58 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]826</div>
827</div>
828</body>
829</html>