Google Git
Sign in
chromium / external / gitster / git-htmldocs / 1291d1a1ed65a3d56c1c3dae7e3d1770eeba618c / . / git-send-email.html
blob: af20bf9a79c2ded883bd059e734f32214f170943 [file] [log] [blame]
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
3 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
5<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]6<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]7<meta name="generator" content="AsciiDoc 8.6.10" />
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]8<title>git-send-email(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]9<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]10/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
11
12/* Default font. */
13body {
14 font-family: Georgia,serif;
15}
16
17/* Title font. */
18h1, h2, h3, h4, h5, h6,
19div.title, caption.title,
20thead, p.table.header,
21#toctitle,
22#author, #revnumber, #revdate, #revremark,
23#footer {
24 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]25}
26
27body {
28 margin: 1em 5% 1em 5%;
29}
30
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]31a {
32 color: blue;
33 text-decoration: underline;
34}
35a:visited {
36 color: fuchsia;
37}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]38
39em {
40 font-style: italic;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]41 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]42}
43
44strong {
45 font-weight: bold;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]46 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]47}
48
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]49h1, h2, h3, h4, h5, h6 {
50 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]51 margin-top: 1.2em;
52 margin-bottom: 0.5em;
53 line-height: 1.3;
54}
55
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]56h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]57 border-bottom: 2px solid silver;
58}
59h2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]60 padding-top: 0.5em;
61}
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]62h3 {
63 float: left;
64}
65h3 + * {
66 clear: left;
67}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]68h5 {
69 font-size: 1.0em;
70}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]71
72div.sectionbody {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]73 margin-left: 0;
74}
75
76hr {
77 border: 1px solid silver;
78}
79
80p {
81 margin-top: 0.5em;
82 margin-bottom: 0.5em;
83}
84
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]85ul, ol, li > p {
86 margin-top: 0;
87}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]88ul > li { color: #aaa; }
89ul > li > * { color: black; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]90
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]91.monospaced, code, pre {
92 font-family: "Courier New", Courier, monospace;
93 font-size: inherit;
94 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]95 padding: 0;
96 margin: 0;
97}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]98pre {
99 white-space: pre-wrap;
100}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]101
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]102#author {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]103 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]104 font-weight: bold;
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]105 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]106}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]107#email {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]108}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]109#revnumber, #revdate, #revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]110}
111
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]112#footer {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]113 font-size: small;
114 border-top: 2px solid silver;
115 padding-top: 0.5em;
116 margin-top: 4.0em;
117}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]118#footer-text {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]119 float: left;
120 padding-bottom: 0.5em;
121}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]122#footer-badges {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]123 float: right;
124 padding-bottom: 0.5em;
125}
126
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]127#preamble {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]128 margin-top: 1.5em;
129 margin-bottom: 1.5em;
130}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]131div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]132div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
133div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]134 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]135 margin-bottom: 1.5em;
136}
137div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]138 margin-top: 2.0em;
139 margin-bottom: 2.0em;
140 margin-right: 10%;
141 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]142}
143
144div.content { /* Block element content. */
145 padding: 0;
146}
147
148/* Block element titles. */
149div.title, caption.title {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]150 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]151 font-weight: bold;
152 text-align: left;
153 margin-top: 1.0em;
154 margin-bottom: 0.5em;
155}
156div.title + * {
157 margin-top: 0;
158}
159
160td div.title:first-child {
161 margin-top: 0.0em;
162}
163div.content div.title:first-child {
164 margin-top: 0.0em;
165}
166div.content + div.title {
167 margin-top: 0.0em;
168}
169
170div.sidebarblock > div.content {
171 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]172 border: 1px solid #dddddd;
173 border-left: 4px solid #f0f0f0;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]174 padding: 0.5em;
175}
176
177div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]178 border: 1px solid #dddddd;
179 border-left: 5px solid #f0f0f0;
180 background: #f8f8f8;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]181 padding: 0.5em;
182}
183
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]184div.quoteblock, div.verseblock {
185 padding-left: 1.0em;
186 margin-left: 1.0em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]187 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]188 border-left: 5px solid #f0f0f0;
189 color: #888;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]190}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]191
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]192div.quoteblock > div.attribution {
193 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]194 text-align: right;
195}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]196
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]197div.verseblock > pre.content {
198 font-family: inherit;
199 font-size: inherit;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]200}
201div.verseblock > div.attribution {
202 padding-top: 0.75em;
203 text-align: left;
204}
205/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]206div.verseblock + div.attribution {
207 text-align: left;
208}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]209
210div.admonitionblock .icon {
211 vertical-align: top;
212 font-size: 1.1em;
213 font-weight: bold;
214 text-decoration: underline;
215 color: #527bbd;
216 padding-right: 0.5em;
217}
218div.admonitionblock td.content {
219 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]220 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]221}
222
223div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]224 border-left: 3px solid #dddddd;
225 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]226}
227
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]228div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]229span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]230a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]231
232dl {
233 margin-top: 0.8em;
234 margin-bottom: 0.8em;
235}
236dt {
237 margin-top: 0.5em;
238 margin-bottom: 0;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]239 font-style: normal;
240 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]241}
242dd > *:first-child {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]243 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]244}
245
246ul, ol {
247 list-style-position: outside;
248}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]249ol.arabic {
250 list-style-type: decimal;
251}
252ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]253 list-style-type: lower-alpha;
254}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]255ol.upperalpha {
256 list-style-type: upper-alpha;
257}
258ol.lowerroman {
259 list-style-type: lower-roman;
260}
261ol.upperroman {
262 list-style-type: upper-roman;
263}
264
265div.compact ul, div.compact ol,
266div.compact p, div.compact p,
267div.compact div, div.compact div {
268 margin-top: 0.1em;
269 margin-bottom: 0.1em;
270}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]271
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]272tfoot {
273 font-weight: bold;
274}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]275td > div.verse {
276 white-space: pre;
277}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]278
279div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]280 margin-top: 0.8em;
281 margin-bottom: 0.8em;
282}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]283div.hdlist tr {
284 padding-bottom: 15px;
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]285}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]286dt.hdlist1.strong, td.hdlist1.strong {
287 font-weight: bold;
288}
289td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]290 vertical-align: top;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]291 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]292 padding-right: 0.8em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]293 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]294}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]295td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]296 vertical-align: top;
297}
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]298div.hdlist.compact tr {
299 margin: 0;
300 padding-bottom: 0;
301}
302
303.comment {
304 background: yellow;
305}
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]306
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]307.footnote, .footnoteref {
308 font-size: 0.8em;
309}
310
311span.footnote, span.footnoteref {
312 vertical-align: super;
313}
314
315#footnotes {
316 margin: 20px 0 20px 0;
317 padding: 7px 0 0 0;
318}
319
320#footnotes div.footnote {
321 margin: 0 0 5px 0;
322}
323
324#footnotes hr {
325 border: none;
326 border-top: 1px solid silver;
327 height: 1px;
328 text-align: left;
329 margin-left: 0;
330 width: 20%;
331 min-width: 100px;
332}
333
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]334div.colist td {
335 padding-right: 0.5em;
336 padding-bottom: 0.3em;
337 vertical-align: top;
338}
339div.colist td img {
340 margin-top: 0.3em;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]341}
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]342
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]343@media print {
344 #footer-badges { display: none; }
345}
346
347#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]348 margin-bottom: 2.5em;
349}
350
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]351#toctitle {
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]352 color: #527bbd;
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]353 font-size: 1.1em;
354 font-weight: bold;
355 margin-top: 1.0em;
356 margin-bottom: 0.1em;
357}
358
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]359div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]360 margin-top: 0;
361 margin-bottom: 0;
362}
363div.toclevel2 {
364 margin-left: 2em;
365 font-size: 0.9em;
366}
367div.toclevel3 {
368 margin-left: 4em;
369 font-size: 0.9em;
370}
371div.toclevel4 {
372 margin-left: 6em;
373 font-size: 0.9em;
374}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]375
376span.aqua { color: aqua; }
377span.black { color: black; }
378span.blue { color: blue; }
379span.fuchsia { color: fuchsia; }
380span.gray { color: gray; }
381span.green { color: green; }
382span.lime { color: lime; }
383span.maroon { color: maroon; }
384span.navy { color: navy; }
385span.olive { color: olive; }
386span.purple { color: purple; }
387span.red { color: red; }
388span.silver { color: silver; }
389span.teal { color: teal; }
390span.white { color: white; }
391span.yellow { color: yellow; }
392
393span.aqua-background { background: aqua; }
394span.black-background { background: black; }
395span.blue-background { background: blue; }
396span.fuchsia-background { background: fuchsia; }
397span.gray-background { background: gray; }
398span.green-background { background: green; }
399span.lime-background { background: lime; }
400span.maroon-background { background: maroon; }
401span.navy-background { background: navy; }
402span.olive-background { background: olive; }
403span.purple-background { background: purple; }
404span.red-background { background: red; }
405span.silver-background { background: silver; }
406span.teal-background { background: teal; }
407span.white-background { background: white; }
408span.yellow-background { background: yellow; }
409
410span.big { font-size: 2em; }
411span.small { font-size: 0.6em; }
412
413span.underline { text-decoration: underline; }
414span.overline { text-decoration: overline; }
415span.line-through { text-decoration: line-through; }
416
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]417div.unbreakable { page-break-inside: avoid; }
418
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]419
420/*
421 * xhtml11 specific
422 *
423 * */
424
425div.tableblock {
426 margin-top: 1.0em;
427 margin-bottom: 1.5em;
428}
429div.tableblock > table {
430 border: 3px solid #527bbd;
431}
432thead, p.table.header {
433 font-weight: bold;
434 color: #527bbd;
435}
436p.table {
437 margin-top: 0;
438}
Junio C Hamano725b0da2020-01-22 22:02:40[diff] [blame]439/* Because the table frame attribute is overridden by CSS in most browsers. */
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]440div.tableblock > table[frame="void"] {
441 border-style: none;
442}
443div.tableblock > table[frame="hsides"] {
444 border-left-style: none;
445 border-right-style: none;
446}
447div.tableblock > table[frame="vsides"] {
448 border-top-style: none;
449 border-bottom-style: none;
450}
451
452
453/*
454 * html5 specific
455 *
456 * */
457
458table.tableblock {
459 margin-top: 1.0em;
460 margin-bottom: 1.5em;
461}
462thead, p.tableblock.header {
463 font-weight: bold;
464 color: #527bbd;
465}
466p.tableblock {
467 margin-top: 0;
468}
469table.tableblock {
470 border-width: 3px;
471 border-spacing: 0px;
472 border-style: solid;
473 border-color: #527bbd;
474 border-collapse: collapse;
475}
476th.tableblock, td.tableblock {
477 border-width: 1px;
478 padding: 4px;
479 border-style: solid;
480 border-color: #527bbd;
481}
482
483table.tableblock.frame-topbot {
484 border-left-style: hidden;
485 border-right-style: hidden;
486}
487table.tableblock.frame-sides {
488 border-top-style: hidden;
489 border-bottom-style: hidden;
490}
491table.tableblock.frame-none {
492 border-style: hidden;
493}
494
495th.tableblock.halign-left, td.tableblock.halign-left {
496 text-align: left;
497}
498th.tableblock.halign-center, td.tableblock.halign-center {
499 text-align: center;
500}
501th.tableblock.halign-right, td.tableblock.halign-right {
502 text-align: right;
503}
504
505th.tableblock.valign-top, td.tableblock.valign-top {
506 vertical-align: top;
507}
508th.tableblock.valign-middle, td.tableblock.valign-middle {
509 vertical-align: middle;
510}
511th.tableblock.valign-bottom, td.tableblock.valign-bottom {
512 vertical-align: bottom;
513}
514
515
516/*
517 * manpage specific
518 *
519 * */
520
521body.manpage h1 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]522 padding-top: 0.5em;
523 padding-bottom: 0.5em;
524 border-top: 2px solid silver;
525 border-bottom: 2px solid silver;
526}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]527body.manpage h2 {
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]528 border-style: none;
529}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]530body.manpage div.sectionbody {
531 margin-left: 3em;
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]532}
533
534@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]535 body.manpage div#toc { display: none; }
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]536}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]537
538
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]539</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]540<script type="text/javascript">
541/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]542var asciidoc = { // Namespace.
543
544/////////////////////////////////////////////////////////////////////
545// Table Of Contents generator
546/////////////////////////////////////////////////////////////////////
547
548/* Author: Mihai Bazon, September 2002
549 * http://students.infoiasi.ro/~mishoo
550 *
551 * Table Of Content generator
552 * Version: 0.4
553 *
554 * Feel free to use this script under the terms of the GNU General Public
555 * License, as long as you do not remove or alter this notice.
556 */
557
558 /* modified by Troy D. Hanson, September 2006. License: GPL */
559 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
560
561// toclevels = 1..4.
562toc: function (toclevels) {
563
564 function getText(el) {
565 var text = "";
566 for (var i = el.firstChild; i != null; i = i.nextSibling) {
567 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
568 text += i.data;
569 else if (i.firstChild != null)
570 text += getText(i);
571 }
572 return text;
573 }
574
575 function TocEntry(el, text, toclevel) {
576 this.element = el;
577 this.text = text;
578 this.toclevel = toclevel;
579 }
580
581 function tocEntries(el, toclevels) {
582 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]583 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]584 // Function that scans the DOM tree for header elements (the DOM2
585 // nodeIterator API would be a better technique but not supported by all
586 // browsers).
587 var iterate = function (el) {
588 for (var i = el.firstChild; i != null; i = i.nextSibling) {
589 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
590 var mo = re.exec(i.tagName);
591 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
592 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
593 }
594 iterate(i);
595 }
596 }
597 }
598 iterate(el);
599 return result;
600 }
601
602 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]603 if (!toc) {
604 return;
605 }
606
607 // Delete existing TOC entries in case we're reloading the TOC.
608 var tocEntriesToRemove = [];
609 var i;
610 for (i = 0; i < toc.childNodes.length; i++) {
611 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]612 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]613 && entry.getAttribute("class")
614 && entry.getAttribute("class").match(/^toclevel/))
615 tocEntriesToRemove.push(entry);
616 }
617 for (i = 0; i < tocEntriesToRemove.length; i++) {
618 toc.removeChild(tocEntriesToRemove[i]);
619 }
620
621 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]622 var entries = tocEntries(document.getElementById("content"), toclevels);
623 for (var i = 0; i < entries.length; ++i) {
624 var entry = entries[i];
625 if (entry.element.id == "")
626 entry.element.id = "_toc_" + i;
627 var a = document.createElement("a");
628 a.href = "#" + entry.element.id;
629 a.appendChild(document.createTextNode(entry.text));
630 var div = document.createElement("div");
631 div.appendChild(a);
632 div.className = "toclevel" + entry.toclevel;
633 toc.appendChild(div);
634 }
635 if (entries.length == 0)
636 toc.parentNode.removeChild(toc);
637},
638
639
640/////////////////////////////////////////////////////////////////////
641// Footnotes generator
642/////////////////////////////////////////////////////////////////////
643
644/* Based on footnote generation code from:
645 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
646 */
647
648footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]649 // Delete existing footnote entries in case we're reloading the footnodes.
650 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]651 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]652 if (!noteholder) {
653 return;
654 }
655 var entriesToRemove = [];
656 for (i = 0; i < noteholder.childNodes.length; i++) {
657 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]658 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]659 entriesToRemove.push(entry);
660 }
661 for (i = 0; i < entriesToRemove.length; i++) {
662 noteholder.removeChild(entriesToRemove[i]);
663 }
664
665 // Rebuild footnote entries.
666 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]667 var spans = cont.getElementsByTagName("span");
668 var refs = {};
669 var n = 0;
670 for (i=0; i<spans.length; i++) {
671 if (spans[i].className == "footnote") {
672 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]673 var note = spans[i].getAttribute("data-note");
674 if (!note) {
675 // Use [\s\S] in place of . so multi-line matches work.
676 // Because JavaScript has no s (dotall) regex flag.
677 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
678 spans[i].innerHTML =
679 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
680 "' title='View footnote' class='footnote'>" + n + "</a>]";
681 spans[i].setAttribute("data-note", note);
682 }
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]683 noteholder.innerHTML +=
684 "<div class='footnote' id='_footnote_" + n + "'>" +
685 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
686 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]687 var id =spans[i].getAttribute("id");
688 if (id != null) refs["#"+id] = n;
689 }
690 }
691 if (n == 0)
692 noteholder.parentNode.removeChild(noteholder);
693 else {
694 // Process footnoterefs.
695 for (i=0; i<spans.length; i++) {
696 if (spans[i].className == "footnoteref") {
697 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
698 href = href.match(/#.*/)[0]; // Because IE return full URL.
699 n = refs[href];
700 spans[i].innerHTML =
701 "[<a href='#_footnote_" + n +
702 "' title='View footnote' class='footnote'>" + n + "</a>]";
703 }
704 }
705 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]706},
707
708install: function(toclevels) {
709 var timerId;
710
711 function reinstall() {
712 asciidoc.footnotes();
713 if (toclevels) {
714 asciidoc.toc(toclevels);
715 }
716 }
717
718 function reinstallAndRemoveTimer() {
719 clearInterval(timerId);
720 reinstall();
721 }
722
723 timerId = setInterval(reinstall, 500);
724 if (document.addEventListener)
725 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
726 else
727 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]728}
729
730}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]731asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]732/*]]>*/
733</script>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]734</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]735<body class="manpage">
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]736<div id="header">
737<h1>
738git-send-email(1) Manual Page
739</h1>
740<h2>NAME</h2>
741<div class="sectionbody">
742<p>git-send-email -
743 Send a collection of patches as emails
744</p>
745</div>
746</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]747<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]748<div class="sect1">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]749<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]750<div class="sectionbody">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]751<div class="verseblock">
Junio C Hamanoc9cb5172018-06-01 07:13:44[diff] [blame]752<pre class="content"><em>git send-email</em> [&lt;options&gt;] &lt;file|directory|rev-list options&gt;&#8230;
Junio C Hamanoabb8a052015-12-04 22:43:11[diff] [blame]753<em>git send-email</em> --dump-aliases</pre>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]754<div class="attribution">
Junio C Hamano15567bc2011-07-23 00:51:59[diff] [blame]755</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]756</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]757</div>
758<div class="sect1">
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]759<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]760<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]761<div class="paragraph"><p>Takes the patches given on the command line and emails them out.
Junio C Hamanob95b43d2009-06-12 08:57:28[diff] [blame]762Patches can be specified as files, directories (which will send all
763files in the directory), or directly as a revision list. In the
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]764last case, any format accepted by <a href="git-format-patch.html">git-format-patch(1)</a> can
Junio C Hamanob95b43d2009-06-12 08:57:28[diff] [blame]765be passed to git send-email.</p></div>
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]766<div class="paragraph"><p>The header of the email is configurable via command-line options. If not
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]767specified on the command line, the user will be prompted with a ReadLine
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]768enabled interface to provide the necessary information.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]769<div class="paragraph"><p>There are two formats accepted for patch files:</p></div>
770<div class="olist arabic"><ol class="arabic">
Junio C Hamanoa6455f62009-02-20 08:33:08[diff] [blame]771<li>
772<p>
773mbox format files
774</p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]775<div class="paragraph"><p>This is what <a href="git-format-patch.html">git-format-patch(1)</a> generates. Most headers and MIME
Junio C Hamanoa6455f62009-02-20 08:33:08[diff] [blame]776formatting are ignored.</p></div>
777</li>
778<li>
779<p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]780The original format used by Greg Kroah-Hartman&#8217;s <em>send_lots_of_email.pl</em>
Junio C Hamano2567b322019-02-05 23:33:56[diff] [blame]781 script
Junio C Hamanoa6455f62009-02-20 08:33:08[diff] [blame]782</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]783<div class="paragraph"><p>This format expects the first line of the file to contain the "Cc:" value
Junio C Hamanoa6455f62009-02-20 08:33:08[diff] [blame]784and the "Subject:" of the message as the second line.</p></div>
785</li>
786</ol></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]787</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]788</div>
789<div class="sect1">
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]790<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]791<div class="sectionbody">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]792<div class="sect2">
793<h3 id="_composing">Composing</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]794<div class="dlist"><dl>
795<dt class="hdlist1">
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]796--annotate
797</dt>
798<dd>
799<p>
Junio C Hamanoea3b7522013-04-18 19:37:53[diff] [blame]800 Review and edit each patch you&#8217;re about to send. Default is the value
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]801 of <code>sendemail.annotate</code>. See the CONFIGURATION section for
802 <code>sendemail.multiEdit</code>.
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]803</p>
804</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]805<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]806--bcc=&lt;address&gt;,&#8230;
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]807</dt>
808<dd>
809<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]810 Specify a "Bcc:" value for each email. Default is the value of
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]811 <code>sendemail.bcc</code>.
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]812</p>
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]813<div class="paragraph"><p>This option may be specified multiple times.</p></div>
Junio C Hamano97f518c2006-06-22 19:49:35[diff] [blame]814</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]815<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]816--cc=&lt;address&gt;,&#8230;
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]817</dt>
818<dd>
819<p>
820 Specify a starting "Cc:" value for each email.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]821 Default is the value of <code>sendemail.cc</code>.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]822</p>
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]823<div class="paragraph"><p>This option may be specified multiple times.</p></div>
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]824</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]825<dt class="hdlist1">
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]826--compose
827</dt>
828<dd>
829<p>
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]830 Invoke a text editor (see GIT_EDITOR in <a href="git-var.html">git-var(1)</a>)
Junio C Hamano3b70d3c2009-11-21 17:37:37[diff] [blame]831 to edit an introductory message for the patch series.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]832</p>
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]833<div class="paragraph"><p>When <code>--compose</code> is used, git send-email will use the From, Subject, and
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]834In-Reply-To headers specified in the message. If the body of the message
835(what you type after the headers and a blank line) only contains blank
Junio C Hamanoe1aeb5e2014-06-06 19:16:29[diff] [blame]836(or Git: prefixed) lines, the summary won&#8217;t be sent, but From, Subject,
Junio C Hamanoea82cff2009-03-18 01:54:48[diff] [blame]837and In-Reply-To headers will be used unless they are removed.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]838<div class="paragraph"><p>Missing From or In-Reply-To headers will be prompted for.</p></div>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]839<div class="paragraph"><p>See the CONFIGURATION section for <code>sendemail.multiEdit</code>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]840</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]841<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]842--from=&lt;address&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]843</dt>
844<dd>
845<p>
Junio C Hamano7ae18252009-05-23 09:53:32[diff] [blame]846 Specify the sender of the emails. If not specified on the command line,
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]847 the value of the <code>sendemail.from</code> configuration option is used. If
848 neither the command-line option nor <code>sendemail.from</code> are set, then the
Junio C Hamano7ae18252009-05-23 09:53:32[diff] [blame]849 user will be prompted for the value. The default for the prompt will be
850 the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
851 set, as returned by "git var -l".
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]852</p>
853</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]854<dt class="hdlist1">
Junio C Hamano8b40d4b2018-03-15 22:52:33[diff] [blame]855--reply-to=&lt;address&gt;
856</dt>
857<dd>
858<p>
859 Specify the address where replies from recipients should go to.
860 Use this if replies to messages should go to another address than what
861 is specified with the --from parameter.
862</p>
863</dd>
864<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]865--in-reply-to=&lt;identifier&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]866</dt>
867<dd>
868<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]869 Make the first mail (or all the mails with <code>--no-thread</code>) appear as a
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]870 reply to the given Message-Id, which avoids breaking threads to
871 provide a new patch series.
872 The second and subsequent emails will be sent as replies according to
Junio C Hamanocb06ef92017-03-21 22:40:14[diff] [blame]873 the <code>--[no-]chain-reply-to</code> setting.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]874</p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]875<div class="paragraph"><p>So for example when <code>--thread</code> and <code>--no-chain-reply-to</code> are specified, the
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]876second and subsequent patches will be replies to the first one like in the
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]877illustration below where <code>[PATCH v2 0/3]</code> is in reply to <code>[PATCH 0/2]</code>:</p></div>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]878<div class="literalblock">
879<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]880<pre><code>[PATCH 0/2] Here is what I did...
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]881 [PATCH 1/2] Clean up and tests
882 [PATCH 2/2] Implementation
883 [PATCH v2 0/3] Here is a reroll
884 [PATCH v2 1/3] Clean up
885 [PATCH v2 2/3] New tests
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]886 [PATCH v2 3/3] Implementation</code></pre>
Junio C Hamano97bcb482010-11-25 03:16:07[diff] [blame]887</div></div>
888<div class="paragraph"><p>Only necessary if --compose is also set. If --compose
889is not set, this will be prompted for.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]890</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]891<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]892--subject=&lt;string&gt;
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]893</dt>
894<dd>
895<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]896 Specify the initial subject of the email thread.
897 Only necessary if --compose is also set. If --compose
898 is not set, this will be prompted for.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]899</p>
900</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]901<dt class="hdlist1">
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]902--to=&lt;address&gt;,&#8230;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]903</dt>
904<dd>
905<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]906 Specify the primary recipient of the emails generated. Generally, this
907 will be the upstream maintainer of the project involved. Default is the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]908 value of the <code>sendemail.to</code> configuration value; if that is unspecified,
Junio C Hamano39c7a692010-10-27 06:08:54[diff] [blame]909 and --to-cmd is not specified, this will be prompted for.
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]910</p>
Junio C Hamanod7ed4042015-08-03 19:43:00[diff] [blame]911<div class="paragraph"><p>This option may be specified multiple times.</p></div>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]912</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]913<dt class="hdlist1">
Junio C Hamano4015aed2010-06-27 20:07:42[diff] [blame]914--8bit-encoding=&lt;encoding&gt;
915</dt>
916<dd>
917<p>
918 When encountering a non-ASCII message or subject that does not
919 declare its encoding, add headers/quoting to indicate it is
920 encoded in &lt;encoding&gt;. Default is the value of the
921 <em>sendemail.assume8bitEncoding</em>; if that is unspecified, this
922 will be prompted for if any non-ASCII files are encountered.
923</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]924<div class="paragraph"><p>Note that no attempts whatsoever are made to validate the encoding.</p></div>
Junio C Hamano4015aed2010-06-27 20:07:42[diff] [blame]925</dd>
Junio C Hamanoa1295452012-11-13 22:32:04[diff] [blame]926<dt class="hdlist1">
927--compose-encoding=&lt;encoding&gt;
928</dt>
929<dd>
930<p>
931 Specify encoding of compose message. Default is the value of the
932 <em>sendemail.composeencoding</em>; if that is unspecified, UTF-8 is assumed.
933</p>
934</dd>
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]935<dt class="hdlist1">
Junio C Hamano1ff03382018-07-25 22:10:48[diff] [blame]936--transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]937</dt>
938<dd>
939<p>
940 Specify the transfer encoding to be used to send the message over SMTP.
941 7bit will fail upon encountering a non-ASCII message. quoted-printable
942 can be useful when the repository contains files that contain carriage
943 returns, but makes the raw patch email file (as saved from a MUA) much
944 harder to inspect manually. base64 is even more fool proof, but also
Junio C Hamano1ff03382018-07-25 22:10:48[diff] [blame]945 even more opaque. auto will use 8bit when possible, and quoted-printable
946 otherwise.
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]947</p>
Junio C Hamano1ff03382018-07-25 22:10:48[diff] [blame]948<div class="paragraph"><p>Default is the value of the <code>sendemail.transferEncoding</code> configuration
949value; if that is unspecified, default to <code>auto</code>.</p></div>
Junio C Hamano6df93d92014-12-22 22:48:09[diff] [blame]950</dd>
Junio C Hamanoc9394b22015-01-07 22:45:48[diff] [blame]951<dt class="hdlist1">
952--xmailer
953</dt>
954<dt class="hdlist1">
955--no-xmailer
956</dt>
957<dd>
958<p>
959 Add (or prevent adding) the "X-Mailer:" header. By default,
960 the header is added, but it can be turned off by setting the
961 <code>sendemail.xmailer</code> configuration variable to <code>false</code>.
962</p>
963</dd>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]964</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]965</div>
966<div class="sect2">
967<h3 id="_sending">Sending</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]968<div class="dlist"><dl>
969<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]970--envelope-sender=&lt;address&gt;
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]971</dt>
972<dd>
973<p>
974 Specify the envelope sender used to send the emails.
975 This is useful if your default address is not the address that is
Junio C Hamano2bd8a742009-12-01 21:16:59[diff] [blame]976 subscribed to a list. In order to use the <em>From</em> address, set the
977 value to "auto". If you use the sendmail binary, you must have
978 suitable privileges for the -f parameter. Default is the value of the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]979 <code>sendemail.envelopeSender</code> configuration variable; if that is
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]980 unspecified, choosing the envelope sender is left to your MTA.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]981</p>
982</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]983<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]984--smtp-encryption=&lt;encryption&gt;
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]985</dt>
986<dd>
987<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]988 Specify the encryption to use, either <em>ssl</em> or <em>tls</em>. Any other
989 value reverts to plain SMTP. Default is the value of
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]990 <code>sendemail.smtpEncryption</code>.
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]991</p>
992</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]993<dt class="hdlist1">
Junio C Hamanocb39aea2010-05-09 07:24:48[diff] [blame]994--smtp-domain=&lt;FQDN&gt;
995</dt>
996<dd>
997<p>
998 Specifies the Fully Qualified Domain Name (FQDN) used in the
999 HELO/EHLO command to the SMTP server. Some servers require the
1000 FQDN to match your IP address. If not set, git send-email attempts
1001 to determine your FQDN automatically. Default is the value of
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1002 <code>sendemail.smtpDomain</code>.
Junio C Hamanocb39aea2010-05-09 07:24:48[diff] [blame]1003</p>
1004</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1005<dt class="hdlist1">
Junio C Hamanoa1746be2015-08-26 23:07:07[diff] [blame]1006--smtp-auth=&lt;mechanisms&gt;
1007</dt>
1008<dd>
1009<p>
1010 Whitespace-separated list of allowed SMTP-AUTH mechanisms. This setting
1011 forces using only the listed mechanisms. Example:
1012</p>
1013<div class="listingblock">
1014<div class="content">
1015<pre><code>$ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...</code></pre>
1016</div></div>
1017<div class="paragraph"><p>If at least one of the specified mechanisms matches the ones advertised by the
1018SMTP server and if it is supported by the utilized SASL library, the mechanism
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1019is used for authentication. If neither <em>sendemail.smtpAuth</em> nor <code>--smtp-auth</code>
Junio C Hamano46fbbcb2018-11-07 03:54:16[diff] [blame]1020is specified, all mechanisms supported by the SASL library can be used. The
1021special value <em>none</em> maybe specified to completely disable authentication
1022independently of <code>--smtp-user</code></p></div>
Junio C Hamanoa1746be2015-08-26 23:07:07[diff] [blame]1023</dd>
1024<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1025--smtp-pass[=&lt;password&gt;]
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1026</dt>
1027<dd>
1028<p>
1029 Password for SMTP-AUTH. The argument is optional: If no
1030 argument is specified, then the empty string is used as
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1031 the password. Default is the value of <code>sendemail.smtpPass</code>,
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1032 however <code>--smtp-pass</code> always overrides this value.
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1033</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1034<div class="paragraph"><p>Furthermore, passwords need not be specified in configuration files
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1035or on the command line. If a username has been specified (with
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1036<code>--smtp-user</code> or a <code>sendemail.smtpUser</code>), but no password has been
1037specified (with <code>--smtp-pass</code> or <code>sendemail.smtpPass</code>), then
Junio C Hamano5e7f1312013-03-21 22:49:01[diff] [blame]1038a password is obtained using <em>git-credential</em>.</p></div>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1039</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1040<dt class="hdlist1">
Junio C Hamano46fbbcb2018-11-07 03:54:16[diff] [blame]1041--no-smtp-auth
1042</dt>
1043<dd>
1044<p>
1045 Disable SMTP authentication. Short hand for <code>--smtp-auth=none</code>
1046</p>
1047</dd>
1048<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1049--smtp-server=&lt;host&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1050</dt>
1051<dd>
1052<p>
Junio C Hamanob63afff2007-05-01 03:05:55[diff] [blame]1053 If set, specifies the outgoing SMTP server to use (e.g.
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1054 <code>smtp.example.com</code> or a raw IP address). Alternatively it can
Junio C Hamanob63afff2007-05-01 03:05:55[diff] [blame]1055 specify a full pathname of a sendmail-like program instead;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1056 the program must support the <code>-i</code> option. Default value can
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1057 be specified by the <code>sendemail.smtpServer</code> configuration
Junio C Hamano371470a2017-12-13 22:26:40[diff] [blame]1058 option; the built-in default is to search for <code>sendmail</code> in
1059 <code>/usr/sbin</code>, <code>/usr/lib</code> and $PATH if such program is
1060 available, falling back to <code>localhost</code> otherwise.
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1061</p>
1062</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1063<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1064--smtp-server-port=&lt;port&gt;
Junio C Hamano4fd58d42007-09-30 00:51:14[diff] [blame]1065</dt>
1066<dd>
1067<p>
1068 Specifies a port different from the default port (SMTP
Junio C Hamanobacccda2009-08-03 08:07:12[diff] [blame]1069 servers typically listen to smtp port 25, but may also listen to
1070 submission port 587, or the common SSL smtp port 465);
1071 symbolic port names (e.g. "submission" instead of 587)
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]1072 are also accepted. The port can also be set with the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1073 <code>sendemail.smtpServerPort</code> configuration variable.
Junio C Hamanofce7c7e2008-07-02 03:06:38[diff] [blame]1074</p>
1075</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1076<dt class="hdlist1">
Junio C Hamano39c7a692010-10-27 06:08:54[diff] [blame]1077--smtp-server-option=&lt;option&gt;
1078</dt>
1079<dd>
1080<p>
1081 If set, specifies the outgoing SMTP server option to use.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1082 Default value can be specified by the <code>sendemail.smtpServerOption</code>
Junio C Hamano39c7a692010-10-27 06:08:54[diff] [blame]1083 configuration option.
1084</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1085<div class="paragraph"><p>The --smtp-server-option option must be repeated for each option you want
Junio C Hamano39c7a692010-10-27 06:08:54[diff] [blame]1086to pass to the server. Likewise, different lines in the configuration files
1087must be used for each option.</p></div>
1088</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1089<dt class="hdlist1">
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]1090--smtp-ssl
1091</dt>
1092<dd>
1093<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1094 Legacy alias for <em>--smtp-encryption ssl</em>.
Junio C Hamano68522892007-09-06 01:33:41[diff] [blame]1095</p>
1096</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1097<dt class="hdlist1">
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]1098--smtp-ssl-cert-path
1099</dt>
1100<dd>
1101<p>
Junio C Hamanoe8acc8e2015-01-14 22:01:34[diff] [blame]1102 Path to a store of trusted CA certificates for SMTP SSL/TLS
1103 certificate validation (either a directory that has been processed
1104 by <em>c_rehash</em>, or a single file containing one or more PEM format
1105 certificates concatenated together: see verify(1) -CAfile and
1106 -CApath for more information on these). Set it to an empty string
1107 to disable certificate verification. Defaults to the value of the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1108 <code>sendemail.smtpsslcertpath</code> configuration variable, if set, or the
Junio C Hamanoe8acc8e2015-01-14 22:01:34[diff] [blame]1109 backing SSL library&#8217;s compiled-in default otherwise (which should
1110 be the best choice on most platforms).
Junio C Hamano58f587a2013-07-22 19:20:59[diff] [blame]1111</p>
1112</dd>
1113<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1114--smtp-user=&lt;user&gt;
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]1115</dt>
1116<dd>
1117<p>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1118 Username for SMTP-AUTH. Default is the value of <code>sendemail.smtpUser</code>;
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1119 if a username is not specified (with <code>--smtp-user</code> or <code>sendemail.smtpUser</code>),
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1120 then authentication is not attempted.
1121</p>
1122</dd>
Junio C Hamano6ebd8042012-02-28 00:17:40[diff] [blame]1123<dt class="hdlist1">
1124--smtp-debug=0|1
1125</dt>
1126<dd>
1127<p>
1128 Enable (1) or disable (0) debug output. If enabled, SMTP
1129 commands and replies will be printed. Useful to debug TLS
1130 connection and authentication problems.
1131</p>
1132</dd>
Junio C Hamano08a3a232017-07-07 02:28:44[diff] [blame]1133<dt class="hdlist1">
1134--batch-size=&lt;num&gt;
1135</dt>
1136<dd>
1137<p>
1138 Some email servers (e.g. smtp.163.com) limit the number emails to be
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]1139 sent per session (connection) and this will lead to a failure when
Junio C Hamano08a3a232017-07-07 02:28:44[diff] [blame]1140 sending many messages. With this option, send-email will disconnect after
1141 sending $&lt;num&gt; messages and wait for a few seconds (see --relogin-delay)
1142 and reconnect, to work around such a limit. You may want to
1143 use some form of credential helper to avoid having to retype
1144 your password every time this happens. Defaults to the
1145 <code>sendemail.smtpBatchSize</code> configuration variable.
1146</p>
1147</dd>
1148<dt class="hdlist1">
1149--relogin-delay=&lt;int&gt;
1150</dt>
1151<dd>
1152<p>
1153 Waiting $&lt;int&gt; seconds before reconnecting to SMTP server. Used together
1154 with --batch-size option. Defaults to the <code>sendemail.smtpReloginDelay</code>
1155 configuration variable.
1156</p>
1157</dd>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1158</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1159</div>
1160<div class="sect2">
1161<h3 id="_automating">Automating</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1162<div class="dlist"><dl>
1163<dt class="hdlist1">
Junio C Hamano51937872019-06-13 22:09:30[diff] [blame]1164--no-[to|cc|bcc]
1165</dt>
1166<dd>
1167<p>
1168 Clears any list of "To:", "Cc:", "Bcc:" addresses previously
1169 set via config.
1170</p>
1171</dd>
1172<dt class="hdlist1">
1173--no-identity
1174</dt>
1175<dd>
1176<p>
1177 Clears the previously read value of <code>sendemail.identity</code> set
1178 via config, if any.
1179</p>
1180</dd>
1181<dt class="hdlist1">
Junio C Hamano39c7a692010-10-27 06:08:54[diff] [blame]1182--to-cmd=&lt;command&gt;
1183</dt>
1184<dd>
1185<p>
1186 Specify a command to execute once per patch file which
1187 should generate patch file specific "To:" entries.
1188 Output of this command must be single email address per line.
1189 Default is the value of <em>sendemail.tocmd</em> configuration value.
1190</p>
1191</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1192<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1193--cc-cmd=&lt;command&gt;
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1194</dt>
1195<dd>
1196<p>
1197 Specify a command to execute once per patch file which
1198 should generate patch file specific "Cc:" entries.
1199 Output of this command must be single email address per line.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1200 Default is the value of <code>sendemail.ccCmd</code> configuration value.
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]1201</p>
1202</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1203<dt class="hdlist1">
Junio C Hamano25e7ba62009-06-14 01:03:22[diff] [blame]1204--[no-]chain-reply-to
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]1205</dt>
1206<dd>
1207<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1208 If this is set, each email will be sent as a reply to the previous
1209 email sent. If disabled with "--no-chain-reply-to", all emails after
1210 the first will be sent as replies to the first email sent. When using
1211 this, it is recommended that the first file given be an overview of the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1212 entire patch series. Disabled by default, but the <code>sendemail.chainReplyTo</code>
Junio C Hamano096dde22009-12-26 23:14:11[diff] [blame]1213 configuration variable can be used to enable it.
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1214</p>
1215</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1216<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1217--identity=&lt;identity&gt;
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1218</dt>
1219<dd>
1220<p>
1221 A configuration identity. When given, causes values in the
1222 <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over
1223 values in the <em>sendemail</em> section. The default identity is
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1224 the value of <code>sendemail.identity</code>.
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1225</p>
1226</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1227<dt class="hdlist1">
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1228--[no-]signed-off-by-cc
1229</dt>
1230<dd>
1231<p>
1232 If this is set, add emails found in Signed-off-by: or Cc: lines to the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1233 cc list. Default is the value of <code>sendemail.signedoffbycc</code> configuration
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1234 value; if that is unspecified, default to --signed-off-by-cc.
Junio C Hamanoc9154122006-02-15 02:22:06[diff] [blame]1235</p>
1236</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1237<dt class="hdlist1">
Junio C Hamano45f804f2014-06-20 22:24:49[diff] [blame]1238--[no-]cc-cover
1239</dt>
1240<dd>
1241<p>
1242 If this is set, emails found in Cc: headers in the first patch of
1243 the series (typically the cover letter) are added to the cc list
1244 for each email set. Default is the value of <em>sendemail.cccover</em>
1245 configuration value; if that is unspecified, default to --no-cc-cover.
1246</p>
1247</dd>
1248<dt class="hdlist1">
1249--[no-]to-cover
1250</dt>
1251<dd>
1252<p>
1253 If this is set, emails found in To: headers in the first patch of
1254 the series (typically the cover letter) are added to the to list
1255 for each email set. Default is the value of <em>sendemail.tocover</em>
1256 configuration value; if that is unspecified, default to --no-to-cover.
1257</p>
1258</dd>
1259<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1260--suppress-cc=&lt;category&gt;
Junio C Hamano9c334152008-02-12 03:18:52[diff] [blame]1261</dt>
1262<dd>
1263<p>
1264 Specify an additional category of recipients to suppress the
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1265 auto-cc of:
Junio C Hamano9c334152008-02-12 03:18:52[diff] [blame]1266</p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1267<div class="openblock">
1268<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1269<div class="ulist"><ul>
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1270<li>
1271<p>
Junio C Hamano94d00a52018-10-30 07:34:40[diff] [blame]1272<em>author</em> will avoid including the patch author.
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1273</p>
1274</li>
1275<li>
1276<p>
Junio C Hamano94d00a52018-10-30 07:34:40[diff] [blame]1277<em>self</em> will avoid including the sender.
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1278</p>
1279</li>
1280<li>
1281<p>
1282<em>cc</em> will avoid including anyone mentioned in Cc lines in the patch header
1283 except for self (use <em>self</em> for that).
1284</p>
1285</li>
1286<li>
1287<p>
Junio C Hamano0e88f3e2009-06-21 08:03:25[diff] [blame]1288<em>bodycc</em> will avoid including anyone mentioned in Cc lines in the
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1289 patch body (commit message) except for self (use <em>self</em> for that).
1290</p>
1291</li>
1292<li>
1293<p>
1294<em>sob</em> will avoid including anyone mentioned in Signed-off-by lines except
Junio C Hamano94d00a52018-10-30 07:34:40[diff] [blame]1295 for self (use <em>self</em> for that).
1296</p>
1297</li>
1298<li>
1299<p>
1300<em>misc-by</em> will avoid including anyone mentioned in Acked-by,
1301 Reviewed-by, Tested-by and other "-by" lines in the patch body,
1302 except Signed-off-by (use <em>sob</em> for that).
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1303</p>
1304</li>
1305<li>
1306<p>
1307<em>cccmd</em> will avoid running the --cc-cmd.
1308</p>
1309</li>
1310<li>
1311<p>
Junio C Hamano94d00a52018-10-30 07:34:40[diff] [blame]1312<em>body</em> is equivalent to <em>sob</em> + <em>bodycc</em> + <em>misc-by</em>.
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1313</p>
1314</li>
1315<li>
1316<p>
1317<em>all</em> will suppress all auto cc values.
1318</p>
1319</li>
1320</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1321</div></div>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1322<div class="paragraph"><p>Default is the value of <code>sendemail.suppresscc</code> configuration value; if
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1323that is unspecified, default to <em>self</em> if --suppress-from is
1324specified, 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]1325</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1326<dt class="hdlist1">
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1327--[no-]suppress-from
Junio C Hamanoeb415992008-06-08 22:49:47[diff] [blame]1328</dt>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1329<dd>
1330<p>
1331 If this is set, do not add the From: address to the cc: list.
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1332 Default is the value of <code>sendemail.suppressFrom</code> configuration
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1333 value; if that is unspecified, default to --no-suppress-from.
1334</p>
1335</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1336<dt class="hdlist1">
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1337--[no-]thread
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]1338</dt>
1339<dd>
1340<p>
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]1341 If this is set, the In-Reply-To and References headers will be
1342 added to each email sent. Whether each mail refers to the
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1343 previous email (<code>deep</code> threading per <em>git format-patch</em>
1344 wording) or to the first email (<code>shallow</code> threading) is
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]1345 governed by "--[no-]chain-reply-to".
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]1346</p>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1347<div class="paragraph"><p>If disabled with "--no-thread", those headers will not be added
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]1348(unless specified with --in-reply-to). Default is the value of the
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1349<code>sendemail.thread</code> configuration value; if that is unspecified,
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]1350default to --thread.</p></div>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1351<div class="paragraph"><p>It is up to the user to ensure that no In-Reply-To header already
Junio C Hamano1bbd0f42009-07-23 06:20:29[diff] [blame]1352exists when <em>git send-email</em> is asked to add it (especially note that
1353<em>git format-patch</em> can be configured to do the threading itself).
1354Failure to do so may not produce the expected result in the
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1355recipient&#8217;s MUA.</p></div>
Junio C Hamanoddc5ad42007-06-27 07:14:52[diff] [blame]1356</dd>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1357</dl></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1358</div>
1359<div class="sect2">
1360<h3 id="_administering">Administering</h3>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1361<div class="dlist"><dl>
1362<dt class="hdlist1">
Junio C Hamanob4a9ede2009-04-08 07:36:32[diff] [blame]1363--confirm=&lt;mode&gt;
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1364</dt>
1365<dd>
1366<p>
1367 Confirm just before sending:
1368</p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1369<div class="openblock">
1370<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1371<div class="ulist"><ul>
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1372<li>
1373<p>
1374<em>always</em> will always confirm before sending
1375</p>
1376</li>
1377<li>
1378<p>
1379<em>never</em> will never confirm before sending
1380</p>
1381</li>
1382<li>
1383<p>
1384<em>cc</em> will confirm before sending when send-email has automatically
1385 added addresses from the patch to the Cc list
1386</p>
1387</li>
1388<li>
1389<p>
1390<em>compose</em> will confirm before sending the first message when using --compose.
1391</p>
1392</li>
1393<li>
1394<p>
1395<em>auto</em> is equivalent to <em>cc</em> + <em>compose</em>
1396</p>
1397</li>
1398</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1399</div></div>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1400<div class="paragraph"><p>Default is the value of <code>sendemail.confirm</code> configuration value; if that
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1401is unspecified, default to <em>auto</em> unless any of the suppress options
1402have been specified, in which case default to <em>compose</em>.</p></div>
1403</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1404<dt class="hdlist1">
Junio C Hamano45889b42007-04-26 07:20:04[diff] [blame]1405--dry-run
1406</dt>
1407<dd>
1408<p>
1409 Do everything except actually send the emails.
1410</p>
1411</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1412<dt class="hdlist1">
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]1413--[no-]format-patch
1414</dt>
1415<dd>
1416<p>
1417 When an argument may be understood either as a reference or as a file name,
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1418 choose to understand it as a format-patch argument (<code>--format-patch</code>)
1419 or as a file name (<code>--no-format-patch</code>). By default, when such a conflict
Junio C Hamano3d141512009-06-01 01:22:40[diff] [blame]1420 occurs, git send-email will fail.
1421</p>
1422</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1423<dt class="hdlist1">
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1424--quiet
Junio C Hamano45889b42007-04-26 07:20:04[diff] [blame]1425</dt>
1426<dd>
1427<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1428 Make git-send-email less verbose. One line per email should be
1429 all that is output.
Junio C Hamano45889b42007-04-26 07:20:04[diff] [blame]1430</p>
1431</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1432<dt class="hdlist1">
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1433--[no-]validate
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]1434</dt>
1435<dd>
1436<p>
Junio C Hamanoa476efa2008-10-10 15:31:42[diff] [blame]1437 Perform sanity checks on patches.
1438 Currently, validation means the following:
Junio C Hamano86f75882006-02-06 02:27:23[diff] [blame]1439</p>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1440<div class="openblock">
1441<div class="content">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1442<div class="ulist"><ul>
Junio C Hamano2fa431b2008-12-28 01:26:23[diff] [blame]1443<li>
1444<p>
Junio C Hamanod88ba732017-05-30 04:14:20[diff] [blame]1445Invoke the sendemail-validate hook if present (see <a href="githooks.html">githooks(5)</a>).
1446</p>
1447</li>
1448<li>
1449<p>
Junio C Hamano1ff03382018-07-25 22:10:48[diff] [blame]1450Warn of patches that contain lines longer than
1451 998 characters unless a suitable transfer encoding
1452 (<em>auto</em>, <em>base64</em>, or <em>quoted-printable</em>) is used;
1453 this is due to SMTP limits as described by
1454 <a href="http://www.ietf.org/rfc/rfc5322.txt">http://www.ietf.org/rfc/rfc5322.txt</a>.
Junio C Hamano2fa431b2008-12-28 01:26:23[diff] [blame]1455</p>
1456</li>
1457</ul></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1458</div></div>
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1459<div class="paragraph"><p>Default is the value of <code>sendemail.validate</code>; if this is not set,
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1460default to <code>--validate</code>.</p></div>
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]1461</dd>
Junio C Hamanocf29d332010-12-11 07:28:56[diff] [blame]1462<dt class="hdlist1">
1463--force
1464</dt>
1465<dd>
1466<p>
1467 Send emails even if safety checks would prevent it.
1468</p>
1469</dd>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]1470</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1471</div>
Junio C Hamanoabb8a052015-12-04 22:43:11[diff] [blame]1472<div class="sect2">
1473<h3 id="_information">Information</h3>
1474<div class="dlist"><dl>
1475<dt class="hdlist1">
1476--dump-aliases
1477</dt>
1478<dd>
1479<p>
1480 Instead of the normal operation, dump the shorthand alias names from
1481 the configured alias file(s), one per line in alphabetical order. Note,
1482 this only includes the alias name and not its expanded email addresses.
1483 See <em>sendemail.aliasesfile</em> for more information about aliases.
1484</p>
1485</dd>
1486</dl></div>
1487</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1488</div>
1489</div>
1490<div class="sect1">
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]1491<h2 id="_configuration">CONFIGURATION</h2>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]1492<div class="sectionbody">
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1493<div class="dlist"><dl>
1494<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1495sendemail.aliasesFile
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]1496</dt>
1497<dd>
1498<p>
1499 To avoid typing long email addresses, point this to one or more
Junio C Hamano042f2142016-06-27 18:05:05[diff] [blame]1500 email aliases files. You must also supply <code>sendemail.aliasFileType</code>.
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]1501</p>
1502</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1503<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1504sendemail.aliasFileType
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]1505</dt>
1506<dd>
1507<p>
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1508 Format of the file(s) specified in sendemail.aliasesFile. Must be
Junio C Hamanoce447ab2015-06-16 22:08:01[diff] [blame]1509 one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, <em>elm</em>, or <em>gnus</em>, or <em>sendmail</em>.
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]1510</p>
Junio C Hamanoce447ab2015-06-16 22:08:01[diff] [blame]1511<div class="paragraph"><p>What an alias file in each format looks like can be found in
1512the documentation of the email program of the same name. The
1513differences and limitations from the standard formats are
1514described below:</p></div>
1515<div class="openblock">
1516<div class="content">
1517<div class="dlist"><dl>
1518<dt class="hdlist1">
1519sendmail
1520</dt>
1521<dd>
1522<div class="ulist"><ul>
1523<li>
1524<p>
1525Quoted aliases and quoted addresses are not supported: lines that
1526 contain a <code>"</code> symbol are ignored.
1527</p>
1528</li>
1529<li>
1530<p>
Junio C Hamanodf5384b2015-06-24 21:12:12[diff] [blame]1531Redirection to a file (<code>/path/name</code>) or pipe (<code>|command</code>) is not
1532 supported.
1533</p>
1534</li>
1535<li>
1536<p>
1537File inclusion (<code>:include: /path/name</code>) is not supported.
Junio C Hamanoce447ab2015-06-16 22:08:01[diff] [blame]1538</p>
1539</li>
1540<li>
1541<p>
1542Warnings are printed on the standard error output for any
1543 explicitly unsupported constructs, and any other lines that are not
1544 recognized by the parser.
1545</p>
1546</li>
1547</ul></div>
1548</dd>
1549</dl></div>
1550</div></div>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]1551</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1552<dt class="hdlist1">
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1553sendemail.multiEdit
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]1554</dt>
1555<dd>
1556<p>
1557 If true (default), a single editor instance will be spawned to edit
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1558 files you have to edit (patches when <code>--annotate</code> is used, and the
1559 summary when <code>--compose</code> is used). If false, files will be edited one
Junio C Hamano610d1762008-11-28 06:27:13[diff] [blame]1560 after the other, spawning a new editor each time.
1561</p>
1562</dd>
Junio C Hamano68cf15a2010-11-06 01:01:59[diff] [blame]1563<dt class="hdlist1">
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1564sendemail.confirm
1565</dt>
1566<dd>
1567<p>
1568 Sets the default for whether to confirm before sending. Must be
Junio C Hamano92d80372016-07-13 22:00:05[diff] [blame]1569 one of <em>always</em>, <em>never</em>, <em>cc</em>, <em>compose</em>, or <em>auto</em>. See <code>--confirm</code>
Junio C Hamano0a235222009-03-06 08:21:09[diff] [blame]1570 in the previous section for the meaning of these values.
1571</p>
1572</dd>
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]1573</dl></div>
Junio C Hamanoc51fede2007-03-12 07:29:20[diff] [blame]1574</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1575</div>
1576<div class="sect1">
Junio C Hamanob9d9d902018-05-23 07:07:42[diff] [blame]1577<h2 id="_examples">EXAMPLES</h2>
Junio C Hamanofacbe512010-05-05 02:42:36[diff] [blame]1578<div class="sectionbody">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1579<div class="sect2">
1580<h3 id="_use_gmail_as_the_smtp_server">Use gmail as the smtp server</h3>
Junio C Hamanob77f8192011-05-05 01:30:38[diff] [blame]1581<div class="paragraph"><p>To use <em>git send-email</em> to send your patches through the GMail SMTP server,
1582edit ~/.gitconfig to specify your account settings:</p></div>
Junio C Hamano48cd3f12019-10-09 05:55:30[diff] [blame]1583<div class="listingblock">
Junio C Hamanofacbe512010-05-05 02:42:36[diff] [blame]1584<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1585<pre><code>[sendemail]
Junio C Hamano322c6242015-03-23 21:32:46[diff] [blame]1586 smtpEncryption = tls
1587 smtpServer = smtp.gmail.com
1588 smtpUser = yourname@gmail.com
1589 smtpServerPort = 587</code></pre>
Junio C Hamanofacbe512010-05-05 02:42:36[diff] [blame]1590</div></div>
Junio C Hamano5213c3b2016-06-03 23:34:40[diff] [blame]1591<div class="paragraph"><p>If you have multifactor authentication setup on your gmail account, you will
Junio C Hamano37cf4082016-05-30 01:22:14[diff] [blame]1592need to generate an app-specific password for use with <em>git send-email</em>. Visit
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]1593<a href="https://security.google.com/settings/security/apppasswords">https://security.google.com/settings/security/apppasswords</a> to create it.</p></div>
Junio C Hamanob77f8192011-05-05 01:30:38[diff] [blame]1594<div class="paragraph"><p>Once your commits are ready to be sent to the mailing list, run the
1595following commands:</p></div>
1596<div class="literalblock">
1597<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1598<pre><code>$ git format-patch --cover-letter -M origin/master -o outgoing/
Junio C Hamanob77f8192011-05-05 01:30:38[diff] [blame]1599$ edit outgoing/0000-*
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1600$ git send-email outgoing/*</code></pre>
Junio C Hamanob77f8192011-05-05 01:30:38[diff] [blame]1601</div></div>
Junio C Hamano96153bf2018-04-25 08:25:34[diff] [blame]1602<div class="paragraph"><p>The first time you run it, you will be prompted for your credentials. Enter the
1603app-specific or your regular password as appropriate. If you have credential
1604helper configured (see <a href="git-credential.html">git-credential(1)</a>), the password will be saved in
1605the credential store so you won&#8217;t have to type it the next time.</p></div>
Junio C Hamanod0a99402019-06-21 18:58:41[diff] [blame]1606<div class="paragraph"><p>Note: the following core Perl modules that may be installed with your
1607distribution of Perl are required:
1608MIME::Base64, MIME::QuotedPrint, Net::Domain and Net::SMTP.
1609These additional Perl modules are also required:
1610Authen::SASL and Mail::Address.</p></div>
Junio C Hamanofacbe512010-05-05 02:42:36[diff] [blame]1611</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1612</div>
1613</div>
1614<div class="sect1">
Junio C Hamanob77f8192011-05-05 01:30:38[diff] [blame]1615<h2 id="_see_also">SEE ALSO</h2>
1616<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1617<div class="paragraph"><p><a href="git-format-patch.html">git-format-patch(1)</a>, <a href="git-imap-send.html">git-imap-send(1)</a>, mbox(5)</p></div>
Junio C Hamanob77f8192011-05-05 01:30:38[diff] [blame]1618</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1619</div>
1620<div class="sect1">
Junio C Hamano9e395072008-07-31 22:11:21[diff] [blame]1621<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1622<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1623<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1624</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1625</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1626</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1627<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1628<div id="footer">
1629<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:53[diff] [blame]1630Last updated
Junio C Hamano7a46cd62020-03-15 21:57:10[diff] [blame]1631 2020-03-10 08:03:13 PDT
Junio C Hamano1a4e8412005-12-27 08:17:23[diff] [blame]1632</div>
1633</div>
1634</body>
1635</html>