<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">

<article lang="en" id="git-send-email(1)">
<articleinfo>
    <title>git-send-email(1)</title>
        <indexterm>
                <primary>git-send-email(1)</primary>
        </indexterm>
</articleinfo>
<simplesect id="_name">
<title>NAME</title>
<simpara>git-send-email - Send a collection of patches as emails</simpara>
</simplesect>
<simplesect id="_synopsis">
<title>SYNOPSIS</title>
<simpara><emphasis>git send-email</emphasis> [options] &lt;file|directory|rev-list options&gt;&#8230;</simpara>
</simplesect>
<simplesect id="_description">
<title>DESCRIPTION</title>
<simpara>Takes the patches given on the command line and emails them out.</simpara>
<simpara>The header of the email is configurable by command line options.  If not
specified on the command line, the user will be prompted with a ReadLine
enabled interface to provide the necessary information.</simpara>
</simplesect>
<simplesect id="_options">
<title>OPTIONS</title>
<simplesect id="_composing">
<title>Composing</title>
<variablelist>
<varlistentry>
<term>
--bcc
</term>
<listitem>
<simpara>
        Specify a "Bcc:" value for each email. Default is the value of
        <emphasis>sendemail.bcc</emphasis>.
</simpara>
<simpara>The --bcc option must be repeated for each user you want on the bcc list.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--cc
</term>
<listitem>
<simpara>
        Specify a starting "Cc:" value for each email.
        Default is the value of <emphasis>sendemail.cc</emphasis>.
</simpara>
<simpara>The --cc option must be repeated for each user you want on the cc list.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--annotate
</term>
<listitem>
<simpara>
        Review each patch you&#8217;re about to send in an editor. The setting
        <emphasis>sendemail.multiedit</emphasis> defines if this will spawn one editor per patch
        or one for all of them at once.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--compose
</term>
<listitem>
<simpara>
        Use $GIT_EDITOR, core.editor, $VISUAL, or $EDITOR to edit an
        introductory message for the patch series.
</simpara>
<simpara>When <emphasis>--compose</emphasis> is used, git send-email gets less interactive will use the
values of the headers you set there. If the body of the email (what you type
after the headers and a blank line) only contains blank (or GIT: prefixed)
lines, the summary won&#8217;t be sent, but git-send-email will still use the
Headers values if you don&#8217;t removed them.</simpara>
<simpara>If it wasn&#8217;t able to see a header in the summary it will ask you about it
interactively after quitting your editor.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--from
</term>
<listitem>
<simpara>
        Specify the sender of the emails.  This will default to
        the value GIT_COMMITTER_IDENT, as returned by "git var -l".
        The user will still be prompted to confirm this entry.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--in-reply-to
</term>
<listitem>
<simpara>
        Specify the contents of the first In-Reply-To header.
        Subsequent emails will refer to the previous email
        instead of this if --chain-reply-to is set (the default)
        Only necessary if --compose is also set.  If --compose
        is not set, this will be prompted for.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--subject
</term>
<listitem>
<simpara>
        Specify the initial subject of the email thread.
        Only necessary if --compose is also set.  If --compose
        is not set, this will be prompted for.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--to
</term>
<listitem>
<simpara>
        Specify the primary recipient of the emails generated. Generally, this
        will be the upstream maintainer of the project involved. Default is the
        value of the <emphasis>sendemail.to</emphasis> configuration value; if that is unspecified,
        this will be prompted for.
</simpara>
<simpara>The --to option must be repeated for each user you want on the to list.</simpara>
</listitem>
</varlistentry>
</variablelist>
</simplesect>
<simplesect id="_sending">
<title>Sending</title>
<variablelist>
<varlistentry>
<term>
--envelope-sender
</term>
<listitem>
<simpara>
        Specify the envelope sender used to send the emails.
        This is useful if your default address is not the address that is
        subscribed to a list. If you use the sendmail binary, you must have
        suitable privileges for the -f parameter. Default is the value of
        the <emphasis>sendemail.envelopesender</emphasis> configuration variable; if that is
        unspecified, choosing the envelope sender is left to your MTA.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--smtp-encryption
</term>
<listitem>
<simpara>
        Specify the encryption to use, either <emphasis>ssl</emphasis> or <emphasis>tls</emphasis>.  Any other
        value reverts to plain SMTP.  Default is the value of
        <emphasis>sendemail.smtpencryption</emphasis>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--smtp-pass
</term>
<listitem>
<simpara>
        Password for SMTP-AUTH. The argument is optional: If no
        argument is specified, then the empty string is used as
        the password. Default is the value of <emphasis>sendemail.smtppass</emphasis>,
        however <emphasis>--smtp-pass</emphasis> always overrides this value.
</simpara>
<simpara>Furthermore, passwords need not be specified in configuration files
or on the command line. If a username has been specified (with
<emphasis>--smtp-user</emphasis> or a <emphasis>sendemail.smtpuser</emphasis>), but no password has been
specified (with <emphasis>--smtp-pass</emphasis> or <emphasis>sendemail.smtppass</emphasis>), then the
user is prompted for a password while the input is masked for privacy.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--smtp-server
</term>
<listitem>
<simpara>
        If set, specifies the outgoing SMTP server to use (e.g.
        <literal>smtp.example.com</literal> or a raw IP address).  Alternatively it can
        specify a full pathname of a sendmail-like program instead;
        the program must support the <literal>-i</literal> option.  Default value can
        be specified by the <emphasis>sendemail.smtpserver</emphasis> configuration
        option; the built-in default is <literal>/usr/sbin/sendmail</literal> or
        <literal>/usr/lib/sendmail</literal> if such program is available, or
        <literal>localhost</literal> otherwise.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--smtp-server-port
</term>
<listitem>
<simpara>
        Specifies a port different from the default port (SMTP
        servers typically listen to smtp port 25 and ssmtp port
        465). This can be set with <emphasis>sendemail.smtpserverport</emphasis>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--smtp-ssl
</term>
<listitem>
<simpara>
        Legacy alias for <emphasis>--smtp-encryption ssl</emphasis>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--smtp-user
</term>
<listitem>
<simpara>
        Username for SMTP-AUTH. Default is the value of <emphasis>sendemail.smtpuser</emphasis>;
        if a username is not specified (with <emphasis>--smtp-user</emphasis> or <emphasis>sendemail.smtpuser</emphasis>),
        then authentication is not attempted.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</simplesect>
<simplesect id="_automating">
<title>Automating</title>
<variablelist>
<varlistentry>
<term>
--cc-cmd
</term>
<listitem>
<simpara>
        Specify a command to execute once per patch file which
        should generate patch file specific "Cc:" entries.
        Output of this command must be single email address per line.
        Default is the value of <emphasis>sendemail.cccmd</emphasis> configuration value.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--[no-]chain-reply-to
</term>
<listitem>
<simpara>
        If this is set, each email will be sent as a reply to the previous
        email sent.  If disabled with "--no-chain-reply-to", all emails after
        the first will be sent as replies to the first email sent.  When using
        this, it is recommended that the first file given be an overview of the
        entire patch series. Default is the value of the <emphasis>sendemail.chainreplyto</emphasis>
        configuration value; if that is unspecified, default to --chain-reply-to.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--identity
</term>
<listitem>
<simpara>
        A configuration identity. When given, causes values in the
        <emphasis>sendemail.&lt;identity&gt;</emphasis> subsection to take precedence over
        values in the <emphasis>sendemail</emphasis> section. The default identity is
        the value of <emphasis>sendemail.identity</emphasis>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--[no-]signed-off-by-cc
</term>
<listitem>
<simpara>
        If this is set, add emails found in Signed-off-by: or Cc: lines to the
        cc list. Default is the value of <emphasis>sendemail.signedoffbycc</emphasis> configuration
        value; if that is unspecified, default to --signed-off-by-cc.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--suppress-cc
</term>
<listitem>
<simpara>
        Specify an additional category of recipients to suppress the
        auto-cc of.  <emphasis>self</emphasis> will avoid including the sender, <emphasis>author</emphasis> will
        avoid including the patch author, <emphasis>cc</emphasis> will avoid including anyone
        mentioned in Cc lines in the patch, <emphasis>sob</emphasis> will avoid including
        anyone mentioned in Signed-off-by lines, and <emphasis>cccmd</emphasis> will avoid
        running the --cc-cmd.  <emphasis>all</emphasis> will suppress all auto cc values.
        Default is the value of <emphasis>sendemail.suppresscc</emphasis> configuration value;
        if that is unspecified, default to <emphasis>self</emphasis> if --suppress-from is
        specified, as well as <emphasis>sob</emphasis> if --no-signed-off-cc is specified.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--[no-]suppress-from
</term>
<listitem>
<simpara>
        If this is set, do not add the From: address to the cc: list.
        Default is the value of <emphasis>sendemail.suppressfrom</emphasis> configuration
        value; if that is unspecified, default to --no-suppress-from.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--[no-]thread
</term>
<listitem>
<simpara>
        If this is set, the In-Reply-To header will be set on each email sent.
        If disabled with "--no-thread", no emails will have the In-Reply-To
        header set. Default is the value of the <emphasis>sendemail.thread</emphasis> configuration
        value; if that is unspecified, default to --thread.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</simplesect>
<simplesect id="_administering">
<title>Administering</title>
<variablelist>
<varlistentry>
<term>
--dry-run
</term>
<listitem>
<simpara>
        Do everything except actually send the emails.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--quiet
</term>
<listitem>
<simpara>
        Make git-send-email less verbose.  One line per email should be
        all that is output.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--[no-]validate
</term>
<listitem>
<simpara>
        Perform sanity checks on patches.
        Currently, validation means the following:
</simpara>
<itemizedlist>
<listitem>
<simpara>
Warn of patches that contain lines longer than 998 characters; this
                        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>.
</simpara>
</listitem>
</itemizedlist>
<simpara>Default is the value of <emphasis>sendemail.validate</emphasis>; if this is not set,
default to <emphasis>--validate</emphasis>.</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--[no-]format-patch
</term>
<listitem>
<simpara>
        When an argument may be understood either as a reference or as a file name,
        choose to understand it as a format-patch argument (<emphasis>--format-patch</emphasis>)
        or as a file name (<emphasis>--no-format-patch</emphasis>). By default, when such a conflict
        occurs, git send-email will fail.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</simplesect>
</simplesect>
<simplesect id="_configuration">
<title>CONFIGURATION</title>
<variablelist>
<varlistentry>
<term>
sendemail.aliasesfile
</term>
<listitem>
<simpara>
        To avoid typing long email addresses, point this to one or more
        email aliases files.  You must also supply <emphasis>sendemail.aliasfiletype</emphasis>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
sendemail.aliasfiletype
</term>
<listitem>
<simpara>
        Format of the file(s) specified in sendemail.aliasesfile. Must be
        one of <emphasis>mutt</emphasis>, <emphasis>mailrc</emphasis>, <emphasis>pine</emphasis>, or <emphasis>gnus</emphasis>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
sendemail.multiedit
</term>
<listitem>
<simpara>
        If true (default), a single editor instance will be spawned to edit
        files you have to edit (patches when <emphasis>--annotate</emphasis> is used, and the
        summary when <emphasis>--compose</emphasis> is used). If false, files will be edited one
        after the other, spawning a new editor each time.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</simplesect>
<simplesect id="_author">
<title>Author</title>
<simpara>Written by Ryan Anderson &lt;<ulink url="mailto:ryan@michonline.com">ryan@michonline.com</ulink>&gt;</simpara>
<simpara>git-send-email is originally based upon
send_lots_of_email.pl by Greg Kroah-Hartman.</simpara>
</simplesect>
<simplesect id="_documentation">
<title>Documentation</title>
<simpara>Documentation by Ryan Anderson</simpara>
</simplesect>
<simplesect id="_git">
<title>GIT</title>
<simpara>Part of the <xref linkend="git(1)"/> suite</simpara>
</simplesect>
</article>
