Google Git
Sign in
chromium / external / gitster / git-htmldocs / b968dbbd6a939fc1282a7837026e131ed921e122 / . / git-send-email.html
blob: 21e221ce02ab00f80da3139511f76f5f22146a65 [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 Hamano86f75882006-02-06 02:27:23[diff] [blame]307--chain-reply-to, --no-chain-reply-to
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]308</dt>
309<dd>
310<p>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]311 If this is set, each email will be sent as a reply to the previous
312 email sent. If disabled with "--no-chain-reply-to", all emails after
313 the first will be sent as replies to the first email sent. When using
314 this, it is recommended that the first file given be an overview of the
315 entire patch series.
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]316 Default is the value of the <em>sendemail.chainreplyto</em> configuration
317 value; if that is unspecified, default to --chain-reply-to.
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]318</p>
319</dd>
320<dt>
321--compose
322</dt>
323<dd>
324<p>
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]325 Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
326 introductory message for the patch series.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]327</p>
328</dd>
329<dt>
330--from
331</dt>
332<dd>
333<p>
334 Specify the sender of the emails. This will default to
335 the value GIT_COMMITTER_IDENT, as returned by "git-var -l".
336 The user will still be prompted to confirm this entry.
337</p>
338</dd>
339<dt>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]340--in-reply-to
341</dt>
342<dd>
343<p>
344 Specify the contents of the first In-Reply-To header.
345 Subsequent emails will refer to the previous email
346 instead of this if --chain-reply-to is set (the default)
347 Only necessary if --compose is also set. If --compose
348 is not set, this will be prompted for.
349</p>
350</dd>
351<dt>
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]352--signed-off-by-cc, --no-signed-off-by-cc
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]353</dt>
354<dd>
355<p>
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]356 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]357 cc list.
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]358 Default is the value of <em>sendemail.signedoffbycc</em> configuration value;
359 if that is unspecified, default to --signed-off-by-cc.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]360</p>
361</dd>
362<dt>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]363--quiet
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]364</dt>
365<dd>
366<p>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]367 Make git-send-email less verbose. One line per email should be
368 all that is output.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]369</p>
370</dd>
371<dt>
372--smtp-server
373</dt>
374<dd>
375<p>
Junio C Hamanob63afff2007-05-01 03:05:55[diff] [blame]376 If set, specifies the outgoing SMTP server to use (e.g.
377 <tt>smtp.example.com</tt> or a raw IP address). Alternatively it can
378 specify a full pathname of a sendmail-like program instead;
Junio C Hamanob19b4f02006-10-29 20:47:22[diff] [blame]379 the program must support the <tt>-i</tt> option. Default value can
380 be specified by the <em>sendemail.smtpserver</em> configuration
381 option; the built-in default is <tt>/usr/sbin/sendmail</tt> or
382 <tt>/usr/lib/sendmail</tt> if such program is available, or
383 <tt>localhost</tt> otherwise.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]384</p>
385</dd>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]386<dt>
387--subject
388</dt>
389<dd>
390<p>
391 Specify the initial subject of the email thread.
392 Only necessary if --compose is also set. If --compose
393 is not set, this will be prompted for.
394</p>
395</dd>
396<dt>
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]397--suppress-from, --no-suppress-from
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]398</dt>
399<dd>
400<p>
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]401 If this is set, do not add the From: address to the cc: list, if it
402 shows up in a From: line.
403 Default is the value of <em>sendemail.suppressfrom</em> configuration value;
404 if that is unspecified, default to --no-supress-from.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]405</p>
406</dd>
407<dt>
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]408--thread, --no-thread
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]409</dt>
410<dd>
411<p>
412 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]413 If disabled with "--no-thread", no emails will have the In-Reply-To
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]414 header set.
Junio C Hamano6865ebd2007-06-28 08:16:14[diff] [blame]415 Default is the value of the <em>sendemail.thread</em> configuration value;
416 if that is unspecified, default to --thread.
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]417</p>
418</dd>
419<dt>
Junio C Hamano45889b42007-04-26 07:20:04[diff] [blame]420--dry-run
421</dt>
422<dd>
423<p>
424 Do everything except actually send the emails.
425</p>
426</dd>
427<dt>
428--envelope-sender
429</dt>
430<dd>
431<p>
432 Specify the envelope sender used to send the emails.
433 This is useful if your default address is not the address that is
434 subscribed to a list. If you use the sendmail binary, you must have
435 suitable privileges for the -f parameter.
436</p>
437</dd>
438<dt>
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]439--to
440</dt>
441<dd>
442<p>
443 Specify the primary recipient of the emails generated.
444 Generally, this will be the upstream maintainer of the
445 project involved.
446</p>
Junio C Hamanoa3fd83c2007-03-02 10:34:36[diff] [blame]447<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]448</dd>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]449</dl>
450</div>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]451<h2>CONFIGURATION</h2>
452<div class="sectionbody">
453<dl>
454<dt>
455sendemail.aliasesfile
456</dt>
457<dd>
458<p>
459 To avoid typing long email addresses, point this to one or more
460 email aliases files. You must also supply <em>sendemail.aliasfiletype</em>.
461</p>
462</dd>
463<dt>
464sendemail.aliasfiletype
465</dt>
466<dd>
467<p>
468 Format of the file(s) specified in sendemail.aliasesfile. Must be
469 one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, or <em>gnus</em>.
470</p>
471</dd>
472<dt>
473sendemail.bcc
474</dt>
475<dd>
476<p>
477 Email address (or alias) to always bcc.
478</p>
479</dd>
480<dt>
481sendemail.chainreplyto
482</dt>
483<dd>
484<p>
485 Boolean value specifying the default to the <em>--chain_reply_to</em>
486 parameter.
487</p>
488</dd>
489<dt>
490sendemail.smtpserver
491</dt>
492<dd>
493<p>
494 Default smtp server to use.
495</p>
496</dd>
497</dl>
498</div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]499<h2>Author</h2>
500<div class="sectionbody">
501<p>Written by Ryan Anderson &lt;ryan@michonline.com&gt;</p>
502<p>git-send-email is originally based upon
503send_lots_of_email.pl by Greg Kroah-Hartman.</p>
504</div>
505<h2>Documentation</h2>
506<div class="sectionbody">
507<p>Documentation by Ryan Anderson</p>
508</div>
509<h2>GIT</h2>
510<div class="sectionbody">
511<p>Part of the <a href="git.html">git(7)</a> suite</p>
512</div>
513<div id="footer">
514<div id="footer-text">
Junio C Hamanof6002a92007-07-20 10:28:22[diff] [blame]515Last updated 20-Jul-2007 10:27:38 UTC
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]516</div>
517</div>
518</body>
519</html>