Google Git
Sign in
chromium / external / gitster / git-htmldocs / 7f99edc01ac35011916ee92540a4add2e3244310 / . / git-send-email.html
blob: 5227151f8402e80bc370b08163d74133ad9a8540 [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 Hamano86f75882006-02-06 02:27:23[diff] [blame]6<meta name="generator" content="AsciiDoc 7.0.2" />
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
19a { color: blue; }
20a:visited { color: fuchsia; }
21
22em {
23 font-style: italic;
24}
25
26strong {
27 font-weight: bold;
28}
29
30tt {
31 color: navy;
32}
33
34h1, h2, h3, h4, h5, h6 {
35 color: #527bbd;
36 font-family: sans-serif;
37 margin-top: 1.2em;
38 margin-bottom: 0.5em;
39 line-height: 1.3;
40}
41
42h1 {
43 border-bottom: 2px solid silver;
44}
45h2 {
46 border-bottom: 2px solid silver;
47 padding-top: 0.5em;
48}
49
50div.sectionbody {
51 font-family: serif;
52 margin-left: 0;
53}
54
55hr {
56 border: 1px solid silver;
57}
58
59p {
60 margin-top: 0.5em;
61 margin-bottom: 0.5em;
62}
63
64pre {
65 padding: 0;
66 margin: 0;
67}
68
69span#author {
70 color: #527bbd;
71 font-family: sans-serif;
72 font-weight: bold;
73 font-size: 1.2em;
74}
75span#email {
76}
77span#revision {
78 font-family: sans-serif;
79}
80
81div#footer {
82 font-family: sans-serif;
83 font-size: small;
84 border-top: 2px solid silver;
85 padding-top: 0.5em;
86 margin-top: 4.0em;
87}
88div#footer-text {
89 float: left;
90 padding-bottom: 0.5em;
91}
92div#footer-badges {
93 float: right;
94 padding-bottom: 0.5em;
95}
96
97div#preamble,
98div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
99div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
100div.admonitionblock {
101 margin-right: 10%;
102 margin-top: 1.5em;
103 margin-bottom: 1.5em;
104}
105div.admonitionblock {
106 margin-top: 2.5em;
107 margin-bottom: 2.5em;
108}
109
110div.content { /* Block element content. */
111 padding: 0;
112}
113
114/* Block element titles. */
115div.title, caption.title {
116 font-family: sans-serif;
117 font-weight: bold;
118 text-align: left;
119 margin-top: 1.0em;
120 margin-bottom: 0.5em;
121}
122div.title + * {
123 margin-top: 0;
124}
125
126td div.title:first-child {
127 margin-top: 0.0em;
128}
129div.content div.title:first-child {
130 margin-top: 0.0em;
131}
132div.content + div.title {
133 margin-top: 0.0em;
134}
135
136div.sidebarblock > div.content {
137 background: #ffffee;
138 border: 1px solid silver;
139 padding: 0.5em;
140}
141
142div.listingblock > div.content {
143 border: 1px solid silver;
144 background: #f4f4f4;
145 padding: 0.5em;
146}
147
148div.quoteblock > div.content {
149 padding-left: 2.0em;
150}
151div.quoteblock .attribution {
152 text-align: right;
153}
154
155div.admonitionblock .icon {
156 vertical-align: top;
157 font-size: 1.1em;
158 font-weight: bold;
159 text-decoration: underline;
160 color: #527bbd;
161 padding-right: 0.5em;
162}
163div.admonitionblock td.content {
164 padding-left: 0.5em;
165 border-left: 2px solid silver;
166}
167
168div.exampleblock > div.content {
169 border-left: 2px solid silver;
170 padding: 0.5em;
171}
172
173div.verseblock div.content {
174 white-space: pre;
175}
176
177div.imageblock div.content { padding-left: 0; }
178div.imageblock img { border: 1px solid silver; }
179span.image img { border-style: none; }
180
181dl {
182 margin-top: 0.8em;
183 margin-bottom: 0.8em;
184}
185dt {
186 margin-top: 0.5em;
187 margin-bottom: 0;
188 font-style: italic;
189}
190dd > *:first-child {
191 margin-top: 0;
192}
193
194ul, ol {
195 list-style-position: outside;
196}
197ol.olist2 {
198 list-style-type: lower-alpha;
199}
200
201div.tableblock > table {
202 border-color: #527bbd;
203 border-width: 3px;
204}
205thead {
206 font-family: sans-serif;
207 font-weight: bold;
208}
209tfoot {
210 font-weight: bold;
211}
212
213div.hlist {
214 margin-top: 0.8em;
215 margin-bottom: 0.8em;
216}
217td.hlist1 {
218 vertical-align: top;
219 font-style: italic;
220 padding-right: 0.8em;
221}
222td.hlist2 {
223 vertical-align: top;
224}
225
226@media print {
227 div#footer-badges { display: none; }
228}
229include::./stylesheets/xhtml11-manpage.css[]
230/* Workarounds for IE6's broken and incomplete CSS2. */
231
232div.sidebar-content {
233 background: #ffffee;
234 border: 1px solid silver;
235 padding: 0.5em;
236}
237div.sidebar-title, div.image-title {
238 font-family: sans-serif;
239 font-weight: bold;
240 margin-top: 0.0em;
241 margin-bottom: 0.5em;
242}
243
244div.listingblock div.content {
245 border: 1px solid silver;
246 background: #f4f4f4;
247 padding: 0.5em;
248}
249
250div.quoteblock-content {
251 padding-left: 2.0em;
252}
253
254div.exampleblock-content {
255 border-left: 2px solid silver;
256 padding-left: 0.5em;
257}
258</style>
259<title>git-send-email(1)</title>
260</head>
261<body>
262<div id="header">
263<h1>
264git-send-email(1) Manual Page
265</h1>
266<h2>NAME</h2>
267<div class="sectionbody">
268<p>git-send-email -
269 Send a collection of patches as emails
270</p>
271</div>
272</div>
273<h2>SYNOPSIS</h2>
274<div class="sectionbody">
275<p><em>git-send-email</em> [options] &lt;file|directory&gt; [&#8230; file|directory]</p>
276</div>
277<h2>DESCRIPTION</h2>
278<div class="sectionbody">
279<p>Takes the patches given on the command line and emails them out.</p>
280<p>The header of the email is configurable by command line options. If not
281specified on the command line, the user will be prompted with a ReadLine
282enabled interface to provide the necessary information.</p>
283</div>
284<h2>OPTIONS</h2>
285<div class="sectionbody">
286<p>The options available are:</p>
287<dl>
288<dt>
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]289--bcc
290</dt>
291<dd>
292<p>
293 Specify a "Bcc:" value for each email.
294</p>
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]295<p>The --bcc option must be repeated for each user you want on the bcc list.</p>
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]296</dd>
297<dt>
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]298--cc
299</dt>
300<dd>
301<p>
302 Specify a starting "Cc:" value for each email.
303</p>
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]304<p>The --cc option must be repeated for each user you want on the cc list.</p>
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]305</dd>
306<dt>
Junio C Hamanoc5653d72007-09-02 06:25:16[diff] [blame]307--cc-cmd
308</dt>
309<dd>
310<p>
311 Specify a command to execute once per patch file which
312 should generate patch file specific "Cc:" entries.
313 Output of this command must be single email address per line.
314 Default is the value of <em>sendemail.cccmd</em> configuration value.
315</p>
316</dd>
317<dt>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]318--chain-reply-to, --no-chain-reply-to
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]319</dt>
320<dd>
321<p>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]322 If this is set, each email will be sent as a reply to the previous
323 email sent. If disabled with "--no-chain-reply-to", all emails after
324 the first will be sent as replies to the first email sent. When using
325 this, it is recommended that the first file given be an overview of the
326 entire patch series.
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]327 Default is the value of the <em>sendemail.chainreplyto</em> configuration
328 value; if that is unspecified, default to --chain-reply-to.
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]329</p>
330</dd>
331<dt>
332--compose
333</dt>
334<dd>
335<p>
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]336 Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
337 introductory message for the patch series.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]338</p>
339</dd>
340<dt>
341--from
342</dt>
343<dd>
344<p>
345 Specify the sender of the emails. This will default to
346 the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
347 The user will still be prompted to confirm this entry.
348</p>
349</dd>
350<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]351--in-reply-to
352</dt>
353<dd>
354<p>
355 Specify the contents of the first In-Reply-To header.
356 Subsequent emails will refer to the previous email
357 instead of this if --chain-reply-to is set (the default)
358 Only necessary if --compose is also set. If --compose
359 is not set, this will be prompted for.
360</p>
361</dd>
362<dt>
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]363--signed-off-by-cc, --no-signed-off-by-cc
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]364</dt>
365<dd>
366<p>
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]367 If this is set, add emails found in Signed-off-by: or Cc: lines to the
Junio C Hamanob8c51282007-03-19 10:43:30[diff] [blame]368 cc list.
Junio C Hamano1b11dcb2007-08-18 07:20:55[diff] [blame]369 Default is the value of <em>sendemail.signedoffcc</em> configuration value;
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]370 if that is unspecified, default to --signed-off-by-cc.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]371</p>
372</dd>
373<dt>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]374--quiet
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]375</dt>
376<dd>
377<p>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]378 Make git-send-email less verbose. One line per email should be
379 all that is output.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]380</p>
381</dd>
382<dt>
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]383--identity
384</dt>
385<dd>
386<p>
387 A configuration identity. When given, causes values in the
388 <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
389 values in the <em>sendemail</em> section. The default identity is
390 the value of <em>sendemail.identity</em>.
391</p>
392</dd>
393<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]394--smtp-server
395</dt>
396<dd>
397<p>
Junio C Hamanob63afff2007-05-01 03:05:55[diff] [blame]398 If set, specifies the outgoing SMTP server to use (e.g.
399 <tt>smtp.example.com</tt> or a raw IP address). Alternatively it can
400 specify a full pathname of a sendmail-like program instead;
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]401 the program must support the <tt>-i</tt> option. Default value can
402 be specified by the <em>sendemail.smtpserver</em> configuration
403 option; the built-in default is <tt>/usr/sbin/sendmail</tt> or
404 <tt>/usr/lib/sendmail</tt> if such program is available, or
405 <tt>localhost</tt> otherwise.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]406</p>
407</dd>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]408<dt>
Junio C Hamano4fd58d42007-09-30 00:51:14[diff] [blame]409--smtp-server-port
410</dt>
411<dd>
412<p>
413 Specifies a port different from the default port (SMTP
414 servers typically listen to smtp port 25 and ssmtp port
415 465).
416</p>
417</dd>
418<dt>
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]419--smtp-user, --smtp-pass
420</dt>
421<dd>
422<p>
423 Username and password for SMTP-AUTH. Defaults are the values of
424 the configuration values <em>sendemail.smtpuser</em> and
425 <em>sendemail.smtppass</em>, but see also <em>sendemail.identity</em>.
426 If not set, authentication is not attempted.
427</p>
428</dd>
429<dt>
430--smtp-ssl
431</dt>
432<dd>
433<p>
434 If set, connects to the SMTP server using SSL.
435 Default is the value of the <em>sendemail.smtpssl</em> configuration value;
436 if that is unspecified, does not use SSL.
437</p>
438</dd>
439<dt>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]440--subject
441</dt>
442<dd>
443<p>
444 Specify the initial subject of the email thread.
445 Only necessary if --compose is also set. If --compose
446 is not set, this will be prompted for.
447</p>
448</dd>
449<dt>
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]450--suppress-from, --no-suppress-from
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]451</dt>
452<dd>
453<p>
Junio C Hamano422cfec2007-11-08 08:07:45[diff] [blame]454 If this is set, do not add the From: address to the cc: list.
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]455 Default is the value of <em>sendemail.suppressfrom</em> configuration value;
Junio C Hamanocae86272007-08-21 02:20:49[diff] [blame]456 if that is unspecified, default to --no-suppress-from.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]457</p>
458</dd>
459<dt>
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]460--thread, --no-thread
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]461</dt>
462<dd>
463<p>
464 If this is set, the In-Reply-To header will be set on each email sent.
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]465 If disabled with "--no-thread", no emails will have the In-Reply-To
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]466 header set.
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]467 Default is the value of the <em>sendemail.thread</em> configuration value;
468 if that is unspecified, default to --thread.
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]469</p>
470</dd>
471<dt>
Junio C Hamano45889b42007-04-26 07:20:04[diff] [blame]472--dry-run
473</dt>
474<dd>
475<p>
476 Do everything except actually send the emails.
477</p>
478</dd>
479<dt>
480--envelope-sender
481</dt>
482<dd>
483<p>
484 Specify the envelope sender used to send the emails.
485 This is useful if your default address is not the address that is
486 subscribed to a list. If you use the sendmail binary, you must have
487 suitable privileges for the -f parameter.
488</p>
489</dd>
490<dt>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]491--to
492</dt>
493<dd>
494<p>
495 Specify the primary recipient of the emails generated.
496 Generally, this will be the upstream maintainer of the
497 project involved.
Junio C Hamanof7bb6692008-01-27 08:23:46[diff] [blame]498 Default is the value of the <em>sendemail.to</em> configuration value;
499 if that is unspecified, this will be prompted for.
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]500</p>
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]501<p>The --to option must be repeated for each user you want on the to list.</p>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]502</dd>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]503</dl>
504</div>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]505<h2>CONFIGURATION</h2>
506<div class="sectionbody">
507<dl>
508<dt>
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]509sendemail.identity
510</dt>
511<dd>
512<p>
513 The default configuration identity. When specified,
514 <em>sendemail.&lt;identity&gt;.&lt;item&gt;</em> will have higher precedence than
515 <em>sendemail.&lt;item&gt;</em>. This is useful to declare multiple SMTP
516 identities and to hoist sensitive authentication information
Junio C Hamanofe986052007-12-19 07:33:38[diff] [blame]517 out of the repository and into the global configuration file.
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]518</p>
519</dd>
520<dt>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]521sendemail.aliasesfile
522</dt>
523<dd>
524<p>
525 To avoid typing long email addresses, point this to one or more
526 email aliases files. You must also supply <em>sendemail.aliasfiletype</em>.
527</p>
528</dd>
529<dt>
530sendemail.aliasfiletype
531</dt>
532<dd>
533<p>
534 Format of the file(s) specified in sendemail.aliasesfile. Must be
535 one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, or <em>gnus</em>.
536</p>
537</dd>
538<dt>
Junio C Hamanoc2b47092007-10-25 06:50:31[diff] [blame]539sendemail.to
540</dt>
541<dd>
542<p>
543 Email address (or alias) to always send to.
544</p>
545</dd>
546<dt>
Junio C Hamanoc5653d72007-09-02 06:25:16[diff] [blame]547sendemail.cccmd
548</dt>
549<dd>
550<p>
551 Command to execute to generate per patch file specific "Cc:"s.
552</p>
553</dd>
554<dt>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]555sendemail.bcc
556</dt>
557<dd>
558<p>
559 Email address (or alias) to always bcc.
560</p>
561</dd>
562<dt>
563sendemail.chainreplyto
564</dt>
565<dd>
566<p>
567 Boolean value specifying the default to the <em>--chain_reply_to</em>
568 parameter.
569</p>
570</dd>
571<dt>
572sendemail.smtpserver
573</dt>
574<dd>
575<p>
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]576 Default SMTP server to use.
577</p>
578</dd>
579<dt>
580sendemail.smtpuser
581</dt>
582<dd>
583<p>
584 Default SMTP-AUTH username.
585</p>
586</dd>
587<dt>
588sendemail.smtppass
589</dt>
590<dd>
591<p>
592 Default SMTP-AUTH password.
593</p>
594</dd>
595<dt>
596sendemail.smtpssl
597</dt>
598<dd>
599<p>
600 Boolean value specifying the default to the <em>--smtp-ssl</em> parameter.
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]601</p>
602</dd>
603</dl>
604</div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]605<h2>Author</h2>
606<div class="sectionbody">
607<p>Written by Ryan Anderson &lt;ryan@michonline.com&gt;</p>
608<p>git-send-email is originally based upon
609send_lots_of_email.pl by Greg Kroah-Hartman.</p>
610</div>
611<h2>Documentation</h2>
612<div class="sectionbody">
613<p>Documentation by Ryan Anderson</p>
614</div>
615<h2>GIT</h2>
616<div class="sectionbody">
617<p>Part of the <a href="git.html">git(7)</a> suite</p>
618</div>
619<div id="footer">
620<div id="footer-text">
Junio C Hamanof7bb6692008-01-27 08:23:46[diff] [blame]621Last updated 27-Jan-2008 08:23:29 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]622</div>
623</div>
624</body>
625</html>