X-Git-Url: http://git.madism.org/?p=apps%2Fmadmutt.git;a=blobdiff_plain;f=doc%2Fmanual.sgml.head;h=33fb23eae31568d4a17cceed24593fe530733058;hp=8ad8d3bc444d3f3c92c46872725ab5963cc8b527;hb=85486f8623f6d9a12f7b251445ac9d203d3ae348;hpb=6833ce8bdca2d64e14485118f2a4417b7e1cb1b1 diff --git a/doc/manual.sgml.head b/doc/manual.sgml.head index 8ad8d3b..33fb23e 100644 --- a/doc/manual.sgml.head +++ b/doc/manual.sgml.head @@ -13,37 +13,39 @@ Introduction

-Mutt Home Page +

This documentation additionaly contains documentation to Mutt-ng Home Page

- + Mailing Lists

-To subscribe to one of the following mailing lists, send a message with the -word - -- low traffic list for announcements - -- help, bug reports and feature requests - -- development mailing list + -- This is where the mutt-ng user support happens. + -- The development mailing list for mutt-ng -Software Distribution Sites

+So far, there are no official releases of Mutt-ng, but you can download +daily snapshots from + + IRC

-Visit channel to chat with other people interested in Mutt. +Visit channel to chat with other people interested in Mutt-ng. -USENET + +Weblog

-See the newsgroup . +If you want to read fresh news about the latest development in Mutt-ng, and get informed +about stuff like interesting, Mutt-ng-related articles and packages for your favorite +distribution, you can read and/or subscribe to our +. Copyright

@@ -411,7 +419,7 @@ you misspelled the passphrase.

(default: L) Reply to the current or tagged message(s) by extracting any addresses which -match the addresses given by the +match the regular expressions given by the commands, but also honor any configuration variable is set. Using this when replying to messages posted @@ -568,7 +576,7 @@ Also see .

If you want to use PGP, you can specify - + ``E'' encrypts, ``S'' signs and ``S<id>'' signs with the given key, setting Configuration

-While the default configuration (or ``preferences'') make Mutt -usable right out of the box, it is often desirable to tailor Mutt to -suit your own tastes. When Mutt is first invoked, it will attempt to -read the ``system'' configuration file (defaults set by your local -system administrator), unless the ``-n'' option is specified. This file is typically -/usr/local/share/mutt/Muttrc or /etc/Muttrc. Mutt -will next look for a file named .muttrc in your home -directory. If this file does not exist and your home directory has -a subdirectory named .mutt/muttrc. +While the default configuration (or ``preferences'') make Mutt-ng usable right out +of the box, it is often desirable to tailor Mutt to suit your own tastes. When +Mutt-ng is first invoked, it will attempt to read the ``system'' configuration +file (defaults set by your local system administrator), unless the ``-n'' option is specified. This file is +typically /usr/local/share/muttng/Muttngrc or /etc/Muttngrc, +Mutt-ng users will find this file in /usr/local/share/muttng/Muttrc or +/etc/Muttngrc. Mutt will next look for a file named .muttrc +in your home directory, Mutt-ng will look for .muttngrc. If this file +does not exist and your home directory has a subdirectory named .muttng/muttngrc. -.muttrc is the file where you will usually place your to configure Mutt. +.muttrc (or .muttngrc for Mutt-ng) is the file where you will +usually place your to configure Mutt. In addition, mutt supports version specific configuration files that are parsed instead of the default files as explained above. For instance, if @@ -806,6 +814,36 @@ A \ at the end of a line can be used to split commands over multiple lines, provided that the split points don't appear in the middle of command names. +Please note that, unlike the various shells, mutt-ng interpretes a ``\'' +at the end of a line also in comments. This allows you to disable a command +split over multiple lines with only one ``#''. + + +# folder-hook . \ + set realname="Michael \"MuttDude\" Elkins" + + +When testing your config files, beware the following caveat. The backslash +at the end of the commented line extends the current line with the next line +- then referred to as a ``continuation line''. As the first line is +commented with a hash (#) all following continuation lines are also +part of a comment and therefore are ignored, too. So take care of comments +when continuation lines are involved within your setup files! + +Abstract example: + + +line1\ +line2a # line2b\ +line3\ +line4 +line5 + + +line1 ``continues'' until line4. however, the part after the # is a +comment which includes line3 and line4. line5 is a new line of its own and +thus is interpreted again. + It is also possible to substitute the output of a Unix command in an initialization file. This is accomplished by enclosing the command in backquotes (``). For example, @@ -892,9 +930,11 @@ Usage: which the macro will be bound. +Multiple maps may be specified by separating multiple menu arguments by +commas. Whitespace may not be used in between the menu arguments and the +commas separating them. + . There are some additions however. The first is that control characters in .) +id="reply_to" name="$reply_to">.) Many users receive e-mail under a number of different addresses. To fully use mutt's features here, the program must be able to @@ -1195,8 +1240,18 @@ purpose of the Mailing lists

@@ -1215,7 +1270,7 @@ the Mail-Followup-To header is a non-standard extension which is not supported by all mail user agents. Adding it is not bullet-proof against receiving personal CCs of list messages. Also note that the generation of the Mail-Followup-To header is controlled by the configuration variable. +name="$followup_to"> configuration variable. More precisely, Mutt maintains lists of patterns for the addresses of known and subscribed mailing lists. Every subscribed mailing @@ -1235,8 +1290,8 @@ mailing list, you could add ``lists mutt-users'' to your initialization file. To tell mutt that you are subscribed to it, add ``subscribe mutt-users'' to your initialization file instead. If you also happen to get mail from someone whose address is - mailbox. See for information on the exact format of and a with its arguments. -Change settings based upon message recipients

Usage: -Usage: +Usage: variable depending on the message's sender +address. + +For each type of Spam detection

+Usage: +Usage: variable. (Tip: try +spam "X-DCC-.*-Metrics:.*(....)=many" "90+/DCC-%1" +spam "X-Spam-Status: Yes" "90+/SA" +spam "X-PerlMX-Spam: .*Probability=([0-9]+)%" "%1/PM" +set spam_separator=", " + + +If I then received a message that DCC registered with ``many'' hits +under the ``Fuz2'' checksum, and that PureMessage registered with a +97% probability of being spam, that message's spam tag would read +90+/DCC-Fuz2, 97/PM. (The four characters before ``=many'' in a +DCC report indicate the checksum used -- in this case, ``Fuz2''.) + +If the $spam_separator variable is unset, then each +spam pattern match supercedes the previous one. Instead of getting +joined +spam "^From: .*MAILER-DAEMON" "999" + + + Setting variables

Usage: @@ -1574,7 +1737,52 @@ path of your home directory. If the filename ends with a vertical bar (|), then source ~/bin/myscript|). + +Configuring features conditionaly

+Usage: +ifdef feature_imap 'source ~/.mutt-ng/imap_setup' +# or +# ifdef imap_user 'source ~/.mutt-ng/imap_setup' +# or +# ... + + +To exit mutt-ng directly if no NNTP support is compiled in: + +ifndef feature_nntp 'push q' +# or +# ifndef newsrc 'push q' +# or +# ... + + +To only set the when the system's SVN +is recent enough to have it: + +ifdef imap_mail_check 'set imap_mail_check=300' + Removing hooks

@@ -1770,6 +1978,7 @@ messages: ~f USER messages originating from USER ~g cryptographically signed messages ~G cryptographically encrypted messages +~H EXPR messages with a spam attribute matching EXPR ~h EXPR messages which contain EXPR in the message header ~k message contains PGP key material ~i ID message which match ID in the ``Message-ID'' field @@ -1795,6 +2004,10 @@ messages: ~y EXPR messages which contain EXPR in the `X-Label' field ~z [MIN]-[MAX] messages with a size in the range MIN to MAX *) ~= duplicated messages (see $duplicate_threads) +~$ unreferenced messages (requires threaded view) +~* ``From'' contains realname and (syntactically) valid + address (excluded are addresses matching against + alternates or any alias) Where EXPR, USER, ID, and SUBJECT are @@ -1871,8 +2084,9 @@ pattern language. For example, ~f "me@(mutt\.org|cs\.hmc\.edu)" -Without the quotes, the parenthesis would truncate the regular expression -to simply Searching by Date

@@ -1962,6 +2176,13 @@ manner. If the variable is set, the next operation applies to the tagged messages automatically, without requiring the ``tag-prefix''. +In or commands, +you can use the ``tag-prefix-cond'' operator. If there are no tagged +messages, mutt will "eat" the rest of the macro to abort it's execution. +Mutt will stop "eating" the macro when it encounters the ``end-cond'' +operator; after this operator the rest of the macro will be executed as +normal. + Using Hooks

A send-hook . 'unmy_hdr From:' -send-hook ~Cb@b.b my_hdr from: c@c.c +send-hook ~C'^b@b\.b$' my_hdr from: c@c.c Message Matching in Hooks

+The sidebar, a feature specific to Mutt-ng, allows you to use a mailbox listing +which looks very similar to the ones you probably know from GUI mail clients. +The sidebar lists all specified mailboxes, shows the number in each +and highlights the ones with new email +Use the following configuration commands: + +set sidebar_visible="yes" +set sidebar_width=25 + + +If you want to specify the mailboxes you can do so with: + +set mbox='=INBOX' +mailboxes INBOX \ + MBOX1 \ + MBOX2 \ + ... + + +You can also specify the colors for mailboxes with new mails by using: + +color sidebar_new red black +color sidebar white black + + +The available functions are: + +sidebar-scroll-up Scrolls the mailbox list up 1 page +sidebar-scroll-down Scrolls the mailbox list down 1 page +sidebar-next Hilights the next mailbox +sidebar-next-new Hilights the next mailbox with new mail +sidebar-previous Hilights the previous mailbox +sidebar-open Opens the currently hilighted mailbox + + +Reasonable key bindings look e.g. like this: + +bind index \Cp sidebar-prev +bind index \Cn sidebar-next +bind index \Cb sidebar-open +bind pager \Cp sidebar-prev +bind pager \Cn sidebar-next +bind pager \Cb sidebar-open + +macro index B ':toggle sidebar_visible^M' +macro pager B ':toggle sidebar_visible^M' + + +You can then go up and down by pressing Ctrl-P and Ctrl-N, and +switch on and off the sidebar simply by pressing 'B'. + External Address Queries

Mutt supports connecting to external directory databases such as LDAP, @@ -2056,7 +2330,7 @@ There are two mechanisms for accessing the query function of mutt. One is to do a query from the index menu using the query function (default: Q). This will prompt for a query, then bring up the query menu which will list the matching responses. From the query menu, you can select -addresses to create aliases, or to mail. You can tag multiple messages +addresses to create aliases, or to mail. You can tag multiple addresses to mail, start a new query, or have a new query appended to the current responses. @@ -2117,6 +2391,7 @@ path. ! -- refers to your (incoming) mailbox > -- refers to your file < -- refers to your file +^ -- refers to the current mailbox - or !! -- refers to the file you've last visited ˜ -- refers to your home directory = or + -- refers to your directory @@ -2184,10 +2459,11 @@ than the author of the message. This can create problems when trying to reply directly to the author in private, since most mail clients will automatically reply to the address given in the ``Reply-To'' field. Mutt uses the -variable to help decide which address to use. If set, you will be +variable to help decide which address to use. If set to Editing threads +

+Mutt has the ability to dynamically restructure threads that are broken +either by misconfigured software or bad behaviour from some +correspondents. This allows to clean your mailboxes formats) from these +annoyances which make it hard to follow a discussion. + +Linking threads +

+ +Some mailers tend to "forget" to correctly set the "In-Reply-To:" and +"References:" headers when replying to a message. This results in broken +discussions because Mutt has not enough information to guess the correct +threading. +You can fix this by tagging the reply, then moving to the parent message +and using the ``link-threads'' function (bound to & by default). The +reply will then be connected to this "parent" message. + +You can also connect multiple childs at once, tagging them and using the +tag-prefix command (';') or the auto_tag option. + +Breaking threads +

+ +On mailing lists, some people are in the bad habit of starting a new +discussion by hitting "reply" to any message from the list and changing +the subject to a totally unrelated one. +You can fix such threads by using the ``break-thread'' function (bound +by default to #), which will turn the subthread starting from the +current message into a whole different thread. + Delivery Status Notification (DSN) Support

+ 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 @@ -2243,7 +2551,7 @@ You can also specify different username for each folder, ie: Polling for new mail is more expensive over POP3 than locally. For this reason the frequency at which Mutt will check for mail remotely can be controlled by the - + variable, which defaults to every 60 seconds. If Mutt was compiled with SSL support (by running the variable. Polling for new mail on an IMAP server can cause noticeable delays. So, you'll want to carefully tune the - + and -variables. Personally I use - -set mail_check=90 -set timeout=15 - -with relatively good results over my slow modem line. +variables. Note that if you are using mbox as the mail store on UW servers prior to v12.250, the server has been reported to disconnect a client if another client @@ -2326,7 +2629,7 @@ As of version 1.2, mutt supports browsing mailboxes on an IMAP server. This is mostly the same as the local file browser, with the following differences: -In lieu of file permissions, mutt displays the string "IMAP", +Instead of file permissions, mutt displays the string "IMAP", possibly followed by the symbol "+", indicating that the entry contains both messages and subfolders. On Cyrus-like servers folders will often contain both messages and @@ -2336,8 +2639,10 @@ following differences: will choose to descend into the subfolder view. If you wish to view the messages in that folder, you must use view-file instead (bound to space by default). -You can delete mailboxes with the delete-mailbox - command (bound to d by default. You may also +You can create, delete and rename mailboxes with the + create-mailbox, delete-mailbox, and + rename-mailbox commands (default bindings: C, + d and r, respectively). You may also subscribe and unsubscribe to mailboxes (normally these are bound to s and u, respectively). @@ -2366,15 +2671,15 @@ in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, LOGIN. There are a few variables which control authentication: - - controls + - controls the username under which you request authentication on the IMAP server, for all authenticators. This is overridden by an explicit username in the mailbox path (ie by using a mailbox name of the form - a + - a password which you may preset, used by all authentication methods where a password is needed. - - a colon-delimited list of IMAP authentication methods to try, in the order you wish to try them. If specified, this overrides mutt's default (attempt everything, in the order @@ -2401,7 +2706,7 @@ account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"' Start a WWW Browser on URLs (EXTERNAL)

-If a message contains URLs (http://www.mutt.org/), it is efficient to get a menu with all the URLs and start a WWW browser on one of them. This functionality is provided by the external urlview program which can be @@ -2412,6 +2717,168 @@ macro index \cb |urlview\n macro pager \cb |urlview\n +Compressed folders Support (OPTIONAL) +

+ +If Mutt was compiled with compressed folders support (by running the +, + and ) which define commands to uncompress and compress +a folder and to append messages to an existing compressed folder +respectively. + +For example: + + +open-hook \\.gz$ "gzip -cd %f > %t" +close-hook \\.gz$ "gzip -c %t > %f" +append-hook \\.gz$ "gzip -c %t >> %f" + + +You do not have to specify all of the commands. If you omit , the folder will be open and +closed again each time you will add to it. If you omit (or give empty command) , the +folder will be open in the mode. If you specify though you'll be able to append +to the folder. + +Note that Mutt will only try to use hooks if the file is not in one of +the accepted formats. In particular, if the file is empty, mutt +supposes it is not compressed. This is important because it allows the +use of programs that do not have well defined extensions. Just use +&dquot;.&dquot; as a regexp. But this may be surprising if your +compressing script produces empty files. In this situation, unset , so that the compressed file +will be removed if you delete all of the messages. + +Open a compressed mailbox for reading

+Usage: +open-hook \\.gz$ "gzip -cd %f > %t" + + +If the Write a compressed mailbox

+Usage: command after some changes were made to it. + +The command. Temporary folder +in this case is the folder previously produced by the < command. + +The +close-hook \\.gz$ "gzip -c %t > %f" + + +If the is not called when you exit +from the folder if the folder was not changed. + +Append a message to a compressed mailbox

+Usage: command. +The temporary folder in this case contains the messages that are being +appended. + +The +append-hook \\.gz$ "gzip -c %t >> %f" + + +When is used, the folder is +not opened, which saves time, but this means that we can not find out +what the folder type is. Thus the default () type is always supposed (i.e. +this is the format used for the temporary folder). + +If the file does not exist when you save to it, is called, and not . is only +for appending to existing folders. + +If the and respectively) each time you will add to it. + +Encrypted folders +

+The compressed folders support can also be used to handle encrypted +folders. If you want to encrypt a folder with PGP, you may want to use +the following hooks: + + +open-hook \\.pgp$ "pgp -f < %f > %t" +close-hook \\.pgp$ "pgp -fe YourPgpUserIdOrKeyId < %t > %f" + + +Please note, that PGP does not support appending to an encrypted +folder, so there is no append-hook defined. + +Mutt's MIME Support

Quite a bit of effort has been made to make Mutt the premier text-mode @@ -2915,7 +3382,7 @@ associated with this extension will then be used to process the attachment according to the rules in the mailcap file and according to any other configuration options (such as auto_view) specified. Common usage would be: -mime-lookup application/octet-stream application/X-Lotus-Manuscript +mime_lookup application/octet-stream application/X-Lotus-Manuscript In addition, the unmime_lookup command may be used to disable this feature @@ -2991,6 +3458,8 @@ The following are the commands understood by mutt. + + - - @@ -3045,6 +3516,8 @@ The following are the commands understood by mutt. + + [no|inv] - + + -