doc: convert git-send-email synopsis and options to new style
Replace [verse] with [synopsis] in the SYNOPSIS block and remove single-quote formatting from the command name. Backtick-quote all option terms in the OPTIONS section, convert the standalone placeholder _<encoding>_ in prose, fix single-quoted server names to backtick form, and convert mbox(5) to `mbox`(5). Also update config/sendemail.adoc: backtick-quote all configuration key terms and fix a bare sendemail.aliasesFile reference in prose. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Jul 23, 2026 at 21:19 UTC
8f41ed137fc9547cad520c5c97638a3a7dfe004b
2 files changed
+127
-127
Documentation/config/sendemail.adoc
+46
-46
@@ -1,25 +1,25 @@
1
-sendemail.identity::
1
+`sendemail.identity`::
2
A configuration identity. When given, causes values in the
3
`sendemail.<identity>` subsection to take precedence over
4
values in the `sendemail` section. The default identity is
5
the value of `sendemail.identity`.
6
7
-sendemail.smtpEncryption::
7
+`sendemail.smtpEncryption`::
8
See linkgit:git-send-email[1] for description. Note that this
9
setting is not subject to the `identity` mechanism.
10
11
-sendemail.smtpSSLCertPath::
11
+`sendemail.smtpSSLCertPath`::
12
Path to ca-certificates (either a directory or a single file).
13
Set it to an empty string to disable certificate verification.
14
15
-sendemail.smtpSSLClientCert::
15
+`sendemail.smtpSSLClientCert`::
16
Path to the client certificate file to present if requested by the
17
server. This is required when the server is set up to verify client
18
certificates. If the corresponding private key is not included in the
19
file, it must be supplied using `sendemail.smtpSSLClientKey` or the
20
`--smtp-ssl-client-key` option.
21
22
-sendemail.smtpSSLClientKey::
22
+`sendemail.smtpSSLClientKey`::
23
Path to the client private key file that corresponds to the client
24
certificate. To avoid misconfiguration, this configuration must be used
25
in conjunction with `sendemail.smtpSSLClientCert` or the
@@ -28,45 +28,45 @@ sendemail.smtpSSLClientKey::
28
the certificate. Visit https://metacpan.org/pod/IO::Socket::SSL for more
29
details.
30
31
-sendemail.<identity>.*::
32
- Identity-specific versions of the `sendemail.*` parameters
31
+`sendemail.<identity>.<config>`::
32
+ Identity-specific versions of the `sendemail.<config>` parameters
33
found below, taking precedence over those when this
34
identity is selected, through either the command-line or
35
`sendemail.identity`.
36
37
-sendemail.multiEdit::
37
+`sendemail.multiEdit`::
38
If `true` (default), a single editor instance will be spawned to edit
39
files you have to edit (patches when `--annotate` is used, and the
40
summary when `--compose` is used). If `false`, files will be edited one
41
after the other, spawning a new editor each time.
42
43
-sendemail.confirm::
43
+`sendemail.confirm`::
44
Sets the default for whether to confirm before sending. Must be
45
one of `always`, `never`, `cc`, `compose`, or `auto`. See `--confirm`
46
in the linkgit:git-send-email[1] documentation for the meaning of these
47
values.
48
49
-sendemail.mailmap::
49
+`sendemail.mailmap`::
50
If `true`, makes linkgit:git-send-email[1] assume `--mailmap`,
51
otherwise assume `--no-mailmap`. `False` by default.
52
53
-sendemail.mailmap.file::
53
+`sendemail.mailmap.file`::
54
The location of a linkgit:git-send-email[1] specific augmenting
55
mailmap file. The default mailmap and `mailmap.file` are loaded
56
first. Thus, entries in this file take precedence over entries in
57
the default mailmap locations. See linkgit:gitmailmap[5].
58
59
-sendemail.mailmap.blob::
59
+`sendemail.mailmap.blob`::
60
Like `sendemail.mailmap.file`, but consider the value as a reference
61
to a blob in the repository. Entries in `sendemail.mailmap.file`
62
take precedence over entries here. See linkgit:gitmailmap[5].
63
64
-sendemail.aliasesFile::
64
+`sendemail.aliasesFile`::
65
To avoid typing long email addresses, point this to one or more
66
email aliases files. You must also supply `sendemail.aliasFileType`.
67
68
-sendemail.aliasFileType::
69
- Format of the file(s) specified in sendemail.aliasesFile. Must be
68
+`sendemail.aliasFileType`::
69
+ Format of the file(s) specified in `sendemail.aliasesFile`. Must be
70
one of `mutt`, `mailrc`, `pine`, `elm`, `gnus`, or `sendmail`.
71
+
72
What an alias file in each format looks like can be found in
@@ -75,7 +75,7 @@ differences and limitations from the standard formats are
75
described below:
76
+
77
--
78
-sendmail;;
78
+`sendmail`;;
79
* Quoted aliases and quoted addresses are not supported: lines that
80
contain a `"` symbol are ignored.
81
* Redirection to a file (`/path/name`) or pipe (`|command`) is not
@@ -85,54 +85,54 @@ sendmail;;
85
explicitly unsupported constructs, and any other lines that are not
86
recognized by the parser.
87
--
88
-sendemail.annotate::
89
-sendemail.bcc::
90
-sendemail.cc::
91
-sendemail.ccCmd::
92
-sendemail.chainReplyTo::
93
-sendemail.envelopeSender::
94
-sendemail.from::
95
-sendemail.headerCmd::
96
-sendemail.signedOffByCc::
97
-sendemail.smtpPass::
98
-sendemail.suppressCc::
99
-sendemail.suppressFrom::
100
-sendemail.to::
101
-sendemail.toCmd::
102
-sendemail.smtpDomain::
103
-sendemail.smtpServer::
104
-sendemail.smtpServerPort::
105
-sendemail.smtpServerOption::
106
-sendemail.smtpUser::
107
-sendemail.imapSentFolder::
108
-sendemail.useImapOnly::
109
-sendemail.thread::
110
-sendemail.transferEncoding::
111
-sendemail.validate::
112
-sendemail.xmailer::
88
+`sendemail.annotate`::
89
+`sendemail.bcc`::
90
+`sendemail.cc`::
91
+`sendemail.ccCmd`::
92
+`sendemail.chainReplyTo`::
93
+`sendemail.envelopeSender`::
94
+`sendemail.from`::
95
+`sendemail.headerCmd`::
96
+`sendemail.signedOffByCc`::
97
+`sendemail.smtpPass`::
98
+`sendemail.suppressCc`::
99
+`sendemail.suppressFrom`::
100
+`sendemail.to`::
101
+`sendemail.toCmd`::
102
+`sendemail.smtpDomain`::
103
+`sendemail.smtpServer`::
104
+`sendemail.smtpServerPort`::
105
+`sendemail.smtpServerOption`::
106
+`sendemail.smtpUser`::
107
+`sendemail.imapSentFolder`::
108
+`sendemail.useImapOnly`::
109
+`sendemail.thread`::
110
+`sendemail.transferEncoding`::
111
+`sendemail.validate`::
112
+`sendemail.xmailer`::
113
These configuration variables all provide a default for
114
linkgit:git-send-email[1] command-line options. See its
115
documentation for details.
116
117
-sendemail.outlookidfix::
117
+`sendemail.outlookidfix`::
118
If `true`, makes linkgit:git-send-email[1] assume `--outlook-id-fix`,
119
and if `false` assume `--no-outlook-id-fix`. If not specified, it will
120
behave the same way as if `--outlook-id-fix` is not specified.
121
122
-sendemail.signedOffCc (deprecated)::
122
+`sendemail.signedOffCc` (deprecated)::
123
Deprecated alias for `sendemail.signedOffByCc`.
124
125
-sendemail.smtpBatchSize::
125
+`sendemail.smtpBatchSize`::
126
Number of messages to be sent per connection, after that a relogin
127
will happen. If the value is `0` or undefined, send all messages in
128
one connection.
129
See also the `--batch-size` option of linkgit:git-send-email[1].
130
131
-sendemail.smtpReloginDelay::
131
+`sendemail.smtpReloginDelay`::
132
Seconds to wait before reconnecting to the smtp server.
133
See also the `--relogin-delay` option of linkgit:git-send-email[1].
134
135
-sendemail.forbidSendmailVariables::
135
+`sendemail.forbidSendmailVariables`::
136
To avoid common misconfiguration mistakes, linkgit:git-send-email[1]
137
will abort with a warning if any configuration options for `sendmail`
138
exist. Set this variable to bypass the check.
Documentation/git-send-email.adoc
+81
-81
@@ -8,11 +8,11 @@ git-send-email - Send a collection of patches as emails
8
9
SYNOPSIS
10
--------
11
-[verse]
12
-'git send-email' [<options>] (<file>|<directory>)...
13
-'git send-email' [<options>] <format-patch-options>
14
-'git send-email' --dump-aliases
15
-'git send-email' --translate-aliases
11
+[synopsis]
12
+git send-email [<options>] (<file>|<directory>)...
13
+git send-email [<options>] <format-patch-options>
14
+git send-email --dump-aliases
15
+git send-email --translate-aliases
16
17
18
DESCRIPTION
@@ -48,24 +48,24 @@ OPTIONS
48
Composing
49
~~~~~~~~~
50
51
---annotate::
51
+`--annotate`::
52
Review and edit each patch you're about to send. Default is the value
53
of `sendemail.annotate`. See the CONFIGURATION section for
54
`sendemail.multiEdit`.
55
56
---bcc=<address>,...::
56
+`--bcc=<address>,...`::
57
Specify a `Bcc:` value for each email. Default is the value of
58
`sendemail.bcc`.
59
+
60
This option may be specified multiple times.
61
62
---cc=<address>,...::
62
+`--cc=<address>,...`::
63
Specify a starting `Cc:` value for each email.
64
Default is the value of `sendemail.cc`.
65
+
66
This option may be specified multiple times.
67
68
---compose::
68
+`--compose`::
69
Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
70
to edit an introductory message for the patch series.
71
+
@@ -80,7 +80,7 @@ Missing `From` or `In-Reply-To` headers will be prompted for.
80
+
81
See the CONFIGURATION section for `sendemail.multiEdit`.
82
83
---from=<address>::
83
+`--from=<address>`::
84
Specify the sender of the emails. If not specified on the command line,
85
the value of the `sendemail.from` configuration option is used. If
86
neither the command-line option nor `sendemail.from` are set, then the
@@ -88,12 +88,12 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
88
the value of `GIT_AUTHOR_IDENT`, or `GIT_COMMITTER_IDENT` if that is not
89
set, as returned by `git var -l`.
90
91
---reply-to=<address>::
91
+`--reply-to=<address>`::
92
Specify the address where replies from recipients should go to.
93
Use this if replies to messages should go to another address than what
94
is specified with the `--from` parameter.
95
96
---in-reply-to=<identifier>::
96
+`--in-reply-to=<identifier>`::
97
Make the first mail (or all the mails with `--no-thread`) appear as a
98
reply to the given Message-ID, which avoids breaking threads to
99
provide a new patch series.
@@ -115,8 +115,8 @@ illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`:
115
Only necessary if `--compose` is also set. If `--compose`
116
is not set, this will be prompted for.
117
118
---outlook-id-fix::
119
---no-outlook-id-fix::
118
+`--outlook-id-fix`::
119
+`--no-outlook-id-fix`::
120
Microsoft Outlook SMTP servers discard the Message-ID sent via email and
121
assign a new random Message-ID, thus breaking threads.
122
+
@@ -126,15 +126,15 @@ threading. Use it only when you know that the server reports the
126
rewritten Message-ID the same way as Outlook servers do.
127
+
128
Without this option specified, the fix is done by default when talking
129
-to 'smtp.office365.com' or 'smtp-mail.outlook.com'. Use
129
+to `smtp.office365.com` or `smtp-mail.outlook.com`. Use
130
`--no-outlook-id-fix` to disable even when talking to these two servers.
131
132
---subject=<string>::
132
+`--subject=<string>`::
133
Specify the initial subject of the email thread.
134
Only necessary if `--compose` is also set. If `--compose`
135
is not set, this will be prompted for.
136
137
---to=<address>,...::
137
+`--to=<address>,...`::
138
Specify the primary recipient of the emails generated. Generally, this
139
will be the upstream maintainer of the project involved. Default is the
140
value of the `sendemail.to` configuration value; if that is unspecified,
@@ -142,20 +142,20 @@ to 'smtp.office365.com' or 'smtp-mail.outlook.com'. Use
142
+
143
This option may be specified multiple times.
144
145
---8bit-encoding=<encoding>::
145
+`--8bit-encoding=<encoding>`::
146
When encountering a non-ASCII message or subject that does not
147
declare its encoding, add headers/quoting to indicate it is
148
- encoded in <encoding>. Default is the value of the
148
+ encoded in _<encoding>_. Default is the value of the
149
`sendemail.assume8bitEncoding`; if that is unspecified, this
150
will be prompted for if any non-ASCII files are encountered.
151
+
152
Note that no attempts whatsoever are made to validate the encoding.
153
154
---compose-encoding=<encoding>::
154
+`--compose-encoding=<encoding>`::
155
Specify encoding of compose message. Default is the value of the
156
`sendemail.composeEncoding`; if that is unspecified, UTF-8 is assumed.
157
158
---transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
158
+`--transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)`::
159
Specify the transfer encoding to be used to send the message over SMTP.
160
`7bit` will fail upon encountering a non-ASCII message. `quoted-printable`
161
can be useful when the repository contains files that contain carriage
@@ -167,8 +167,8 @@ Note that no attempts whatsoever are made to validate the encoding.
167
Default is the value of the `sendemail.transferEncoding` configuration
168
value; if that is unspecified, default to `auto`.
169
170
---xmailer::
171
---no-xmailer::
170
+`--xmailer`::
171
+`--no-xmailer`::
172
Add (or prevent adding) the `X-Mailer:` header. By default,
173
the header is added, but it can be turned off by setting the
174
`sendemail.xmailer` configuration variable to `false`.
@@ -176,7 +176,7 @@ value; if that is unspecified, default to `auto`.
176
Sending
177
~~~~~~~
178
179
---envelope-sender=<address>::
179
+`--envelope-sender=<address>`::
180
Specify the envelope sender used to send the emails.
181
This is useful if your default address is not the address that is
182
subscribed to a list. In order to use the `From` address, set the
@@ -185,7 +185,7 @@ Sending
185
`sendemail.envelopeSender` configuration variable; if that is
186
unspecified, choosing the envelope sender is left to your MTA.
187
188
---sendmail-cmd=<command>::
188
+`--sendmail-cmd=<command>`::
189
Specify a command to run to send the email. The command should
190
be sendmail-like; specifically, it must support the `-i` option.
191
The command will be executed in the shell if necessary. Default
@@ -193,7 +193,7 @@ Sending
193
`--smtp-server` is also unspecified, `git send-email` will search
194
for `sendmail` in `/usr/sbin`, `/usr/lib` and `$PATH`.
195
196
---smtp-encryption=<encryption>::
196
+`--smtp-encryption=<encryption>`::
197
Specify in what way encrypting begins for the SMTP connection.
198
Valid values are `ssl` and `tls`. Any other value reverts to plain
199
(unencrypted) SMTP, which defaults to port 25.
@@ -207,14 +207,14 @@ Sending
207
documentation or your server configuration to make sure
208
for your own case. Default is the value of `sendemail.smtpEncryption`.
209
210
---smtp-domain=<FQDN>::
210
+`--smtp-domain=<FQDN>`::
211
Specify the Fully Qualified Domain Name (FQDN) used in the
212
HELO/EHLO command to the SMTP server. Some servers require the
213
FQDN to match your IP address. If not set, `git send-email` attempts
214
to determine your FQDN automatically. Default is the value of
215
`sendemail.smtpDomain`.
216
217
---smtp-auth=<mechanisms>::
217
+`--smtp-auth=<mechanisms>`::
218
Whitespace-separated list of allowed SMTP-AUTH mechanisms. This setting
219
forces using only the listed mechanisms. Example:
220
+
@@ -229,7 +229,7 @@ is specified, all mechanisms supported by the SASL library can be used. The
229
special value `none` maybe specified to completely disable authentication
230
independently of `--smtp-user`.
231
232
---smtp-pass[=<password>]::
232
+`--smtp-pass[=<password>]`::
233
Password for SMTP-AUTH. The argument is optional: If no
234
argument is specified, then the empty string is used as
235
the password. Default is the value of `sendemail.smtpPass`,
@@ -241,10 +241,10 @@ or on the command line. If a username has been specified (with
241
specified (with `--smtp-pass` or `sendemail.smtpPass`), then
242
a password is obtained using linkgit:git-credential[1].
243
244
---no-smtp-auth::
244
+`--no-smtp-auth`::
245
Disable SMTP authentication. Short hand for `--smtp-auth=none`.
246
247
---smtp-server=<host>::
247
+`--smtp-server=<host>`::
248
Specify the outgoing SMTP server to use (e.g.
249
`smtp.example.com` or a raw IP address). If unspecified, and if
250
`--sendmail-cmd` is also unspecified, the default is to search
@@ -257,7 +257,7 @@ option. This method does not support passing arguments or using plain
257
command names. For those use cases, consider using `--sendmail-cmd`
258
instead.
259
260
---smtp-server-port=<port>::
260
+`--smtp-server-port=<port>`::
261
Specify a port different from the default port (SMTP
262
servers typically listen to smtp port 25, but may also listen to
263
submission port 587, or the common SSL smtp port 465);
@@ -265,7 +265,7 @@ instead.
265
are also accepted. The port can also be set with the
266
`sendemail.smtpServerPort` configuration variable.
267
268
---smtp-server-option=<option>::
268
+`--smtp-server-option=<option>`::
269
Specify the outgoing SMTP server option to use.
270
Default value can be specified by the `sendemail.smtpServerOption`
271
configuration option.
@@ -274,15 +274,15 @@ The `--smtp-server-option` option must be repeated for each option you want
274
to pass to the server. Likewise, different lines in the configuration files
275
must be used for each option.
276
277
---smtp-ssl::
277
+`--smtp-ssl`::
278
Legacy alias for `--smtp-encryption ssl`.
279
280
---smtp-ssl-cert-path <path>::
280
+`--smtp-ssl-cert-path <path>`::
281
Path to a store of trusted CA certificates for SMTP SSL/TLS
282
certificate validation (either a directory that has been processed
283
by `c_rehash`, or a single file containing one or more PEM format
284
certificates concatenated together: see the description of the
285
- `-CAfile` _<file>_ and the `-CApath` _<dir>_ options of
285
+ `-CAfile <file>` and the `-CApath <dir>` options of
286
https://docs.openssl.org/master/man1/openssl-verify/
287
[OpenSSL's verify(1) manual page] for more information on these).
288
Set it to an empty string to disable certificate verification.
@@ -290,7 +290,7 @@ must be used for each option.
290
variable, if set, or the backing SSL library's compiled-in default
291
otherwise (which should be the best choice on most platforms).
292
293
---smtp-ssl-client-cert <path>::
293
+`--smtp-ssl-client-cert <path>`::
294
Path to the client certificate file to present if requested by the
295
server. This option is required when the server is set up to verify
296
client certificates. If the corresponding private key is not included in
@@ -299,7 +299,7 @@ must be used for each option.
299
to the value of the `sendemail.smtpSSLClientCert` configuration
300
variable, if set.
301
302
---smtp-ssl-client-key <path>::
302
+`--smtp-ssl-client-key <path>`::
303
Path to the client private key file that corresponds to the client
304
certificate. To avoid misconfiguration, this option must be used in
305
conjunction with the `sendemail.smtpSSLClientKey` configuration variable
@@ -309,17 +309,17 @@ must be used for each option.
309
more details. Defaults to the value of the `sendemail.smtpSSLClientKey`
310
configuration variable, if set.
311
312
---smtp-user=<user>::
312
+`--smtp-user=<user>`::
313
Username for SMTP-AUTH. Default is the value of `sendemail.smtpUser`;
314
if a username is not specified (with `--smtp-user` or `sendemail.smtpUser`),
315
then authentication is not attempted.
316
317
---smtp-debug=(0|1)::
317
+`--smtp-debug=(0|1)`::
318
Enable (1) or disable (0) debug output. If enabled, SMTP
319
commands and replies will be printed. Useful to debug TLS
320
connection and authentication problems.
321
322
---imap-sent-folder=<folder>::
322
+`--imap-sent-folder=<folder>`::
323
Some email providers (e.g. iCloud) do not send a copy of the emails sent
324
using SMTP to the `Sent` folder or similar in your mailbox. Use this option
325
to use `git imap-send` to send a copy of the emails to the folder specified
@@ -331,8 +331,8 @@ must be used for each option.
331
This feature requires setting up `git imap-send`. See linkgit:git-imap-send[1]
332
for instructions.
333
334
---use-imap-only::
335
---no-use-imap-only::
334
+`--use-imap-only`::
335
+`--no-use-imap-only`::
336
If this is set, all emails will only be copied to the IMAP folder specified
337
with `--imap-sent-folder` or `sendemail.imapSentFolder` and will not be sent
338
to the recipients. Useful if you just want to create a draft of the emails
@@ -344,8 +344,8 @@ for instructions.
344
This feature requires setting up `git imap-send`. See linkgit:git-imap-send[1]
345
for instructions.
346
347
---batch-size=<num>::
348
- Some email servers (e.g. 'smtp.163.com') limit the number of emails to be
347
+`--batch-size=<num>`::
348
+ Some email servers (e.g. `smtp.163.com`) limit the number of emails to be
349
sent per session (connection) and this will lead to a failure when
350
sending many messages. With this option, send-email will disconnect after
351
sending _<num>_ messages and wait for a few seconds
@@ -354,7 +354,7 @@ for instructions.
354
retype your password every time this happens. Defaults to the
355
`sendemail.smtpBatchSize` configuration variable.
356
357
---relogin-delay=<int>::
357
+`--relogin-delay=<int>`::
358
Waiting _<int>_ seconds before reconnecting to SMTP server. Used together
359
with `--batch-size` option. Defaults to the `sendemail.smtpReloginDelay`
360
configuration variable.
@@ -362,29 +362,29 @@ for instructions.
362
Automating
363
~~~~~~~~~~
364
365
---no-to::
366
---no-cc::
367
---no-bcc::
365
+`--no-to`::
366
+`--no-cc`::
367
+`--no-bcc`::
368
Clear any list of `To:`, `Cc:`, `Bcc:` addresses previously
369
set via config.
370
371
---no-identity::
371
+`--no-identity`::
372
Clear the previously read value of `sendemail.identity` set
373
via config, if any.
374
375
---to-cmd=<command>::
375
+`--to-cmd=<command>`::
376
Specify a command to execute once per patch file which
377
should generate patch file specific `To:` entries.
378
Output of this command must be single email address per line.
379
Default is the value of `sendemail.toCmd` configuration value.
380
381
---cc-cmd=<command>::
381
+`--cc-cmd=<command>`::
382
Specify a command to execute once per patch file which
383
should generate patch file specific `Cc:` entries.
384
Output of this command must be single email address per line.
385
Default is the value of `sendemail.ccCmd` configuration value.
386
387
---header-cmd=<command>::
387
+`--header-cmd=<command>`::
388
Specify a command that is executed once per outgoing message
389
and output RFC 2822 style header lines to be inserted into
390
them. When the `sendemail.headerCmd` configuration variable is
@@ -392,11 +392,11 @@ Automating
392
at the command line, its value takes precedence over the
393
`sendemail.headerCmd` configuration variable.
394
395
---no-header-cmd::
395
+`--no-header-cmd`::
396
Disable any header command in use.
397
398
---chain-reply-to::
399
---no-chain-reply-to::
398
+`--chain-reply-to`::
399
+`--no-chain-reply-to`::
400
If this is set, each email will be sent as a reply to the previous
401
email sent. If disabled with `--no-chain-reply-to`, all emails after
402
the first will be sent as replies to the first email sent. When using
@@ -404,34 +404,34 @@ Automating
404
entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
405
configuration variable can be used to enable it.
406
407
---identity=<identity>::
407
+`--identity=<identity>`::
408
A configuration identity. When given, causes values in the
409
`sendemail.<identity>` subsection to take precedence over
410
values in the `sendemail` section. The default identity is
411
the value of `sendemail.identity`.
412
413
---signed-off-by-cc::
414
---no-signed-off-by-cc::
413
+`--signed-off-by-cc`::
414
+`--no-signed-off-by-cc`::
415
If this is set, add emails found in the `Signed-off-by` trailer or `Cc:`
416
lines to the cc list. Default is the value of `sendemail.signedOffByCc`
417
configuration value; if that is unspecified, default to
418
`--signed-off-by-cc`.
419
420
---cc-cover::
421
---no-cc-cover::
420
+`--cc-cover`::
421
+`--no-cc-cover`::
422
If this is set, emails found in `Cc:` headers in the first patch of
423
the series (typically the cover letter) are added to the cc list
424
for each email set. Default is the value of `sendemail.ccCover`
425
configuration value; if that is unspecified, default to `--no-cc-cover`.
426
427
---to-cover::
428
---no-to-cover::
427
+`--to-cover`::
428
+`--no-to-cover`::
429
If this is set, emails found in `To:` headers in the first patch of
430
the series (typically the cover letter) are added to the to list
431
for each email set. Default is the value of `sendemail.toCover`
432
configuration value; if that is unspecified, default to `--no-to-cover`.
433
434
---suppress-cc=<category>::
434
+`--suppress-cc=<category>`::
435
Specify an additional category of recipients to suppress the
436
auto-cc of:
437
+
@@ -456,14 +456,14 @@ Default is the value of `sendemail.suppressCc` configuration value; if
456
that is unspecified, default to `self` if `--suppress-from` is
457
specified, as well as `body` if `--no-signed-off-by-cc` is specified.
458
459
---suppress-from::
460
---no-suppress-from::
459
+`--suppress-from`::
460
+`--no-suppress-from`::
461
If this is set, do not add the `From:` address to the `Cc:` list.
462
Default is the value of `sendemail.suppressFrom` configuration
463
value; if that is unspecified, default to `--no-suppress-from`.
464
465
---thread::
466
---no-thread::
465
+`--thread`::
466
+`--no-thread`::
467
If this is set, the `In-Reply-To` and `References` headers will be
468
added to each email sent. Whether each mail refers to the
469
previous email (`deep` threading per `git format-patch`
@@ -481,8 +481,8 @@ exists when `git send-email` is asked to add it (especially note that
481
Failure to do so may not produce the expected result in the
482
recipient's MUA.
483
484
---mailmap::
485
---no-mailmap::
484
+`--mailmap`::
485
+`--no-mailmap`::
486
Use the mailmap file (see linkgit:gitmailmap[5]) to map all
487
addresses to their canonical real name and email address. Additional
488
mailmap data specific to `git send-email` may be provided using the
@@ -492,7 +492,7 @@ recipient's MUA.
492
Administering
493
~~~~~~~~~~~~~
494
495
---confirm=<mode>::
495
+`--confirm=<mode>`::
496
Confirm just before sending:
497
+
498
--
@@ -508,22 +508,22 @@ Default is the value of `sendemail.confirm` configuration value; if that
508
is unspecified, default to `auto` unless any of the suppress options
509
have been specified, in which case default to `compose`.
510
511
---dry-run::
511
+`--dry-run`::
512
Do everything except actually send the emails.
513
514
---format-patch::
515
---no-format-patch::
514
+`--format-patch`::
515
+`--no-format-patch`::
516
When an argument may be understood either as a reference or as a file name,
517
choose to understand it as a format-patch argument (`--format-patch`)
518
or as a file name (`--no-format-patch`). By default, when such a conflict
519
occurs, `git send-email` will fail.
520
521
---quiet::
521
+`--quiet`::
522
Make `git send-email` less verbose. One line per email should be
523
all that is output.
524
525
---validate::
526
---no-validate::
525
+`--validate`::
526
+`--no-validate`::
527
Perform sanity checks on patches.
528
Currently, validation means the following:
529
+
@@ -539,20 +539,20 @@ have been specified, in which case default to `compose`.
539
Default is the value of `sendemail.validate`; if this is not set,
540
default to `--validate`.
541
542
---force::
542
+`--force`::
543
Send emails even if safety checks would prevent it.
544
545
546
Information
547
~~~~~~~~~~~
548
549
---dump-aliases::
549
+`--dump-aliases`::
550
Instead of the normal operation, dump the shorthand alias names from
551
the configured alias file(s), one per line in alphabetical order. Note
552
that this only includes the alias name and not its expanded email addresses.
553
See `sendemail.aliasesFile` for more information about aliases.
554
555
---translate-aliases::
555
+`--translate-aliases`::
556
Instead of the normal operation, read from standard input and
557
interpret each line as an email alias. Translate it according to the
558
configured alias file(s). Output each translated name and email
@@ -718,7 +718,7 @@ include::format-patch-caveats.adoc[]
718
719
SEE ALSO
720
--------
721
-linkgit:git-format-patch[1], linkgit:git-imap-send[1], mbox(5)
721
+linkgit:git-format-patch[1], linkgit:git-imap-send[1], `mbox`(5)
722
723
GIT
724
---