Skip to content

Commit 4c0fe0a

Browse files
moygitster
authored andcommitted
git-send-email.txt: clarify which options take an argument.
Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent fbdc056 commit 4c0fe0a

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

Documentation/git-send-email.txt

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ OPTIONS
3939
Composing
4040
~~~~~~~~~
4141

42-
--bcc::
42+
--bcc=<address>::
4343
Specify a "Bcc:" value for each email. Default is the value of
4444
'sendemail.bcc'.
4545
+
4646
The --bcc option must be repeated for each user you want on the bcc list.
4747

48-
--cc::
48+
--cc=<address>::
4949
Specify a starting "Cc:" value for each email.
5050
Default is the value of 'sendemail.cc'.
5151
+
@@ -68,24 +68,24 @@ and In-Reply-To headers will be used unless they are removed.
6868
+
6969
Missing From or In-Reply-To headers will be prompted for.
7070

71-
--from::
71+
--from=<address>::
7272
Specify the sender of the emails. This will default to
7373
the value GIT_COMMITTER_IDENT, as returned by "git var -l".
7474
The user will still be prompted to confirm this entry.
7575

76-
--in-reply-to::
76+
--in-reply-to=<identifier>::
7777
Specify the contents of the first In-Reply-To header.
7878
Subsequent emails will refer to the previous email
7979
instead of this if --chain-reply-to is set (the default)
8080
Only necessary if --compose is also set. If --compose
8181
is not set, this will be prompted for.
8282

83-
--subject::
83+
--subject=<string>::
8484
Specify the initial subject of the email thread.
8585
Only necessary if --compose is also set. If --compose
8686
is not set, this will be prompted for.
8787

88-
--to::
88+
--to=<address>::
8989
Specify the primary recipient of the emails generated. Generally, this
9090
will be the upstream maintainer of the project involved. Default is the
9191
value of the 'sendemail.to' configuration value; if that is unspecified,
@@ -97,20 +97,20 @@ The --to option must be repeated for each user you want on the to list.
9797
Sending
9898
~~~~~~~
9999

100-
--envelope-sender::
100+
--envelope-sender=<address>::
101101
Specify the envelope sender used to send the emails.
102102
This is useful if your default address is not the address that is
103103
subscribed to a list. If you use the sendmail binary, you must have
104104
suitable privileges for the -f parameter. Default is the value of
105105
the 'sendemail.envelopesender' configuration variable; if that is
106106
unspecified, choosing the envelope sender is left to your MTA.
107107

108-
--smtp-encryption::
108+
--smtp-encryption=<encryption>::
109109
Specify the encryption to use, either 'ssl' or 'tls'. Any other
110110
value reverts to plain SMTP. Default is the value of
111111
'sendemail.smtpencryption'.
112112

113-
--smtp-pass::
113+
--smtp-pass[=<password>]::
114114
Password for SMTP-AUTH. The argument is optional: If no
115115
argument is specified, then the empty string is used as
116116
the password. Default is the value of 'sendemail.smtppass',
@@ -122,7 +122,7 @@ or on the command line. If a username has been specified (with
122122
specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
123123
user is prompted for a password while the input is masked for privacy.
124124

125-
--smtp-server::
125+
--smtp-server=<host>::
126126
If set, specifies the outgoing SMTP server to use (e.g.
127127
`smtp.example.com` or a raw IP address). Alternatively it can
128128
specify a full pathname of a sendmail-like program instead;
@@ -132,15 +132,15 @@ user is prompted for a password while the input is masked for privacy.
132132
`/usr/lib/sendmail` if such program is available, or
133133
`localhost` otherwise.
134134

135-
--smtp-server-port::
135+
--smtp-server-port=<port>::
136136
Specifies a port different from the default port (SMTP
137137
servers typically listen to smtp port 25 and ssmtp port
138138
465). This can be set with 'sendemail.smtpserverport'.
139139

140140
--smtp-ssl::
141141
Legacy alias for '--smtp-encryption ssl'.
142142

143-
--smtp-user::
143+
--smtp-user=<user>::
144144
Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
145145
if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
146146
then authentication is not attempted.
@@ -149,21 +149,21 @@ user is prompted for a password while the input is masked for privacy.
149149
Automating
150150
~~~~~~~~~~
151151

152-
--cc-cmd::
152+
--cc-cmd=<command>::
153153
Specify a command to execute once per patch file which
154154
should generate patch file specific "Cc:" entries.
155155
Output of this command must be single email address per line.
156156
Default is the value of 'sendemail.cccmd' configuration value.
157157

158-
--[no-]chain-reply-to::
158+
--[no-]chain-reply-to=<identifier>::
159159
If this is set, each email will be sent as a reply to the previous
160160
email sent. If disabled with "--no-chain-reply-to", all emails after
161161
the first will be sent as replies to the first email sent. When using
162162
this, it is recommended that the first file given be an overview of the
163163
entire patch series. Default is the value of the 'sendemail.chainreplyto'
164164
configuration value; if that is unspecified, default to --chain-reply-to.
165165

166-
--identity::
166+
--identity=<identity>::
167167
A configuration identity. When given, causes values in the
168168
'sendemail.<identity>' subsection to take precedence over
169169
values in the 'sendemail' section. The default identity is
@@ -174,7 +174,7 @@ Automating
174174
cc list. Default is the value of 'sendemail.signedoffbycc' configuration
175175
value; if that is unspecified, default to --signed-off-by-cc.
176176

177-
--suppress-cc::
177+
--suppress-cc=<category>::
178178
Specify an additional category of recipients to suppress the
179179
auto-cc of:
180180
+
@@ -211,7 +211,7 @@ specified, as well as 'body' if --no-signed-off-cc is specified.
211211
Administering
212212
~~~~~~~~~~~~~
213213

214-
--confirm::
214+
--confirm=<mode>::
215215
Confirm just before sending:
216216
+
217217
--

0 commit comments

Comments
 (0)