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>
Matthieu Moy committed
Apr 7, 2009 at 19:24 UTC
4c0fe0af68fdfc2d328992b8cadc953159f0ea30
1 file changed
+17
-17
Documentation/git-send-email.txt
+17
-17
@@ -39,13 +39,13 @@ OPTIONS
39
Composing
40
~~~~~~~~~
41
42
---bcc::
42
+--bcc=<address>::
43
Specify a "Bcc:" value for each email. Default is the value of
44
'sendemail.bcc'.
45
+
46
The --bcc option must be repeated for each user you want on the bcc list.
47
48
---cc::
48
+--cc=<address>::
49
Specify a starting "Cc:" value for each email.
50
Default is the value of 'sendemail.cc'.
51
+
@@ -68,24 +68,24 @@ and In-Reply-To headers will be used unless they are removed.
68
+
69
Missing From or In-Reply-To headers will be prompted for.
70
71
---from::
71
+--from=<address>::
72
Specify the sender of the emails. This will default to
73
the value GIT_COMMITTER_IDENT, as returned by "git var -l".
74
The user will still be prompted to confirm this entry.
75
76
---in-reply-to::
76
+--in-reply-to=<identifier>::
77
Specify the contents of the first In-Reply-To header.
78
Subsequent emails will refer to the previous email
79
instead of this if --chain-reply-to is set (the default)
80
Only necessary if --compose is also set. If --compose
81
is not set, this will be prompted for.
82
83
---subject::
83
+--subject=<string>::
84
Specify the initial subject of the email thread.
85
Only necessary if --compose is also set. If --compose
86
is not set, this will be prompted for.
87
88
---to::
88
+--to=<address>::
89
Specify the primary recipient of the emails generated. Generally, this
90
will be the upstream maintainer of the project involved. Default is the
91
value of the 'sendemail.to' configuration value; if that is unspecified,
@@ -97,7 +97,7 @@ The --to option must be repeated for each user you want on the to list.
97
Sending
98
~~~~~~~
99
100
---envelope-sender::
100
+--envelope-sender=<address>::
101
Specify the envelope sender used to send the emails.
102
This is useful if your default address is not the address that is
103
subscribed to a list. If you use the sendmail binary, you must have
@@ -105,12 +105,12 @@ Sending
105
the 'sendemail.envelopesender' configuration variable; if that is
106
unspecified, choosing the envelope sender is left to your MTA.
107
108
---smtp-encryption::
108
+--smtp-encryption=<encryption>::
109
Specify the encryption to use, either 'ssl' or 'tls'. Any other
110
value reverts to plain SMTP. Default is the value of
111
'sendemail.smtpencryption'.
112
113
---smtp-pass::
113
+--smtp-pass[=<password>]::
114
Password for SMTP-AUTH. The argument is optional: If no
115
argument is specified, then the empty string is used as
116
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
122
specified (with '--smtp-pass' or 'sendemail.smtppass'), then the
123
user is prompted for a password while the input is masked for privacy.
124
125
---smtp-server::
125
+--smtp-server=<host>::
126
If set, specifies the outgoing SMTP server to use (e.g.
127
`smtp.example.com` or a raw IP address). Alternatively it can
128
specify a full pathname of a sendmail-like program instead;
@@ -132,7 +132,7 @@ user is prompted for a password while the input is masked for privacy.
132
`/usr/lib/sendmail` if such program is available, or
133
`localhost` otherwise.
134
135
---smtp-server-port::
135
+--smtp-server-port=<port>::
136
Specifies a port different from the default port (SMTP
137
servers typically listen to smtp port 25 and ssmtp port
138
465). This can be set with 'sendemail.smtpserverport'.
@@ -140,7 +140,7 @@ user is prompted for a password while the input is masked for privacy.
140
--smtp-ssl::
141
Legacy alias for '--smtp-encryption ssl'.
142
143
---smtp-user::
143
+--smtp-user=<user>::
144
Username for SMTP-AUTH. Default is the value of 'sendemail.smtpuser';
145
if a username is not specified (with '--smtp-user' or 'sendemail.smtpuser'),
146
then authentication is not attempted.
@@ -149,13 +149,13 @@ user is prompted for a password while the input is masked for privacy.
149
Automating
150
~~~~~~~~~~
151
152
---cc-cmd::
152
+--cc-cmd=<command>::
153
Specify a command to execute once per patch file which
154
should generate patch file specific "Cc:" entries.
155
Output of this command must be single email address per line.
156
Default is the value of 'sendemail.cccmd' configuration value.
157
158
---[no-]chain-reply-to::
158
+--[no-]chain-reply-to=<identifier>::
159
If this is set, each email will be sent as a reply to the previous
160
email sent. If disabled with "--no-chain-reply-to", all emails after
161
the first will be sent as replies to the first email sent. When using
@@ -163,7 +163,7 @@ Automating
163
entire patch series. Default is the value of the 'sendemail.chainreplyto'
164
configuration value; if that is unspecified, default to --chain-reply-to.
165
166
---identity::
166
+--identity=<identity>::
167
A configuration identity. When given, causes values in the
168
'sendemail.<identity>' subsection to take precedence over
169
values in the 'sendemail' section. The default identity is
@@ -174,7 +174,7 @@ Automating
174
cc list. Default is the value of 'sendemail.signedoffbycc' configuration
175
value; if that is unspecified, default to --signed-off-by-cc.
176
177
---suppress-cc::
177
+--suppress-cc=<category>::
178
Specify an additional category of recipients to suppress the
179
auto-cc of:
180
+
@@ -211,7 +211,7 @@ specified, as well as 'body' if --no-signed-off-cc is specified.
211
Administering
212
~~~~~~~~~~~~~
213
214
---confirm::
214
+--confirm=<mode>::
215
Confirm just before sending:
216
+
217
--