OSDN Git Service

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