Rocco Rutte:
[apps/madmutt.git] / doc / manual.sgml.head
index 7bbf027..6469349 100644 (file)
@@ -2460,6 +2460,15 @@ ifndef feature_slang 'source ~/.mutt-ng/setup-ncurses'</verb>
 
   <!--}}}--> 
 
+<sect>Obsolete Variables <!--{{{--> 
+
+<p>In the process of ensuring and creating more consistency, many
+variables have been renamed and some of the old names were already
+removed. Please see <ref id="sect_obsolete" name="Obsolete Variables">
+for a complete list.
+
+<!--}}}--> 
+
 <!--}}}--> 
 
 <chapt>Advanced Usage <!--{{{--> 
@@ -3269,21 +3278,37 @@ current message into a whole different thread.
 
 <!--}}}--> 
 
-<sect>Delivery Status Notification (DSN) Support <!--{{{--> 
+<sect>Delivery Status Notification (DSN) Support<label id="dsn"> <!--{{{--> 
 <p>
 
 RFC1894 defines a set of MIME content types for relaying information
 about the status of electronic mail messages.  These can be thought of as
-``return receipts.'' Berkeley sendmail 8.8.x currently has some command
-line options in which the mail client can make requests as to what type
-of status messages should be returned.
+``return receipts.''
+
+Users can make use of it in one of the following two ways:
+
+<itemize>
+  <item>Berkeley sendmail 8.8.x currently has some command line options
+    in which the mail client can make requests as to what type of status
+    messages should be returned.
+  <item>The SMTP support via libESMTP supports it, too.
+</itemize>
+
+To support this, there are two variables:
+
+<itemize>
+
+  <item><ref id="dsn_notify" name="&dollar;dsn&lowbar;notify"> is used
+    to request receipts for different results (such as failed message,
+    message delivered, etc.).
 
-To support this, there are two variables. <ref id="dsn_notify"
-name="&dollar;dsn&lowbar;notify"> is used to request receipts for
-different results (such as failed message, message delivered, etc.).
-<ref id="dsn_return" name="&dollar;dsn&lowbar;return"> requests how much
-of your message should be returned with the receipt (headers or full
-message).  Refer to the man page on sendmail for more details on DSN.
+  <item><ref id="dsn_return" name="&dollar;dsn&lowbar;return"> requests
+    how much of your message should be returned with the receipt
+    (headers or full message).
+
+</itemize>
+
+Please see the reference chapter for possible values.
 
 <!--}}}--> 
 
@@ -3512,6 +3537,42 @@ score !~* =42
 
 <!--}}}--> 
 
+<sect>SMTP Support (OPTIONAL) <!--{{{--> 
+
+<p>Mutt-ng can be built using a library called ``libESMTP'' which
+provides SMTP functionality. When <tt/configure/ was called with
+<tt/--with-libesmtp/ or the output <tt>muttng -v</tt> contains
+<tt>+USE_LIBESMTP</tt>, this will be or is the case already. The SMTP
+support includes support for Delivery Status Notification (see <ref
+id="dsn" name="Delivery Status Notification"> section) as well as
+handling the <tt/8BITMIME/ flag controlled via <ref id="use_8bitmime"
+name="&dollar;use&lowbar;8bitmime">.
+
+<p>To enable sending mail directly via SMTP without an MTA such as
+Postfix or SSMTP and the like, simply set the <ref id="smtp_host"
+name="&dollar;smtp&lowbar;host"> variable pointing to your SMTP server.
+
+<p>Authentication mechanisms are available via the <ref id="smtp_user"
+name="&dollar;smtp&lowbar;user"> and <ref id="smtp_pass"
+name="&dollar;smtp&lowbar;pass"> variables.
+
+<p>Transport Encryption via the StartTLS command is also available. For
+this to work, first of all Mutt-ng must be built with SSL or GNUTLS.
+Secondly, the <ref id="smtp_use_tls"
+name="&dollar;smtp&lowbar;use&lowbar;tls"> variable must be either set
+to ``enabled'' or ``required.'' In both cases, StartTLS will be used if
+the server supports it: for the second case, the connection will fail if
+it doesn't while switching back to unencrypted communication for the
+first one.
+
+<p>Some mail providers require user's to set a particular envelope
+sender, i.e. they allow for only one value which may not be what the
+user wants to send as the <tt/From:/ header. In this case, the variable
+<ref id="smtp_envelope" name="&dollar;smtp&lowbar;envelope"> may be used
+to set the envelope different from the <tt/From:/ header.
+
+<!-- }}} -->
+
 <sect>Managing multiple IMAP/POP/NNTP accounts (OPTIONAL)<label id="account-hook"> <!--{{{--> 
 <p>
 
@@ -4471,5 +4532,60 @@ The following are the commands understood by mutt.
 </itemize>
 
 <sect>Configuration variables<label id="variables">
+
+<p>The following list contains all variables which, in the process of
+providing more consistency, have been renamed and are partially even
+removed already. The left column contains the old synonym variables,
+the right column the full/new name:
+
+<label id="sect_obsolete">
+<tscreen><verb>
+edit_hdrs               edit_headers
+forw_decode             forward_decode
+forw_format             forward_format
+forw_quote              forward_quote
+hdr_format              index_format
+indent_str              indent_string
+mime_fwd                mime_forward
+msg_format              message_format
+pgp_autosign            crypt_autosign
+pgp_autoencrypt         crypt_autoencrypt
+pgp_replyencrypt        crypt_replyencrypt
+pgp_replysign           crypt_replysign
+pgp_replysignencrypted  crypt_replysignencrypted
+pgp_verify_sig          crypt_verify_sig
+pgp_create_traditional  pgp_autoinline
+pgp_auto_traditional    pgp_replyinline
+forw_decrypt            forward_decrypt
+smime_sign_as           smime_default_key
+post_indent_str         post_indent_string
+print_cmd               print_command
+shorten_hierarchy       sidebar_shorten_hierarchy
+ask_followup_to         nntp_ask_followup_to
+ask_x_comment_to        nntp_ask_x_comment_to
+catchup_newsgroup       nntp_catchup
+followup_to_poster      nntp_followup_to_poster
+group_index_format      nntp_group_index_format
+inews                   nntp_inews
+mime_subject            nntp_mime_subject
+news_cache_dir          nntp_cache_dir
+news_server             nntp_host
+newsrc                  nntp_newsrc
+nntp_poll               nntp_mail_check
+pop_checkinterval       pop_mail_check
+post_moderated          nntp_post_moderated
+save_unsubscribed       nntp_save_unsubscribed
+show_new_news           nntp_show_new_news
+show_only_unread        nntp_show_only_unread
+x_comment_to            nntp_x_comment_to
+smtp_auth_username      smtp_user
+smtp_auth_password      smtp_pass
+</verb></tscreen>
+
+The <tt/contrib/ subdirectory contains a script named
+<tt/update-config.pl/ which eases migration.
+
+A complete list of current variables follows.
+
 <p>