584138-mx_update_context-segfault.patch: fix a segfault due to holes in IMAP headers...

[software/mutt-debian.git] / doc / Muttrc

diff --git a/doc/Muttrc b/doc/Muttrc
index 40ac02c8c01acd86442967e7fbeb1b07ef29da11..4ccb6437e0b118ac60b6184ca3ae21ed4c4adef3 100644 (file)
--- a/doc/Muttrc
+++ b/doc/Muttrc
@@ -87,7 +87,7 @@ attachments   +I text/plain
 ## line is unnecessary if you already have "attach-allow */.*", of
 ## course.  These are off by default!  The MIME elements contained
 ## within a message/* or multipart/* are still examined, even if the
 ## line is unnecessary if you already have "attach-allow */.*", of
 ## course.  These are off by default!  The MIME elements contained
 ## within a message/* or multipart/* are still examined, even if the

-## containers themseves don't qualify.
+## containers themselves don't qualify.

 ##
 #attachments  +A message/.* multipart/.*
 #attachments  +I message/.* multipart/.*
 ##
 #attachments  +A message/.* multipart/.*
 #attachments  +I message/.* multipart/.*


@@ -479,7 +479,7 @@ attachments   -I message/external-body
 # Upon startup Mutt tries to derive this value from environment variables
 # such as $LC_CTYPE or $LANG.
 # 
 # Upon startup Mutt tries to derive this value from environment variables
 # such as $LC_CTYPE or $LANG.
 # 

-# Note: It should only be set in case Mutt isn't abled to determine the
+# Note: It should only be set in case Mutt isn't able to determine the

 # character set used correctly.
 # 
 # 
 # character set used correctly.
 # 
 # 


@@ -778,7 +778,7 @@ attachments   -I message/external-body
 # 
 # If ``yes'', always attempt to verify PGP or S/MIME signatures.
 # If ``ask-*'', ask whether or not to verify the signature.
 # 
 # If ``yes'', always attempt to verify PGP or S/MIME signatures.
 # If ``ask-*'', ask whether or not to verify the signature.

-# If \Fi``no'', never attempt to verify cryptographic signatures.
+# If ``no'', never attempt to verify cryptographic signatures.

 # (Crypto only)
 # 
 # 
 # (Crypto only)
 # 
 # 


@@ -901,7 +901,7 @@ attachments   -I message/external-body
 # Note: when using $sendmail for delivery, you should not enable
 # this unless you are either using Sendmail 8.8.x or greater or a MTA
 # providing a sendmail(1)-compatible interface supporting the -N option
 # Note: when using $sendmail for delivery, you should not enable
 # this unless you are either using Sendmail 8.8.x or greater or a MTA
 # providing a sendmail(1)-compatible interface supporting the -N option

-# for DSN. For SMTP delivery, DSN support is autodetected so that it
+# for DSN. For SMTP delivery, DSN support is auto-detected so that it

 # depends on the server whether DSN will be used or not.
 # 
 # 
 # depends on the server whether DSN will be used or not.
 # 
 # 


@@ -922,7 +922,7 @@ attachments   -I message/external-body
 # Note: when using $sendmail for delivery, you should not enable
 # this unless you are either using Sendmail 8.8.x or greater or a MTA
 # providing a sendmail(1)-compatible interface supporting the -R option
 # Note: when using $sendmail for delivery, you should not enable
 # this unless you are either using Sendmail 8.8.x or greater or a MTA
 # providing a sendmail(1)-compatible interface supporting the -R option

-# for DSN. For SMTP delivery, DSN support is autodetected so that it
+# for DSN. For SMTP delivery, DSN support is auto-detected so that it

 # depends on the server whether DSN will be used or not.
 # 
 # 
 # depends on the server whether DSN will be used or not.
 # 
 # 


@@ -1008,7 +1008,7 @@ attachments   -I message/external-body
 # Default: "~"
 # 
 # 
 # Default: "~"
 # 
 # 

-# Escape character to use for functions in the builtin editor.
+# Escape character to use for functions in the built-in editor.

 # 
 # 
 # set fast_reply=no
 # 
 # 
 # set fast_reply=no


@@ -1077,6 +1077,7 @@ attachments   -I message/external-body
 # its own set of printf(3)-like sequences:
 # %C      current file number
 # %d      date/time folder was last modified
 # its own set of printf(3)-like sequences:
 # %C      current file number
 # %d      date/time folder was last modified

+# %D      date/time folder was last modified using $date_format.

 # %f      filename (``/'' is appended to directory names,
 #         ``@'' to symbolic links and ``*'' to executable
 #         files)
 # %f      filename (``/'' is appended to directory names,
 #         ``@'' to symbolic links and ``*'' to executable
 #         files)


@@ -1283,7 +1284,7 @@ attachments   -I message/external-body
 # When mutt is compiled with qdbm or tokyocabinet as header cache backend,
 # this option determines whether the database will be compressed.
 # Compression results in database files roughly being one fifth
 # When mutt is compiled with qdbm or tokyocabinet as header cache backend,
 # this option determines whether the database will be compressed.
 # Compression results in database files roughly being one fifth

-# of the usual diskspace, but the uncompression can result in a
+# of the usual diskspace, but the decompression can result in a

 # slower opening of cached folder(s) which in general is still
 # much faster than opening non header cached folders.
 # 
 # slower opening of cached folder(s) which in general is still
 # much faster than opening non header cached folders.
 # 


@@ -1480,7 +1481,7 @@ attachments   -I message/external-body
 # Default: no
 # 
 # 
 # Default: no
 # 
 # 

-# Affects the behaviour of the <reply> function when replying to
+# Affects the behavior of the <reply> function when replying to

 # messages from mailing lists (as defined by the ``subscribe'' or
 # ``lists'' commands).  When set, if the ``Reply-To:'' field is
 # set to the same value as the ``To:'' field, Mutt assumes that the
 # messages from mailing lists (as defined by the ``subscribe'' or
 # ``lists'' commands).  When set, if the ``Reply-To:'' field is
 # set to the same value as the ``To:'' field, Mutt assumes that the


@@ -1501,7 +1502,7 @@ attachments   -I message/external-body
 # This is a colon-delimited list of authentication methods mutt may
 # attempt to use to log in to an IMAP server, in the order mutt should
 # try them.  Authentication methods are either ``login'' or the right
 # This is a colon-delimited list of authentication methods mutt may
 # attempt to use to log in to an IMAP server, in the order mutt should
 # try them.  Authentication methods are either ``login'' or the right

-# side of an IMAP ``AUTH=xxx'' capability string, eg ``digest-md5'', ``gssapi''
+# side of an IMAP ``AUTH=xxx'' capability string, e.g. ``digest-md5'', ``gssapi''

 # or ``cram-md5''. This option is case-insensitive. If it's
 # unset (the default) mutt will try all available methods,
 # in order from most-secure to least-secure.
 # or ``cram-md5''. This option is case-insensitive. If it's
 # unset (the default) mutt will try all available methods,
 # in order from most-secure to least-secure.


@@ -1793,7 +1794,7 @@ attachments   -I message/external-body
 # %O      original save folder where mutt would formerly have
 #         stashed the message: list name or recipient name
 #         if not sent to a list
 # %O      original save folder where mutt would formerly have
 #         stashed the message: list name or recipient name
 #         if not sent to a list

-# %P      progress indicator for the builtin pager (how much of the file has been displayed)
+# %P      progress indicator for the built-in pager (how much of the file has been displayed)

 # %s      subject of the message
 # %S      status of the message (``N''/``D''/``d''/``!''/``r''/*)
 # %t      ``To:'' field (recipients)
 # %s      subject of the message
 # %S      status of the message (``N''/``D''/``d''/``!''/``r''/*)
 # %t      ``To:'' field (recipients)


@@ -1879,6 +1880,22 @@ attachments   -I message/external-body
 # new mail. Also see the $timeout variable.
 # 
 # 
 # new mail. Also see the $timeout variable.
 # 
 # 

+# set mail_check_recent=yes
+#
+# Name: mail_check_recent
+# Type: boolean
+# Default: yes
+# 
+# 
+# When set, Mutt will only notify you about new mail that has been received
+# since the last time you opened the mailbox.  When unset, Mutt will notify you
+# if any new mail exists in the mailbox, regardless of whether you have visited it
+# recently.
+# 
+# When $mark_old is set, Mutt does not consider the mailbox to contain new
+# mail if only old messages exist.
+# 
+# 

 # set mailcap_path=""
 #
 # Name: mailcap_path
 # set mailcap_path=""
 #
 # Name: mailcap_path


@@ -1991,7 +2008,7 @@ attachments   -I message/external-body
 # 
 # 
 # The default mailbox type used when creating new folders. May be any of
 # 
 # 
 # The default mailbox type used when creating new folders. May be any of

-# ``mbox'', ``MMDF'', ``MH'' and ``Maildir''. This is overriden by the
+# ``mbox'', ``MMDF'', ``MH'' and ``Maildir''. This is overridden by the

 # -m command-line option.
 # 
 # 
 # -m command-line option.
 # 
 # 


@@ -2108,7 +2125,7 @@ attachments   -I message/external-body
 # Default: no
 # 
 # 
 # Default: no
 # 
 # 

-# When unset, mutt will mimic mh's behaviour and rename deleted messages
+# When unset, mutt will mimic mh's behavior and rename deleted messages

 # to ,<old file name> in mh folders instead of really deleting
 # them. This leaves the message on disk but makes programs reading the folder
 # ignore it. If the variable is set, the message files will simply be
 # to ,<old file name> in mh folders instead of really deleting
 # them. This leaves the message on disk but makes programs reading the folder
 # ignore it. If the variable is set, the message files will simply be


@@ -2262,7 +2279,7 @@ attachments   -I message/external-body
 # 
 # 
 # This variable specifies which pager you would like to use to view
 # 
 # 
 # This variable specifies which pager you would like to use to view

-# messages. The value ``builtin'' means to use the builtin pager, otherwise this
+# messages. The value ``builtin'' means to use the built-in pager, otherwise this

 # variable should specify the pathname of the external pager you would
 # like to use.
 # 
 # variable should specify the pathname of the external pager you would
 # like to use.
 # 


@@ -2862,7 +2879,7 @@ attachments   -I message/external-body
 # This is a colon-delimited list of authentication methods mutt may
 # attempt to use to log in to an POP server, in the order mutt should
 # try them.  Authentication methods are either ``user'', ``apop'' or any
 # This is a colon-delimited list of authentication methods mutt may
 # attempt to use to log in to an POP server, in the order mutt should
 # try them.  Authentication methods are either ``user'', ``apop'' or any

-# SASL mechanism, eg ``digest-md5'', ``gssapi'' or ``cram-md5''.
+# SASL mechanism, e.g. ``digest-md5'', ``gssapi'' or ``cram-md5''.

 # This option is case-insensitive. If this option is unset
 # (the default) mutt will try all available methods, in order from
 # most-secure to least-secure.
 # This option is case-insensitive. If this option is unset
 # (the default) mutt will try all available methods, in order from
 # most-secure to least-secure.


@@ -2902,7 +2919,7 @@ attachments   -I message/external-body
 # 
 # 
 # The name of your POP server for the <fetch-mail> function.  You
 # 
 # 
 # The name of your POP server for the <fetch-mail> function.  You

-# can also specify an alternative port, username and password, ie:
+# can also specify an alternative port, username and password, i.e.:

 # [pop[s]://][username[:password]@]popserver[:port]
 # 
 # where ``[...]'' denotes an optional part.
 # [pop[s]://][username[:password]@]popserver[:port]
 # 
 # where ``[...]'' denotes an optional part.


@@ -3093,10 +3110,13 @@ attachments   -I message/external-body
 # Default: ""
 # 
 # 
 # Default: ""
 # 
 # 

-# This specifies the command that mutt will use to make external address
-# queries.  The string should contain a ``%s'', which will be substituted
-# with the query string the user types.  See ``query'' for more
-# information.
+# This specifies the command Mutt will use to make external address
+# queries.  The string may contain a ``%s'', which will be substituted
+# with the query string the user types.  Mutt will add quotes around the
+# string substituted for ``%s'' automatically according to shell quoting
+# rules, so you should avoid adding your own.  If no ``%s'' is found in
+# the string, Mutt will append the user's query to the end of the string.
+# See ``query'' for more information.

 # 
 # 
 # set query_format="%4c %t %-25.25a %-25.25n %?e?(%e)?"
 # 
 # 
 # set query_format="%4c %t %-25.25a %-25.25n %?e?(%e)?"


@@ -3334,7 +3354,7 @@ attachments   -I message/external-body
 # Default: yes
 # 
 # 
 # Default: yes
 # 
 # 

-# This variable fine-tunes the behaviour of the $reverse_name feature.
+# This variable fine-tunes the behavior of the $reverse_name feature.

 # When it is set, mutt will use the address from incoming messages as-is,
 # possibly including eventual real names.  When it is unset, mutt will
 # override any such real names with the setting of the $realname variable.
 # When it is set, mutt will use the address from incoming messages as-is,
 # possibly including eventual real names.  When it is unset, mutt will
 # override any such real names with the setting of the $realname variable.


@@ -3555,7 +3575,7 @@ attachments   -I message/external-body
 # this variable unless your signature contains just your name.  The
 # reason for this is because many software packages use ``-- \n'' to
 # detect your signature.  For example, Mutt has the ability to highlight
 # this variable unless your signature contains just your name.  The
 # reason for this is because many software packages use ``-- \n'' to
 # detect your signature.  For example, Mutt has the ability to highlight

-# the signature in a different color in the builtin pager.
+# the signature in a different color in the built-in pager.

 # 
 # 
 # set sig_on_top=no
 # 
 # 
 # set sig_on_top=no


@@ -3830,7 +3850,7 @@ attachments   -I message/external-body
 # Default: no
 # 
 # 
 # Default: no
 # 
 # 

-# The default behaviour of mutt is to use PGP on all auto-sign/encryption
+# The default behavior of mutt is to use PGP on all auto-sign/encryption

 # operations. To override and to use OpenSSL instead this must be set.
 # However, this has no effect while replying, since mutt will automatically
 # select the same application that was used to sign/encrypt the original
 # operations. To override and to use OpenSSL instead this must be set.
 # However, this has no effect while replying, since mutt will automatically
 # select the same application that was used to sign/encrypt the original


@@ -3950,7 +3970,7 @@ attachments   -I message/external-body
 # 
 # This is a colon-delimited list of authentication methods mutt may
 # attempt to use to log in to an SMTP server, in the order mutt should
 # 
 # This is a colon-delimited list of authentication methods mutt may
 # attempt to use to log in to an SMTP server, in the order mutt should

-# try them.  Authentication methods are any SASL mechanism, eg
+# try them.  Authentication methods are any SASL mechanism, e.g.

 # ``digest-md5'', ``gssapi'' or ``cram-md5''.
 # This option is case-insensitive. If it is ``unset''
 # (the default) mutt will try all available methods, in order from
 # ``digest-md5'', ``gssapi'' or ``cram-md5''.
 # This option is case-insensitive. If it is ``unset''
 # (the default) mutt will try all available methods, in order from


@@ -3984,8 +4004,8 @@ attachments   -I message/external-body
 # 
 # 
 # Defines the SMTP smarthost where sent messages should relayed for
 # 
 # 
 # Defines the SMTP smarthost where sent messages should relayed for

-# delivery. This should take the form of an SMTP URL, eg:
-# smtp[s]://[user[:pass]@]host[:port]/
+# delivery. This should take the form of an SMTP URL, e.g.:
+# smtp[s]://[user[:pass]@]host[:port]

 # 
 # where ``[...]'' denotes an optional part.
 # Setting this variable overrides the value of the $sendmail
 # 
 # where ``[...]'' denotes an optional part.
 # Setting this variable overrides the value of the $sendmail


@@ -4377,7 +4397,7 @@ attachments   -I message/external-body
 # personal mailbox where you might have several unrelated messages with
 # the subjects like ``hi'' which will get grouped together. See also
 # $sort_re for a less drastic way of controlling this
 # personal mailbox where you might have several unrelated messages with
 # the subjects like ``hi'' which will get grouped together. See also
 # $sort_re for a less drastic way of controlling this

-# behaviour.
+# behavior.

 # 
 # 
 # set suspend=yes
 # 
 # 
 # set suspend=yes


@@ -4408,11 +4428,11 @@ attachments   -I message/external-body
 # Note that $indent_string is ignored when this option is set.
 # 
 # 
 # Note that $indent_string is ignored when this option is set.
 # 
 # 

-# set thorough_search=no
+# set thorough_search=yes

 #
 # Name: thorough_search
 # Type: boolean
 #
 # Name: thorough_search
 # Type: boolean

-# Default: no
+# Default: yes

 # 
 # 
 # Affects the ~b and ~h search operations described in
 # 
 # 
 # Affects the ~b and ~h search operations described in


@@ -4472,7 +4492,7 @@ attachments   -I message/external-body
 # Default: 600
 # 
 # 
 # Default: 600
 # 
 # 

-# When Mutt is waiting for user input either idleing in menus or
+# When Mutt is waiting for user input either idling in menus or

 # in an interactive prompt, Mutt would block until input is
 # present. Depending on the context, this would prevent certain
 # operations from working, like checking for new mail or keeping
 # in an interactive prompt, Mutt would block until input is
 # present. Depending on the context, this would prevent certain
 # operations from working, like checking for new mail or keeping


@@ -4650,7 +4670,7 @@ attachments   -I message/external-body
 # 
 # 
 # Specifies the visual editor to invoke when the ``~v'' command is
 # 
 # 
 # Specifies the visual editor to invoke when the ``~v'' command is

-# given in the builtin editor.
+# given in the built-in editor.

 # 
 # 
 # set wait_key=yes
 # 
 # 
 # set wait_key=yes


@@ -4693,7 +4713,24 @@ attachments   -I message/external-body
 # 
 # When set to a positive value, mutt will wrap text at $wrap characters.
 # When set to a negative value, mutt will wrap text so that there are $wrap
 # 
 # When set to a positive value, mutt will wrap text at $wrap characters.
 # When set to a negative value, mutt will wrap text so that there are $wrap

-# characters of empty space on the right side of the terminal.
+# characters of empty space on the right side of the terminal. Setting it
+# to zero makes mutt wrap at the terminal width.
+# 
+# 
+# set wrap_headers=78
+#
+# Name: wrap_headers
+# Type: number
+# Default: 78
+# 
+# 
+# This option specifies the number of characters to use for wrapping
+# an outgoing message's headers. Allowed values are between 78 and 998
+# inclusive.
+# 
+# Note: This option usually shouldn't be changed. RFC5233
+# recommends a line length of 78 (the default), so please only change
+# this setting when you know what you're doing.

 # 
 # 
 # set wrap_search=yes
 # 
 # 
 # set wrap_search=yes