OSDN Git Service

Add Git official document to help
[tortoisegit/TortoiseGitJp.git] / doc / source / en / TortoiseGit / git_doc / git-send-email.html.xml
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
3 \r
4 <article lang="en" id="git-send-email(1)">\r
5 <articleinfo>\r
6     <title>git-send-email(1)</title>\r
7         <indexterm>\r
8                 <primary>git-send-email(1)</primary>\r
9         </indexterm>\r
10 </articleinfo>\r
11 <simplesect id="_name">\r
12 <title>NAME</title>\r
13 <simpara>git-send-email - Send a collection of patches as emails</simpara>\r
14 </simplesect>\r
15 <simplesect id="_synopsis">\r
16 <title>SYNOPSIS</title>\r
17 <simpara><emphasis>git send-email</emphasis> [options] &lt;file|directory|rev-list options&gt;&#8230;</simpara>\r
18 </simplesect>\r
19 <simplesect id="_description">\r
20 <title>DESCRIPTION</title>\r
21 <simpara>Takes the patches given on the command line and emails them out.</simpara>\r
22 <simpara>The header of the email is configurable by command line options.  If not\r
23 specified on the command line, the user will be prompted with a ReadLine\r
24 enabled interface to provide the necessary information.</simpara>\r
25 </simplesect>\r
26 <simplesect id="_options">\r
27 <title>OPTIONS</title>\r
28 <simplesect id="_composing">\r
29 <title>Composing</title>\r
30 <variablelist>\r
31 <varlistentry>\r
32 <term>\r
33 --bcc\r
34 </term>\r
35 <listitem>\r
36 <simpara>\r
37         Specify a "Bcc:" value for each email. Default is the value of\r
38         <emphasis>sendemail.bcc</emphasis>.\r
39 </simpara>\r
40 <simpara>The --bcc option must be repeated for each user you want on the bcc list.</simpara>\r
41 </listitem>\r
42 </varlistentry>\r
43 <varlistentry>\r
44 <term>\r
45 --cc\r
46 </term>\r
47 <listitem>\r
48 <simpara>\r
49         Specify a starting "Cc:" value for each email.\r
50         Default is the value of <emphasis>sendemail.cc</emphasis>.\r
51 </simpara>\r
52 <simpara>The --cc option must be repeated for each user you want on the cc list.</simpara>\r
53 </listitem>\r
54 </varlistentry>\r
55 <varlistentry>\r
56 <term>\r
57 --annotate\r
58 </term>\r
59 <listitem>\r
60 <simpara>\r
61         Review each patch you&#8217;re about to send in an editor. The setting\r
62         <emphasis>sendemail.multiedit</emphasis> defines if this will spawn one editor per patch\r
63         or one for all of them at once.\r
64 </simpara>\r
65 </listitem>\r
66 </varlistentry>\r
67 <varlistentry>\r
68 <term>\r
69 --compose\r
70 </term>\r
71 <listitem>\r
72 <simpara>\r
73         Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an\r
74         introductory message for the patch series.\r
75 </simpara>\r
76 <simpara>When <emphasis>--compose</emphasis> is used, git send-email gets less interactive will use the\r
77 values of the headers you set there. If the body of the email (what you type\r
78 after the headers and a blank line) only contains blank (or GIT: prefixed)\r
79 lines, the summary won&#8217;t be sent, but git-send-email will still use the\r
80 Headers values if you don&#8217;t removed them.</simpara>\r
81 <simpara>If it wasn&#8217;t able to see a header in the summary it will ask you about it\r
82 interactively after quitting your editor.</simpara>\r
83 </listitem>\r
84 </varlistentry>\r
85 <varlistentry>\r
86 <term>\r
87 --from\r
88 </term>\r
89 <listitem>\r
90 <simpara>\r
91         Specify the sender of the emails.  This will default to\r
92         the value GIT_COMMITTER_IDENT, as returned by "git var -l".\r
93         The user will still be prompted to confirm this entry.\r
94 </simpara>\r
95 </listitem>\r
96 </varlistentry>\r
97 <varlistentry>\r
98 <term>\r
99 --in-reply-to\r
100 </term>\r
101 <listitem>\r
102 <simpara>\r
103         Specify the contents of the first In-Reply-To header.\r
104         Subsequent emails will refer to the previous email\r
105         instead of this if --chain-reply-to is set (the default)\r
106         Only necessary if --compose is also set.  If --compose\r
107         is not set, this will be prompted for.\r
108 </simpara>\r
109 </listitem>\r
110 </varlistentry>\r
111 <varlistentry>\r
112 <term>\r
113 --subject\r
114 </term>\r
115 <listitem>\r
116 <simpara>\r
117         Specify the initial subject of the email thread.\r
118         Only necessary if --compose is also set.  If --compose\r
119         is not set, this will be prompted for.\r
120 </simpara>\r
121 </listitem>\r
122 </varlistentry>\r
123 <varlistentry>\r
124 <term>\r
125 --to\r
126 </term>\r
127 <listitem>\r
128 <simpara>\r
129         Specify the primary recipient of the emails generated. Generally, this\r
130         will be the upstream maintainer of the project involved. Default is the\r
131         value of the <emphasis>sendemail.to</emphasis> configuration value; if that is unspecified,\r
132         this will be prompted for.\r
133 </simpara>\r
134 <simpara>The --to option must be repeated for each user you want on the to list.</simpara>\r
135 </listitem>\r
136 </varlistentry>\r
137 </variablelist>\r
138 </simplesect>\r
139 <simplesect id="_sending">\r
140 <title>Sending</title>\r
141 <variablelist>\r
142 <varlistentry>\r
143 <term>\r
144 --envelope-sender\r
145 </term>\r
146 <listitem>\r
147 <simpara>\r
148         Specify the envelope sender used to send the emails.\r
149         This is useful if your default address is not the address that is\r
150         subscribed to a list. If you use the sendmail binary, you must have\r
151         suitable privileges for the -f parameter. Default is the value of\r
152         the <emphasis>sendemail.envelopesender</emphasis> configuration variable; if that is\r
153         unspecified, choosing the envelope sender is left to your MTA.\r
154 </simpara>\r
155 </listitem>\r
156 </varlistentry>\r
157 <varlistentry>\r
158 <term>\r
159 --smtp-encryption\r
160 </term>\r
161 <listitem>\r
162 <simpara>\r
163         Specify the encryption to use, either <emphasis>ssl</emphasis> or <emphasis>tls</emphasis>.  Any other\r
164         value reverts to plain SMTP.  Default is the value of\r
165         <emphasis>sendemail.smtpencryption</emphasis>.\r
166 </simpara>\r
167 </listitem>\r
168 </varlistentry>\r
169 <varlistentry>\r
170 <term>\r
171 --smtp-pass\r
172 </term>\r
173 <listitem>\r
174 <simpara>\r
175         Password for SMTP-AUTH. The argument is optional: If no\r
176         argument is specified, then the empty string is used as\r
177         the password. Default is the value of <emphasis>sendemail.smtppass</emphasis>,\r
178         however <emphasis>--smtp-pass</emphasis> always overrides this value.\r
179 </simpara>\r
180 <simpara>Furthermore, passwords need not be specified in configuration files\r
181 or on the command line. If a username has been specified (with\r
182 <emphasis>--smtp-user</emphasis> or a <emphasis>sendemail.smtpuser</emphasis>), but no password has been\r
183 specified (with <emphasis>--smtp-pass</emphasis> or <emphasis>sendemail.smtppass</emphasis>), then the\r
184 user is prompted for a password while the input is masked for privacy.</simpara>\r
185 </listitem>\r
186 </varlistentry>\r
187 <varlistentry>\r
188 <term>\r
189 --smtp-server\r
190 </term>\r
191 <listitem>\r
192 <simpara>\r
193         If set, specifies the outgoing SMTP server to use (e.g.\r
194         <literal>smtp.example.com</literal> or a raw IP address).  Alternatively it can\r
195         specify a full pathname of a sendmail-like program instead;\r
196         the program must support the <literal>-i</literal> option.  Default value can\r
197         be specified by the <emphasis>sendemail.smtpserver</emphasis> configuration\r
198         option; the built-in default is <literal>/usr/sbin/sendmail</literal> or\r
199         <literal>/usr/lib/sendmail</literal> if such program is available, or\r
200         <literal>localhost</literal> otherwise.\r
201 </simpara>\r
202 </listitem>\r
203 </varlistentry>\r
204 <varlistentry>\r
205 <term>\r
206 --smtp-server-port\r
207 </term>\r
208 <listitem>\r
209 <simpara>\r
210         Specifies a port different from the default port (SMTP\r
211         servers typically listen to smtp port 25 and ssmtp port\r
212         465). This can be set with <emphasis>sendemail.smtpserverport</emphasis>.\r
213 </simpara>\r
214 </listitem>\r
215 </varlistentry>\r
216 <varlistentry>\r
217 <term>\r
218 --smtp-ssl\r
219 </term>\r
220 <listitem>\r
221 <simpara>\r
222         Legacy alias for <emphasis>--smtp-encryption ssl</emphasis>.\r
223 </simpara>\r
224 </listitem>\r
225 </varlistentry>\r
226 <varlistentry>\r
227 <term>\r
228 --smtp-user\r
229 </term>\r
230 <listitem>\r
231 <simpara>\r
232         Username for SMTP-AUTH. Default is the value of <emphasis>sendemail.smtpuser</emphasis>;\r
233         if a username is not specified (with <emphasis>--smtp-user</emphasis> or <emphasis>sendemail.smtpuser</emphasis>),\r
234         then authentication is not attempted.\r
235 </simpara>\r
236 </listitem>\r
237 </varlistentry>\r
238 </variablelist>\r
239 </simplesect>\r
240 <simplesect id="_automating">\r
241 <title>Automating</title>\r
242 <variablelist>\r
243 <varlistentry>\r
244 <term>\r
245 --cc-cmd\r
246 </term>\r
247 <listitem>\r
248 <simpara>\r
249         Specify a command to execute once per patch file which\r
250         should generate patch file specific "Cc:" entries.\r
251         Output of this command must be single email address per line.\r
252         Default is the value of <emphasis>sendemail.cccmd</emphasis> configuration value.\r
253 </simpara>\r
254 </listitem>\r
255 </varlistentry>\r
256 <varlistentry>\r
257 <term>\r
258 --[no-]chain-reply-to\r
259 </term>\r
260 <listitem>\r
261 <simpara>\r
262         If this is set, each email will be sent as a reply to the previous\r
263         email sent.  If disabled with "--no-chain-reply-to", all emails after\r
264         the first will be sent as replies to the first email sent.  When using\r
265         this, it is recommended that the first file given be an overview of the\r
266         entire patch series. Default is the value of the <emphasis>sendemail.chainreplyto</emphasis>\r
267         configuration value; if that is unspecified, default to --chain-reply-to.\r
268 </simpara>\r
269 </listitem>\r
270 </varlistentry>\r
271 <varlistentry>\r
272 <term>\r
273 --identity\r
274 </term>\r
275 <listitem>\r
276 <simpara>\r
277         A configuration identity. When given, causes values in the\r
278         <emphasis>sendemail.&lt;identity&gt;</emphasis> subsection to take precedence over\r
279         values in the <emphasis>sendemail</emphasis> section. The default identity is\r
280         the value of <emphasis>sendemail.identity</emphasis>.\r
281 </simpara>\r
282 </listitem>\r
283 </varlistentry>\r
284 <varlistentry>\r
285 <term>\r
286 --[no-]signed-off-by-cc\r
287 </term>\r
288 <listitem>\r
289 <simpara>\r
290         If this is set, add emails found in Signed-off-by: or Cc: lines to the\r
291         cc list. Default is the value of <emphasis>sendemail.signedoffbycc</emphasis> configuration\r
292         value; if that is unspecified, default to --signed-off-by-cc.\r
293 </simpara>\r
294 </listitem>\r
295 </varlistentry>\r
296 <varlistentry>\r
297 <term>\r
298 --suppress-cc\r
299 </term>\r
300 <listitem>\r
301 <simpara>\r
302         Specify an additional category of recipients to suppress the\r
303         auto-cc of.  <emphasis>self</emphasis> will avoid including the sender, <emphasis>author</emphasis> will\r
304         avoid including the patch author, <emphasis>cc</emphasis> will avoid including anyone\r
305         mentioned in Cc lines in the patch, <emphasis>sob</emphasis> will avoid including\r
306         anyone mentioned in Signed-off-by lines, and <emphasis>cccmd</emphasis> will avoid\r
307         running the --cc-cmd.  <emphasis>all</emphasis> will suppress all auto cc values.\r
308         Default is the value of <emphasis>sendemail.suppresscc</emphasis> configuration value;\r
309         if that is unspecified, default to <emphasis>self</emphasis> if --suppress-from is\r
310         specified, as well as <emphasis>sob</emphasis> if --no-signed-off-cc is specified.\r
311 </simpara>\r
312 </listitem>\r
313 </varlistentry>\r
314 <varlistentry>\r
315 <term>\r
316 --[no-]suppress-from\r
317 </term>\r
318 <listitem>\r
319 <simpara>\r
320         If this is set, do not add the From: address to the cc: list.\r
321         Default is the value of <emphasis>sendemail.suppressfrom</emphasis> configuration\r
322         value; if that is unspecified, default to --no-suppress-from.\r
323 </simpara>\r
324 </listitem>\r
325 </varlistentry>\r
326 <varlistentry>\r
327 <term>\r
328 --[no-]thread\r
329 </term>\r
330 <listitem>\r
331 <simpara>\r
332         If this is set, the In-Reply-To header will be set on each email sent.\r
333         If disabled with "--no-thread", no emails will have the In-Reply-To\r
334         header set. Default is the value of the <emphasis>sendemail.thread</emphasis> configuration\r
335         value; if that is unspecified, default to --thread.\r
336 </simpara>\r
337 </listitem>\r
338 </varlistentry>\r
339 </variablelist>\r
340 </simplesect>\r
341 <simplesect id="_administering">\r
342 <title>Administering</title>\r
343 <variablelist>\r
344 <varlistentry>\r
345 <term>\r
346 --dry-run\r
347 </term>\r
348 <listitem>\r
349 <simpara>\r
350         Do everything except actually send the emails.\r
351 </simpara>\r
352 </listitem>\r
353 </varlistentry>\r
354 <varlistentry>\r
355 <term>\r
356 --quiet\r
357 </term>\r
358 <listitem>\r
359 <simpara>\r
360         Make git-send-email less verbose.  One line per email should be\r
361         all that is output.\r
362 </simpara>\r
363 </listitem>\r
364 </varlistentry>\r
365 <varlistentry>\r
366 <term>\r
367 --[no-]validate\r
368 </term>\r
369 <listitem>\r
370 <simpara>\r
371         Perform sanity checks on patches.\r
372         Currently, validation means the following:\r
373 </simpara>\r
374 <itemizedlist>\r
375 <listitem>\r
376 <simpara>\r
377 Warn of patches that contain lines longer than 998 characters; this\r
378                         is due to SMTP limits as described by <ulink url="http://www.ietf.org/rfc/rfc2821.txt">http://www.ietf.org/rfc/rfc2821.txt</ulink>.\r
379 </simpara>\r
380 </listitem>\r
381 </itemizedlist>\r
382 <simpara>Default is the value of <emphasis>sendemail.validate</emphasis>; if this is not set,\r
383 default to <emphasis>--validate</emphasis>.</simpara>\r
384 </listitem>\r
385 </varlistentry>\r
386 <varlistentry>\r
387 <term>\r
388 --[no-]format-patch\r
389 </term>\r
390 <listitem>\r
391 <simpara>\r
392         When an argument may be understood either as a reference or as a file name,\r
393         choose to understand it as a format-patch argument (<emphasis>--format-patch</emphasis>)\r
394         or as a file name (<emphasis>--no-format-patch</emphasis>). By default, when such a conflict\r
395         occurs, git send-email will fail.\r
396 </simpara>\r
397 </listitem>\r
398 </varlistentry>\r
399 </variablelist>\r
400 </simplesect>\r
401 </simplesect>\r
402 <simplesect id="_configuration">\r
403 <title>CONFIGURATION</title>\r
404 <variablelist>\r
405 <varlistentry>\r
406 <term>\r
407 sendemail.aliasesfile\r
408 </term>\r
409 <listitem>\r
410 <simpara>\r
411         To avoid typing long email addresses, point this to one or more\r
412         email aliases files.  You must also supply <emphasis>sendemail.aliasfiletype</emphasis>.\r
413 </simpara>\r
414 </listitem>\r
415 </varlistentry>\r
416 <varlistentry>\r
417 <term>\r
418 sendemail.aliasfiletype\r
419 </term>\r
420 <listitem>\r
421 <simpara>\r
422         Format of the file(s) specified in sendemail.aliasesfile. Must be\r
423         one of <emphasis>mutt</emphasis>, <emphasis>mailrc</emphasis>, <emphasis>pine</emphasis>, or <emphasis>gnus</emphasis>.\r
424 </simpara>\r
425 </listitem>\r
426 </varlistentry>\r
427 <varlistentry>\r
428 <term>\r
429 sendemail.multiedit\r
430 </term>\r
431 <listitem>\r
432 <simpara>\r
433         If true (default), a single editor instance will be spawned to edit\r
434         files you have to edit (patches when <emphasis>--annotate</emphasis> is used, and the\r
435         summary when <emphasis>--compose</emphasis> is used). If false, files will be edited one\r
436         after the other, spawning a new editor each time.\r
437 </simpara>\r
438 </listitem>\r
439 </varlistentry>\r
440 </variablelist>\r
441 </simplesect>\r
442 <simplesect id="_author">\r
443 <title>Author</title>\r
444 <simpara>Written by Ryan Anderson &lt;<ulink url="mailto:ryan@michonline.com">ryan@michonline.com</ulink>&gt;</simpara>\r
445 <simpara>git-send-email is originally based upon\r
446 send_lots_of_email.pl by Greg Kroah-Hartman.</simpara>\r
447 </simplesect>\r
448 <simplesect id="_documentation">\r
449 <title>Documentation</title>\r
450 <simpara>Documentation by Ryan Anderson</simpara>\r
451 </simplesect>\r
452 <simplesect id="_git">\r
453 <title>GIT</title>\r
454 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
455 </simplesect>\r
456 </article>\r