1 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml" xml:
lang=
"en">
5 <meta http-equiv=
"Content-Type" content=
"text/html; charset=UTF-8" />
6 <meta name=
"generator" content=
"AsciiDoc 8.2.5" />
7 <style type=
"text/css">
9 p
, li
, dt
, dd
, div
, pre
, h1
, h2
, h3
, h4
, h5
, h6
{
11 border: 1px solid red;
16 margin: 1em 5% 1em 5%;
21 text-decoration: underline
;
39 h1
, h2
, h3
, h4
, h5
, h6
{
41 font-family: sans-serif
;
48 border-bottom: 2px solid silver
;
66 border: 1px solid silver
;
81 font-family: sans-serif
;
88 font-family: sans-serif
;
92 font-family: sans-serif
;
94 border-top: 2px solid silver
;
100 padding-bottom: 0.5em;
104 padding-bottom: 0.5em;
108 div
.tableblock
, div
.imageblock
, div
.exampleblock
, div
.verseblock
,
109 div
.quoteblock
, div
.literalblock
, div
.listingblock
, div
.sidebarblock
,
110 div
.admonitionblock
{
113 margin-bottom: 1.5em;
115 div
.admonitionblock
{
117 margin-bottom: 2.5em;
120 div
.content
{ /* Block element content. */
124 /* Block element titles. */
125 div
.title
, caption
.title
{
126 font-family: sans-serif
;
130 margin-bottom: 0.5em;
136 td div
.title:first-child
{
139 div
.content div
.title:first-child
{
142 div
.content
+ div
.title
{
146 div
.sidebarblock
> div
.content
{
148 border: 1px solid silver
;
155 div
.listingblock
> div
.content
{
156 border: 1px solid silver
;
161 div
.quoteblock
> div
.content
{
168 div
.verseblock
+ div
.attribution
{
172 div
.admonitionblock
.icon
{
176 text-decoration: underline
;
178 padding-right: 0.5em;
180 div
.admonitionblock td
.content
{
182 border-left: 2px solid silver
;
185 div
.exampleblock
> div
.content
{
186 border-left: 2px solid silver
;
190 div
.verseblock div
.content
{
194 div
.imageblock div
.content
{ padding-left: 0; }
195 div
.imageblock img
{ border: 1px solid silver
; }
196 span
.image img
{ border-style: none
; }
200 margin-bottom: 0.8em;
212 list-style-position: outside
;
215 list-style-type: lower-alpha
;
218 div
.tableblock
> table
{
219 border: 3px solid
#527bbd;
222 font-family: sans-serif
;
231 margin-bottom: 0.8em;
239 padding-right: 0.8em;
246 div#footer-badges
{ display: none
; }
251 font-family: sans-serif
;
255 margin-bottom: 0.1em;
258 div
.toclevel1
, div
.toclevel2
, div
.toclevel3
, div
.toclevel4
{
274 include1::./stylesheets
/xhtml11-manpage
.css
[]
275 /* Workarounds for IE6's broken and incomplete CSS2. */
277 div
.sidebar-content
{
279 border: 1px solid silver
;
282 div
.sidebar-title
, div
.image-title
{
283 font-family: sans-serif
;
286 margin-bottom: 0.5em;
289 div
.listingblock div
.content
{
290 border: 1px solid silver
;
295 div
.quoteblock-content
{
299 div
.exampleblock-content
{
300 border-left: 2px solid silver
;
304 /* IE6 sets dynamically generated links as visited. */
305 div#toc
a:visited
{ color: blue
; }
307 <title>git-send-email(
1)
</title>
312 git-send-email(
1) Manual Page
315 <div class=
"sectionbody">
317 Send a collection of patches as emails
322 <div class=
"sectionbody">
323 <div class=
"para"><p><em>git send-email
</em> [options]
<file|directory|rev-list options
>…</p></div>
325 <h2 id=
"_description">DESCRIPTION
</h2>
326 <div class=
"sectionbody">
327 <div class=
"para"><p>Takes the patches given on the command line and emails them out.
328 Patches can be specified as files, directories (which will send all
329 files in the directory), or directly as a revision list. In the
330 last case, any format accepted by
<a href=
"git-format-patch.html">git-format-patch(
1)
</a> can
331 be passed to git send-email.
</p></div>
332 <div class=
"para"><p>The header of the email is configurable by command line options. If not
333 specified on the command line, the user will be prompted with a ReadLine
334 enabled interface to provide the necessary information.
</p></div>
335 <div class=
"para"><p>There are two formats accepted for patch files:
</p></div>
336 <div class=
"olist"><ol>
341 <div class=
"para"><p>This is what
<a href=
"git-format-patch.html">git-format-patch(
1)
</a> generates. Most headers and MIME
342 formatting are ignored.
</p></div>
346 The original format used by Greg Kroah-Hartman's
<em>send_lots_of_email.pl
</em>
349 <div class=
"para"><p>This format expects the first line of the file to contain the
"Cc:" value
350 and the
"Subject:" of the message as the second line.
</p></div>
354 <h2 id=
"_options">OPTIONS
</h2>
355 <div class=
"sectionbody">
356 <h3 id=
"_composing">Composing
</h3><div style=
"clear:left"></div>
357 <div class=
"vlist"><dl>
363 Review and edit each patch you're about to send. See the
364 CONFIGURATION section for
<em>sendemail.multiedit
</em>.
368 --bcc=
<address
>
372 Specify a
"Bcc:" value for each email. Default is the value of
373 <em>sendemail.bcc
</em>.
375 <div class=
"para"><p>The --bcc option must be repeated for each user you want on the bcc list.
</p></div>
382 Specify a starting
"Cc:" value for each email.
383 Default is the value of
<em>sendemail.cc
</em>.
385 <div class=
"para"><p>The --cc option must be repeated for each user you want on the cc list.
</p></div>
392 Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
393 introductory message for the patch series.
395 <div class=
"para"><p>When
<em>--compose
</em> is used, git send-email will use the From, Subject, and
396 In-Reply-To headers specified in the message. If the body of the message
397 (what you type after the headers and a blank line) only contains blank
398 (or GIT: prefixed) lines the summary won't be sent, but From, Subject,
399 and In-Reply-To headers will be used unless they are removed.
</p></div>
400 <div class=
"para"><p>Missing From or In-Reply-To headers will be prompted for.
</p></div>
401 <div class=
"para"><p>See the CONFIGURATION section for
<em>sendemail.multiedit
</em>.
</p></div>
404 --from=
<address
>
408 Specify the sender of the emails. If not specified on the command line,
409 the value of the
<em>sendemail.from
</em> configuration option is used. If
410 neither the command line option nor
<em>sendemail.from
</em> are set, then the
411 user will be prompted for the value. The default for the prompt will be
412 the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
413 set, as returned by
"git var -l".
417 --in-reply-to=
<identifier
>
421 Specify the contents of the first In-Reply-To header.
422 Subsequent emails will refer to the previous email
423 instead of this if --chain-reply-to is set (the default)
424 Only necessary if --compose is also set. If --compose
425 is not set, this will be prompted for.
429 --subject=
<string
>
433 Specify the initial subject of the email thread.
434 Only necessary if --compose is also set. If --compose
435 is not set, this will be prompted for.
443 Specify the primary recipient of the emails generated. Generally, this
444 will be the upstream maintainer of the project involved. Default is the
445 value of the
<em>sendemail.to
</em> configuration value; if that is unspecified,
446 this will be prompted for.
448 <div class=
"para"><p>The --to option must be repeated for each user you want on the to list.
</p></div>
451 <h3 id=
"_sending">Sending
</h3><div style=
"clear:left"></div>
452 <div class=
"vlist"><dl>
454 --envelope-sender=
<address
>
458 Specify the envelope sender used to send the emails.
459 This is useful if your default address is not the address that is
460 subscribed to a list. If you use the sendmail binary, you must have
461 suitable privileges for the -f parameter. Default is the value of
462 the
<em>sendemail.envelopesender
</em> configuration variable; if that is
463 unspecified, choosing the envelope sender is left to your MTA.
467 --smtp-encryption=
<encryption
>
471 Specify the encryption to use, either
<em>ssl
</em> or
<em>tls
</em>. Any other
472 value reverts to plain SMTP. Default is the value of
473 <em>sendemail.smtpencryption
</em>.
477 --smtp-pass[=
<password
>]
481 Password for SMTP-AUTH. The argument is optional: If no
482 argument is specified, then the empty string is used as
483 the password. Default is the value of
<em>sendemail.smtppass
</em>,
484 however
<em>--smtp-pass
</em> always overrides this value.
486 <div class=
"para"><p>Furthermore, passwords need not be specified in configuration files
487 or on the command line. If a username has been specified (with
488 <em>--smtp-user
</em> or a
<em>sendemail.smtpuser
</em>), but no password has been
489 specified (with
<em>--smtp-pass
</em> or
<em>sendemail.smtppass
</em>), then the
490 user is prompted for a password while the input is masked for privacy.
</p></div>
493 --smtp-server=
<host
>
497 If set, specifies the outgoing SMTP server to use (e.g.
498 <tt>smtp.example.com
</tt> or a raw IP address). Alternatively it can
499 specify a full pathname of a sendmail-like program instead;
500 the program must support the
<tt>-i
</tt> option. Default value can
501 be specified by the
<em>sendemail.smtpserver
</em> configuration
502 option; the built-in default is
<tt>/usr/sbin/sendmail
</tt> or
503 <tt>/usr/lib/sendmail
</tt> if such program is available, or
504 <tt>localhost
</tt> otherwise.
508 --smtp-server-port=
<port
>
512 Specifies a port different from the default port (SMTP
513 servers typically listen to smtp port
25, but may also listen to
514 submission port
587, or the common SSL smtp port
465);
515 symbolic port names (e.g.
"submission" instead of
587)
516 are also accepted. The port can also be set with the
517 <em>sendemail.smtpserverport
</em> configuration variable.
525 Legacy alias for
<em>--smtp-encryption ssl
</em>.
529 --smtp-user=
<user
>
533 Username for SMTP-AUTH. Default is the value of
<em>sendemail.smtpuser
</em>;
534 if a username is not specified (with
<em>--smtp-user
</em> or
<em>sendemail.smtpuser
</em>),
535 then authentication is not attempted.
539 <h3 id=
"_automating">Automating
</h3><div style=
"clear:left"></div>
540 <div class=
"vlist"><dl>
542 --cc-cmd=
<command
>
546 Specify a command to execute once per patch file which
547 should generate patch file specific
"Cc:" entries.
548 Output of this command must be single email address per line.
549 Default is the value of
<em>sendemail.cccmd
</em> configuration value.
553 --[no-]chain-reply-to
557 If this is set, each email will be sent as a reply to the previous
558 email sent. If disabled with
"--no-chain-reply-to", all emails after
559 the first will be sent as replies to the first email sent. When using
560 this, it is recommended that the first file given be an overview of the
561 entire patch series. Default is the value of the
<em>sendemail.chainreplyto
</em>
562 configuration value; if that is unspecified, default to --chain-reply-to.
566 --identity=
<identity
>
570 A configuration identity. When given, causes values in the
571 <em>sendemail.
<identity
></em> subsection to take precedence over
572 values in the
<em>sendemail
</em> section. The default identity is
573 the value of
<em>sendemail.identity
</em>.
577 --[no-]signed-off-by-cc
581 If this is set, add emails found in Signed-off-by: or Cc: lines to the
582 cc list. Default is the value of
<em>sendemail.signedoffbycc
</em> configuration
583 value; if that is unspecified, default to --signed-off-by-cc.
587 --suppress-cc=
<category
>
591 Specify an additional category of recipients to suppress the
594 <div class=
"ilist"><ul>
597 <em>author
</em> will avoid including the patch author
602 <em>self
</em> will avoid including the sender
607 <em>cc
</em> will avoid including anyone mentioned in Cc lines in the patch header
608 except for self (use
<em>self
</em> for that).
613 <em>bodycc
</em> will avoid including anyone mentioned in Cc lines in the
614 patch body (commit message) except for self (use
<em>self
</em> for that).
619 <em>sob
</em> will avoid including anyone mentioned in Signed-off-by lines except
620 for self (use
<em>self
</em> for that).
625 <em>cccmd
</em> will avoid running the --cc-cmd.
630 <em>body
</em> is equivalent to
<em>sob
</em> +
<em>bodycc
</em>
635 <em>all
</em> will suppress all auto cc values.
639 <div class=
"para"><p>Default is the value of
<em>sendemail.suppresscc
</em> configuration value; if
640 that is unspecified, default to
<em>self
</em> if --suppress-from is
641 specified, as well as
<em>body
</em> if --no-signed-off-cc is specified.
</p></div>
648 If this is set, do not add the From: address to the cc: list.
649 Default is the value of
<em>sendemail.suppressfrom
</em> configuration
650 value; if that is unspecified, default to --no-suppress-from.
658 If this is set, the In-Reply-To and References headers will be
659 added to each email sent. Whether each mail refers to the
660 previous email (
<tt>deep
</tt> threading per
<em>git format-patch
</em>
661 wording) or to the first email (
<tt>shallow
</tt> threading) is
662 governed by
"--[no-]chain-reply-to".
664 <div class=
"para"><p>If disabled with
"--no-thread", those headers will not be added
665 (unless specified with --in-reply-to). Default is the value of the
666 <em>sendemail.thread
</em> configuration value; if that is unspecified,
667 default to --thread.
</p></div>
668 <div class=
"para"><p>It is up to the user to ensure that no In-Reply-To header already
669 exists when
<em>git send-email
</em> is asked to add it (especially note that
670 <em>git format-patch
</em> can be configured to do the threading itself).
671 Failure to do so may not produce the expected result in the
672 recipient's MUA.
</p></div>
675 <h3 id=
"_administering">Administering
</h3><div style=
"clear:left"></div>
676 <div class=
"vlist"><dl>
678 --confirm=
<mode
>
682 Confirm just before sending:
684 <div class=
"ilist"><ul>
687 <em>always
</em> will always confirm before sending
692 <em>never
</em> will never confirm before sending
697 <em>cc
</em> will confirm before sending when send-email has automatically
698 added addresses from the patch to the Cc list
703 <em>compose
</em> will confirm before sending the first message when using --compose.
708 <em>auto
</em> is equivalent to
<em>cc
</em> +
<em>compose
</em>
712 <div class=
"para"><p>Default is the value of
<em>sendemail.confirm
</em> configuration value; if that
713 is unspecified, default to
<em>auto
</em> unless any of the suppress options
714 have been specified, in which case default to
<em>compose
</em>.
</p></div>
721 Do everything except actually send the emails.
729 When an argument may be understood either as a reference or as a file name,
730 choose to understand it as a format-patch argument (
<em>--format-patch
</em>)
731 or as a file name (
<em>--no-format-patch
</em>). By default, when such a conflict
732 occurs, git send-email will fail.
740 Make git-send-email less verbose. One line per email should be
749 Perform sanity checks on patches.
750 Currently, validation means the following:
752 <div class=
"ilist"><ul>
755 Warn of patches that contain lines longer than
998 characters; this
756 is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.
760 <div class=
"para"><p>Default is the value of
<em>sendemail.validate
</em>; if this is not set,
761 default to
<em>--validate
</em>.
</p></div>
765 <h2 id=
"_configuration">CONFIGURATION
</h2>
766 <div class=
"sectionbody">
767 <div class=
"vlist"><dl>
769 sendemail.aliasesfile
773 To avoid typing long email addresses, point this to one or more
774 email aliases files. You must also supply
<em>sendemail.aliasfiletype
</em>.
778 sendemail.aliasfiletype
782 Format of the file(s) specified in sendemail.aliasesfile. Must be
783 one of
<em>mutt
</em>,
<em>mailrc
</em>,
<em>pine
</em>,
<em>elm
</em>, or
<em>gnus
</em>.
791 If true (default), a single editor instance will be spawned to edit
792 files you have to edit (patches when
<em>--annotate
</em> is used, and the
793 summary when
<em>--compose
</em> is used). If false, files will be edited one
794 after the other, spawning a new editor each time.
802 Sets the default for whether to confirm before sending. Must be
803 one of
<em>always
</em>,
<em>never
</em>,
<em>cc
</em>,
<em>compose
</em>, or
<em>auto
</em>. See
<em>--confirm
</em>
804 in the previous section for the meaning of these values.
809 <h2 id=
"_author">Author
</h2>
810 <div class=
"sectionbody">
811 <div class=
"para"><p>Written by Ryan Anderson
<ryan@michonline.com
></p></div>
812 <div class=
"para"><p>git-send-email is originally based upon
813 send_lots_of_email.pl by Greg Kroah-Hartman.
</p></div>
815 <h2 id=
"_documentation">Documentation
</h2>
816 <div class=
"sectionbody">
817 <div class=
"para"><p>Documentation by Ryan Anderson
</p></div>
819 <h2 id=
"_git">GIT
</h2>
820 <div class=
"sectionbody">
821 <div class=
"para"><p>Part of the
<a href=
"git.html">git(
1)
</a> suite
</p></div>
824 <div id=
"footer-text">
825 Last updated
2009-
08-
03 08:
06:
58 UTC