Autogenerated HTML docs for v1.6.0.2-514-g23abd3

1 files changed, 109 insertions, 220 deletions

diff --git a/git-send-email.html b/git-send-email.html
index 598fb0fe3..d20682d96 100644
--- a/git-send-email.html
+++ b/git-send-email.html
@@ -331,14 +331,15 @@ enabled interface to provide the necessary information.</p></div>
 </div>

 <h2 id="_options">OPTIONS</h2>

 <div class="sectionbody">

-<div class="para"><p>The options available are:</p></div>

+<h3 id="_composing">Composing</h3><div style="clear:left"></div>

 <div class="vlist"><dl>

 <dt>

 --bcc

 </dt>

 <dd>

 <p>

-        Specify a "Bcc:" value for each email.

+        Specify a "Bcc:" value for each email. Default is the value of

+        <em>sendemail.bcc</em>.

 </p>

 <div class="para"><p>The --bcc option must be repeated for each user you want on the bcc list.</p></div>

 </dd>

@@ -352,34 +353,6 @@ enabled interface to provide the necessary information.</p></div>
 <div class="para"><p>The --cc option must be repeated for each user you want on the cc list.</p></div>

 </dd>

 <dt>

---cc-cmd

-</dt>

-<dd>

-<p>

-        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 <em>sendemail.cccmd</em> configuration value.

-</p>

-</dd>

-<dt>

---chain-reply-to

-</dt>

-<dt>

---no-chain-reply-to

-</dt>

-<dd>

-<p>

-        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 <em>sendemail.chainreplyto</em> configuration

-        value; if that is unspecified, default to --chain-reply-to.

-</p>

-</dd>

-<dt>

 --compose

 </dt>

 <dd>

@@ -411,40 +384,70 @@ enabled interface to provide the necessary information.</p></div>
 </p>

 </dd>

 <dt>

---signed-off-by-cc

+--subject

 </dt>

+<dd>

+<p>

+        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.

+</p>

+</dd>

 <dt>

---no-signed-off-by-cc

+--to

 </dt>

 <dd>

 <p>

-        If this is set, add emails found in Signed-off-by: or Cc: lines to the

-        cc list.

-        Default is the value of <em>sendemail.signedoffcc</em> configuration value;

-        if that is unspecified, default to --signed-off-by-cc.

+        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 <em>sendemail.to</em> configuration value; if that is unspecified,

+        this will be prompted for.

 </p>

+<div class="para"><p>The --to option must be repeated for each user you want on the to list.</p></div>

 </dd>

+</dl></div>

+<h3 id="_sending">Sending</h3><div style="clear:left"></div>

+<div class="vlist"><dl>

 <dt>

---quiet

+--envelope-sender

 </dt>

 <dd>

 <p>

-        Make git-send-email less verbose.  One line per email should be

-        all that is output.

+        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 <em>sendemail.envelopesender</em> configuration variable; if that is

+        unspecified, choosing the envelope sender is left to your MTA.

 </p>

 </dd>

 <dt>

---identity

+--smtp-encryption

 </dt>

 <dd>

 <p>

-        A configuration identity. When given, causes values in the

-        <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over

-        values in the <em>sendemail</em> section. The default identity is

-        the value of <em>sendemail.identity</em>.

+        Specify the encryption to use, either <em>ssl</em> or <em>tls</em>.  Any other

+        value reverts to plain SMTP.  Default is the value of

+        <em>sendemail.smtpencryption</em>.

 </p>

 </dd>

 <dt>

+--smtp-pass

+</dt>

+<dd>

+<p>

+        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 <em>sendemail.smtppass</em>,

+        however <em>--smtp-pass</em> always overrides this value.

+</p>

+<div class="para"><p>Furthermore, passwords need not be specified in configuration files

+or on the command line. If a username has been specified (with

+<em>--smtp-user</em> or a <em>sendemail.smtpuser</em>), but no password has been

+specified (with <em>--smtp-pass</em> or <em>sendemail.smtppass</em>), then the

+user is prompted for a password while the input is masked for privacy.</p></div>

+</dd>

+<dt>

 --smtp-server

 </dt>

 <dd>

@@ -466,102 +469,73 @@ enabled interface to provide the necessary information.</p></div>
 <p>

         Specifies a port different from the default port (SMTP

         servers typically listen to smtp port 25 and ssmtp port

-        465).

+        465). This can be set with <em>sendemail.smtpserverport</em>.

 </p>

 </dd>

 <dt>

---smtp-user

+--smtp-ssl

 </dt>

 <dd>

 <p>

-        Username for SMTP-AUTH. In place of this option, the following

-        configuration variables can be specified:

+        Legacy alias for <em>--smtp-encryption ssl</em>.

 </p>

-<div class="ilist"><ul>

-<li>

-<p>

-sendemail.smtpuser

-</p>

-</li>

-<li>

-<p>

-sendemail.&lt;identity&gt;.smtpuser (see sendemail.identity).

-</p>

-</li>

-</ul></div>

-<div class="para"><p>However, --smtp-user always overrides these variables.</p></div>

-<div class="para"><p>If a username is not specified (with --smtp-user or a

-configuration variable), then authentication is not attempted.</p></div>

 </dd>

 <dt>

---smtp-pass

+--smtp-user

 </dt>

 <dd>

 <p>

-        Password for SMTP-AUTH. The argument is optional: If no

-        argument is specified, then the empty string is used as

-        the password.

-</p>

-<div class="para"><p>In place of this option, the following configuration variables

-can be specified:</p></div>

-<div class="ilist"><ul>

-<li>

-<p>

-sendemail.smtppass

+        Username for SMTP-AUTH. Default is the value of <em>sendemail.smtpuser</em>;

+        if a username is not specified (with <em>--smtp-user</em> or <em>sendemail.smtpuser</em>),

+        then authentication is not attempted.

 </p>

-</li>

-<li>

-<p>

-sendemail.&lt;identity&gt;.smtppass (see sendemail.identity).

-</p>

-</li>

-</ul></div>

-<div class="para"><p>However, --smtp-pass always overrides these variables.</p></div>

-<div class="para"><p>Furthermore, passwords need not be specified in configuration files

-or on the command line. If a username has been specified (with

---smtp-user or a configuration variable), but no password has been

-specified (with --smtp-pass or a configuration variable), then the

-user is prompted for a password while the input is masked for privacy.</p></div>

 </dd>

+</dl></div>

+<h3 id="_automating">Automating</h3><div style="clear:left"></div>

+<div class="vlist"><dl>

 <dt>

---smtp-encryption

+--cc-cmd

 </dt>

 <dd>

 <p>

-        Specify the encryption to use, either <em>ssl</em> or <em>tls</em>.  Any other

-        value reverts to plain SMTP.  Default is the value of

-        <em>sendemail.smtpencryption</em>.

+        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 <em>sendemail.cccmd</em> configuration value.

 </p>

 </dd>

 <dt>

---smtp-ssl

+--[no-]chain-reply-to

 </dt>

 <dd>

 <p>

-        Legacy alias for <em>--smtp-encryption=ssl</em>.

+        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 <em>sendemail.chainreplyto</em>

+        configuration value; if that is unspecified, default to --chain-reply-to.

 </p>

 </dd>

 <dt>

---subject

+--identity

 </dt>

 <dd>

 <p>

-        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.

+        A configuration identity. When given, causes values in the

+        <em>sendemail.&lt;identity&gt;</em> subsection to take precedence over

+        values in the <em>sendemail</em> section. The default identity is

+        the value of <em>sendemail.identity</em>.

 </p>

 </dd>

 <dt>

---suppress-from

-</dt>

-<dt>

---no-suppress-from

+--[no-]signed-off-by-cc

 </dt>

 <dd>

 <p>

-        If this is set, do not add the From: address to the cc: list.

-        Default is the value of <em>sendemail.suppressfrom</em> configuration value;

-        if that is unspecified, default to --no-suppress-from.

+        If this is set, add emails found in Signed-off-by: or Cc: lines to the

+        cc list. Default is the value of <em>sendemail.signedoffbycc</em> configuration

+        value; if that is unspecified, default to --signed-off-by-cc.

 </p>

 </dd>

 <dt>

@@ -581,20 +555,29 @@ user is prompted for a password while the input is masked for privacy.</p></div>
 </p>

 </dd>

 <dt>

---thread

+--[no-]suppress-from

 </dt>

+<dd>

+<p>

+        If this is set, do not add the From: address to the cc: list.

+        Default is the value of <em>sendemail.suppressfrom</em> configuration

+        value; if that is unspecified, default to --no-suppress-from.

+</p>

+</dd>

 <dt>

---no-thread

+--[no-]thread

 </dt>

 <dd>

 <p>

         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 <em>sendemail.thread</em> configuration value;

-        if that is unspecified, default to --thread.

+        header set. Default is the value of the <em>sendemail.thread</em> configuration

+        value; if that is unspecified, default to --thread.

 </p>

 </dd>

+</dl></div>

+<h3 id="_administering">Administering</h3><div style="clear:left"></div>

+<div class="vlist"><dl>

 <dt>

 --dry-run

 </dt>

@@ -604,31 +587,32 @@ user is prompted for a password while the input is masked for privacy.</p></div>
 </p>

 </dd>

 <dt>

---envelope-sender

+--quiet

 </dt>

 <dd>

 <p>

-        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 <em>sendemail.envelopesender</em> configuration

-        variable; if that is unspecified, choosing the envelope sender is left

-        to your MTA.

+        Make git-send-email less verbose.  One line per email should be

+        all that is output.

 </p>

 </dd>

 <dt>

---to

+--[no-]validate

 </dt>

 <dd>

 <p>

-        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 <em>sendemail.to</em> configuration value;

-        if that is unspecified, this will be prompted for.

+        Perform sanity checks on patches.

+        Currently, validation means the following:

 </p>

-<div class="para"><p>The --to option must be repeated for each user you want on the to list.</p></div>

+<div class="ilist"><ul>

+<li>

+<p>

+Warn of patches that contain lines longer than 998 characters; this

+                        is due to SMTP limits as described by http://www.ietf.org/rfc/rfc2821.txt.

+</p>

+</li>

+</ul></div>

+<div class="para"><p>Default is the value of <em>sendemail.validate</em>; if this is not set,

+default to <em>--validate</em>.</p></div>

 </dd>

 </dl></div>

 </div>

@@ -636,18 +620,6 @@ user is prompted for a password while the input is masked for privacy.</p></div>
 <div class="sectionbody">

 <div class="vlist"><dl>

 <dt>

-sendemail.identity

-</dt>

-<dd>

-<p>

-        The default configuration identity. When specified,

-        <em>sendemail.&lt;identity&gt;.&lt;item&gt;</em> will have higher precedence than

-        <em>sendemail.&lt;item&gt;</em>. This is useful to declare multiple SMTP

-        identities and to hoist sensitive authentication information

-        out of the repository and into the global configuration file.

-</p>

-</dd>

-<dt>

 sendemail.aliasesfile

 </dt>

 <dd>

@@ -665,89 +637,6 @@ sendemail.aliasfiletype
         one of <em>mutt</em>, <em>mailrc</em>, <em>pine</em>, or <em>gnus</em>.

 </p>

 </dd>

-<dt>

-sendemail.to

-</dt>

-<dd>

-<p>

-        Email address (or alias) to always send to.

-</p>

-</dd>

-<dt>

-sendemail.cccmd

-</dt>

-<dd>

-<p>

-        Command to execute to generate per patch file specific "Cc:"s.

-</p>

-</dd>

-<dt>

-sendemail.bcc

-</dt>

-<dd>

-<p>

-        Email address (or alias) to always bcc.

-</p>

-</dd>

-<dt>

-sendemail.chainreplyto

-</dt>

-<dd>

-<p>

-        Boolean value specifying the default to the <em>--chain_reply_to</em>

-        parameter.

-</p>

-</dd>

-<dt>

-sendemail.smtpserver

-</dt>

-<dd>

-<p>

-        Default SMTP server to use.

-</p>

-</dd>

-<dt>

-sendemail.smtpserverport

-</dt>

-<dd>

-<p>

-        Default SMTP server port to use.

-</p>

-</dd>

-<dt>

-sendemail.smtpuser

-</dt>

-<dd>

-<p>

-        Default SMTP-AUTH username.

-</p>

-</dd>

-<dt>

-sendemail.smtppass

-</dt>

-<dd>

-<p>

-        Default SMTP-AUTH password.

-</p>

-</dd>

-<dt>

-sendemail.smtpencryption

-</dt>

-<dd>

-<p>

-        Default encryption method.  Use <em>ssl</em> for SSL (and specify an

-        appropriate port), or <em>tls</em> for TLS.  Takes precedence over

-        <em>smtpssl</em> if both are specified.

-</p>

-</dd>

-<dt>

-sendemail.smtpssl

-</dt>

-<dd>

-<p>

-        Legacy boolean that sets <em>smtpencryption=ssl</em> if enabled.

-</p>

-</dd>

 </dl></div>

 </div>

 <h2 id="_author">Author</h2>

@@ -766,7 +655,7 @@ send_lots_of_email.pl by Greg Kroah-Hartman.</p></div>
 </div>

 <div id="footer">

 <div id="footer-text">

-Last updated 2008-09-19 06:33:11 UTC

+Last updated 2008-10-10 15:30:50 UTC

 </div>

 </div>

 </body>