From: Floyd Anderson Date: Thu, 19 Apr 2018 03:42:01 +0000 (+0200) Subject: Reformat elements: indentation/wrapping X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=22d5ee9713bc923716b68fa63a524569b4f1fa85;p=neomutt Reformat elements: indentation/wrapping ...and tidy dashes, trailing whitespace, try to fix all spaces around brackets and punctuation marks etc., e.g. keep link tags on the same line to avoid an underlined space after hyperlinks in rendered result. --- diff --git a/doc/manual.xml.head b/doc/manual.xml.head index 61c5ba043..810a0efd0 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -15,24 +15,28 @@ vim: ts=2 sw=2 sts=2 expandtab: version @VERSION@ - All mail clients suck. This one just sucks less.— me, - circa 1995 + All mail clients suck. This one just sucks less. – me, + circa 1995 + Introduction - NeoMutt is a small but very powerful - text-based MIME mail client. NeoMutt is highly configurable, and is well - suited to the mail power user with advanced features like key bindings, - keyboard macros, mail threading, regular expression searches and a powerful - pattern matching language for selecting groups of messages. + NeoMutt is a small but very powerful + text-based MIME mail client. NeoMutt is highly configurable, and is well + suited to the mail power user with advanced features like key bindings, + keyboard macros, mail threading, regular expression searches and + a powerful pattern matching language for selecting groups of messages. + NeoMutt Home Page - The homepage can be found at - https://www.neomutt.org. + + The homepage can be found at + https://www.neomutt.org. + @@ -40,7 +44,7 @@ vim: ts=2 sw=2 sts=2 expandtab: - neomutt-users@neomutt.org — help, bug reports and + neomutt-users@neomutt.org – help, bug reports and feature requests. To subscribe to this list, please send a mail to neomutt-users-request@neomutt.org with the subject "subscribe". @@ -48,8 +52,8 @@ vim: ts=2 sw=2 sts=2 expandtab: - neomutt-devel@neomutt.org — development mailing list. - To subscribe to this list, please send a mail to + neomutt-devel@neomutt.org – development mailing + list. To subscribe to this list, please send a mail to neomutt-devel-request@neomutt.org with the subject "subscribe". @@ -63,16 +67,20 @@ vim: ts=2 sw=2 sts=2 expandtab: Issue Tracking System - Bugs may be reported on the devel mailing list, or on GitHub: - https://github.com/neomutt/neomutt/issues + + Bugs may be reported on the devel mailing list, or on GitHub: + https://github.com/neomutt/neomutt/issues + IRC - For the IRC user community, visit channel - #neomutt on - irc.freenode.net. + + For the IRC user community, visit channel + #neomutt on + irc.freenode.net. + @@ -80,25 +88,34 @@ vim: ts=2 sw=2 sts=2 expandtab: Contributing to NeoMutt - There are various ways to contribute to the NeoMutt project. - Especially for new users it may be helpful to meet other new and - experienced users to chat about NeoMutt, talk about problems and share - tricks. - Since translations of NeoMutt into other languages are highly - appreciated, the NeoMutt developers always look for skilled translators that - help improve and continue to maintain stale translations. - For contributing code patches for new features and bug fixes, - please refer to the developer pages at - https://www.neomutt.org/dev.html - for more details. + + There are various ways to contribute to the NeoMutt project. + + + Especially for new users it may be helpful to meet other new and + experienced users to chat about NeoMutt, talk about problems and share + tricks. + + + Since translations of NeoMutt into other languages are highly + appreciated, the NeoMutt developers always look for skilled translators + that help improve and continue to maintain stale translations. + + + For contributing code patches for new features and bug fixes, + please refer to the developer pages at + https://www.neomutt.org/dev.html + for more details. + Typographical Conventions - This section lists typographical conventions followed throughout - this manual. See table - for typographical conventions for special - terms. + + This section lists typographical conventions followed throughout this + manual. See table for typographical + conventions for special terms. + Typographical conventions for special terms @@ -148,100 +165,126 @@ vim: ts=2 sw=2 sts=2 expandtab:
- Examples are presented as: + + Examples are presented as: + neomutt -v - Within command synopsis, curly brackets ( - {}) denote a set of options of which one is mandatory, - square brackets ( - []) denote optional arguments, three dots denote that the - argument may be repeated arbitrary times. + + Within command synopsis, curly brackets ({}) denote + a set of options of which one is mandatory, square brackets + ([]) denote optional arguments, three dots denote that + the argument may be repeated arbitrary times. + Copyright - NeoMutt is Copyright © 1996-2016 Michael R. Elkins - me@neomutt.org and others. - This program is free software; you can redistribute it and/or - modify it under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 2 of the License, or (at - your option) any later version. - This program is distributed in the hope that it will be useful, but - WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General - Public License for more details. - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software Foundation, - Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + NeoMutt is Copyright © 1996-2016 Michael R. Elkins + me@neomutt.org and others. + + + This program is free software; you can redistribute it and/or modify it + under the terms of the GNU General Public License as published by the + Free Software Foundation; either version 2 of the License, or (at your + option) any later version. + + + This program is distributed in the hope that it will be useful, but + WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + General Public License for more details. + + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + Getting Started - This section is intended as a brief overview of how to use NeoMutt. - There are many other features which are described elsewhere in the manual. - There is even more information available in the NeoMutt FAQ and various web - pages. See the - NeoMutt homepage for more - details. - The keybindings described in this section are the defaults as - distributed. Your local system administrator may have altered the defaults - for your site. You can always type - ?in any menu to display the current bindings. - The first thing you need to do is invoke NeoMutt, simply by typing - neomutt at the command line. There are various command-line - options, see either the NeoMutt man page or the - reference. + + This section is intended as a brief overview of how to use NeoMutt. + There are many other features which are described elsewhere in the + manual. There is even more information available in the NeoMutt FAQ and + various web pages. See the + NeoMutt homepage for more + details. + + + The keybindings described in this section are the defaults as + distributed. Your local system administrator may have altered the + defaults for your site. You can always type ? in any menu + to display the current bindings. + + + The first thing you need to do is invoke NeoMutt, simply by typing + neomutt at the command line. There are various + command-line options, see either the NeoMutt man page or the + reference. + Core Concepts - NeoMutt is a text-based application which interacts with users through - different menus which are mostly line-/entry-based or page-based. A - line-based menu is the so-called - index menu (listing all messages of the currently opened - folder) or the - alias menu (allowing you to select recipients from a list). - Examples for page-based menus are the - pager(showing one message at a time) or the - help menu listing all available key bindings. - The user interface consists of a context sensitive help line at the - top, the menu's contents followed by a context sensitive status line and - finally the command line. The command line is used to display - informational and error messages as well as for prompts and for entering - interactive commands. - NeoMutt is configured through variables which, if the user wants to - permanently use a non-default value, are written to configuration files. - NeoMutt supports a rich config file syntax to make even complex - configuration files readable and commentable. - Because NeoMutt allows for customizing almost all key bindings, there - are so-called - functions which can be executed manually (using the command - line) or in macros. Macros allow the user to bind a sequence of commands - to a single key or a short key sequence instead of repeating a sequence - of actions over and over. - Many commands (such as saving or copying a message to another - folder) can be applied to a single message or a set of messages - (so-called - tagged messages). To help selecting messages, NeoMutt provides - a rich set of message patterns (such as recipients, sender, body - contents, date sent/received, etc.) which can be combined into complex - expressions using the boolean - and and - or operations as well as negating. These patterns can - also be used to (for example) search for messages or to limit the index - to show only matching messages. - NeoMutt supports a - hook concept which allows the user to execute arbitrary - configuration commands and functions in certain situations such as - entering a folder, starting a new message or replying to an existing one. - These hooks can be used to highly customize NeoMutt's behavior including - managing multiple identities, customizing the display for a folder or - even implementing auto-archiving based on a per-folder basis and much - more. - Besides an interactive mode, NeoMutt can also be used as a - command-line tool only send messages. It also supports a - mailx(1)-compatible interface, see - for a complete list of - command-line options. + + NeoMutt is a text-based application which interacts with users through + different menus which are mostly line-/entry-based or page-based. + A line-based menu is the so-called index menu (listing + all messages of the currently opened folder) or the + alias menu (allowing you to select recipients from + a list). Examples for page-based menus are the pager + (showing one message at a time) or the help menu listing + all available key bindings. + + + The user interface consists of a context sensitive help line at the + top, the menu's contents followed by a context sensitive status line + and finally the command line. The command line is used to display + informational and error messages as well as for prompts and for + entering interactive commands. + + + NeoMutt is configured through variables which, if the user wants to + permanently use a non-default value, are written to configuration + files. NeoMutt supports a rich config file syntax to make even complex + configuration files readable and commentable. + + + Because NeoMutt allows for customizing almost all key bindings, there + are so-called functions which can be executed manually + (using the command line) or in macros. Macros allow the user to bind + a sequence of commands to a single key or a short key sequence instead + of repeating a sequence of actions over and over. + + + Many commands (such as saving or copying a message to another folder) + can be applied to a single message or a set of messages (so-called + tagged messages). To help selecting messages, NeoMutt + provides a rich set of message patterns (such as recipients, sender, + body contents, date sent/received, etc.) which can be combined into + complex expressions using the boolean and and + or operations as well as negating. These patterns + can also be used to (for example) search for messages or to limit the + index to show only matching messages. + + + NeoMutt supports a hook concept which allows the user to + execute arbitrary configuration commands and functions in certain + situations such as entering a folder, starting a new message or + replying to an existing one. These hooks can be used to highly + customize NeoMutt's behavior including managing multiple identities, + customizing the display for a folder or even implementing + auto-archiving based on a per-folder basis and much more. + + + Besides an interactive mode, NeoMutt can also be used as a command-line + tool only send messages. It also supports + a mailx(1)-compatible interface, see + for a complete list of + command-line options. + @@ -249,60 +292,76 @@ vim: ts=2 sw=2 sts=2 expandtab: Index - The index is the screen that you usually see first when you start - NeoMutt. It gives an overview over your emails in the currently opened - mailbox. By default, this is your system mailbox. The information you - see in the index is a list of emails, each with its number on the left, - its flags (new email, important email, email that has been forwarded or - replied to, tagged email, ...), the date when email was sent, its - sender, the email size, and the subject. Additionally, the index also - shows thread hierarchies: when you reply to an email, and the other - person replies back, you can see the other person's email in a - "sub-tree" below. This is especially useful for personal email between - a group of people or when you've subscribed to mailing lists. + + The index is the screen that you usually see first when you start + NeoMutt. It gives an overview over your emails in the currently + opened mailbox. By default, this is your system mailbox. The + information you see in the index is a list of emails, each with its + number on the left, its flags (new email, important email, email that + has been forwarded or replied to, tagged email, ...), the date when + email was sent, its sender, the email size, and the subject. + Additionally, the index also shows thread hierarchies: when you reply + to an email, and the other person replies back, you can see the other + person's email in a "sub-tree" below. This is especially useful for + personal email between a group of people or when you've subscribed to + mailing lists. + Pager - The pager is responsible for showing the email content. On the - top of the pager you have an overview over the most important email - headers like the sender, the recipient, the subject, and much more - information. How much information you actually see depends on your - configuration, which we'll describe below. - Below the headers, you see the email body which usually contains - the message. If the email contains any attachments, you will see more - information about them below the email body, or, if the attachments are - text files, you can view them directly in the pager. - To give the user a good overview, it is possible to configure - NeoMutt to show different things in the pager with different colors. - Virtually everything that can be described with a regular expression - can be colored, e.g. URLs, email addresses or smileys. + + The pager is responsible for showing the email content. On the top of + the pager you have an overview over the most important email headers + like the sender, the recipient, the subject, and much more + information. How much information you actually see depends on your + configuration, which we'll describe below. + + + Below the headers, you see the email body which usually contains the + message. If the email contains any attachments, you will see more + information about them below the email body, or, if the attachments + are text files, you can view them directly in the pager. + + + To give the user a good overview, it is possible to configure NeoMutt + to show different things in the pager with different colors. + Virtually everything that can be described with a regular expression + can be colored, e.g. URLs, email addresses or smileys. + File Browser - The file browser is the interface to the local or remote file - system. When selecting a mailbox to open, the browser allows custom - sorting of items, limiting the items shown by a regular expression and - a freely adjustable format of what to display in which way. It also - allows for easy navigation through the file system when selecting - file(s) to attach to a message, select multiple files to attach and - many more. + + The file browser is the interface to the local or remote file system. + When selecting a mailbox to open, the browser allows custom sorting + of items, limiting the items shown by a regular expression and + a freely adjustable format of what to display in which way. It also + allows for easy navigation through the file system when selecting + file(s) to attach to a message, select multiple files to attach and + many more. + Sidebar - The Sidebar shows a list of all your mailboxes. The list can be - turned on and off, it can be themed and the list style can be - configured. - This part of the manual is suitable for beginners. If you already - know NeoMutt you could skip ahead to the main - Sidebar guide. If you just want to get - started, you could use the sample - Sidebar neomuttrc. - To check if NeoMutt supports - Sidebar, look for the string - +sidebar in the neomutt version. + + The Sidebar shows a list of all your mailboxes. The list can be + turned on and off, it can be themed and the list style can be + configured. + + + This part of the manual is suitable for beginners. If you already + know NeoMutt you could skip ahead to the main + Sidebar guide. If you just want to get + started, you could use the sample + Sidebar neomuttrc. + + + To check if NeoMutt supports Sidebar, look for the + string +sidebar in the neomutt version. + neomutt -v Let's turn on the Sidebar: @@ -314,8 +373,10 @@ set sidebar_format = "%B%?F? [%F]?%* %?N?%N/?%S" set mail_check_stats - You will see something like this. A list of mailboxes on the - left. A list of emails, from the selected mailbox, on the right. + + You will see something like this. A list of mailboxes on the left. + A list of emails, from the selected mailbox, on the right. + Fruit [1] 3/8| 1 + Jan 24 Rhys Lee (192) Yew @@ -330,26 +391,29 @@ Seas 1/7| 4 ! Feb 28 Summer Jackson (264) Lemon | - This user has four mailboxes: - Fruit, - Cars, - Animals and - Seas. - The current, open, mailbox is - Fruit. We can also see information about the other - mailboxes. For example: The - Animals mailbox contains, 1 flagged email, 2 new emails - out of a total of 6 emails. + + This user has four mailboxes: Fruit, + Cars, Animals and Seas. + + + The current, open, mailbox is Fruit. We can also see + information about the other mailboxes. For example: The + Animals mailbox contains, 1 flagged email, 2 new + emails out of a total of 6 emails. + Navigation - The Sidebar adds some new - functions to NeoMutt. - The user pressed the - c key to - <change-folder>to the - Animals mailbox. The Sidebar automatically updated the - indicator to match. + + The Sidebar adds some new + functions to NeoMutt. + + + The user pressed the c key to + <change-folder> to the + Animals mailbox. The Sidebar automatically updated + the indicator to match. + Fruit [1] 3/8| 1 Jan 03 Tia Gibson (362) Caiman @@ -364,7 +428,9 @@ Seas 1/7| 4 Sep 25 Grace Hall ( 27) Capybara | - Let's map some functions: + + Let's map some functions: + bind index,pager \CP sidebar-prev # Ctrl-Shift-P – Previous Mailbox @@ -372,10 +438,11 @@ bind index,pager \CN sidebar-next # Ctrl-Shift-N bind index,pager \CO sidebar-open # Ctrl-Shift-O – Open Highlighted Mailbox - Press - Ctrl-Shift-N(Next mailbox) twice will move the Sidebar - highlight to down to the - Seas mailbox. + + Press Ctrl-Shift-N (Next mailbox) twice will move + the Sidebar highlight to down to + the Seas mailbox. + Fruit [1] 3/8| 1 Jan 03 Tia Gibson (362) Caiman @@ -391,17 +458,18 @@ Cars 4| 3 ! Aug 16 Ewan Brown (333) Hummingbird - Functions - <sidebar-next>and - <sidebar-prev>move the Sidebar - highlight. They - do not change the open - mailbox. + + Functions <sidebar-next> and + <sidebar-prev> move the Sidebar + highlight. They do not change the open mailbox. + - Press - Ctrl-Shift-O( - <sidebar-open>) to open the highlighted - mailbox. + + Press Ctrl-Shift-O + (<sidebar-open>) to open the highlighted + mailbox. + Fruit [1] 3/8| 1 ! Mar 07 Finley Jones (139) Molucca Sea @@ -420,47 +488,65 @@ Cars 4| 3 + Feb 28 Imogen Baker (193) Pechora Sea Features - The Sidebar shows a list of mailboxes in a panel. - Everything about the Sidebar can be configured. + + The Sidebar shows a list of mailboxes in a panel. + + + Everything about the Sidebar can be configured. + <link linkend="intro-sidebar-basics">State of the Sidebar</link> - Visibility + + Visibility + - Width + + Width + - <link linkend="intro-sidebar-limit">Which mailboxes are - displayed</link> + <link linkend="intro-sidebar-limit">Which mailboxes are displayed</link> - Display all + + Display all + - Limit to mailboxes with new mail + + Limit to mailboxes with new mail + - Whitelist mailboxes to display always + + Whitelist mailboxes to display always + - <link linkend="sidebar-sort">The order in which mailboxes are - displayed</link> + <link linkend="sidebar-sort">The order in which mailboxes are displayed</link> - Unsorted (order of mailboxes commands) + + Unsorted (order of mailboxes commands) + - Sorted alphabetically + + Sorted alphabetically + - Sorted by number of new mails + + Sorted by number of new mails + @@ -468,13 +554,19 @@ Cars 4| 3 + Feb 28 Imogen Baker (193) Pechora Sea Color - Sidebar indicators and divider + + Sidebar indicators and divider + - Mailboxes depending on their type + + Mailboxes depending on their type + - Mailboxes depending on their contents + + Mailboxes depending on their contents + @@ -482,53 +574,61 @@ Cars 4| 3 + Feb 28 Imogen Baker (193) Pechora Sea Key bindings - Hide/Unhide the Sidebar + + Hide/Unhide the Sidebar + - Select previous/next mailbox + + Select previous/next mailbox + - Select previous/next mailbox with new mail + + Select previous/next mailbox with new mail + - Page up/down through a list of mailboxes + + Page up/down through a list of mailboxes + Misc - Formatting string for - mailbox + Formatting string for mailbox - Wraparound - searching + Wraparound searching - Flexible mailbox - abbreviations + Flexible mailbox abbreviations - Support for Unicode mailbox names (UTF-8) + + Support for Unicode mailbox names (UTF-8) + Display - Everything about the Sidebar can be configured. + + Everything about the Sidebar can be configured. + For a quick reference: - Sidebar variables to - set + Sidebar variables to set @@ -545,24 +645,29 @@ Cars 4| 3 + Feb 28 Imogen Baker (193) Pechora Sea Sidebar Basics - The most important variable is - $sidebar_visible. You can set this in your - neomuttrc, or bind a key to the function - <sidebar-toggle-visible>. + + The most important variable is + $sidebar_visible. You can set this in your + neomuttrc, or bind a key to the function + <sidebar-toggle-visible>. + set sidebar_visible # Make the Sidebar visible by default bind index,pager B sidebar-toggle-visible # Use 'B' to switch the Sidebar on and off - Next, decide how wide you want the Sidebar to be. 25 - characters might be enough for the mailbox name and some numbers. - Remember, you can hide/show the Sidebar at the press of - button. - Finally, you might want to change the divider character. By - default, Sidebar draws an ASCII line between it and the Index panel - If your terminal supports it, you can use a Unicode line-drawing - character. + + Next, decide how wide you want the Sidebar to be. 25 characters + might be enough for the mailbox name and some numbers. Remember, + you can hide/show the Sidebar at the press of button. + + + Finally, you might want to change the divider character. By + default, Sidebar draws an ASCII line between it and the Index + panel If your terminal supports it, you can use a Unicode + line-drawing character. + set sidebar_width = 25 # Plenty of space @@ -574,39 +679,47 @@ set sidebar_divider_char = '│' # Pretty line Sidebar Format String - $sidebar_format allows you to customize the - Sidebar display. For an introduction, read - format strings including the - section about - - conditionals. - The default value is: - %B%* %n - A more detailed value is: - %B%?F? [%F]?%* %?N?%N/?%S + $sidebar_format allows you to customize the + Sidebar display. For an introduction, read + format strings including the + section about + conditionals. + + + The default value is: %B%* %n + + + A more detailed value is: + %B%?F? [%F]?%* %?N?%N/?%S + Which breaks down as: - %B- Mailbox name + %B – Mailbox name + - %?F? [%F]?- If flagged emails - [%F], otherwise nothing + %?F? [%F]? – If flagged emails + [%F], otherwise nothing + - %*- Pad with spaces + %* – Pad with spaces + - %?N?%N/?- If new emails - %N/, otherwise nothing + %?N?%N/? – If new emails + %N/, otherwise nothing + - %S- Total number of emails + %S – Total number of emails + @@ -692,13 +805,20 @@ set sidebar_divider_char = '│' # Pretty line - * = Can be optionally printed if nonzero - † = To use this expandos, you must first: + + * = Can be optionally printed if nonzero + + + † = To use this expandos, you must first: set mail_check_stats - ‡ = Only applicable to the current folder - Here are some examples. They show the number of (F)lagged, - (N)ew and (S)ize. + + ‡ = Only applicable to the current folder + + + Here are some examples. They show the number of (F)lagged, (N)ew + and (S)ize. + sidebar_format @@ -750,16 +870,20 @@ set sidebar_divider_char = '│' # Pretty line Abbreviating Mailbox Names - $sidebar_delim_chars tells Sidebar how to split - up mailbox paths. For local directories use - /; for IMAP folders use - . + $sidebar_delim_chars tells Sidebar how to + split up mailbox paths. For local directories use + /; for IMAP folders use . + Example 1 - This example works well if your mailboxes have unique names - after the last separator. - Add some mailboxes of different depths. + + This example works well if your mailboxes have unique names + after the last separator. + + + Add some mailboxes of different depths. + set folder="~/mail" @@ -768,7 +892,9 @@ mailboxes =water/sea/sicily =water/sea/archipelago =water/sea/sibuyan mailboxes =water/ocean/atlantic =water/ocean/pacific =water/ocean/arctic - Shorten the names: + + Shorten the names: + set sidebar_short_path # Shorten mailbox names (truncate all subdirs) @@ -776,8 +902,11 @@ set sidebar_component_depth=1 # Shorten mailb set sidebar_delim_chars="/" # Delete everything up to the last or Nth / character - The screenshot below shows what the Sidebar would look like - before and after shortening using sidebar_short_path. + + The screenshot below shows what the Sidebar would look like + before and after shortening using + sidebar_short_path. + |fruit/apple |apple @@ -791,8 +920,11 @@ set sidebar_delim_chars="/" # Delete everyt |water/ocean/arctic |arctic - The screenshot below shows what the Sidebar would look like - before and after shortening using sidebar_component_depth=1. + + The screenshot below shows what the Sidebar would look like + before and after shortening using + sidebar_component_depth=1. + |fruit/apple |apple @@ -810,9 +942,13 @@ set sidebar_delim_chars="/" # Delete everyt Example 2 - This example works well if you have lots of mailboxes which - are arranged in a tree. - Add some mailboxes of different depths. + + This example works well if you have lots of mailboxes which are + arranged in a tree. + + + Add some mailboxes of different depths. + set folder="~/mail" @@ -825,7 +961,9 @@ mailboxes =water/ocean mailboxes =water/ocean/atlantic =water/ocean/pacific =water/ocean/arctic - Shorten the names: + + Shorten the names: + set sidebar_short_path # Shorten mailbox names @@ -834,8 +972,10 @@ set sidebar_folder_indent # Indent folder set sidebar_indent_string=" " # Indent with two spaces - The screenshot below shows what the Sidebar would look like - before and after shortening. + + The screenshot below shows what the Sidebar would look like + before and after shortening. + |fruit |fruit @@ -853,21 +993,27 @@ set sidebar_indent_string=" " # Indent with t |water/ocean/arctic | arctic - Sometimes, it will be necessary to add mailboxes, that you - don't use, to fill in part of the tree. This will trade vertical - space for horizontal space (but it looks good). + + Sometimes, it will be necessary to add mailboxes, that you + don't use, to fill in part of the tree. This will trade + vertical space for horizontal space (but it looks good). + Limiting the Number of Mailboxes - If you have a lot of mailboxes, sometimes it can be useful to - hide the ones you aren't using. - $sidebar_new_mail_only tells Sidebar to only show - mailboxes that contain new, or flagged, email. - If you want some mailboxes to be always visible, then use the - sidebar_whitelist command. It takes a list of - mailboxes as parameters. + + If you have a lot of mailboxes, sometimes it can be useful to + hide the ones you aren't using. + $sidebar_new_mail_only tells Sidebar to only + show mailboxes that contain new, or flagged, email. + + + If you want some mailboxes to be always visible, then use the + sidebar_whitelist command. It takes a list of + mailboxes as parameters. + set sidebar_new_mail_only # Only mailboxes with new/flagged email @@ -879,7 +1025,9 @@ sidebar_whitelist fruit fruit/apple # Always displa Colors - Here is a sample color scheme: + + Here is a sample color scheme: + color sidebar_indicator default color17 # Dark blue background @@ -891,10 +1039,12 @@ color sidebar_flagged red default # Red# Dark grey - There is a priority order when coloring Sidebar mailboxes. e.g. - If a mailbox has new mail it will have the - sidebar_new color, even if it also contains flagged - mails. + + There is a priority order when coloring Sidebar mailboxes. e.g. If + a mailbox has new mail it will have the + sidebar_new color, even if it also contains + flagged mails. +
Sidebar Color Priority @@ -957,11 +1107,14 @@ color sidebar_divider color8 default # Dark grey Config Changes - If you haven't used Sidebar before, you can ignore this - section. - Some of the Sidebar config has been changed to make its meaning - clearer. These changes have been made since the previous Sidebar - release: 2015-11-11. + + If you haven't used Sidebar before, you can ignore this section. + + + Some of the Sidebar config has been changed to make its meaning + clearer. These changes have been made since the previous Sidebar + release: 2015-11-11. +
Config Changes @@ -1045,52 +1198,63 @@ color sidebar_divider color8 default # Dark grey Help - The help screen is meant to offer a quick help to the user. It - lists the current configuration of key bindings and their associated - commands including a short description, and currently unbound functions - that still need to be associated with a key binding (or alternatively, - they can be called via the NeoMutt command prompt). + + The help screen is meant to offer a quick help to the user. It lists + the current configuration of key bindings and their associated + commands including a short description, and currently unbound + functions that still need to be associated with a key binding (or + alternatively, they can be called via the NeoMutt command prompt). + Compose Menu - The compose menu features a split screen containing the - information which really matter before actually sending a message by - mail: who gets the message as what (recipients and who gets what kind - of copy). Additionally, users may set security options like deciding - whether to sign, encrypt or sign and encrypt a message with/for what - keys. Also, it's used to attach messages, to re-edit any attachment - including the message itself. + + The compose menu features a split screen containing the information + which really matter before actually sending a message by mail: who + gets the message as what (recipients and who gets what kind of copy). + Additionally, users may set security options like deciding whether to + sign, encrypt or sign and encrypt a message with/for what keys. Also, + it's used to attach messages, to re-edit any attachment including the + message itself. + Alias Menu - The alias menu is used to help users finding the recipients of - messages. For users who need to contact many people, there's no need to - remember addresses or names completely because it allows for searching, - too. The alias mechanism and thus the alias menu also features grouping - several addresses by a shorter nickname, the actual alias, so that - users don't have to select each single recipient manually. + + The alias menu is used to help users finding the recipients of + messages. For users who need to contact many people, there's no need + to remember addresses or names completely because it allows for + searching, too. The alias mechanism and thus the alias menu also + features grouping several addresses by a shorter nickname, the actual + alias, so that users don't have to select each single recipient + manually. + Attachment Menu - As will be later discussed in detail, NeoMutt features a good and - stable MIME implementation, that is, it supports sending and receiving - messages of arbitrary MIME types. The attachment menu displays a - message's structure in detail: what content parts are attached to which - parent part (which gives a true tree structure), which type is of what - type and what size. Single parts may saved, deleted or modified to - offer great and easy access to message's internals. + + As will be later discussed in detail, NeoMutt features a good and + stable MIME implementation, that is, it supports sending and + receiving messages of arbitrary MIME types. The attachment menu + displays a message's structure in detail: what content parts are + attached to which parent part (which gives a true tree structure), + which type is of what type and what size. Single parts may saved, + deleted or modified to offer great and easy access to message's + internals. + Moving Around in Menus - The most important navigation keys common to line- or entry-based - menus are shown in - and in - for page-based menus. + + The most important navigation keys common to line- or entry-based menus + are shown in and in for page-based menus. +
Most common navigation keys in entry-based menus @@ -1226,11 +1390,13 @@ color sidebar_divider color8 default # Dark grey Introduction - NeoMutt has a built-in line editor for inputting text, e.g. email - addresses or filenames. The keys used to manipulate text input are very - similar to those of Emacs. See - for a full reference of available - functions, their default key bindings, and short descriptions. + + NeoMutt has a built-in line editor for inputting text, e.g. email + addresses or filenames. The keys used to manipulate text input are + very similar to those of Emacs. See + for a full reference of available + functions, their default key bindings, and short descriptions. +
Most common line editor keys @@ -1403,80 +1569,99 @@ color sidebar_divider color8 default # Dark grey
- You can remap the - editor functions using the - - bind - command. For example, to make the <Delete> key delete the - character in front of the cursor rather than under, you could - use: + + You can remap the editor functions using the + bind command. For + example, to make the <Delete> key delete the character in front + of the cursor rather than under, you could use: + bind editor <delete> backspace History - NeoMutt maintains a history for the built-in editor. The number of - items is controlled by the - $history variable and can be made - persistent using an external file specified using - $history_file and - $save_history. You may cycle - through them at an editor prompt by using the - <history-up>and/or - <history-down>commands. NeoMutt will remember the - currently entered text as you cycle through history, and will wrap - around to the initial entry line. - NeoMutt maintains several distinct history lists, one for each of - the following categories: + + NeoMutt maintains a history for the built-in editor. The number of + items is controlled by the $history + variable and can be made persistent using an external file specified + using $history_file and + $save_history. You may cycle through + them at an editor prompt by using the + <history-up> and/or + <history-down> commands. NeoMutt will + remember the currently entered text as you cycle through history, and + will wrap around to the initial entry line. + + + NeoMutt maintains several distinct history lists, one for each of the + following categories: + - .neomuttrc commands + .neomuttrc commands + - addresses and aliases + + addresses and aliases + - shell commands + + shell commands + - filenames + + filenames + - patterns + + patterns + - everything else + + everything else + - NeoMutt automatically filters out consecutively repeated items from - the history. If - $history_remove_dups is set, - all repeated items are removed from the history. It also mimics the - behavior of some shells by ignoring items starting with a space. The - latter feature can be useful in macros to not clobber the history's - valuable entries with unwanted entries. + + NeoMutt automatically filters out consecutively repeated items from + the history. If + $history_remove_dups is + set, all repeated items are removed from the history. It also mimics + the behavior of some shells by ignoring items starting with a space. + The latter feature can be useful in macros to not clobber the + history's valuable entries with unwanted entries. + Reading Mail - Similar to many other mail clients, there are two modes in which - mail is read in NeoMutt. The first is a list of messages in the mailbox, - which is called the - index menu in NeoMutt. The second mode is the display of the - message contents. This is called the - pager. - The next few sections describe the functions provided in each of - these modes. + + Similar to many other mail clients, there are two modes in which mail + is read in NeoMutt. The first is a list of messages in the mailbox, + which is called the index menu in NeoMutt. The second + mode is the display of the message contents. This is called the + pager. + + + The next few sections describe the functions provided in each of these + modes. + The Message Index - Common keys used to navigate through and manage messages in the - index are shown in - . How messages are presented in the - index menu can be customized using the - $index_format variable. + + Common keys used to navigate through and manage messages in the index + are shown in . How messages are + presented in the index menu can be customized using the + $index_format variable. + Most common message index keys @@ -1607,20 +1792,21 @@ color sidebar_divider color8 default # Dark grey
- In addition to who sent the message and the subject, a short - summary of the disposition of each message is printed beside the - message number. Zero or more of the - flags in - may appear, some of which can be - turned on or off using these functions: - <set-flag>and - <clear-flag>bound by default to - w and - W respectively. - Furthermore, the flags in - reflect who the message is - addressed to. They can be customized with the - $to_chars variable. + + In addition to who sent the message and the subject, a short summary + of the disposition of each message is printed beside the message + number. Zero or more of the flags in + may appear, some of which can + be turned on or off using these functions: + <set-flag> and + <clear-flag> bound by default to + w and W respectively. + + + Furthermore, the flags in + reflect who the message is addressed to. They can be customized with + the $to_chars variable. + Message status flags @@ -1727,12 +1913,13 @@ color sidebar_divider color8 default # Dark grey The Pager - By default, NeoMutt uses its built-in pager to display the contents - of messages (an external pager such as - less(1)can be configured, see - $pager variable). The pager is very similar - to the Unix program - less(1)though not nearly as featureful. + + By default, NeoMutt uses its built-in pager to display the contents + of messages (an external pager such as less(1) can + be configured, see $pager variable). The + pager is very similar to the Unix program less(1) + though not nearly as featureful. +
Most common pager keys @@ -1792,26 +1979,30 @@ color sidebar_divider color8 default # Dark grey
- In addition to key bindings in - , many of the functions from the index - menu are also available in the pager, such as - <delete-message>or - <copy-message>(this is one advantage over - using an external pager to view messages). - Also, the internal pager supports a couple other advanced - features. For one, it will accept and translate the - standard nroff sequences for bold and underline. These - sequences are a series of either the letter, backspace ( - ^H), the letter again for bold or the letter, backspace, - _ for denoting underline. NeoMutt will attempt to display - these in bold and underline respectively if your terminal supports - them. If not, you can use the bold and underline - color objects to specify a - color or mono attribute for them. - Additionally, the internal pager supports the ANSI escape - sequences for character attributes. NeoMutt translates them into the - correct color and character settings. The sequences NeoMutt supports - are: + + In addition to key bindings in , many + of the functions from the index menu are also available in the pager, + such as <delete-message> or + <copy-message> (this is one advantage over + using an external pager to view messages). + + + Also, the internal pager supports a couple other advanced features. + For one, it will accept and translate the standard + nroff sequences for bold and underline. These sequences are a series + of either the letter, backspace (^H), the letter + again for bold or the letter, backspace, _ for + denoting underline. NeoMutt will attempt to display these in bold and + underline respectively if your terminal supports them. If not, you + can use the bold and underline color + objects to specify a color or mono attribute for + them. + + + Additionally, the internal pager supports the ANSI escape sequences + for character attributes. NeoMutt translates them into the correct + color and character settings. The sequences NeoMutt supports are: + \e[ @@ -1820,9 +2011,10 @@ color sidebar_divider color8 default # Dark grey Ps;m - where - Ps can be one of the codes shown in - . + + where Ps can be one of the codes shown in + . + ANSI escape sequences @@ -1917,40 +2109,46 @@ color sidebar_divider color8 default # Dark grey
- NeoMutt uses these attributes for handling - text/enriched messages, and they can also be used by - an external - autoview script for highlighting - purposes. + + NeoMutt uses these attributes for handling + text/enriched messages, and they can also be used + by an external autoview script for + highlighting purposes. + - If you change the colors for your display, for example by - changing the color associated with color2 for your xterm, then that - color will be used instead of green. + + If you change the colors for your display, for example by changing + the color associated with color2 for your xterm, then that color + will be used instead of green. + - Note that the search commands in the pager take regular - expressions, which are not quite the same as the more complex - patterns used by the search command in - the index. This is because patterns are used to select messages by - criteria whereas the pager already displays a selected - message. + + Note that the search commands in the pager take regular + expressions, which are not quite the same as the more complex + patterns used by the search command + in the index. This is because patterns are used to select messages + by criteria whereas the pager already displays a selected message. + Threaded Mode - So-called - threads provide a hierarchy of messages where replies are - linked to their parent message(s). This organizational form is - extremely useful in mailing lists where different parts of the - discussion diverge. NeoMutt displays threads as a tree structure. - In NeoMutt, when a mailbox is - sorted by - threads, there are a few additional functions - available in the - index and - pager modes as shown in - . + + So-called threads provide a hierarchy of messages + where replies are linked to their parent message(s). This + organizational form is extremely useful in mailing lists where + different parts of the discussion diverge. NeoMutt displays threads + as a tree structure. + + + In NeoMutt, when a mailbox is sorted by + threads, there are a few additional functions + available in the index and + pager modes as shown in + . + Most common thread mode keys @@ -2064,52 +2262,54 @@ color sidebar_divider color8 default # Dark grey
- Collapsing a thread displays only the first message in the thread - and hides the others. This is useful when threads contain so many - messages that you can only see a handful of threads on the screen. See - %M in - $index_format. For example, you - could use - %?M?(#%03M)&(%4l)?in - $index_format to optionally display - the number of hidden messages if the thread is collapsed. The - - %?<char>?<if-part>&<else-part>?syntax - is explained in detail in - format string - conditionals. - Technically, every reply should contain a list of its parent - messages in the thread tree, but not all do. In these cases, NeoMutt - groups them by subject which can be controlled using the - $strict_threads variable. + + Collapsing a thread displays only the first message in the thread and + hides the others. This is useful when threads contain so many + messages that you can only see a handful of threads on the screen. + See %M in $index_format. For + example, you could use %?M?(#%03M)&(%4l)? in + $index_format to optionally display + the number of hidden messages if the thread is collapsed. The + %?<char>?<if-part>&<else-part>? + syntax is explained in detail in + format string conditionals. + + + Technically, every reply should contain a list of its parent messages + in the thread tree, but not all do. In these cases, NeoMutt groups + them by subject which can be controlled using the + $strict_threads variable. + Miscellaneous Functions - In addition, the - index and - pager menus have these interesting - functions: + + In addition, the index and + pager menus have these interesting functions: + <create-alias> (default: a) - Creates a new alias based upon the current message (or - prompts for a new one). Once editing is complete, an - - alias - command is added to the file specified by the - $alias_file variable for future - use + + Creates a new alias based upon the current message (or prompts + for a new one). Once editing is complete, an + alias command + is added to the file specified by the + $alias_file variable for + future use + - NeoMutt does not read the - $alias_file upon startup so - you must explicitly - - source - the file. + + NeoMutt does not read the + $alias_file upon startup so + you must explicitly + source the + file. + @@ -2118,15 +2318,15 @@ color sidebar_divider color8 default # Dark grey <check-traditional-pgp> (default: Esc P) - This function will search the current message for content - signed or encrypted with PGP the - traditional way, that is, without proper MIME - tagging. Technically, this function will temporarily change the - MIME content types of the body parts containing PGP data; this is - similar to the - - <edit-type> - function's effect. + + This function will search the current message for content + signed or encrypted with PGP the traditional + way, that is, without proper MIME tagging. Technically, this + function will temporarily change the MIME content types of the + body parts containing PGP data; this is similar to the + <edit-type> + function's effect. + @@ -2134,22 +2334,23 @@ color sidebar_divider color8 default # Dark grey <edit-raw-message> - This command (available in the index and pager) allows you - to edit the raw current message as it's present in the mail - folder. After you have finished editing, the changed message will - be appended to the current folder, and the original message will - be marked for deletion; if the message is unchanged it won't be - replaced. - <edit> is a - synonym of this for backwards compatibility. - See also - - <edit-or-view-raw-message> - , - - <view-raw-message> - . + This command (available in the index and pager) allows you to + edit the raw current message as it's present in the mail + folder. After you have finished editing, the changed message + will be appended to the current folder, and the original + message will be marked for deletion; if the message is + unchanged it won't be replaced. + + + <edit> is + a synonym of this for backwards compatibility. + + + See also + <edit-or-view-raw-message>, + <view-raw-message>. + @@ -2157,10 +2358,11 @@ color sidebar_divider color8 default # Dark grey <edit> - Alias of - - <edit-raw-message> - for backwards compatibility. + + Alias of + <edit-raw-message> + for backwards compatibility. + @@ -2168,15 +2370,12 @@ color sidebar_divider color8 default # Dark grey <edit-or-view-raw-message> (default: e) - This command (available in the index and pager) is the same - as - - <edit-raw-message> - - if the mailbox is writable, otherwise it the same as - - <view-raw-message> - . + + This command (available in the index and pager) is the same as + <edit-raw-message> + if the mailbox is writable, otherwise it the same as + <view-raw-message>. + @@ -2185,18 +2384,22 @@ color sidebar_divider color8 default # Dark grey (default: ^E on the attachment menu, and in the pager and index menus; ^T on the compose menu) - This command is used to temporarily edit an attachment's - content type to fix, for instance, bogus character set - parameters. When invoked from the index or from the pager, you'll - have the opportunity to edit the top-level attachment's content - type. On the - attachment menu, you can - change any attachment's content type. These changes are not - persistent, and get lost upon changing folders. - Note that this command is also available on the - compose menu. There, it's - used to fine-tune the properties of attachments you are going to - send. + + This command is used to temporarily edit an attachment's + content type to fix, for instance, bogus character set + parameters. When invoked from the index or from the pager, + you'll have the opportunity to edit the top-level attachment's + content type. On the + attachment menu, you can + change any attachment's content type. These changes are not + persistent, and get lost upon changing folders. + + + Note that this command is also available on the + compose menu. There, it's + used to fine-tune the properties of attachments you are going + to send. + @@ -2205,21 +2408,24 @@ color sidebar_divider color8 default # Dark grey (default: :) - This command is used to execute any command you would - normally put in a configuration file. A common use is to check - the settings of variables, or in conjunction with - macros to change settings on the - fly. - + + This command is used to execute any command you would normally + put in a configuration file. A common use is to check the + settings of variables, or in conjunction with + macros to change settings on the + fly. + + <extract-keys> (default: ^K) - This command extracts PGP public keys from the current or - tagged message(s) and adds them to your PGP public key - ring. + + This command extracts PGP public keys from the current or + tagged message(s) and adds them to your PGP public key ring. + @@ -2227,8 +2433,10 @@ color sidebar_divider color8 default # Dark grey <forget-passphrase> (default: ^F) - This command wipes the passphrase(s) from memory. It is - useful, if you misspelled the passphrase. + + This command wipes the passphrase(s) from memory. It is useful, + if you misspelled the passphrase. + @@ -2236,20 +2444,21 @@ color sidebar_divider color8 default # Dark grey <list-reply> (default: L) - Reply to the current or tagged message(s) by extracting any - addresses which match the regular expressions given by the - - lists or - subscribecommands, but also honor any - Mail-Followup-To header(s) if the - - $honor_followup_to configuration variable is set. In - addition, the - List-Post header field is examined for - mailto:URLs specifying a mailing list address. - Using this when replying to messages posted to mailing lists - helps avoid duplicate copies being sent to the author of the - message you are replying to. + + Reply to the current or tagged message(s) by extracting any + addresses which match the regular expressions given by the + lists or + subscribe + commands, but also honor any + Mail-Followup-To header(s) if the + $honor_followup_to + configuration variable is set. In addition, the + List-Post header field is examined for + mailto: URLs specifying a mailing list + address. Using this when replying to messages posted to + mailing lists helps avoid duplicate copies being sent to the + author of the message you are replying to. + @@ -2257,13 +2466,15 @@ color sidebar_divider color8 default # Dark grey <pipe-message> (default: |) - Asks for an external Unix command and pipes the current or - tagged message(s) to it. The variables - $pipe_decode, - $pipe_split, - $pipe_sep and - $wait_key control the exact - behavior of this function. + + Asks for an external Unix command and pipes the current or + tagged message(s) to it. The variables + $pipe_decode, + $pipe_split, + $pipe_sep and + $wait_key control the exact + behavior of this function. + @@ -2271,16 +2482,20 @@ color sidebar_divider color8 default # Dark grey <resend-message> (default: Esc e) - NeoMutt takes the current message as a template for a new - message. This function is best described as "recall from - arbitrary folders". It can conveniently be used to forward MIME - messages while preserving the original mail structure. Note that - the amount of headers included here depends on the value of the - $weed variable. - This function is also available from the attachment menu. - You can use this to easily resend a message which was included - with a bounce message as a - message/rfc822 body part. + + NeoMutt takes the current message as a template for a new + message. This function is best described as "recall from + arbitrary folders". It can conveniently be used to forward MIME + messages while preserving the original mail structure. Note + that the amount of headers included here depends on the value + of the $weed variable. + + + This function is also available from the attachment menu. You + can use this to easily resend a message which was included with + a bounce message as a message/rfc822 body + part. + @@ -2288,12 +2503,15 @@ color sidebar_divider color8 default # Dark grey <shell-escape> (default: !) - Asks for an external Unix command and executes it. The - $wait_key can be used to control - whether NeoMutt will wait for a key to be pressed when the command - returns (presumably to let the user read the output of the - command), based on the return status of the named command. If no - command is given, an interactive shell is executed. + + Asks for an external Unix command and executes it. The + $wait_key can be used to + control whether NeoMutt will wait for a key to be pressed when + the command returns (presumably to let the user read the output + of the command), based on the return status of the named + command. If no command is given, an interactive shell is + executed. + @@ -2301,13 +2519,15 @@ color sidebar_divider color8 default # Dark grey <toggle-quoted> (default: T) - The pager uses the - $quote_regex variable to - detect quoted text when displaying the body of the message. This - function toggles the display of the quoted material in the - message. It is particularly useful when being interested in just - the response and there is a large amount of quoted text in the - way. + + The pager uses the + $quote_regex variable to + detect quoted text when displaying the body of the message. + This function toggles the display of the quoted material in the + message. It is particularly useful when being interested in + just the response and there is a large amount of quoted text in + the way. + @@ -2315,19 +2535,18 @@ color sidebar_divider color8 default # Dark grey <view-raw-message> - This command (available in the index and pager) opens the - raw message read-only in an editor. This command does not allow - editing the message, use - - <edit-raw-message> - for this. - See also - - <edit-raw-message> - , - - <edit-or-view-raw-message> - . + + This command (available in the index and pager) opens the raw + message read-only in an editor. This command does not allow + editing the message, use + <edit-raw-message> + for this. + + + See also + <edit-raw-message>, + <edit-or-view-raw-message>. + @@ -2335,9 +2554,10 @@ color sidebar_divider color8 default # Dark grey <skip-quoted> (default: S) - This function will go to the next line of non-quoted text - which comes after a line of quoted text in the internal - pager. + + This function will go to the next line of non-quoted text which + comes after a line of quoted text in the internal pager. + @@ -2349,10 +2569,12 @@ color sidebar_divider color8 default # Dark grey Introduction - The bindings shown in - are available in the - index and - pager to start a new message. + + The bindings shown in + are available in the + index and pager to start + a new message. + Most common mail sending keys @@ -2418,81 +2640,87 @@ color sidebar_divider color8 default # Dark grey
- Bouncing a message sends the message as-is to the - recipient you specify. - Forwarding a message allows you to add comments or - modify the message you are forwarding. These items are discussed in - greater detail in the next section - - Forwarding and Bouncing - Mail. - NeoMutt will then enter the - compose menu and prompt you for the recipients to - place on the - To:header field when you hit - m to start a new message. Next, it will ask you for - the - Subject:field for the message, providing a default if - you are replying to or forwarding a message. You again have the chance - to adjust recipients, subject, and security settings right before - actually sending the message. See also - $askcc, - $askbcc, - $autoedit, - $bounce, - $fast_reply, and - $include for changing how and if NeoMutt - asks these questions. - When replying, NeoMutt fills these fields with proper values - depending on the reply type. The types of replying supported - are: + Bouncing a message sends the message as-is to + the recipient you specify. Forwarding a message + allows you to add comments or modify the message you are forwarding. + These items are discussed in greater detail in the next section + Forwarding and Bouncing Mail. + + + NeoMutt will then enter the compose menu and + prompt you for the recipients to place on the To: + header field when you hit m to start a new + message. Next, it will ask you for the Subject: field + for the message, providing a default if you are replying to or + forwarding a message. You again have the chance to adjust recipients, + subject, and security settings right before actually sending the + message. See also + $askcc, + $askbcc, + $autoedit, + $bounce, + $fast_reply, and + $include for changing how and if + NeoMutt asks these questions. + + + When replying, NeoMutt fills these fields with proper values + depending on the reply type. The types of replying supported are: + Simple reply - Reply to the author directly. + + Reply to the author directly. + Group reply - Reply to the author as well to all recipients except you; - this consults - - alternates - . + + Reply to the author as well to all recipients except you; + this consults + alternates. + List reply - Reply to all mailing list addresses found, either specified - via configuration or auto-detected. See - for details. + + Reply to all mailing list addresses found, either specified via + configuration or auto-detected. See + for details. + - After getting recipients for new messages, forwards or replies, - NeoMutt will then automatically start your - $editor on the message body. If the - $edit_headers variable is set, the - headers will be at the top of the message in your editor; the message - body should start on a new line after the existing blank line at the - end of headers. Any messages you are replying to will be added in sort - order to the message, with appropriate - $attribution, - $indent_string and - $post_indent_string. When - forwarding a message, if the - $mime_forward variable is unset, a - copy of the forwarded message will be included. If you have specified a - $signature, it will be appended to the - message. - Once you have finished editing the body of your mail message, you - are returned to the - compose menu providing the functions shown in - to modify, send or postpone the - message. + + After getting recipients for new messages, forwards or replies, + NeoMutt will then automatically start your + $editor on the message body. If the + $edit_headers variable is set, + the headers will be at the top of the message in your editor; the + message body should start on a new line after the existing blank line + at the end of headers. Any messages you are replying to will be added + in sort order to the message, with appropriate + $attribution, + $indent_string and + $post_indent_string. When + forwarding a message, if the + $mime_forward variable is unset, + a copy of the forwarded message will be included. If you have + specified a $signature, it will be + appended to the message. + + + Once you have finished editing the body of your mail message, you are + returned to the compose menu providing the + functions shown in to modify, + send or postpone the message. + Most common compose menu keys @@ -2649,125 +2877,148 @@ color sidebar_divider color8 default # Dark grey
- The compose menu is also used to edit the attachments for a - message which can be either files or other messages. The - <attach-message>function to will prompt you - for a folder to attach messages from. You can now tag messages in that - folder and they will be attached to the message you are sending. + + The compose menu is also used to edit the attachments for a message + which can be either files or other messages. The + <attach-message> function to will prompt you + for a folder to attach messages from. You can now tag messages in + that folder and they will be attached to the message you are sending. + - Note that certain operations like composing a new mail, - replying, forwarding, etc. are not permitted when you are in that - folder. The %r in - $status_format will change to a - A to indicate that you are in attach-message - mode. + + Note that certain operations like composing a new mail, replying, + forwarding, etc. are not permitted when you are in that folder. The + %r in $status_format will + change to a A to indicate that you are in + attach-message mode. + Editing the Message Header - When editing the header because of - $edit_headers being set, there are a - several pseudo headers available which will not be included in sent - messages but trigger special NeoMutt behavior. + + When editing the header because of + $edit_headers being set, there are + a several pseudo headers available which will not be included in sent + messages but trigger special NeoMutt behavior. + Fcc: Pseudo Header - If you specify - Fcc: - filename + If you specify + + + Fcc: filename + + + as a header, NeoMutt will pick up filename + just as if you had used the <edit-fcc> + function in the compose menu. It can later be + changed from the compose menu. - as a header, NeoMutt will pick up - filename just as if you had used the - <edit-fcc>function in the - compose menu. It can later be changed from the - compose menu. Attach: Pseudo Header - You can also attach files to your message by specifying - Attach: - filename[ - description] - where - filename is the file to attach and - description is an optional string to use as the - description of the attached file. Spaces in filenames have to be - escaped using backslash ( - \). The file can be removed as well as more added from - the compose menu. + You can also attach files to your message by specifying + + + Attach: + filename [description] + + + where filename is the file to attach and + description is an optional string to use as + the description of the attached file. Spaces in filenames have to + be escaped using backslash (\). The file can be + removed as well as more added from the compose menu. + Pgp: Pseudo Header - If you want to use PGP, you can specify - Pgp:[ - E| - S| - S - <id>] + If you want to use PGP, you can specify + + + Pgp: [ + E | + S | + S + <id> ] + - E selects encryption, - S selects signing and - S<id>selects signing with the given key, setting - $pgp_sign_as permanently. The - selection can later be changed in the compose menu. + E selects encryption, S selects + signing and S<id> selects signing with the + given key, setting $pgp_sign_as + permanently. The selection can later be changed in the compose + menu. + In-Reply-To: Header - When replying to messages, the - In-Reply-To:header contains the Message-Id of - the message(s) you reply to. If you remove or modify its value, NeoMutt - will not generate a - References:field, which allows you to create a - new message thread, for example to create a new message to a mailing - list without having to enter the mailing list's address. - If you intend to start a new thread by replying, please make - really sure you remove the - In-Reply-To:header in your editor. Otherwise, - though you'll produce a technically valid reply, some netiquette - guardians will be annoyed by this so-called - thread hijacking. + + When replying to messages, the In-Reply-To: + header contains the Message-Id of the message(s) you reply to. If + you remove or modify its value, NeoMutt will not generate + a References: field, which allows you to + create a new message thread, for example to create a new message to + a mailing list without having to enter the mailing list's address. + + + If you intend to start a new thread by replying, please make really + sure you remove the In-Reply-To: header in + your editor. Otherwise, though you'll produce a technically valid + reply, some netiquette guardians will be annoyed by this so-called + thread hijacking. + Sending Cryptographically Signed/Encrypted Messages - If you have told NeoMutt to PGP or S/MIME encrypt a message, it will - guide you through a key selection process when you try to send the - message. NeoMutt will not ask you any questions about keys which have a - certified user ID matching one of the message recipients' mail - addresses. However, there may be situations in which there are several - keys, weakly certified user ID fields, or where no matching keys can be - found. - In these cases, you are dropped into a menu with a list of keys - from which you can select one. When you quit this menu, or NeoMutt can't - find any matching keys, you are prompted for a user ID. You can, as - usually, abort this prompt using - ^G. When you do so, NeoMutt will return to the compose - screen. - Once you have successfully finished the key selection, the - message will be encrypted using the selected public keys when sent - out. - - To ensure you can view encrypted messages you have sent, you - may wish to set $pgp_self_encrypt - and $pgp_default_key for PGP, or - $smime_self_encrypt - and $smime_default_key for S/MIME. - - Most fields of the entries in the key selection menu (see also - $pgp_entry_format) have obvious - meanings. But some explanations on the capabilities, flags, and - validity fields are in order. - The flags sequence ( - %f) will expand to one of the flags in - . + + If you have told NeoMutt to PGP or S/MIME encrypt a message, it will + guide you through a key selection process when you try to send the + message. NeoMutt will not ask you any questions about keys which have + a certified user ID matching one of the message recipients' mail + addresses. However, there may be situations in which there are + several keys, weakly certified user ID fields, or where no matching + keys can be found. + + + In these cases, you are dropped into a menu with a list of keys from + which you can select one. When you quit this menu, or NeoMutt can't + find any matching keys, you are prompted for a user ID. You can, as + usually, abort this prompt using ^G. When you do + so, NeoMutt will return to the compose screen. + + + Once you have successfully finished the key selection, the message + will be encrypted using the selected public keys when sent out. + + + To ensure you can view encrypted messages you have sent, you may wish + to set $pgp_self_encrypt and + $pgp_default_key for PGP, or + $smime_self_encrypt and + $smime_default_key for + S/MIME. + + + Most fields of the entries in the key selection menu (see also + $pgp_entry_format) have + obvious meanings. But some explanations on the capabilities, flags, + and validity fields are in order. + + + The flags sequence (%f) will expand to one of the + flags in . + PGP key menu flags @@ -2799,30 +3050,31 @@ color sidebar_divider color8 default # Dark grey
- The capabilities field ( - %c) expands to a two-character sequence representing a - key's capabilities. The first character gives the key's encryption - capabilities: A minus sign ( - -) means that the key cannot be used for encryption. A - dot ( - .) means that it's marked as a signature key in one of - the user IDs, but may also be used for encryption. The letter - e indicates that this key can be used for - encryption. - The second character indicates the key's signing capabilities. - Once again, a - -implies - not for signing, - .implies that the key is marked as an encryption key in - one of the user-ids, and - s denotes a key which can be used for signing. - Finally, the validity field ( - %t) indicates how well-certified a user-id is. A - question mark ( - ?) indicates undefined validity, a minus character ( - -) marks an untrusted association, a space character - means a partially trusted association, and a plus character ( - +) indicates complete validity. + + The capabilities field (%c) expands to + a two-character sequence representing a key's capabilities. The first + character gives the key's encryption capabilities: A minus sign + (-) means that the key cannot be used for encryption. + A dot (.) means that it's marked as a signature key + in one of the user IDs, but may also be used for encryption. The + letter e indicates that this key can be used for + encryption. + + + The second character indicates the key's signing capabilities. Once + again, a - implies not for signing, + . implies that the key is marked as an encryption key + in one of the user-ids, and s denotes a key which can + be used for signing. + + + Finally, the validity field (%t) indicates how + well-certified a user-id is. A question mark (?) + indicates undefined validity, a minus character (-) + marks an untrusted association, a space character means a partially + trusted association, and a plus character (+) + indicates complete validity. + @@ -2831,107 +3083,127 @@ color sidebar_divider color8 default # Dark grey Concept - format=flowed-style messages (or - f=f for short) are - text/plain messages that consist of paragraphs - which a receiver's mail client may reformat to its own needs which - mostly means to customize line lengths regardless of what the sender - sent. Technically this is achieved by letting lines of a - flowable paragraph end in spaces except for the last - line. - While for text-mode clients like NeoMutt it's the best way to - assume only a standard 80x25 character cell terminal, it may be - desired to let the receiver decide completely how to view a - message. + format=flowed-style messages (or + f=f for short) are text/plain + messages that consist of paragraphs which a receiver's mail client + may reformat to its own needs which mostly means to customize line + lengths regardless of what the sender sent. Technically this is + achieved by letting lines of a flowable paragraph + end in spaces except for the last line. + + + While for text-mode clients like NeoMutt it's the best way to + assume only a standard 80x25 character cell terminal, it may be + desired to let the receiver decide completely how to view + a message. + NeoMutt Support - NeoMutt only supports setting the required - format=flowed MIME parameter on outgoing messages - if the - $text_flowed variable is set, - specifically it does not add the trailing spaces. - After editing the initial message text and before entering the - compose menu, NeoMutt properly space-stuffs the message. - Space-stuffing is required by RFC3676 defining - format=flowed and means to prepend a space - to: + + NeoMutt only supports setting the required + format=flowed MIME parameter on outgoing + messages if the $text_flowed + variable is set, specifically it does not add the trailing spaces. + + + After editing the initial message text and before entering the + compose menu, NeoMutt properly space-stuffs the message. + Space-stuffing is required by RFC3676 defining + format=flowed and means to prepend a space to: + - all lines starting with a space + + all lines starting with a space + - lines starting with the word - - From - followed by space + + lines starting with the word + From followed by space + - all lines starting with - - > - which is not intended to be a quote character + + all lines starting with + > which is not intended to + be a quote character + - NeoMutt only supports space-stuffing for the first two types of - lines but not for the third: It is impossible to safely detect - whether a leading - >character starts a quote or not. - Furthermore, NeoMutt only applies space-stuffing - once after the initial edit is finished. + + NeoMutt only supports space-stuffing for the first two types of + lines but not for the third: It is impossible to safely detect + whether a leading > character starts + a quote or not. Furthermore, NeoMutt only applies space-stuffing + once after the initial edit is finished. + - All leading spaces are to be removed by receiving clients to - restore the original message prior to further processing. + + All leading spaces are to be removed by receiving clients to + restore the original message prior to further processing. + Editor Considerations - As NeoMutt provides no additional features to compose - f=f messages, it's completely up to the user and - his editor to produce proper messages. Please consider your editor's - documentation if you intend to send - f=f messages. - Please note that when editing messages from the compose menu - several times before really sending a mail, it's up to the user to - ensure that the message is properly space-stuffed. - For example, - vim provides the - w flag for its - formatoptions setting to assist in creating - f=f messages, see - :help fo-table for details. + + As NeoMutt provides no additional features to compose + f=f messages, it's completely up to the user and + his editor to produce proper messages. Please consider your + editor's documentation if you intend to send f=f + messages. + + + Please note that when editing messages from the compose menu + several times before really sending a mail, it's up to the user to + ensure that the message is properly space-stuffed. + + + For example, vim provides the + w flag for its formatoptions + setting to assist in creating f=f messages, see + :help fo-table for details. + Reformatting - NeoMutt has some support for reformatting when viewing and - replying to - format=flowed messages. In order to take advantage - of these, - $reflow_text must be set. + + NeoMutt has some support for reformatting when viewing and replying + to format=flowed messages. In order to take + advantage of these, $reflow_text + must be set. + - Paragraphs are automatically reflowed and wrapped at a - width specified by - $reflow_wrap. + + Paragraphs are automatically reflowed and wrapped at a width + specified by $reflow_wrap. + - In its original format, the quoting style of - format=flowed messages can be difficult to - read, and doesn't intermix well with non-flowed replies. Setting - - $reflow_space_quotes adds spaces after each level of - quoting when in the pager and replying in a non-flowed format - (i.e. with - $text_flowed unset). + + In its original format, the quoting style of + format=flowed messages can be difficult to + read, and doesn't intermix well with non-flowed replies. + Setting + $reflow_space_quotes + adds spaces after each level of quoting when in the pager and + replying in a non-flowed format (i.e. with + $text_flowed unset). + - If - $reflow_space_quotes is - unset, NeoMutt will still add one trailing space after all the - quotes in the pager (but not when replying). + + If + $reflow_space_quotes + is unset, NeoMutt will still add one trailing space after all + the quotes in the pager (but not when replying). + @@ -2940,75 +3212,89 @@ color sidebar_divider color8 default # Dark grey Forwarding and Bouncing Mail - Bouncing and forwarding let you send an existing message to - recipients that you specify. Bouncing a message sends a verbatim copy of - a message to alternative addresses as if they were the message's original - recipients specified in the Bcc header. Forwarding a message, on the - other hand, allows you to modify the message before it is resent (for - example, by adding your own comments). Bouncing is done using the - <bounce>function and forwarding using the - <forward>function bound to - b and - f respectively. - Forwarding can be done by including the original message in the new - message's body (surrounded by indicating lines) or including it as a MIME - attachment, depending on the value of the - $mime_forward variable. Decoding of - attachments, like in the pager, can be controlled by the - $forward_decode and - $mime_forward_decode variables, - respectively. The desired forwarding format may depend on the content, - therefore - $mime_forward is a quadoption which, - for example, can be set to - ask-no. - The inclusion of headers is controlled by the current setting of - the - $weed variable, unless - $mime_forward is set. - By default a forwarded message does not reference the messages it - contains. When - $forward_references is set, a - forwarded message includes the - In-Reply-To:and - References:headers, just like a reply would. Hence the - forwarded message becomes part of the original thread instead of starting - a new one. - Editing the message to forward follows the same procedure as - sending or replying to a message does. + + Bouncing and forwarding let you send an existing message to recipients + that you specify. Bouncing a message sends a verbatim copy of a message + to alternative addresses as if they were the message's original + recipients specified in the Bcc header. Forwarding a message, on the + other hand, allows you to modify the message before it is resent (for + example, by adding your own comments). Bouncing is done using the + <bounce> function and forwarding using the + <forward> function bound to b + and f respectively. + + + Forwarding can be done by including the original message in the new + message's body (surrounded by indicating lines) or including it as + a MIME attachment, depending on the value of the + $mime_forward variable. Decoding of + attachments, like in the pager, can be controlled by the + $forward_decode and + $mime_forward_decode + variables, respectively. The desired forwarding format may depend on + the content, therefore + $mime_forward is a quadoption + which, for example, can be set to ask-no. + + + The inclusion of headers is controlled by the current setting of the + $weed variable, unless + $mime_forward is set. + + + By default a forwarded message does not reference the messages it + contains. When + $forward_references is set, + a forwarded message includes the In-Reply-To: and + References: headers, just like a reply would. Hence the + forwarded message becomes part of the original thread instead of + starting a new one. + + + Editing the message to forward follows the same procedure as sending or + replying to a message does. + Postponing Mail - At times it is desirable to delay sending a message that you have - already begun to compose. When the - <postpone-message>function is used in the - compose menu, the body of your message and - attachments are stored in the mailbox specified by the - $postponed variable. This means that you - can recall the message even if you exit NeoMutt and then restart it at a - later time. - Once a message is postponed, there are several ways to resume it. - From the command line you can use the - -p option, or if you compose a new message from the - index or - pager you will be prompted if postponed messages - exist. If multiple messages are currently postponed, the - postponed menu will pop up and you can select which - message you would like to resume. + + At times it is desirable to delay sending a message that you have + already begun to compose. When the + <postpone-message> function is used in the + compose menu, the body of your message and + attachments are stored in the mailbox specified by the + $postponed variable. This means that + you can recall the message even if you exit NeoMutt and then restart it + at a later time. + + + Once a message is postponed, there are several ways to resume it. From + the command line you can use the -p option, or if you + compose a new message from the index or + pager you will be prompted if postponed messages + exist. If multiple messages are currently postponed, the + postponed menu will pop up and you can select + which message you would like to resume. + - If you postpone a reply to a message, the reply setting of the - message is only updated when you actually finish the message and send - it. Also, you must be in the same folder with the message you replied - to for the status of the message to be updated. + + If you postpone a reply to a message, the reply setting of the + message is only updated when you actually finish the message and send + it. Also, you must be in the same folder with the message you replied + to for the status of the message to be updated. + - See also the - $postpone quad-option. + + See also the $postpone quad-option. + Logging - NeoMutt has different types of logging/error messages + + NeoMutt has different types of logging/error messages + Primitive Errors: errors emitted by C library functions such as @@ -3028,26 +3314,33 @@ color sidebar_divider color8 default # Dark grey Debug: Debug messages usually only interesting while debugging. - These log messages are shown in the command bar at the bottom of the - UI (usually below the status line) and errors are shown in a different - colour than the other message types. The colours used for displaying can - be adjusted with color error ... and color - message ..., respectively. See the - description of color for the precise syntax. - - The command bar shows only the last message. To show the last 100 - messages (this includes all types of messages from debug to error) the - function - <show-log-messages> can be used. - Debug messages are not shown by default. To enable them NeoMutt - must be compiled with +debug. Furthermore, the debug - log level must be set with the - -d command line parameter at startup. The - -d parameter expects a debug level which can range - from 1 to 5 and affects verbosity of the debug messages. A value of 2 is - recommended for the start. If debug logging is enabled, all log messages - (i.e. errors, warnings, ..., debug) are additionally written to the file - ~/.neomuttdebug0. + + These log messages are shown in the command bar at the bottom of the UI + (usually below the status line) and errors are shown in a different + colour than the other message types. The colours used for displaying + can be adjusted with color error ... and + color message ..., respectively. See the + description of color + for the precise syntax. + + + The command bar shows only the last message. To show the last 100 + messages (this includes all types of messages from debug to error) the + function + <show-log-messages> + can be used. + + + Debug messages are not shown by default. To enable them NeoMutt must be + compiled with +debug. Furthermore, the debug log + level must be set with the + -d command line parameter + at startup. The -d parameter expects a debug level + which can range from 1 to 5 and affects verbosity of the debug + messages. A value of 2 is recommended for the start. If debug logging + is enabled, all log messages (i.e. errors, warnings, ..., debug) are + additionally written to the file ~/.neomuttdebug0. + @@ -3056,17 +3349,22 @@ color sidebar_divider color8 default # Dark grey Location of Initialization Files - When NeoMutt starts up it looks for two configuration files -- one - system file and one - user file. - NeoMutt first reads the system configuration file, then the user - configuration file. The two files are merged in the sense that "last - setting wins". That is, if a setting is defined in both files, the user - configuration file's value for that setting is the one that takes - precedence and becomes effective. - NeoMutt searches for several different file names when looking for - config. It looks for NeoMutt config files before Mutt config files and - versioned config before plain config. For example: + + When NeoMutt starts up it looks for two configuration files – one + system file and one user file. + + + NeoMutt first reads the system configuration file, then the user + configuration file. The two files are merged in the sense that "last + setting wins". That is, if a setting is defined in both files, the user + configuration file's value for that setting is the one that takes + precedence and becomes effective. + + + NeoMutt searches for several different file names when looking for + config. It looks for NeoMutt config files before Mutt config files and + versioned config before plain config. For example: + NeoMutt config file search order @@ -3081,24 +3379,31 @@ color sidebar_divider color8 default # Dark grey
- This allows the user to create separate NeoMutt and Mutt config - files on the same system. + + This allows the user to create separate NeoMutt and Mutt config files + on the same system. + Location of system config files - NeoMutt will search for a system config file in a - neomutt directory in several places. First it searches - the locations specified in the - XDG_CONFIG_DIRS environment variable, which defaults - to - /etc/xdg. Next, it looks in - /etc. Finally, it tries - /usr/share. - The system config file will not be read if the - -n option is used on the - command line. - NeoMutt will read just one file, the first file it finds, from the - list below. + + NeoMutt will search for a system config file in + a neomutt directory in several places. First it + searches the locations specified in the + XDG_CONFIG_DIRS environment variable, which + defaults to /etc/xdg. Next, it looks in + /etc. Finally, it tries + /usr/share. + + + The system config file will not be read if the -n + option is used on the + command line. + + + NeoMutt will read just one file, the first file it finds, from the + list below. + NeoMutt system config file locations @@ -3138,19 +3443,23 @@ color sidebar_divider color8 default # Dark grey Location of user config files - NeoMutt will search for a user config file in several places. First - it looks in the directory specified in the - XDG_CONFIG_HOME environment variable, which defaults - to - ~/.config/neomutt. Next, it looks in - ~ (your home directory). Finally, it tries - ~/.neomutt. - You may specify your own location for the user config file using - the - -F option on the - command line. - NeoMutt will read just one file, the first file it finds, from the - list below. + + NeoMutt will search for a user config file in several places. First + it looks in the directory specified in the + XDG_CONFIG_HOME environment variable, which + defaults to ~/.config/neomutt. Next, it looks in + ~ (your home directory). Finally, it tries + ~/.neomutt. + + + You may specify your own location for the user config file using the + -F option on the + command line. + + + NeoMutt will read just one file, the first file it finds, from the + list below. +
NeoMutt user config file locations @@ -3203,31 +3512,28 @@ color sidebar_divider color8 default # Dark grey system config in /etc and the user config in, e.g. ~/.neomuttrc - The last file that gets read will overwrite any settings from - previous config files. This means that an administrator can set some + previous config files. This means that an administrator can set some defaults which the user can override. - Additionally, there are a handful of config items which can be set - using an environment variable. They have a lower priority than the + using an environment variable. They have a lower priority than the NeoMutt config files: - $editor, - $from, - $mailcap_path, - $news_server, - shell, - $spoolfile, - $tmpdir, + $editor, + $from, + $mailcap_path, + $news_server, + shell, + $spoolfile, + $tmpdir, $visual. - - Finally, it's possible to set some - variables directly on the command-line using the - -e option. + Finally, it's possible to + set some variables directly on the + command-line using the -e option.
@@ -3269,27 +3575,27 @@ color sidebar_divider color8 default # Dark grey
- - Syntax of Initialization Files - An initialization file consists of a series of - commands. Each line of the file may - contain one or more commands. When multiple commands are used, they must - be separated by a semicolon ( - ;). + + An initialization file consists of a series of + commands. Each line of the file may + contain one or more commands. When multiple commands are used, they + must be separated by a semicolon (;). + Multiple configuration commands per line set realname='John Smith' ; ignore x- - The hash mark, or pound sign ( - #), is used as a - comment character. You can use it to annotate your - initialization file. All text after the comment character to the end of - the line is ignored. + + The hash mark, or pound sign (#), is used as + a comment character. You can use it to annotate your + initialization file. All text after the comment character to the end of + the line is ignored. + Commenting configuration files @@ -3298,39 +3604,39 @@ my_hdr X-Disclaimer: Why are you listening to me? # T - Single quotes ( - ') and double quotes ( - ") can be used to quote strings which contain spaces or - other special characters. The difference between the two types of quotes - is similar to that of many popular shell programs, namely that a single - quote is used to specify a literal string (one that is not interpreted - for shell variables or quoting with a backslash [see next paragraph]), - while double quotes indicate a string for which should be evaluated. For - example, backticks are evaluated inside of double quotes, but - not for single quotes. - - \quotes the next character, just as in shells such as bash - and zsh. For example, if want to put quotes - "inside of a string, you can use - \to force the next character to be a literal instead of - interpreted character. + + Single quotes (') and double quotes (") + can be used to quote strings which contain spaces or other special + characters. The difference between the two types of quotes is similar + to that of many popular shell programs, namely that a single quote is + used to specify a literal string (one that is not interpreted for shell + variables or quoting with a backslash [see next paragraph]), while + double quotes indicate a string for which should be evaluated. For + example, backticks are evaluated inside of double quotes, but + not for single quotes. + + + \ quotes the next character, just as in shells such as + bash and zsh. For example, if want to put quotes " + inside of a string, you can use \ to force the next + character to be a literal instead of interpreted character. + Escaping quotes in configuration files set realname="Michael \"MuttDude\" Elkins" - \\means to insert a literal - \into the line. - \n and - \r have their usual C meanings of linefeed and - carriage-return, respectively. - A - \at the end of a line can be used to split commands over - multiple lines as it - escapes the line end, provided that the split points don't - appear in the middle of command names. Lines are first concatenated - before interpretation so that a multi-line can be commented by commenting - out the first line only. + \\ means to insert a literal \ into the + line. \n and \r have their usual + C meanings of linefeed and carriage-return, respectively. + + + A \ at the end of a line can be used to split commands + over multiple lines as it escapes the line end, provided + that the split points don't appear in the middle of command names. + Lines are first concatenated before interpretation so that a multi-line + can be commented by commenting out the first line only. + Splitting long configuration commands over several lines @@ -3341,76 +3647,90 @@ over several lines" - It is also possible to substitute the output of a Unix command in - an initialization file. This is accomplished by enclosing the command in - backticks (``). In - , the output of the Unix command - uname -a will be substituted before the line is parsed. - Since initialization files are line oriented, only the first line of - output from the Unix command will be substituted. + + It is also possible to substitute the output of a Unix command in an + initialization file. This is accomplished by enclosing the command in + backticks (``). In , the output of the + Unix command uname -a will be substituted before the + line is parsed. Since initialization files are line oriented, only the + first line of output from the Unix command will be substituted. + Using external command's output in configuration files my_hdr X-Operating-System: `uname -a` - Both environment variables and NeoMutt variables can be accessed by - prepending - $to the name of the variable. For example, + + Both environment variables and NeoMutt variables can be accessed by + prepending $ to the name of the variable. For example, + Using environment variables in configuration files set record=+sent_on_$HOSTNAME - will cause NeoMutt to save outgoing messages to a folder named - sent_on_kremvax if the environment variable - $HOSTNAME is set to - kremvax.(See - $record for details.) - NeoMutt expands the variable when it is assigned, not when it is used. - If the value of a variable on the right-hand side of an assignment - changes after the assignment, the variable on the left-hand side will not - be affected. - The commands understood by NeoMutt are explained in the next - paragraphs. For a complete list, see the - command reference. - All configuration files are expected to be in the current locale as - specified by the - $charset variable which doesn't have a - default value since it's determined by NeoMutt at startup. If a - configuration file is not encoded in the same character set the - $config_charset variable should be - used: all lines starting with the next are recoded from - $config_charset to - $charset. - This mechanism should be avoided if possible as it has the - following implications: + + will cause NeoMutt to save outgoing messages to a folder named + sent_on_kremvax if the environment variable + $HOSTNAME is set to kremvax. (See + $record for details.) + + + NeoMutt expands the variable when it is assigned, not when it is used. + If the value of a variable on the right-hand side of an assignment + changes after the assignment, the variable on the left-hand side will + not be affected. + + + The commands understood by NeoMutt are explained in the next + paragraphs. For a complete list, see the + command reference. + + + All configuration files are expected to be in the current locale as + specified by the $charset variable which + doesn't have a default value since it's determined by NeoMutt at + startup. If a configuration file is not encoded in the same character + set the $config_charset variable + should be used: all lines starting with the next are recoded from + $config_charset to + $charset. + + + This mechanism should be avoided if possible as it has the following + implications: + - These variables should be set early in a configuration file - with - $charset preceding - $config_charset so NeoMutt knows - what character set to convert to. + + These variables should be set early in a configuration file with + $charset preceding + $config_charset so NeoMutt + knows what character set to convert to. + - If - $config_charset is set, it - should be set in each configuration file because the value is global - and - not per configuration file. + + If $config_charset is set, it + should be set in each configuration file because the value is + global and not per configuration file. + - Because NeoMutt first recodes a line before it attempts to parse - it, a conversion introducing question marks or other characters as - part of errors (unconvertable characters, transliteration) may - introduce syntax errors or silently change the meaning of certain - tokens (e.g. inserting question marks into regular - expressions). + + Because NeoMutt first recodes a line before it attempts to parse + it, a conversion introducing question marks or other characters as + part of errors (unconvertable characters, transliteration) may + introduce syntax errors or silently change the meaning of certain + tokens (e.g. inserting question marks into regular expressions). + Address Groups - Usage: + + Usage: + group @@ -3446,77 +3766,75 @@ over several lines" - NeoMutt supports grouping addresses logically into named groups. An - address or address pattern can appear in several groups at the same time. - These groups can be used in - patterns(for searching, limiting and - tagging) and in hooks by using group patterns. This can be useful to - classify mail and take certain actions depending on in what groups the - message is. For example, the NeoMutt user's mailing list would fit into the - categories - mailing list and - NeoMutt-related. Using - - send-hook - , the sender can be set to a dedicated one for writing mailing - list messages, and the signature could be set to a NeoMutt-related one for - writing to a NeoMutt list — for other lists, the list sender setting still - applies but a different signature can be selected. Or, given a group only - containing recipients known to accept encrypted mail, - auto-encryption can be achieved easily. - The - group command is used to directly add either addresses - or regular expressions to the specified group or groups. The different - categories of arguments to the - group command can be in any order. The flags - -rx and - -addr specify what the following strings (that cannot - begin with a hyphen) should be interpreted as: either a regular - expression or an email address, respectively. - These address groups can also be created implicitly by the - - alias - , - - lists - , - - subscribe - and - - alternates - commands by specifying the optional - -group option. For example, + + NeoMutt supports grouping addresses logically into named groups. An + address or address pattern can appear in several groups at the same + time. These groups can be used in + patterns (for searching, limiting and + tagging) and in hooks by using group patterns. This can be useful to + classify mail and take certain actions depending on in what groups the + message is. For example, the NeoMutt user's mailing list would fit into + the categories mailing list and + NeoMutt-related. Using + send-hook, the + sender can be set to a dedicated one for writing mailing list messages, + and the signature could be set to a NeoMutt-related one for writing to + a NeoMutt list – for other lists, the list sender setting still applies + but a different signature can be selected. Or, given a group only + containing recipients known to accept encrypted mail, + auto-encryption can be achieved easily. + + + The group command is used to directly add either + addresses or regular expressions to the specified group or groups. The + different categories of arguments to the group + command can be in any order. The flags -rx and + -addr specify what the following strings (that + cannot begin with a hyphen) should be interpreted as: either a regular + expression or an email address, respectively. + + + These address groups can also be created implicitly by the + alias, + lists, + subscribe and + alternates + commands by specifying the optional -group option. + For example, + alternates -group me address1 address2 alternates -group me -group work address3 - would create a group named - me which contains all your addresses and a group named - work which contains only your work address - address3. Besides many other possibilities, this - could be used to automatically mark your own messages in a mailing list - folder as read or use a special signature for work-related - messages. - The - ungroup command is used to remove addresses or regular - expressions from the specified group or groups. The syntax is similar to - the - group command, however the special character - *can be used to empty a group of all of its contents. - As soon as a group gets empty because all addresses and regular - expressions have been removed, it'll internally be removed, too (i.e. - there cannot be an empty group). When removing regular expressions from a - group, the pattern must be specified exactly as given to the - group command or - -group argument. + + would create a group named me which contains all your + addresses and a group named work which contains only + your work address address3. Besides many other + possibilities, this could be used to automatically mark your own + messages in a mailing list folder as read or use a special signature + for work-related messages. + + + The ungroup command is used to remove addresses or + regular expressions from the specified group or groups. The syntax is + similar to the group command, however the special + character * can be used to empty a group of all of + its contents. As soon as a group gets empty because all addresses and + regular expressions have been removed, it'll internally be removed, too + (i.e. there cannot be an empty group). When removing regular + expressions from a group, the pattern must be specified exactly as + given to the group command or + -group argument. + Defining/Using Aliases - Usage: + + Usage: + alias @@ -3546,46 +3864,51 @@ alternates -group me -group work address3 - It's usually very cumbersome to remember or type out the address of - someone you are communicating with. NeoMutt allows you to create - aliases which map a short string to a full address. + + It's usually very cumbersome to remember or type out the address of + someone you are communicating with. NeoMutt allows you to create + aliases which map a short string to a full address. + - If you want to create an alias for more than one address, you - must separate the addresses with a comma ( - ,). + + If you want to create an alias for more than one address, you + must separate the addresses with a comma + (,). + - The optional - -group argument to - alias causes the aliased address(es) to be added to the - named - group. - To remove an alias or aliases ( - *means all aliases): + + The optional -group argument to + alias causes the aliased address(es) to be added to + the named group. + + + To remove an alias or aliases (* means all aliases): + alias muttdude me@cs.hmc.edu (Michael Elkins) alias theguys manny, moe, jack - Unlike other mailers, NeoMutt doesn't require aliases to be defined in - a special file. The - alias command can appear anywhere in a configuration - file, as long as this file is - - sourced. Consequently, you can have multiple - alias files, or you can have all aliases defined in your - .neomuttrc. - On the other hand, the - - <create-alias> - function can use only one file, the one pointed to by the - $alias_file variable (which is - ~/.neomuttrc by default). This file is not special either, - in the sense that NeoMutt will happily append aliases to any file, but in - order for the new aliases to take effect you need to explicitly - - source - this file too. + + Unlike other mailers, NeoMutt doesn't require aliases to be defined in + a special file. The alias command can appear + anywhere in a configuration file, as long as this file is + sourced. Consequently, + you can have multiple alias files, or you can have all aliases defined + in your .neomuttrc. + + + On the other hand, the + <create-alias> + function can use only one file, the one pointed to by the + $alias_file variable (which is + ~/.neomuttrc by default). This file is not special + either, in the sense that NeoMutt will happily append aliases to any + file, but in order for the new aliases to take effect you need to + explicitly source this + file too. + Configuring external alias files @@ -3596,28 +3919,34 @@ set alias_file=~/.mail_aliases - To use aliases, you merely use the alias at any place in NeoMutt where - NeoMutt prompts for addresses, such as the - To:or - Cc:prompt. You can also enter aliases in your editor - at the appropriate headers if you have the - $edit_headers variable set. - In addition, at the various address prompts, you can use the tab - character to expand a partial alias to the full alias. If there are - multiple matches, NeoMutt will bring up a menu with the matching aliases. In - order to be presented with the full list of aliases, you must hit tab - without a partial alias, such as at the beginning of the prompt or after - a comma denoting multiple addresses. - In the alias menu, you can select as many aliases as you want with - the - select-entry key (default: <Return>), and use the - exit key (default: q) to return to the address - prompt. + + To use aliases, you merely use the alias at any place in NeoMutt where + NeoMutt prompts for addresses, such as the To: or + Cc: prompt. You can also enter aliases in your + editor at the appropriate headers if you have the + $edit_headers variable set. + + + In addition, at the various address prompts, you can use the tab + character to expand a partial alias to the full alias. If there are + multiple matches, NeoMutt will bring up a menu with the matching + aliases. In order to be presented with the full list of aliases, you + must hit tab without a partial alias, such as at the beginning of the + prompt or after a comma denoting multiple addresses. + + + In the alias menu, you can select as many aliases as you want with the + select-entry key (default: <Return>), and use + the exit key (default: q) to return to the address + prompt. + Changing the Default Key Bindings - Usage: + + Usage: + bind @@ -3630,137 +3959,158 @@ set alias_file=~/.mail_aliases function - This command allows you to change the default key bindings - (operation invoked when pressing a key). - map specifies in which menu the binding belongs. - Multiple maps may be specified by separating them with commas (no - additional whitespace is allowed). The currently defined maps are: + This command allows you to change the default key bindings (operation + invoked when pressing a key). + + + map specifies in which menu the binding belongs. + Multiple maps may be specified by separating them with commas (no + additional whitespace is allowed). The currently defined maps are: + generic - This is not a real menu, but is used as a fallback for all of - the other menus except for the pager and editor modes. If a key is - not defined in another menu, NeoMutt will look for a binding to use in - this menu. This allows you to bind a key to a certain function in - multiple menus instead of having multiple - bind statements to accomplish the same - task. + + This is not a real menu, but is used as a fallback for all of the + other menus except for the pager and editor modes. If a key is + not defined in another menu, NeoMutt will look for a binding to + use in this menu. This allows you to bind a key to a certain + function in multiple menus instead of having multiple + bind statements to accomplish the same task. + alias - The alias menu is the list of your personal aliases as - defined in your - .neomuttrc. It is the mapping from a short alias - name to the full email address(es) of the recipient(s). + + The alias menu is the list of your personal aliases as defined in + your .neomuttrc. It is the mapping from + a short alias name to the full email address(es) of the + recipient(s). + attach - The attachment menu is used to access the attachments on - received messages. + + The attachment menu is used to access the attachments on received + messages. + browser - The browser is used for both browsing the local directory - structure, and for listing all of your incoming mailboxes. + + The browser is used for both browsing the local directory + structure, and for listing all of your incoming mailboxes. + editor - The editor is used to allow the user to enter a single line - of text, such as the - To or - Subject prompts in the - compose menu. + + The editor is used to allow the user to enter a single line of + text, such as the To or + Subject prompts in the + compose menu. + index - The index is the list of messages contained in a - mailbox. + + The index is the list of messages contained in a mailbox. + compose - The compose menu is the screen used when sending a new - message. + + The compose menu is the screen used when sending a new message. + pager - The pager is the mode used to display message/attachment - data, and help listings. + + The pager is the mode used to display message/attachment data, + and help listings. + pgp - The pgp menu is used to select the OpenPGP keys used to - encrypt outgoing messages. + + The pgp menu is used to select the OpenPGP keys used to encrypt + outgoing messages. + smime - The smime menu is used to select the OpenSSL certificates - used to encrypt outgoing messages. + + The smime menu is used to select the OpenSSL certificates used to + encrypt outgoing messages. + postpone - The postpone menu is similar to the index menu, except is - used when recalling a message the user was composing, but saved - until later. + + The postpone menu is similar to the index menu, except is used + when recalling a message the user was composing, but saved until + later. + query - The query menu is the browser for results returned by - $query_command. + + The query menu is the browser for results returned by + $query_command. + mix - The mixmaster screen is used to select remailer options for - outgoing messages (if NeoMutt is compiled with Mixmaster - support). + + The mixmaster screen is used to select remailer options for + outgoing messages (if NeoMutt is compiled with Mixmaster + support). + - key is the key (or key sequence) you wish to bind. To - specify a control character, use the sequence - \Cx, where - x is the letter of the control character (for - example, to specify control-A use - \Ca). Note that the case of - x as well as - \C is ignored, so that - \CA, - \Ca, - \cA and - \ca are all equivalent. An alternative form is to - specify the key as a three digit octal number prefixed with a - \(for example - \177 is equivalent to - \c?). In addition, - key may be a symbolic name as shown in - . + key is the key (or key sequence) you wish to bind. + To specify a control character, use the sequence + \Cx, where x is the letter of + the control character (for example, to specify control-A use + \Ca). Note that the case of x as + well as \C is ignored, so that + \CA, \Ca, + \cA and \ca are all + equivalent. An alternative form is to specify the key as a three digit + octal number prefixed with a \ (for example + \177 is equivalent to \c?). + In addition, key may be a symbolic name as shown + in . + Symbolic key names @@ -3867,43 +4217,50 @@ set alias_file=~/.mail_aliases
- The - <what-key>function can be used to explore - keycode and symbolic names for other keys on your keyboard. Executing - this function will display information about each key pressed, until - terminated by - ^G. - - key does not need to be enclosed in quotes unless it - contains a space ( -  ) or semi-colon ( - ;). - - function specifies which action to take when - key is pressed. For a complete list of functions, see - the - reference. Note that the - bind expects - function to be specified without angle - brackets. - The special function - <noop>unbinds the specified key sequence. + + The <what-key> function can be used to explore + keycode and symbolic names for other keys on your keyboard. Executing + this function will display information about each key pressed, until + terminated by ^G. + + + key does not need to be enclosed in quotes unless + it contains a space ( ) or semi-colon + (;). + + + function specifies which action to take when + key is pressed. For a complete list of functions, + see the reference. Note that the + bind expects function to be + specified without angle brackets. + + + The special function <noop> unbinds the + specified key sequence. + Warnings about Duplicated Bindings - Due to a limitation of NeoMutt, creating key bindings, or macros, - will overwrite existing mappings with similar, shorter, names. + + Due to a limitation of NeoMutt, creating key bindings, or macros, + will overwrite existing mappings with similar, shorter, names. + bind index g group-reply bind index gg first-entry - In this example, the g binding will be - overwritten and cannot be used. Newer versions of NeoMutt will warn the - user about this. - To avoid warnings on startup, first set the shorter binding to - noop (no operation). + + In this example, the g binding will be overwritten + and cannot be used. Newer versions of NeoMutt will warn the user + about this. + + + To avoid warnings on startup, first set the shorter binding to + noop (no operation). + bind index g noop @@ -3915,7 +4272,9 @@ bind index gg first-entry Defining Aliases for Character Sets - Usage: + + Usage: + charset-hook @@ -3933,20 +4292,24 @@ bind index gg first-entry local-charset - The - charset-hook command defines an alias for a character - set. This is useful to properly display messages which are tagged with a - character set name not known to NeoMutt. - The - iconv-hook command defines a system-specific name for a - character set. This is helpful when your systems character conversion - library insists on using strange, system-specific names for character - sets. + + The charset-hook command defines an alias for + a character set. This is useful to properly display messages which are + tagged with a character set name not known to NeoMutt. + + + The iconv-hook command defines a system-specific + name for a character set. This is helpful when your systems character + conversion library insists on using strange, system-specific names for + character sets. + Setting Variables Based Upon Mailbox - Usage: + + Usage: + folder-hook @@ -3956,55 +4319,60 @@ bind index gg first-entry command - It is often desirable to change settings based on which mailbox you - are reading. The - folder-hook command provides a method by which you can - execute any configuration command. - regex is a regular expression specifying in which - mailboxes to execute - command before loading. If a mailbox matches multiple - folder-hooks, they are executed in the order given in - the - .neomuttrc. - The regex parameter has - mailbox shortcut expansion performed on - the first character. See - for more details. + + It is often desirable to change settings based on which mailbox you are + reading. The folder-hook command provides a method + by which you can execute any configuration command. + regex is a regular expression specifying in which + mailboxes to execute command before loading. If + a mailbox matches multiple folder-hooks, they are + executed in the order given in the .neomuttrc. + + + The regex parameter has mailbox + shortcut expansion performed on the first character. See + for more details. + - If you use the - !shortcut for - $spoolfile at the beginning of the - pattern, you must place it inside of double or single quotes in order - to distinguish it from the logical - not operator for the expression. + + If you use the ! shortcut for + $spoolfile at the beginning of the + pattern, you must place it inside of double or single quotes in order + to distinguish it from the logical not operator + for the expression. + - Settings are - not restored when you leave the mailbox. For - example, a command action to perform is to change the sorting method - based upon the mailbox being read: + + Settings are not restored when you leave the + mailbox. For example, a command action to perform is to change the + sorting method based upon the mailbox being read: + folder-hook work "set sort=threads" - However, the sorting method is not restored to its previous value - when reading a different mailbox. To specify a - default command, use the pattern - .before other - folder-hooks adjusting a value on a per-folder basis - because - folder-hooks are evaluated in the order given in the - configuration file. + + However, the sorting method is not restored to its previous value + when reading a different mailbox. To specify + a default command, use the pattern + . before other folder-hooks + adjusting a value on a per-folder basis because + folder-hooks are evaluated in the order given in + the configuration file. + - The keyboard buffer will not be processed until after all hooks - are run; multiple - push or - exec commands will end up being processed in - reverse order. + + The keyboard buffer will not be processed until after all hooks are + run; multiple push or + exec commands will end up being processed + in reverse order. + - The following example will set the - sort variable to - date-sent for all folders but to - threads for all folders containing - work in their name. + + The following example will set the sort + variable to date-sent for all folders but to + threads for all folders containing + work in their name. + Setting sort method based on mailbox name @@ -4018,7 +4386,9 @@ folder-hook work "set sort=threads" Keyboard Macros - Usage: + + Usage: + macro @@ -4034,52 +4404,58 @@ folder-hook work "set sort=threads" description - Macros are useful when you would like a single key to perform a - series of actions. When you press - key in menu - menu, NeoMutt will behave as if you had typed - sequence. So if you have a common sequence of - commands you type, you can create a macro to execute those commands with - a single key or fewer keys. - - menu is the - map which the macro will be bound in. 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. - - key and - sequence are expanded by the same rules as the - key bindings with some additions. The first is - that control characters in - sequence can also be specified as - ^x. In order to get a caret ( - ^) you need to use - ^^. Secondly, to specify a certain key such as - up or to invoke a function directly, you can use the - format - <key name>and - <function name>. For a listing of key names - see the section on - key bindings. Functions are listed in the - reference. - The advantage with using function names directly is that the macros - will work regardless of the current key bindings, so they are not - dependent on the user having particular key definitions. This makes them - more robust and portable, and also facilitates defining of macros in - files used by more than one user (e.g., the system neomuttrc). - Optionally you can specify a descriptive text after - sequence, which is shown in the help screens if they - contain a description. + + Macros are useful when you would like a single key to perform a series + of actions. When you press key in menu + menu, NeoMutt will behave as if you had typed + sequence. So if you have a common sequence of + commands you type, you can create a macro to execute those commands + with a single key or fewer keys. + + + menu is the map which + the macro will be bound in. 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. + + + key and sequence are expanded + by the same rules as the key bindings with + some additions. The first is that control characters in + sequence can also be specified as + ^x. In order to get a caret (^) + you need to use ^^. Secondly, to specify a certain + key such as up or to invoke a function directly, + you can use the format <key name> and + <function name>. For a listing of key names + see the section on key bindings. Functions + are listed in the reference. + + + The advantage with using function names directly is that the macros + will work regardless of the current key bindings, so they are not + dependent on the user having particular key definitions. This makes + them more robust and portable, and also facilitates defining of macros + in files used by more than one user (e.g., the system neomuttrc). + + + Optionally you can specify a descriptive text after + sequence, which is shown in the help screens if + they contain a description. + - Macro definitions (if any) listed in the help screen(s), are - silently truncated at the screen width, and are not wrapped. + + Macro definitions (if any) listed in the help screen(s), are silently + truncated at the screen width, and are not wrapped. + Using Color and Mono Video Attributes - Usage: + + Usage: + color @@ -4156,239 +4532,340 @@ folder-hook work "set sort=threads" - If your terminal supports color, you can spice up NeoMutt by creating - your own color scheme. To define the color of an object (type of - information), you must specify both a foreground color - and a background color (it is not possible to only - specify one or the other). - - header and - body match - regex in the header/body of a message, - index-object can match - pattern(see - ) in the message index. Note that IMAP - server-side searches (=b, =B, =h) are not supported for color index - patterns. - When - $header_color_partial is unset - (the default), a - header matched by - regex will have color applied to the entire header. - When set, color is applied only to the exact text matched by - regex. - - object can be one of: + + If your terminal supports color, you can spice up NeoMutt by creating + your own color scheme. To define the color of an object (type of + information), you must specify both a foreground color + and a background color (it is not possible to only + specify one or the other). + + + header and body match + regex in the header/body of a message, + index-object can match + pattern (see ) in the + message index. Note that IMAP server-side searches (=b, =B, =h) are not + supported for color index patterns. + + + When $header_color_partial + is unset (the default), a header matched by + regex will have color applied to the entire + header. When set, color is applied only to the exact text matched by + regex. + + + object can be one of: + - attachment + + attachment + - bold (highlighting bold patterns in the body of - messages) + + bold (highlighting bold patterns in the body of messages) + - error (error messages printed by NeoMutt) + + error (error messages printed by NeoMutt) + - hdrdefault (default color of the message header in the - pager) + + hdrdefault (default color of the message header in the pager) + - index_author (color of the author name in the index, uses - pattern) + + index_author (color of the author name in the index, uses + pattern) + - index_collapsed (the number of messages in a collapsed thread - in the index) + + index_collapsed (the number of messages in a collapsed thread in + the index) + - index_date (color of the date field in the index) + + index_date (color of the date field in the index) + - index_flags (color of the message flags in the index) + + index_flags (color of the message flags in the index) + - index_label (color of the message label in the index) + + index_label (color of the message label in the index) + - index_number (color of the message number in the index) + + index_number (color of the message number in the index) + - index_size (color of the message size and line number in the - index) + + index_size (color of the message size and line number in the index) + - index_subject (color of the subject in the index, uses - pattern) + + index_subject (color of the subject in the index, uses + pattern) + - indicator (arrow or bar used to indicate the current item in a - menu) + + indicator (arrow or bar used to indicate the current item in + a menu) + - markers (the - +markers at the beginning of wrapped lines in the - pager) + + markers (the + markers at the beginning of wrapped + lines in the pager) + - message (informational messages) + + message (informational messages) + - normal + + normal + - progress(visual progress bar) + progress (visual progress bar) + - prompt + + prompt + - quoted (text matching - $quote_regex in the body of a - message) + + quoted (text matching + $quote_regex in the body of + a message) + - quoted1, quoted2, ..., quoted - N(higher levels of quoting) + + quoted1, quoted2, ..., quoted N (higher levels + of quoting) + - search (highlighting of words in the pager) + + search (highlighting of words in the pager) + - signature + + signature + - status (mode lines used to display info about the mailbox or - message) + + status (mode lines used to display info about the mailbox or + message) + - tilde (the - ~used to pad blank lines in the pager) + + tilde (the ~ used to pad blank lines in the pager) + - tree (thread tree drawn in the message index and attachment - menu) + + tree (thread tree drawn in the message index and attachment menu) + - underline (highlighting underlined patterns in the body of - messages) + + underline (highlighting underlined patterns in the body of + messages) + - composeobject can be one of: + composeobject can be one of: + - header + + header + - security_encrypt + + security_encrypt + - security_sign + + security_sign + - security_both + + security_both + - security_none + + security_none + - index-object can be one of the following: + index-object can be one of the following: + - index (default highlighting of the entire index line, uses - pattern) + + index (default highlighting of the entire index line, uses + pattern) + - index_date (the date field) + + index_date (the date field) + - index_flags (the message flags, %S %Z, uses - pattern) + + index_flags (the message flags, %S %Z, uses + pattern) + - index_number (the message number, %C) + + index_number (the message number, %C) + - index_collapsed (the number of messages in a collapsed thread, - %M) + + index_collapsed (the number of messages in a collapsed thread, %M) + - index_author (the author name, %A %a %F %L %n, uses - pattern) + + index_author (the author name, %A %a %F %L %n, uses + pattern) + - index_subject (the subject, %s, uses - pattern) + + index_subject (the subject, %s, uses pattern) + - index_size (the message size, %c %l) + + index_size (the message size, %c %l) + - index_label (the message label, %y %Y) + + index_label (the message label, %y %Y) + - index_tags (the transformed message tags, %g) + + index_tags (the transformed message tags, %g) + - index_tag (an individual message tag, %G, uses - pattern / tag name) + + index_tag (an individual message tag, %G, uses pattern + / tag name) + - foreground and - background can be one of the following: + foreground and background can + be one of the following: + - white + + white + - black + + black + - green + + green + - magenta + + magenta + - blue + + blue + - cyan + + cyan + - yellow + + yellow + - red + + red + - default + + default + - color - x + + color + x + - foreground can optionally be prefixed with the - keyword - bright to make the foreground color boldfaced (e.g., - brightred). - alert to make a blinking/alert color (e.g., - alertred). - If your terminal supports it, the special keyword - default can be used as a transparent color. The value - brightdefault is also valid. If NeoMutt is linked - against the - S-Lang library, you also need to set the - $COLORFGBG environment variable to the default colors - of your terminal for this to work; for example (for Bourne-like - shells): + foreground can optionally be prefixed with the + keyword bright to make the foreground color + boldfaced (e.g., brightred). + alert to make a blinking/alert color (e.g., + alertred). + + + If your terminal supports it, the special keyword + default can be used as a transparent color. The + value brightdefault is also valid. If NeoMutt is + linked against the S-Lang library, you also need + to set the $COLORFGBG environment variable to the + default colors of your terminal for this to work; for example (for + Bourne-like shells): + set COLORFGBG="green;black" @@ -4396,36 +4873,38 @@ export COLORFGBG - The - S-Lang library requires you to use the - lightgray and - brown keywords instead of - white and - yellow when setting this variable. + + The S-Lang library requires you to use the + lightgray and brown + keywords instead of white and + yellow when setting this variable. + - The - uncolor command can be applied to the index, header - and body objects only. It removes entries from the list. You - must specify the same pattern specified in the - color command for it to be removed. The pattern - *is a special token which means to clear the color list - of all entries. + + The uncolor command can be applied to the index, + header and body objects only. It removes entries from the list. You + must specify the same pattern specified in the + color command for it to be removed. The pattern + * is a special token which means to clear the color + list of all entries. + - NeoMutt also recognizes the keywords - color0, - color1, ..., - color - N-1( - N being the number of colors supported by your - terminal). This is useful when you remap the colors for your display (for - example by changing the color associated with - color2 for your xterm), since color names may then - lose their normal meaning. + + NeoMutt also recognizes the keywords color0, + color1, ..., color + N-1 (N being the number of + colors supported by your terminal). This is useful when you remap the + colors for your display (for example by changing the color associated + with color2 for your xterm), since color names may + then lose their normal meaning. + - If your terminal does not support color, it is still possible - change the video attributes through the use of the - mono command. Usage: + + If your terminal does not support color, it is still possible change + the video attributes through the use of the mono + command. Usage: + mono @@ -4480,25 +4959,35 @@ export COLORFGBG - For - object, see the - color command. - attribute can be one of the following: + + For object, see the color + command. attribute can be one of the following: + - none + + none + - bold + + bold + - underline + + underline + - reverse + + reverse + - standout + + standout + @@ -4508,17 +4997,21 @@ export COLORFGBG Header Display - When displaying a message in the pager, NeoMutt folds long header - lines at - $wrap columns. Though there're precise rules - about where to break and how, NeoMutt always folds headers using a tab for - readability. (Note that the sending side is not affected by this, NeoMutt - tries to implement standards compliant folding.) + + When displaying a message in the pager, NeoMutt folds long header + lines at $wrap columns. Though there're + precise rules about where to break and how, NeoMutt always folds + headers using a tab for readability. (Note that the sending side is + not affected by this, NeoMutt tries to implement standards compliant + folding.) + Selecting Headers - Usage: + + Usage: + ignore @@ -4537,25 +5030,29 @@ export COLORFGBG - Messages often have many header fields added by automatic - processing systems, or which may not seem useful to display on the - screen. This command allows you to specify header fields which you - don't normally want to see in the pager. - You do not need to specify the full header field name. For - example, - ignore content-will ignore all header fields that begin - with the pattern - content-. - ignore *will ignore all headers. - To remove a previously added token from the list, use the - unignore command. The - unignore command will make NeoMutt display headers with the - given pattern. For example, if you do - ignore x-it is possible to - unignore x-mailer. - - unignore *will remove all tokens from the ignore - list. + + Messages often have many header fields added by automatic processing + systems, or which may not seem useful to display on the screen. This + command allows you to specify header fields which you don't normally + want to see in the pager. + + + You do not need to specify the full header field name. For example, + ignore content- will ignore all header fields that + begin with the pattern content-. + ignore * will ignore all headers. + + + To remove a previously added token from the list, use the + unignore command. The unignore command + will make NeoMutt display headers with the given pattern. For + example, if you do ignore x- it is possible to + unignore x-mailer. + + + unignore * will remove all tokens from the ignore + list. + Header weeding @@ -4572,7 +5069,9 @@ unignore posted-to: Ordering Displayed Headers - Usage: + + Usage: + hdr_order @@ -4591,15 +5090,16 @@ unignore posted-to: - With the - hdr_order command you can specify an order in which - NeoMutt will attempt to present these headers to you when viewing - messages. - - - unhdr_order*will clear all previous headers - from the order list, thus removing the header order effects set by the - system-wide startup file. + + With the hdr_order command you can specify an + order in which NeoMutt will attempt to present these headers to you + when viewing messages. + + + unhdr_order* will clear all + previous headers from the order list, thus removing the header order + effects set by the system-wide startup file. + Configuring header display order hdr_order From Date: From: To: Cc: Subject: @@ -4609,7 +5109,9 @@ unignore posted-to: Alternative Addresses - Usage: + + Usage: + alternates @@ -4636,59 +5138,66 @@ unignore posted-to: - With various functions, NeoMutt will treat messages differently, - depending on whether you sent them or whether you received them from - someone else. For instance, when replying to a message that you sent to a - different party, NeoMutt will automatically suggest to send the response to - the original message's recipients — responding to yourself won't make - much sense in many cases. (See - $reply_to.) - Many users receive e-mail under a number of different addresses. To - fully use NeoMutt's features here, the program must be able to recognize - what e-mail addresses you receive mail under. That's the purpose of the - alternates command: It takes a list of regular - expressions, each of which can identify an address under which you - receive e-mail. - As addresses are matched using regular expressions and not exact - strict comparisons, you should make sure you specify your addresses as - precise as possible to avoid mismatches. For example, if you - specify: + + With various functions, NeoMutt will treat messages differently, + depending on whether you sent them or whether you received them from + someone else. For instance, when replying to a message that you sent to + a different party, NeoMutt will automatically suggest to send the + response to the original message's recipients – responding to yourself + won't make much sense in many cases. (See + $reply_to.) + + + Many users receive e-mail under a number of different addresses. To + fully use NeoMutt's features here, the program must be able to + recognize what e-mail addresses you receive mail under. That's the + purpose of the alternates command: It takes a list + of regular expressions, each of which can identify an address under + which you receive e-mail. + + + As addresses are matched using regular expressions and not exact strict + comparisons, you should make sure you specify your addresses as precise + as possible to avoid mismatches. For example, if you specify: + alternates user@example - NeoMutt will consider - - some-user@example - as being your address, too which may not be desired. As a - solution, in such cases addresses should be specified as: + + NeoMutt will consider + some-user@example as being your + address, too which may not be desired. As a solution, in such cases + addresses should be specified as: + alternates '^user@example$' - The - -group flag causes all of the subsequent regular - expressions to be added to the named group. - The - unalternates command can be used to write exceptions to - alternates patterns. If an address matches something in - an - alternates command, but you nonetheless do not think it - is from you, you can list a more precise pattern under an - unalternates command. - To remove a regular expression from the - alternates list, use the - unalternates command with exactly the same - regex. Likewise, if the - regex for an - alternates command matches an entry on the - unalternates list, that - unalternates entry will be removed. If the - regex for - unalternates is - *, - all entries on - alternates will be removed. + + The -group flag causes all of the subsequent regular + expressions to be added to the named group. + + + The unalternates command can be used to write + exceptions to alternates patterns. If an address + matches something in an alternates command, but you + nonetheless do not think it is from you, you can list a more precise + pattern under an unalternates command. + + + To remove a regular expression from the alternates + list, use the unalternates command with exactly the + same regex. Likewise, if the + regex for an alternates command + matches an entry on the unalternates list, that + unalternates entry will be removed. If the + regex for unalternates is + *, all entries on + alternates will be removed. + Mailing Lists - Usage: + + Usage: + lists @@ -4731,108 +5240,127 @@ unignore posted-to: - NeoMutt has a few nice features for - handling mailing lists. In order to - take advantage of them, you must specify which addresses belong to - mailing lists, and which mailing lists you are subscribed to. NeoMutt also - has limited support for auto-detecting mailing lists: it supports parsing - mailto:links in the common - List-Post:header which has the same effect as - specifying the list address via the - lists command (except the group feature). Once you have - done this, the - - <list-reply> - function will work for all known lists. Additionally, when you - send a message to a subscribed list, NeoMutt will add a Mail-Followup-To - header to tell other users' mail user agents not to send copies of - replies to your personal address. + + NeoMutt has a few nice features for + handling mailing lists. In order to + take advantage of them, you must specify which addresses belong to + mailing lists, and which mailing lists you are subscribed to. NeoMutt + also has limited support for auto-detecting mailing lists: it supports + parsing mailto: links in the common + List-Post: header which has the same effect as + specifying the list address via the lists command + (except the group feature). Once you have done this, the + <list-reply> + function will work for all known lists. Additionally, when you send + a message to a subscribed list, NeoMutt will add a Mail-Followup-To + header to tell other users' mail user agents not to send copies of + replies to your personal address. + - 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 - $followup_to configuration variable - since it's common practice on some mailing lists to send Cc upon - replies (which is more a group- than a list-reply). + + 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 + $followup_to configuration + variable since it's common practice on some mailing lists to send Cc + upon replies (which is more a group- than a list-reply). + - More precisely, NeoMutt maintains lists of patterns for the addresses - of known and subscribed mailing lists. Every subscribed mailing list is - known. To mark a mailing list as known, use the - list command. To mark it as subscribed, use - subscribe. - You can use regular expressions with both commands. To mark all - messages sent to a specific bug report's address on Debian's bug tracking - system as list mail, for instance, you could say + + More precisely, NeoMutt maintains lists of patterns for the addresses + of known and subscribed mailing lists. Every subscribed mailing list is + known. To mark a mailing list as known, use the list + command. To mark it as subscribed, use subscribe. + + + You can use regular expressions with both commands. To mark all + messages sent to a specific bug report's address on Debian's bug + tracking system as list mail, for instance, you could say + subscribe [0-9]+.*@bugs.debian.org - as it's often sufficient to just give a portion of the list's - e-mail address. - Specify as much of the address as you need to to remove ambiguity. - For example, if you've subscribed to the NeoMutt mailing list, you will - receive mail addressed to - neomutt-users@neomutt.org. So, to tell NeoMutt that this is a - mailing list, you could add - lists neomutt-users@to your initialization file. To tell - NeoMutt that you are subscribed to it, add - - subscribe neomutt-users to your initialization - file instead. If you also happen to get mail from someone whose address - is - neomutt-users@example.com, you could use - - lists ^neomutt-users@neomutt\\.org$or - - subscribe ^neomutt-users@neomutt\\.org$to match - only mail from the actual list. - The - -group flag adds all of the subsequent regular - expressions to the named - address group in addition to adding to - the specified address list. - The - unlists command is used to remove a token from the list of - known and subscribed mailing-lists. Use - unlists *to remove all tokens. - To remove a mailing list from the list of subscribed mailing lists, - but keep it on the list of known mailing lists, use - unsubscribe. - - - - Using Multiple Spool Mailboxes - Usage: - - mbox-hook - - [!]regex - + + as it's often sufficient to just give a portion of the list's e-mail + address. + + + Specify as much of the address as you need to to remove ambiguity. For + example, if you've subscribed to the NeoMutt mailing list, you will + receive mail addressed to neomutt-users@neomutt.org. + So, to tell NeoMutt that this is a mailing list, you could add + lists neomutt-users@ to your initialization file. To + tell NeoMutt that you are subscribed to it, add + subscribe neomutt-users to your + initialization file instead. If you also happen to get mail from + someone whose address is neomutt-users@example.com, + you could use + lists^neomutt-users@neomutt\\.org$ + or + subscribe^neomutt-users@neomutt\\.org$ + to match only mail from the actual list. + + + The -group flag adds all of the subsequent regular + expressions to the named address group + in addition to adding to the specified address list. + + + The unlists command is used to remove a token from the + list of known and subscribed mailing-lists. Use + unlists * to remove all tokens. + + + To remove a mailing list from the list of subscribed mailing lists, but + keep it on the list of known mailing lists, use + unsubscribe. + + + + + Using Multiple Spool Mailboxes + + Usage: + + + mbox-hook + + [!]regex + mailbox - This command is used to move read messages from a specified mailbox - to a different mailbox automatically when you quit or change folders. - regex is a regular expression specifying the mailbox - to treat as a - spool mailbox and - mailbox specifies where mail should be saved when - read. - The regex parameter has - mailbox shortcut expansion performed on - the first character. See - for more details. - Note that execution of mbox-hooks is dependent on the - $move configuration variable. If set to - no(the default), mbox-hooks will not be executed. - Unlike some of the other - hook commands, only the - first matching regex is used (it is not possible to - save read mail in more than a single mailbox). + + This command is used to move read messages from a specified mailbox to + a different mailbox automatically when you quit or change folders. + regex is a regular expression specifying the + mailbox to treat as a spool mailbox and + mailbox specifies where mail should be saved when + read. + + + The regex parameter has + mailbox shortcut expansion performed + on the first character. See for more + details. + + + Note that execution of mbox-hooks is dependent on the + $move configuration variable. If set to + no (the default), mbox-hooks will not be executed. + + + Unlike some of the other hook commands, only the + first matching regex is used (it is not possible + to save read mail in more than a single mailbox). + Monitoring Incoming Mail - Usage: + + Usage: + mailboxes @@ -4851,47 +5379,52 @@ unignore posted-to: - This command specifies folders which can receive mail and which - will be checked for new messages periodically. - - folder can either be a local file or directory - (Mbox/Mmdf or Maildir/Mh). If NeoMutt was built with POP and/or IMAP - support, - folder can also be a POP/IMAP folder URL. The URL - syntax is described in - , POP and IMAP are described in - and - respectively. - NeoMutt provides a number of advanced features for handling (possibly - many) folders and new mail within them, please refer to - for details (including in what situations and - how often NeoMutt checks for new mail). Additionally, - $new_mail_command can be used - to run a command when new mail is detected. - The - unmailboxes command is used to remove a token from the list - of folders which receive mail. Use - unmailboxes *to remove all tokens. + + This command specifies folders which can receive mail and which will be + checked for new messages periodically. + + + folder can either be a local file or directory + (Mbox/Mmdf or Maildir/Mh). If NeoMutt was built with POP and/or IMAP + support, folder can also be a POP/IMAP folder URL. + The URL syntax is described in , POP and + IMAP are described in and + respectively. + + + NeoMutt provides a number of advanced features for handling (possibly + many) folders and new mail within them, please refer to + for details (including in what situations + and how often NeoMutt checks for new mail). Additionally, + $new_mail_command can be used + to run a command when new mail is detected. + + + The unmailboxes command is used to remove a token from + the list of folders which receive mail. Use + unmailboxes * to remove all tokens. + - The folders in the - mailboxes command are resolved when the command is - executed, so if these names contain - shortcut characters(such as - =and - !), any variable definition that affects these - characters (like - $folder and - $spoolfile) should be set before the - mailboxes command. If none of these shortcuts are - used, a local path should be absolute as otherwise NeoMutt tries to find - it relative to the directory from where NeoMutt was started which may not - always be desired. + + The folders in the mailboxes command are resolved + when the command is executed, so if these names contain + shortcut characters (such as + = and !), any variable definition that + affects these characters (like $folder + and $spoolfile) should be set before + the mailboxes command. If none of these shortcuts + are used, a local path should be absolute as otherwise NeoMutt tries + to find it relative to the directory from where NeoMutt was started + which may not always be desired. + User-Defined Headers - Usage: + + Usage: + my_hdr @@ -4907,16 +5440,18 @@ unignore posted-to: - The - my_hdr command allows you to create your own header - fields which will be added to every message you send and appear in the - editor if - $edit_headers is set. - For example, if you would like to add an - Organization:header field to all of your outgoing - messages, you can put the command something like shown in - in your - .neomuttrc. + + The my_hdr command allows you to create your own + header fields which will be added to every message you send and appear + in the editor if $edit_headers is + set. + + + For example, if you would like to add an Organization: + header field to all of your outgoing messages, you can put the command + something like shown in in your + .neomuttrc. + Defining custom headers @@ -4926,29 +5461,35 @@ my_hdr Organization: A Really Big Company, Anytown, USA - Space characters are - not allowed between the keyword and the colon ( - :). The standard for electronic mail (RFC2822) says that - space is illegal there, so NeoMutt enforces the rule. + + Space characters are not allowed between the + keyword and the colon (:). The standard for + electronic mail (RFC2822) says that space is illegal there, so + NeoMutt enforces the rule. + - If you would like to add a header field to a single message, you - should either set the - $edit_headers variable, or use the - <edit-headers>function (default: - E) in the compose menu so that you can edit the header of - your message along with the body. - To remove user defined header fields, use the - unmy_hdr command. You may specify an asterisk ( - *) to remove all header fields, or the fields to remove. - For example, to remove all - To and - Cc header fields, you could use: + + If you would like to add a header field to a single message, you should + either set the $edit_headers + variable, or use the <edit-headers> function + (default: E) in the compose menu so that you can edit + the header of your message along with the body. + + + To remove user defined header fields, use the + unmy_hdr command. You may specify an asterisk + (*) to remove all header fields, or the fields to + remove. For example, to remove all To and + Cc header fields, you could use: + unmy_hdr to cc Specify Default Save Mailbox - Usage: + + Usage: + save-hook @@ -4958,17 +5499,17 @@ my_hdr Organization: A Really Big Company, Anytown, USA mailbox - This command is used to override the default mailbox used when - saving messages. - mailbox will be used as the default if the message - matches - pattern, see - for information on the exact - format. - To provide more flexibility and good defaults, NeoMutt applies the - expandos of - $index_format to - mailbox after it was expanded. + + This command is used to override the default mailbox used when saving + messages. mailbox will be used as the default if + the message matches pattern, see + for information on the exact format. + + + To provide more flexibility and good defaults, NeoMutt applies the + expandos of $index_format to + mailbox after it was expanded. + Using %-expandos in <command>save-hook</command> @@ -4983,15 +5524,18 @@ save-hook aol\\.com$ +spam - Also see the - - fcc-save-hook - command. + + Also see the + fcc-save-hook + command. + Specify Default Fcc: Mailbox When Composing - Usage: + + Usage: + fcc-hook @@ -5001,32 +5545,37 @@ save-hook aol\\.com$ +spam mailbox - This command is used to save outgoing mail in a mailbox other than - $record. NeoMutt searches the initial list of - message recipients for the first matching - pattern and uses - mailbox as the default Fcc: mailbox. If no match is - found the message will be saved to - $record mailbox. - To provide more flexibility and good defaults, NeoMutt applies the - expandos of - $index_format to - mailbox after it was expanded. - See - for information on the exact format of - pattern. + + This command is used to save outgoing mail in a mailbox other than + $record. NeoMutt searches the initial + list of message recipients for the first matching + pattern and uses mailbox as + the default Fcc: mailbox. If no match is found the message will be + saved to $record mailbox. + + + To provide more flexibility and good defaults, NeoMutt applies the + expandos of $index_format to + mailbox after it was expanded. + + + See for information on the exact format + of pattern. + fcc-hook [@.]aol\\.com$ +spammers - ...will save a copy of all messages going to the aol.com domain to - the `+spammers' mailbox by default. Also see the - - fcc-save-hook - command. + + ...will save a copy of all messages going to the aol.com domain to the + `+spammers' mailbox by default. Also see the + fcc-save-hook + command. + - Specify Default Save Filename and Default Fcc: Mailbox at - Once - Usage: + Specify Default Save Filename and Default Fcc: Mailbox at Once + + Usage: + fcc-save-hook @@ -5036,22 +5585,22 @@ save-hook aol\\.com$ +spam mailbox - This command is a shortcut, equivalent to doing both a - - fcc-hook - and a - - save-hook - with its arguments, including %-expansion on - mailbox according to - $index_format. + + This command is a shortcut, equivalent to doing both a + fcc-hook and a + save-hook with its + arguments, including %-expansion on mailbox + according to $index_format. + Change Settings Based Upon Message Recipients - Usage: + + Usage: + reply-hook @@ -5075,77 +5624,82 @@ save-hook aol\\.com$ +spam command - These commands can be used to execute arbitrary configuration - commands based upon recipients of the message. - pattern is used to match the message, see - for details. - command is executed when - pattern matches. - - reply-hook is matched against the message you are - replying to, instead of the message you are - sending. - send-hook is matched against all messages, both - new and - replies. + + These commands can be used to execute arbitrary configuration commands + based upon recipients of the message. pattern is + used to match the message, see for + details. command is executed when + pattern matches. + + + reply-hook is matched against the message you are + replying to, instead of the message you are + sending. send-hook is matched + against all messages, both new and + replies. + - reply-hooks are matched - before the - send-hook, - regardless of the order specified in the user's - configuration file. However, you can inhibit - send-hook in the reply case by using the pattern - '! ~Q'( - not replied, see - ) in the - send-hook to tell when - reply-hook have been executed. + reply-hooks are matched + before the send-hook, + regardless of the order specified in the user's + configuration file. However, you can inhibit + send-hook in the reply case by using the pattern + '! ~Q' (not replied, see + ) in the send-hook + to tell when reply-hook have been executed. + - send2-hook is matched every time a message is changed, - either by editing it, or by using the compose menu to change its - recipients or subject. - send2-hook is executed after - send-hook, and can, e.g., be used to set parameters - such as the - $sendmail variable depending on the - message's sender address. - For each type of - send-hook or - reply-hook, when multiple matches occur, commands are - executed in the order they are specified in the - .neomuttrc(for that type of hook). - Example: - - send-hook work " - set mime_forward signature=''" - Another typical use for this command is to change the values of the - $attribution, - $attribution_locale, and - $signature variables in order to change - the language of the attributions and signatures based upon the - recipients. + send2-hook is matched every time a message is + changed, either by editing it, or by using the compose menu to change + its recipients or subject. send2-hook is executed + after send-hook, and can, e.g., be used to set + parameters such as the $sendmail + variable depending on the message's sender address. + + + For each type of send-hook or + reply-hook, when multiple matches occur, commands + are executed in the order they are specified in the + .neomuttrc (for that type of hook). + + + Example: + + send-hook work "set + mime_forward signature=''" + + + + Another typical use for this command is to change the values of the + $attribution, + $attribution_locale, and + $signature variables in order to + change the language of the attributions and signatures based upon the + recipients. + - send-hook's are only executed once after getting the - initial list of recipients. Adding a recipient after replying or - editing the message will not cause any - send-hook to be executed, similarly if - $autoedit is set (as then the initial - list of recipients is empty). Also note that - - my_hdr - commands which modify recipient headers, or the message's - subject, don't have any effect on the current message when executed - from a - send-hook. + send-hook's are only executed once after getting the + initial list of recipients. Adding a recipient after replying or + editing the message will not cause any + send-hook to be executed, similarly if + $autoedit is set (as then the initial + list of recipients is empty). Also note that + my_hdr commands + which modify recipient headers, or the message's subject, don't have + any effect on the current message when executed from + a send-hook. + Change Settings Before Formatting a Message - Usage: + + Usage: + message-hook @@ -5155,18 +5709,21 @@ save-hook aol\\.com$ +spam command - This command can be used to execute arbitrary configuration - commands before viewing or formatting a message based upon information - about the message. - command is executed if the - pattern matches the message to be displayed. When - multiple matches occur, commands are executed in the order they are - specified in the - .neomuttrc. - See - for information on the exact format of - pattern. - Example: + + This command can be used to execute arbitrary configuration commands + before viewing or formatting a message based upon information about the + message. command is executed if the + pattern matches the message to be displayed. When + multiple matches occur, commands are executed in the order they are + specified in the .neomuttrc. + + + See for information on the exact format + of pattern. + + + Example: + message-hook ~A 'set pager=builtin' @@ -5177,7 +5734,9 @@ message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""' Choosing the Cryptographic Key of the Recipient - Usage: + + Usage: + crypt-hook @@ -5187,73 +5746,82 @@ message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""' keyid - When encrypting messages with PGP/GnuPG or OpenSSL, you may want to - associate a certain key with a given e-mail address automatically, either - because the recipient's public key can't be deduced from the destination - address, or because, for some reasons, you need to override the key NeoMutt - would normally use. The - crypt-hook command provides a method by which you can - specify the ID of the public key to be used when encrypting messages to a - certain recipient. You may use multiple crypt-hooks with the same regex; - multiple matching crypt-hooks result in the use of multiple keyids for a - recipient. During key selection, NeoMutt will confirm whether each - crypt-hook is to be used (unless the - $crypt_confirmhook option is - unset). If all crypt-hooks for a recipient are declined, NeoMutt will use - the original recipient address for key selection instead. - The meaning of - keyid is to be taken broadly in this context: You can - either put a numerical key ID or fingerprint here, an e-mail address, or - even just a real name. + + When encrypting messages with PGP/GnuPG or OpenSSL, you may want to + associate a certain key with a given e-mail address automatically, + either because the recipient's public key can't be deduced from the + destination address, or because, for some reasons, you need to override + the key NeoMutt would normally use. The crypt-hook + command provides a method by which you can specify the ID of the public + key to be used when encrypting messages to a certain recipient. You may + use multiple crypt-hooks with the same regex; multiple matching + crypt-hooks result in the use of multiple keyids for a recipient. + During key selection, NeoMutt will confirm whether each crypt-hook is + to be used (unless the + $crypt_confirmhook option is + unset). If all crypt-hooks for a recipient are declined, NeoMutt will + use the original recipient address for key selection instead. + + + The meaning of keyid is to be taken broadly in + this context: You can either put a numerical key ID or fingerprint + here, an e-mail address, or even just a real name. + Adding Key Sequences to the Keyboard Buffer - Usage: + + Usage: + push string - This command adds the named string to the beginning of the keyboard - buffer. The string may contain control characters, key names and function - names like the sequence string in the - macro command. You may use it to - automatically run a sequence of commands at startup, or when entering - certain folders. For example, - shows how to automatically collapse - all threads when entering a folder. + + This command adds the named string to the beginning of the keyboard + buffer. The string may contain control characters, key names and + function names like the sequence string in the + macro command. You may use it to + automatically run a sequence of commands at startup, or when entering + certain folders. For example, + shows how to automatically collapse all threads when entering a folder. + Embedding <command>push</command> in <command>folder-hook</command> folder-hook . 'push <collapse-all>' - For using functions like shown in the example, it's important to - use angle brackets ( - <and - >) to make NeoMutt recognize the input as a function name. - Otherwise it will simulate individual just keystrokes, i.e. - - push collapse-all - would be interpreted as if you had typed - c, followed by - o, followed by - l, ..., which is not desired and may lead to very - unexpected behavior. - Keystrokes can be used, too, but are less portable because of - potentially changed key bindings. With default bindings, this is - equivalent to the above example: + + For using functions like shown in the example, it's important to use + angle brackets (< and >) to make + NeoMutt recognize the input as a function name. Otherwise it will + simulate individual just keystrokes, i.e. + push collapse-all would be + interpreted as if you had typed c, followed by + o, followed by l, ..., which is not + desired and may lead to very unexpected behavior. + + + Keystrokes can be used, too, but are less portable because of + potentially changed key bindings. With default bindings, this is + equivalent to the above example: + folder-hook . 'push \eV' - because it simulates that Esc+V was pressed (which is the default - binding of - <collapse-all>). + + because it simulates that Esc+V was pressed (which is the default + binding of <collapse-all>). + Executing Functions - Usage: + + Usage: + exec @@ -5263,21 +5831,19 @@ message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""' function - This command can be used to execute any function. Functions are - listed in the - function reference. - - exec - function - is equivalent to - - push <function> - . + + This command can be used to execute any function. Functions are listed + in the function reference. + exec function is + equivalent to push <function>. + Message Scoring - Usage: + + Usage: + score @@ -5296,39 +5862,36 @@ message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""' - The - score commands adds - value to a message's score if - pattern matches it. - pattern is a string in the format described in the - patterns section (note: For efficiency - reasons, patterns which scan information not available in the index, such - as - ~b, - ~B, - ~h, or - ~X may not be used). - value is a positive or negative integer. A message's - final score is the sum total of all matching - score entries. However, you may optionally prefix - value with an equal sign ( - =) to cause evaluation to stop at a particular entry if - there is a match. Negative final scores are rounded up to 0. - The - unscore command removes score entries from the list. - You - must specify the same pattern specified in the - score command for it to be removed. The pattern - *is a special token which means to clear the list of all - score entries. - - Scoring occurs as the messages are read in, before the mailbox is - sorted. Because of this, patterns which depend on threading, such as - ~=, - ~$, and - ~(), will not work by default. A workaround is to push - the scoring command in a folder hook. This will cause the mailbox to be - rescored after it is opened and input starts being processed: + + The score commands adds value + to a message's score if pattern matches it. + pattern is a string in the format described in the + patterns section (note: For efficiency + reasons, patterns which scan information not available in the index, + such as ~b, ~B, + ~h, or ~X may not be used). + value is a positive or negative integer. + A message's final score is the sum total of all matching + score entries. However, you may optionally prefix + value with an equal sign (=) to + cause evaluation to stop at a particular entry if there is a match. + Negative final scores are rounded up to 0. + + + The unscore command removes score entries from the + list. You must specify the same pattern specified + in the score command for it to be removed. The + pattern * is a special token which means to clear the + list of all score entries. + + + Scoring occurs as the messages are read in, before the mailbox is + sorted. Because of this, patterns which depend on threading, such as + ~=, ~$, and + ~(), will not work by default. A workaround is to + push the scoring command in a folder hook. This will cause the mailbox + to be rescored after it is opened and input starts being processed: + folder-hook . 'push "<enter-command>score ~= 10<enter>"' @@ -5338,7 +5901,9 @@ folder-hook . 'push "<enter-command>score ~= 10<enter>"' Spam Detection - Usage: + + Usage: + spam @@ -5357,55 +5922,55 @@ folder-hook . 'push "<enter-command>score ~= 10<enter>"' - NeoMutt has generalized support for external spam-scoring filters. By - defining your spam patterns with the - spam and - nospam commands, you can - limit, - search, and - sort your mail based on its spam attributes, as - determined by the external filter. You also can display the spam - attributes in your index display using the - %H selector in the - $index_format variable. (Tip: try - %?H?[%H] ?to display spam tags only when they are - defined for a given message.) - Your first step is to define your external filter's spam patterns - using the - spam command. - pattern should be a regular expression that matches a - header in a mail message. If any message in the mailbox matches this - regular expression, it will receive a - spam tag or - spam attribute(unless it also matches a - nospam pattern — see below.) The appearance of this - attribute is entirely up to you, and is governed by the - format parameter. - format can be any static text, but it also can - include back-references from the - pattern expression. (A regular expression - back-reference refers to a sub-expression contained within - parentheses.) - %1 is replaced with the first back-reference in the - regex, - %2 with the second, etc. - To match spam tags, NeoMutt needs the corresponding header information - which is always the case for local and POP folders but not for IMAP in - the default configuration. Depending on the spam header to be analyzed, - $imap_headers may need to be - adjusted. - If you're using multiple spam filters, a message can have more than - one spam-related header. You can define - spam patterns for each filter you use. If a message - matches two or more of these patterns, and the - $spam_separator variable is set to a - string, then the message's spam tag will consist of all the - format strings joined together, with the value of - $spam_separator separating - them. - For example, suppose one uses DCC, SpamAssassin, and PureMessage, - then the configuration might look like in - . + + NeoMutt has generalized support for external spam-scoring filters. By + defining your spam patterns with the spam and + nospam commands, you can limit, + search, and sort your mail + based on its spam attributes, as determined by the external filter. You + also can display the spam attributes in your index display using the + %H selector in the + $index_format variable. (Tip: try + %?H?[%H] ? to display spam tags only when they are + defined for a given message.) + + + Your first step is to define your external filter's spam patterns using + the spam command. pattern + should be a regular expression that matches a header in a mail message. + If any message in the mailbox matches this regular expression, it will + receive a spam tag or spam attribute + (unless it also matches a nospam pattern – see + below.) The appearance of this attribute is entirely up to you, and is + governed by the format parameter. + format can be any static text, but it also can + include back-references from the pattern + expression. (A regular expression back-reference refers + to a sub-expression contained within parentheses.) + %1 is replaced with the first back-reference in the + regex, %2 with the second, etc. + + + To match spam tags, NeoMutt needs the corresponding header information + which is always the case for local and POP folders but not for IMAP in + the default configuration. Depending on the spam header to be analyzed, + $imap_headers may need to be + adjusted. + + + If you're using multiple spam filters, a message can have more than one + spam-related header. You can define spam patterns + for each filter you use. If a message matches two or more of these + patterns, and the $spam_separator + variable is set to a string, then the message's spam tag will consist + of all the format strings joined together, with + the value of $spam_separator + separating them. + + + For example, suppose one uses DCC, SpamAssassin, and PureMessage, then + the configuration might look like in . + Configuring spam detection @@ -5417,79 +5982,78 @@ set spam_separator=", " - If then a message is received 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 supersedes the previous one. Instead of - getting joined - format strings, you'll get only the last one to - match. - The spam tag is what will be displayed in the index when you use - %H in the - $index_format variable. It's also the - string that the - ~H pattern-matching expression matches against for - <search>and - <limit>functions. And it's what sorting by spam - attribute will use as a sort key. - That's a pretty complicated example, and most people's actual - environments will have only one spam filter. The simpler your - configuration, the more effective NeoMutt can be, especially when it comes - to sorting. - Generally, when you sort by spam tag, NeoMutt will sort - lexically— that is, by ordering strings - alphanumerically. However, if a spam tag begins with a number, NeoMutt will - sort numerically first, and lexically only when two numbers are equal in - value. (This is like UNIX's - sort -n.) A message with no spam attributes at all — - that is, one that didn't match - any of your - spam patterns — is sorted at lowest priority. Numbers - are sorted next, beginning with 0 and ranging upward. Finally, - non-numeric strings are sorted, with - a taking lower priority than - z. Clearly, in general, sorting by spam tags is most - effective when you can coerce your filter to give you a raw number. But - in case you can't, NeoMutt can still do something useful. - The - nospam command can be used to write exceptions to - spam patterns. If a header pattern matches something in - a - spam command, but you nonetheless do not want it to - receive a spam tag, you can list a more precise pattern under a - nospam command. - If the - pattern given to - nospam is exactly the same as the - pattern on an existing - spam list entry, the effect will be to remove the entry - from the spam list, instead of adding an exception. Likewise, if the - pattern for a - spam command matches an entry on the - nospam list, that nospam entry will be removed. If the - pattern for - nospam is - *, - all entries on both lists will be removed. This might - be the default action if you use - spam and - nospam in conjunction with a - folder-hook. - You can have as many - spam or - nospam commands as you like. You can even do your own - primitive - spam detection within NeoMutt — for example, if you - consider all mail from - MAILER-DAEMON to be spam, you can use a - spam command like this: + + If then a message is received 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 supersedes the previous one. + Instead of getting joined format strings, you'll + get only the last one to match. + + + The spam tag is what will be displayed in the index when you use + %H in the + $index_format variable. It's also + the string that the ~H pattern-matching expression + matches against for <search> and + <limit> functions. And it's what sorting by + spam attribute will use as a sort key. + + + That's a pretty complicated example, and most people's actual + environments will have only one spam filter. The simpler your + configuration, the more effective NeoMutt can be, especially when it + comes to sorting. + + + Generally, when you sort by spam tag, NeoMutt will sort + lexically – that is, by ordering strings + alphanumerically. However, if a spam tag begins with a number, NeoMutt + will sort numerically first, and lexically only when two numbers are + equal in value. (This is like UNIX's sort -n.) + A message with no spam attributes at all – that is, one that didn't + match any of your spam patterns + – is sorted at lowest priority. Numbers are sorted next, beginning with + 0 and ranging upward. Finally, non-numeric strings are sorted, with + a taking lower priority than z. Clearly, + in general, sorting by spam tags is most effective when you can coerce + your filter to give you a raw number. But in case you can't, NeoMutt + can still do something useful. + + + The nospam command can be used to write exceptions + to spam patterns. If a header pattern matches + something in a spam command, but you nonetheless do + not want it to receive a spam tag, you can list a more precise pattern + under a nospam command. + + + If the pattern given to nospam + is exactly the same as the pattern on an existing + spam list entry, the effect will be to remove the + entry from the spam list, instead of adding an exception. Likewise, if + the pattern for a spam command + matches an entry on the nospam list, that nospam + entry will be removed. If the pattern for + nospam is *, + all entries on both lists will be removed. This + might be the default action if you use spam and + nospam in conjunction with + a folder-hook. + + + You can have as many spam or + nospam commands as you like. You can even do your + own primitive spam detection within NeoMutt – for + example, if you consider all mail from MAILER-DAEMON + to be spam, you can use a spam command like this: + spam "^From: .*MAILER-DAEMON" "999" @@ -5498,88 +6062,102 @@ set spam_separator=", " Variable Types - NeoMutt supports these types of configuration variables: + + NeoMutt supports these types of configuration variables: + boolean - A boolean expression, either - yes or - no. + + A boolean expression, either yes or + no. + number - A signed integer number in the range -32768 to - 32767. + + A signed integer number in the range -32768 to 32767. + string - Arbitrary text. + + Arbitrary text. + path - A specialized string for representing paths including - support for mailbox shortcuts (see - ) as well as tilde ( - ~) for a user's home directory and more. + + A specialized string for representing paths including support + for mailbox shortcuts (see ) as + well as tilde (~) for a user's home directory + and more. + quadoption - Like a boolean but triggers a prompt when set to - ask-yes or - ask-no with - yes and - no preselected respectively. + + Like a boolean but triggers a prompt when set to + ask-yes or ask-no with + yes and no preselected + respectively. + sort order - A specialized string allowing only particular words as - values depending on the variable. + + A specialized string allowing only particular words as values + depending on the variable. + regular expression - A regular expression, see - for an introduction. + + A regular expression, see for an + introduction. + folder magic - Specifies the type of folder to use: - mbox, - mmdf, - mh or - maildir. Currently only used to determine - the type for newly created folders. + + Specifies the type of folder to use: mbox, + mmdf, mh or + maildir. Currently only used to determine + the type for newly created folders. + e-mail address - An e-mail address either with or without realname. The - older - - user@example.org (Joe User) - form is supported but strongly deprecated. + + An email address either with or without realname. The older + user@example.org (Joe User) + form is supported but strongly deprecated. + user-defined - Arbitrary text, see - for details. + + Arbitrary text, see for details. + @@ -5587,9 +6165,13 @@ set spam_separator=", " Commands - The following commands are available to manipulate and query - variables: - Usage: + + The following commands are available to manipulate and query + variables: + + + Usage: + set @@ -5631,68 +6213,69 @@ set spam_separator=", " variable - This command is used to set (and unset) - configuration variables. There are - four basic types of variables: boolean, number, string and quadoption. - boolean variables can be - set(true) or - unset(false). - number variables can be assigned a positive integer - value. - string variables consist of any number of printable - characters and must be enclosed in quotes if they contain spaces or - tabs. You may also use the escape sequences - \n and - \t for newline and tab, respectively. - quadoption variables are used to control whether or - not to be prompted for certain actions, or to specify a default action. - A value of - yes will cause the action to be carried out - automatically as if you had answered yes to the question. Similarly, a - value of - no will cause the action to be carried out as if - you had answered - no.A value of - ask-yes will cause a prompt with a default answer - of - yes and - ask-no will provide a default answer of - no. - Prefixing a variable with - no will unset it. Example: - - set noaskbcc. - For - boolean variables, you may optionally prefix the - variable name with - inv to toggle the value (on or off). This is useful - when writing macros. Example: - - set invsmart_wrap. - The - toggle command automatically prepends the - inv prefix to all specified variables. - The - unset command automatically prepends the - no prefix to all specified variables. - Using the - <enter-command>function in the - index menu, you can query the value of a variable - by prefixing the name of the variable with a question mark: + + This command is used to set (and unset) + configuration variables. There are + four basic types of variables: boolean, number, string and + quadoption. boolean variables can be + set (true) or unset + (false). number variables can be assigned + a positive integer value. string variables + consist of any number of printable characters and must be enclosed in + quotes if they contain spaces or tabs. You may also use the escape + sequences \n and \t for newline and + tab, respectively. quadoption variables are + used to control whether or not to be prompted for certain actions, or + to specify a default action. A value of yes + will cause the action to be carried out automatically as if you had + answered yes to the question. Similarly, a value of + no will cause the action to be carried out as if + you had answered no. A value of + ask-yes will cause a prompt with a default + answer of yes and ask-no will + provide a default answer of no. + + + Prefixing a variable with no will unset it. Example: + set noaskbcc. + + + For boolean variables, you may optionally prefix + the variable name with inv to toggle the value (on + or off). This is useful when writing macros. Example: + set invsmart_wrap. + + + The toggle command automatically prepends the + inv prefix to all specified variables. + + + The unset command automatically prepends the + no prefix to all specified variables. + + + Using the <enter-command> function in the + index menu, you can query the value of + a variable by prefixing the name of the variable with a question + mark: + set ?allow_8bit - The question mark is actually only required for boolean and - quadoption variables. - The - reset command resets all given variables to the - compile time defaults (hopefully mentioned in this manual). If you use - the command - set and prefix the variable with - &this has the same behavior as the - reset command. - With the - reset command there exists the special variable - all, which allows you to reset all variables to their - system defaults. + + The question mark is actually only required for boolean and + quadoption variables. + + + The reset command resets all given variables to + the compile time defaults (hopefully mentioned in this manual). If + you use the command set and prefix the variable + with & this has the same behavior as the + reset command. + + + With the reset command there exists the special + variable all, which allows you to reset all variables + to their system defaults. + @@ -5700,31 +6283,35 @@ set spam_separator=", " Introduction - Along with the variables listed in the - Configuration variables section, NeoMutt - supports user-defined variables with names starting with - my_ as in, for example, - my_cfgdir. - The - set command either creates a custom - my_ variable or changes its value if it does exist - already. The - unset and - reset commands remove the variable entirely. - Since user-defined variables are expanded in the same way that - environment variables are (except for the - shell-escape command and backtick - expansion), this feature can be used to make configuration files more - readable. + + Along with the variables listed in the + Configuration variables section, + NeoMutt supports user-defined variables with names starting with + my_ as in, for example, + my_cfgdir. + + + The set command either creates a custom + my_ variable or changes its value if it does + exist already. The unset and + reset commands remove the variable entirely. + + + Since user-defined variables are expanded in the same way that + environment variables are (except for the + shell-escape command and + backtick expansion), this feature can be used to make configuration + files more readable. + Examples - The following example defines and uses the variable - my_cfgdir to abbreviate the calls of the - - source - command: + + The following example defines and uses the variable + my_cfgdir to abbreviate the calls of the + source command: + Using user-defined variables for config file readability @@ -5736,14 +6323,14 @@ source $my_cfgdir/hooks $my_cfgdir/macros - A custom variable can also be used in macros to backup the - current value of another variable. In the following example, the - value of the - $delete is changed temporarily while its - original value is saved as - my_delete. After the macro has executed all - commands, the original value of - $delete is restored. + + A custom variable can also be used in macros to backup the current + value of another variable. In the following example, the value of + the $delete is changed temporarily + while its original value is saved as my_delete. + After the macro has executed all commands, the original value of + $delete is restored. + Using user-defined variables for backing up other config option values @@ -5757,18 +6344,18 @@ macro pager ,x '\ - Since NeoMutt expands such values already when parsing the - configuration file(s), the value of - $my_delete in the last example would be the value - of - $delete exactly as it was at that point - during parsing the configuration file. If another statement would - change the value for - $delete later in the same or another - file, it would have no effect on - $my_delete. However, the expansion can be deferred - to runtime, as shown in the next example, when escaping the dollar - sign. + + Since NeoMutt expands such values already when parsing the + configuration file(s), the value of $my_delete + in the last example would be the value of + $delete exactly as it was at that + point during parsing the configuration file. If another statement + would change the value for $delete + later in the same or another file, it would have no effect on + $my_delete. However, the expansion can be + deferred to runtime, as shown in the next example, when escaping + the dollar sign. + Deferring user-defined variable expansion to runtime @@ -5781,25 +6368,29 @@ macro pager <PageDown> "\ - Note that there is a space between - <enter-command>and the - set configuration command, preventing NeoMutt from - recording the - macro's commands into its history. + + Note that there is a space between + <enter-command> and the + set configuration command, preventing NeoMutt + from recording the macro's commands into its + history. + Type Conversions - Variables are always assigned string values which NeoMutt parses - into its internal representation according to the type of the variable, - for example an integer number for numeric types. For all queries - (including $-expansion) the value is converted from its internal type - back into string. As a result, any variable can be assigned any value - given that its content is valid for the target. This also counts for - custom variables which are of type string. In case of parsing errors, - NeoMutt will print error messages. - demonstrates type conversions. + + Variables are always assigned string values which NeoMutt parses into + its internal representation according to the type of the variable, + for example an integer number for numeric types. For all queries + (including $-expansion) the value is converted from its internal type + back into string. As a result, any variable can be assigned any value + given that its content is valid for the target. This also counts for + custom variables which are of type string. In case of parsing errors, + NeoMutt will print error messages. + demonstrates type conversions. + Type conversions using variables @@ -5813,15 +6404,18 @@ set my_foo = $my_inc # value is string "10 - These assignments are all valid. If, however, the value of - $my_lines would have been - five(or something else that cannot be parsed into a - number), the assignment to - $pager_index_lines would have produced an error - message. - Type conversion applies to all configuration commands which take - arguments. But please note that every expanded value of a variable is - considered just a single token. A working example is: + + These assignments are all valid. If, however, the value of + $my_lines would have been five (or + something else that cannot be parsed into a number), the assignment + to $pager_index_lines would have produced an error + message. + + + Type conversion applies to all configuration commands which take + arguments. But please note that every expanded value of a variable is + considered just a single token. A working example is: + set my_pattern = "~A" @@ -5830,48 +6424,57 @@ set my_number = "10" score $my_pattern +$my_number - What does - not work is: + + What does not work is: + set my_mx = "+mailbox1 +mailbox2" mailboxes $my_mx +mailbox3 - because the value of - $my_mx is interpreted as a single mailbox named - +mailbox1 +mailbox2 and not two distinct - mailboxes. + + because the value of $my_mx is interpreted as + a single mailbox named +mailbox1 +mailbox2 and not two + distinct mailboxes. + Reading Initialization Commands From Another File - Usage: + + Usage: + source file - This command allows the inclusion of initialization commands from - other files. For example, I place all of my aliases in - ~/.mail_aliases so that I can make my - ~/.neomuttrc readable and keep my aliases private. - If the filename begins with a tilde ( - ~), it will be expanded to the path of your home - directory. - If the filename ends with a vertical bar ( - |), then - filename is considered to be an executable program - from which to read input (e.g. - - source~/bin/myscript|). + + This command allows the inclusion of initialization commands from other + files. For example, I place all of my aliases in + ~/.mail_aliases so that I can make my + ~/.neomuttrc readable and keep my aliases private. + + + If the filename begins with a tilde (~), it will be + expanded to the path of your home directory. + + + If the filename ends with a vertical bar (|), then + filename is considered to be an executable program + from which to read input (e.g. + source~/bin/myscript|). + Removing Hooks - Usage: + + Usage: + unhook @@ -5883,12 +6486,13 @@ mailboxes $my_mx +mailbox3 - This command permits you to flush hooks you have previously - defined. You can either remove all hooks by giving the - *character as an argument, or you can remove all hooks of - a specific type by saying something like - - unhook send-hook. + + This command permits you to flush hooks you have previously defined. + You can either remove all hooks by giving the * + character as an argument, or you can remove all hooks of a specific + type by saying something like + unhook send-hook. + @@ -5896,147 +6500,168 @@ mailboxes $my_mx +mailbox3 Basic usage - Format strings are a general concept you'll find in several - locations through the NeoMutt configuration, especially in the - $index_format, - $pager_format, - $status_format, and other related - variables. These can be very straightforward, and it's quite possible - you already know how to use them. - The most basic format string element is a percent symbol followed - by another character. For example, - %s represents a message's Subject: header in the - $index_format variable. The - expandos available are documented with each format - variable, but there are general modifiers available with all formatting - expandos, too. Those are our concern here. - Some of the modifiers are borrowed right out of C (though you - might know them from Perl, Python, shell, or another language). These - are the - [-]m.n modifiers, as in - %-12.12s. As with such programming languages, these - modifiers allow you to specify the minimum and maximum size of the - resulting string, as well as its justification. If the - -sign follows the percent, the string will be - left-justified instead of right-justified. If there's a number - immediately following that, it's the minimum amount of space the - formatted string will occupy — if it's naturally smaller than that, it - will be padded out with spaces. If a decimal point and another number - follow, that's the maximum space allowable — the string will not be - permitted to exceed that width, no matter its natural size. Each of - these three elements is optional, so that all these are legal format - strings: - %-12s, - %4c, - %.15F and - %-12.15L. - NeoMutt adds some other modifiers to format strings. If you use an - equals symbol ( - =) as a numeric prefix (like the minus above), it - will force the string to be centered within its minimum space range. - For example, - %=14y will reserve 14 characters for the %y expansion - — that's the set of message keywords (formerly X-Label). If the - expansion results in a string less than 14 characters, it will be - centered in a 14-character space. If the X-Label for a message were - test, that expansion would look like - -      test     . - There are two very little-known modifiers that affect the way - that an expando is replaced. If there is an underline ( - _) character between any format modifiers (as above) and - the expando letter, it will expands in all lower case. And if you use a - colon ( - :), it will replace all decimal points with - underlines. + + Format strings are a general concept you'll find in several locations + through the NeoMutt configuration, especially in the + $index_format, + $pager_format, + $status_format, and other + related variables. These can be very straightforward, and it's quite + possible you already know how to use them. + + + The most basic format string element is a percent symbol followed by + another character. For example, %s represents + a message's Subject: header in the + $index_format variable. The + expandos available are documented with each format + variable, but there are general modifiers available with all + formatting expandos, too. Those are our concern here. + + + Some of the modifiers are borrowed right out of C (though you might + know them from Perl, Python, shell, or another language). These are + the [-]m.n modifiers, as in + %-12.12s. As with such programming languages, + these modifiers allow you to specify the minimum and maximum size of + the resulting string, as well as its justification. If the + - sign follows the percent, the string will be + left-justified instead of right-justified. If there's a number + immediately following that, it's the minimum amount of space the + formatted string will occupy – if it's naturally smaller than that, + it will be padded out with spaces. If a decimal point and another + number follow, that's the maximum space allowable – the string will + not be permitted to exceed that width, no matter its natural size. + Each of these three elements is optional, so that all these are legal + format strings: %-12s, %4c, + %.15F and %-12.15L. + + + NeoMutt adds some other modifiers to format strings. If you use an + equals symbol (=) as a numeric prefix (like the + minus above), it will force the string to be centered within its + minimum space range. For example, %=14y will + reserve 14 characters for the %y expansion – that's the set of + message keywords (formerly X-Label). If the expansion results in + a string less than 14 characters, it will be centered in + a 14-character space. If the X-Label for a message were + test, that expansion would look like +      test     . + + + There are two very little-known modifiers that affect the way that an + expando is replaced. If there is an underline (_) + character between any format modifiers (as above) and the expando + letter, it will expands in all lower case. And if you use a colon + (:), it will replace all decimal points with + underlines. + Conditionals - Depending on the format string variable, some of its sequences - can be used to optionally print a string if their value is nonzero. For - example, you may only want to see the number of flagged messages if - such messages exist, since zero is not particularly meaningful. To - optionally print a string based upon one of the above sequences, the - following construct is used: + + Depending on the format string variable, some of its sequences can be + used to optionally print a string if their value is nonzero. For + example, you may only want to see the number of flagged messages if + such messages exist, since zero is not particularly meaningful. To + optionally print a string based upon one of the above sequences, the + following construct is used: + %?<sequence_char>?<optional_string>? - where - sequence_char is an expando, and - optional_string is the string you would like - printed if - sequence_char is nonzero. - optional_string may contain other sequences as well - as normal text, but you may not nest optional strings. - Here is an example illustrating how to optionally print the - number of new messages in a mailbox in - $status_format: + + where sequence_char is an expando, and + optional_string is the string you would like + printed if sequence_char is nonzero. + optional_string may contain other sequences as + well as normal text, but you may not nest optional strings. + + + Here is an example illustrating how to optionally print the number of + new messages in a mailbox in + $status_format: + %?n?%n new messages.? - You can also switch between two strings using the following - construct: + + You can also switch between two strings using the following + construct: + %?<sequence_char>?<if_string>&<else_string>? - If the value of - sequence_char is non-zero, - if_string will be expanded, otherwise - else_string will be expanded. - The conditional sequences can also be nested by using the %< - and > operators. The %? notation can still be used but requires - quoting. For example: + + If the value of sequence_char is non-zero, + if_string will be expanded, otherwise + else_string will be expanded. + + + The conditional sequences can also be nested by using the %< and + > operators. The %? notation can still be used but requires + quoting. For example: + %<x?true&false> %<x?%<y?%<z?xyz&xy>&x>&none> - For more examples, see - + + For more examples, see + Filters - Any format string ending in a vertical bar ( - |) will be expanded and piped through the first word in - the string, using spaces as separator. The string returned will be used - for display. If the returned string ends in %, it will be passed - through the formatter a second time. This allows the filter to generate - a replacement format string including % expandos. - All % expandos in a format string are expanded before the script - is called so that: + + Any format string ending in a vertical bar (|) will + be expanded and piped through the first word in the string, using + spaces as separator. The string returned will be used for display. If + the returned string ends in %, it will be passed through the + formatter a second time. This allows the filter to generate + a replacement format string including % expandos. + + + All % expandos in a format string are expanded before the script is + called so that: + Using external filters in format strings set status_format="script.sh '%r %f (%L)'|" - will make NeoMutt expand - %r, - %f and - %L before calling the script. The example also shows - that arguments can be quoted: the script will receive the expanded - string between the single quotes as the only argument. - A practical example is the - mutt_xtitle script installed in the - samples subdirectory of the NeoMutt documentation: it - can be used as filter for - $status_format to set the current - terminal's title, if supported. + + will make NeoMutt expand %r, %f + and %L before calling the script. The example also + shows that arguments can be quoted: the script will receive the + expanded string between the single quotes as the only argument. + + + A practical example is the mutt_xtitle script + installed in the samples subdirectory of the + NeoMutt documentation: it can be used as filter for + $status_format to set the + current terminal's title, if supported. + Padding - In most format strings, NeoMutt supports different types of padding - using special %-expandos: + + In most format strings, NeoMutt supports different types of padding + using special %-expandos: + %|X - When this occurs, NeoMutt will fill the rest of the line with - the character - X. For example, filling the rest of the line - with dashes is done by setting: + + When this occurs, NeoMutt will fill the rest of the line with + the character X. For example, filling the + rest of the line with dashes is done by setting: + set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-" @@ -6049,15 +6674,16 @@ set status_format = "%v on %h: %B: %?n?%n&no? new messages %|-" %>X - Since the previous expando stops at the end of line, there - must be a way to fill the gap between two items via the - %>X expando: it puts as many characters - X in between two items so that the rest of the - line will be right-justified. For example, to not put the version - string and hostname the above example on the left but on the - right and fill the gap with spaces, one might use (note the space - after - %>): + + Since the previous expando stops at the end of line, there must + be a way to fill the gap between two items via the + %>X expando: it puts as many characters + X in between two items so that the rest of + the line will be right-justified. For example, to not put the + version string and hostname the above example on the left but + on the right and fill the gap with spaces, one might use (note + the space after %>): + set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)" @@ -6070,18 +6696,19 @@ set status_format = "%B: %?n?%n&no? new messages %> (%v on %h)" %*X - Normal right-justification will print everything to the - left of the - %>, displaying padding and whatever lies to - the right only if there's room. By contrast, - soft-fill gives priority to the right-hand side, - guaranteeing space to display it and showing padding only if - there's still room. If necessary, soft-fill will eat text - leftwards to make room for rightward text. For example, to - right-justify the subject making sure as much as possible of it - fits on screen, one might use (note two spaces after - %*: the second ensures there's a space between - the truncated right-hand side and the subject): + + Normal right-justification will print everything to the left of + the %>, displaying padding and whatever + lies to the right only if there's room. By contrast, + soft-fill gives priority to the right-hand side, + guaranteeing space to display it and showing padding only if + there's still room. If necessary, soft-fill will eat text + leftwards to make room for rightward text. For example, to + right-justify the subject making sure as much as possible of it + fits on screen, one might use (note two spaces after + %*: the second ensures there's a space + between the truncated right-hand side and the subject): + set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" @@ -6094,14 +6721,17 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" Conditional Dates - This feature allows the format of dates in the index to vary based - on how recent the message is. This is especially useful in combination - with the nested-if feature. - For example, using - - %<[y?%<[d?%[%H:%M]&%[%m/%d]>&%[%y.%m]>for - the date in the - $index_format will produce a display like: + + This feature allows the format of dates in the index to vary based on + how recent the message is. This is especially useful in combination + with the nested-if feature. + + + For example, using + %<[y?%<[d?%[%H:%M]&%[%m/%d]>&%[%y.%m]> + for the date in the $index_format will produce + a display like: + 1 + 14.12 Grace Hall ( 13) Gulliver's Travels @@ -6114,7 +6744,9 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" Control allowed header fields in a mailto: URL - Usage: + + Usage: + mailto_allow @@ -6135,22 +6767,23 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" - As a security measure, NeoMutt will only add user-approved header - fields from a - mailto:URL. This is necessary since NeoMutt will handle - certain header fields, such as - Attach:, in a special way. The - mailto_allow and - unmailto_allow commands allow the user to modify the - list of approved headers. - NeoMutt initializes the default list to contain only the - Subject and - Body header fields, which are the only requirement - specified by the - mailto:specification in RFC2368, and - the Cc, In-Reply-To, - References headers to aid with replies to - mailing lists. + + As a security measure, NeoMutt will only add user-approved header + fields from a mailto: URL. This is necessary since + NeoMutt will handle certain header fields, such as + Attach:, in a special way. The + mailto_allow and unmailto_allow + commands allow the user to modify the list of approved headers. + + + NeoMutt initializes the default list to contain only the + Subject and Body header fields, + which are the only requirement specified by the + mailto: specification in RFC2368, and the + Cc, In-Reply-To, + References headers to aid with replies to mailing + lists. + @@ -6159,127 +6792,145 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" Character Set Handling - A - character set is basically a mapping between bytes and - glyphs and implies a certain character encoding scheme. For example, for - the ISO 8859 family of character sets, an encoding of 8bit per character - is used. For the Unicode character set, different character encodings may - be used, UTF-8 being the most popular. In UTF-8, a character is - represented using a variable number of bytes ranging from 1 to 4. - Since NeoMutt is a command-line tool run from a shell, and delegates - certain tasks to external tools (such as an editor for composing/editing - messages), all of these tools need to agree on a character set and - encoding. There exists no way to reliably deduce the character set a - plain text file has. Interoperability is gained by the use of - well-defined environment variables. The full set can be printed by - issuing - locale on the command line. - Upon startup, NeoMutt determines the character set on its own using - routines that inspect locale-specific environment variables. Therefore, - it is generally not necessary to set the - $charset variable in NeoMutt. It may even be - counter-productive as NeoMutt uses system and library functions that derive - the character set themselves and on which NeoMutt has no influence. It's - safest to let NeoMutt work out the locale setup itself. - If you happen to work with several character sets on a regular - basis, it's highly advisable to use Unicode and an UTF-8 locale. Unicode - can represent nearly all characters in a message at the same time. When - not using a Unicode locale, it may happen that you receive messages with - characters not representable in your locale. When displaying such a - message, or replying to or forwarding it, information may get lost - possibly rendering the message unusable (not only for you but also for - the recipient, this breakage is not reversible as lost information cannot - be guessed). - A Unicode locale makes all conversions superfluous which eliminates - the risk of conversion errors. It also eliminates potentially wrong - expectations about the character set between NeoMutt and external - programs. - The terminal emulator used also must be properly configured for the - current locale. Terminal emulators usually do - not derive the locale from environment variables, - they need to be configured separately. If the terminal is incorrectly - configured, NeoMutt may display random and unexpected characters (question - marks, octal codes, or just random glyphs), format strings may not work - as expected, you may not be abled to enter non-ascii characters, and - possible more. Data is always represented using bytes and so a correct - setup is very important as to the machine, all character sets - look the same. - Warning: A mismatch between what system and library functions think - the locale is and what NeoMutt was told what the locale is may make it - behave badly with non-ascii input: it will fail at seemingly random - places. This warning is to be taken seriously since not only local mail - handling may suffer: sent messages may carry wrong character set - information the - receiver has too deal with. The need to set - $charset directly in most cases points at terminal and - environment variable setup problems, not NeoMutt problems. - A list of officially assigned and known character sets can be found - at - IANA, - a list of locally supported locales can be obtained by running - locale -a. + + A character set is basically a mapping between bytes and + glyphs and implies a certain character encoding scheme. For example, + for the ISO 8859 family of character sets, an encoding of 8bit per + character is used. For the Unicode character set, different character + encodings may be used, UTF-8 being the most popular. In UTF-8, + a character is represented using a variable number of bytes ranging + from 1 to 4. + + + Since NeoMutt is a command-line tool run from a shell, and delegates + certain tasks to external tools (such as an editor for + composing/editing messages), all of these tools need to agree on + a character set and encoding. There exists no way to reliably deduce + the character set a plain text file has. Interoperability is gained by + the use of well-defined environment variables. The full set can be + printed by issuing locale on the command line. + + + Upon startup, NeoMutt determines the character set on its own using + routines that inspect locale-specific environment variables. Therefore, + it is generally not necessary to set the $charset + variable in NeoMutt. It may even be counter-productive as NeoMutt uses + system and library functions that derive the character set themselves + and on which NeoMutt has no influence. It's safest to let NeoMutt work + out the locale setup itself. + + + If you happen to work with several character sets on a regular basis, + it's highly advisable to use Unicode and an UTF-8 locale. Unicode can + represent nearly all characters in a message at the same time. When not + using a Unicode locale, it may happen that you receive messages with + characters not representable in your locale. When displaying such + a message, or replying to or forwarding it, information may get lost + possibly rendering the message unusable (not only for you but also for + the recipient, this breakage is not reversible as lost information + cannot be guessed). + + + A Unicode locale makes all conversions superfluous which eliminates the + risk of conversion errors. It also eliminates potentially wrong + expectations about the character set between NeoMutt and external + programs. + + + The terminal emulator used also must be properly configured for the + current locale. Terminal emulators usually do not + derive the locale from environment variables, they need to be + configured separately. If the terminal is incorrectly configured, + NeoMutt may display random and unexpected characters (question marks, + octal codes, or just random glyphs), format strings may not work as + expected, you may not be abled to enter non-ascii characters, and + possible more. Data is always represented using bytes and so a correct + setup is very important as to the machine, all character sets + look the same. + + + Warning: A mismatch between what system and library functions think the + locale is and what NeoMutt was told what the locale is may make it + behave badly with non-ascii input: it will fail at seemingly random + places. This warning is to be taken seriously since not only local mail + handling may suffer: sent messages may carry wrong character set + information the receiver has too deal with. The + need to set $charset directly in most cases points + at terminal and environment variable setup problems, not NeoMutt + problems. + + + A list of officially assigned and known character sets can be found at + IANA, + a list of locally supported locales can be obtained by running + locale -a. + Regular Expressions - All string patterns in NeoMutt including those in more complex - patterns must be specified using regular - expressions (regex) in the - POSIX extended syntax (which is more or less the syntax - used by egrep and GNU awk). For your convenience, we have included below - a brief description of this syntax. - The search is case sensitive if the pattern contains at least one - upper case letter, and case insensitive otherwise. + + All string patterns in NeoMutt including those in more complex + patterns must be specified using + regular expressions (regex) in the POSIX extended syntax + (which is more or less the syntax used by egrep and GNU awk). For your + convenience, we have included below a brief description of this syntax. + + + The search is case sensitive if the pattern contains at least one upper + case letter, and case insensitive otherwise. + - \must be quoted if used for a regular expression in an - initialization command: - \\. + \ must be quoted if used for a regular expression in + an initialization command: \\. + - A regular expression is a pattern that describes a set of strings. - Regular expressions are constructed analogously to arithmetic - expressions, by using various operators to combine smaller - expressions. + + A regular expression is a pattern that describes a set of strings. + Regular expressions are constructed analogously to arithmetic + expressions, by using various operators to combine smaller expressions. + - The regular expression can be enclosed/delimited by either " or ' - which is useful if the regular expression includes a white-space - character. See - for more information on " and ' - delimiter processing. To match a literal " or ' you must preface it - with \ (backslash). + + The regular expression can be enclosed/delimited by either " or + ' which is useful if the regular expression includes a white-space + character. See for more + information on " and ' delimiter processing. To match a literal " or + ' you must preface it with \ (backslash). + - The fundamental building blocks are the regular expressions that - match a single character. Most characters, including all letters and - digits, are regular expressions that match themselves. Any metacharacter - with special meaning may be quoted by preceding it with a - backslash. - The period - .matches any single character. The caret - ^and the dollar sign - $are metacharacters that respectively match the empty - string at the beginning and end of a line. - A list of characters enclosed by - [and - ]matches any single character in that list; if the first - character of the list is a caret - ^then it matches any character - not in the list. For example, the regular expression - [0123456789]matches any single digit. A range of - ASCII characters may be specified by giving the first and last - characters, separated by a hyphen - -. Most metacharacters lose their special meaning inside - lists. To include a literal - ]place it first in the list. Similarly, to include a - literal - ^place it anywhere but first. Finally, to include a - literal hyphen - -place it last. - Certain named classes of characters are predefined. Character - classes consist of - [:, a keyword denoting the class, and - :]. The following classes are defined by the POSIX - standard in - + + The fundamental building blocks are the regular expressions that match + a single character. Most characters, including all letters and digits, + are regular expressions that match themselves. Any metacharacter with + special meaning may be quoted by preceding it with a backslash. + + + The period . matches any single character. The caret + ^ and the dollar sign $ are + metacharacters that respectively match the empty string at the + beginning and end of a line. + + + A list of characters enclosed by [ and ] + matches any single character in that list; if the first character of + the list is a caret ^ then it matches any character + not in the list. For example, the regular + expression [0123456789] matches any single digit. + A range of ASCII characters may be specified by giving the first and + last characters, separated by a hyphen -. Most + metacharacters lose their special meaning inside lists. To include + a literal ] place it first in the list. Similarly, to + include a literal ^ place it anywhere but first. + Finally, to include a literal hyphen - place it last. + + + Certain named classes of characters are predefined. Character classes + consist of [:, a keyword denoting the class, and + :]. The following classes are defined by the POSIX + standard in + POSIX regular expression character classes @@ -6347,61 +6998,62 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"
- A character class is only valid in a regular expression inside the - brackets of a character list. + + A character class is only valid in a regular expression inside the + brackets of a character list. + - Note that the brackets in these class names are part of the - symbolic names, and must be included in addition to the brackets - delimiting the bracket list. For example, - [[:digit:]]is equivalent to - [0-9]. + + Note that the brackets in these class names are part of the symbolic + names, and must be included in addition to the brackets delimiting + the bracket list. For example, [[:digit:]] is + equivalent to [0-9]. + - Two additional special sequences can appear in character lists. - These apply to non-ASCII character sets, which can have single symbols - (called collating elements) that are represented with more than one - character, as well as several characters that are equivalent for - collating or sorting purposes: + + Two additional special sequences can appear in character lists. These + apply to non-ASCII character sets, which can have single symbols + (called collating elements) that are represented with more than one + character, as well as several characters that are equivalent for + collating or sorting purposes: + Collating Symbols - A collating symbol is a multi-character collating element - enclosed in - [.and - .]. For example, if - ch is a collating element, then - [[.ch.]]is a regex that matches this - collating element, while - [ch]is a regex that matches either - c or - h. + + A collating symbol is a multi-character collating element + enclosed in [. and .]. For example, + if ch is a collating element, then + [[.ch.]] is a regex that matches this + collating element, while [ch] is a regex + that matches either c or h. + Equivalence Classes - An equivalence class is a locale-specific name for a list of - characters that are equivalent. The name is enclosed in - [=and - =]. For example, the name - e might be used to represent all of - e with grave ( - è), - e with acute ( - é) and - e. In this case, - [[=e=]]is a regex that matches any of: - e with grave ( - è), - e with acute ( - é) and - e. + + An equivalence class is a locale-specific name for a list of + characters that are equivalent. The name is enclosed in + [= and =]. For example, the name + e might be used to represent all of + e with grave (è), e + with acute (é) and e. In this + case, [[=e=]] is a regex that matches any + of: e with grave (è), + e with acute (é) and + e. + - A regular expression matching a single character may be followed by - one of several repetition operators described in - . + + A regular expression matching a single character may be followed by one + of several repetition operators described in + . + Regular expression repetition operators @@ -6452,20 +7104,27 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"
- Two regular expressions may be concatenated; the resulting regular - expression matches any string formed by concatenating two substrings that - respectively match the concatenated subexpressions. - Two regular expressions may be joined by the infix operator - |; the resulting regular expression matches any string - matching either subexpression. - Repetition takes precedence over concatenation, which in turn takes - precedence over alternation. A whole subexpression may be enclosed in - parentheses to override these precedence rules. + + Two regular expressions may be concatenated; the resulting regular + expression matches any string formed by concatenating two substrings + that respectively match the concatenated subexpressions. + + + Two regular expressions may be joined by the infix operator + |; the resulting regular expression matches any string + matching either subexpression. + + + Repetition takes precedence over concatenation, which in turn takes + precedence over alternation. A whole subexpression may be enclosed in + parentheses to override these precedence rules. + - If you compile NeoMutt with the included regular expression engine, - the following operators may also be used in regular expressions as - described in - . + + If you compile NeoMutt with the included regular expression engine, + the following operators may also be used in regular expressions as + described in . + @@ -6517,9 +7176,10 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"
- Please note however that these operators are not defined by POSIX, - so they may or may not be available in stock libraries on various - systems. + + Please note however that these operators are not defined by POSIX, so + they may or may not be available in stock libraries on various systems. + @@ -6527,12 +7187,13 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" Pattern Modifier - Many of NeoMutt's commands allow you to specify a pattern to match ( - limit, - tag-pattern, - delete-pattern, etc.). - shows several ways to select - messages. + + Many of NeoMutt's commands allow you to specify a pattern to match + (limit, tag-pattern, + delete-pattern, etc.). + shows several ways to select + messages. + Pattern modifiers @@ -6896,69 +7557,72 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"
- Where - EXPR is a - regular expression, and - GROUP is an - address group. - *) The forms - <[ - MAX], - >[ - MIN], - [ - MIN]-and - -[ - MAX]are allowed, too. - **) The suffixes - K and - M are allowed to specify kilobyte and megabyte - respectively. - ***) The message number ranges (introduced by - ~m) are even more general and powerful than the - other types of ranges. Read on and see - below. - Special attention has to be paid when using regular expressions - inside of patterns. Specifically, NeoMutt's parser for these patterns will - strip one level of backslash ( - \), which is normally used for quoting. If it is your - intention to use a backslash in the regular expression, you will need - to use two backslashes instead ( - \\). You can force NeoMutt to treat - EXPR as a simple substring instead of a regular - expression by using = instead of ~ in the pattern name. For example, - =b *.*will find all messages that contain the - literal string - *.*. Simple string matches are less powerful than - regular expressions but can be considerably faster. This is especially - true for IMAP folders, because string matches can be performed on the - server instead of by fetching every message. IMAP treats - =h specially: it must be of the form - header: substring and will not partially match header - names. The substring part may be omitted if you simply wish to find - messages containing a particular header without regard to its - value. - Patterns matching lists of addresses (notably c, C, p, P and t) - match if there is at least one match in the whole list. If you want to - make sure that all elements of that list match, you need to prefix your - pattern with - ^. This example matches all mails which only has - recipients from Germany. + + Where EXPR is a + regular expression, and + GROUP is an + address group. + + + *) The forms <[MAX], + >[MIN], + [MIN]- and + -[MAX] are allowed, too. + + + **) The suffixes K and M are allowed to + specify kilobyte and megabyte respectively. + + + ***) The message number ranges (introduced by ~m) + are even more general and powerful than the other types of ranges. + Read on and see below. + + + Special attention has to be paid when using regular expressions + inside of patterns. Specifically, NeoMutt's parser for these patterns + will strip one level of backslash (\), which is + normally used for quoting. If it is your intention to use a backslash + in the regular expression, you will need to use two backslashes + instead (\\). You can force NeoMutt to treat + EXPR as a simple substring instead of a regular + expression by using = instead of ~ in the pattern name. For example, + =b *.* will find all messages that contain the + literal string *.*. Simple string matches are less + powerful than regular expressions but can be considerably faster. + This is especially true for IMAP folders, because string matches can + be performed on the server instead of by fetching every message. IMAP + treats =h specially: it must be of the form + header: substring and will not partially match header + names. The substring part may be omitted if you simply wish to find + messages containing a particular header without regard to its value. + + + Patterns matching lists of addresses (notably c, C, p, P and t) match + if there is at least one match in the whole list. If you want to make + sure that all elements of that list match, you need to prefix your + pattern with ^. This example matches all mails which + only has recipients from Germany. + Matching all addresses in address lists ^~C \.de$ - You can restrict address pattern matching to aliases that you - have defined with the "@" modifier. This example matches messages whose - recipients are all from Germany, and who are known to your alias - list. + + You can restrict address pattern matching to aliases that you have + defined with the "@" modifier. This example matches messages whose + recipients are all from Germany, and who are known to your alias + list. + Matching restricted to aliases ^@~C \.de$ - To match any defined alias, use a regular expression that matches - any string. This example matches messages whose senders are known - aliases. + + To match any defined alias, use a regular expression that matches any + string. This example matches messages whose senders are known + aliases. + Matching any defined alias @~f . @@ -6966,11 +7630,12 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" Message Ranges - If a message number range (from now on: MNR) contains a comma ( - ,), it is a - relative MNR. That means the numbers denote - offsets from the highlighted message. For - example: + + If a message number range (from now on: MNR) contains a comma + (,), it is a relative MNR. + That means the numbers denote offsets from the + highlighted message. For example: + Relative Message Number Ranges @@ -6997,9 +7662,11 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"
- In addition to numbers, either side of the range can also - contain one of the special characters (shortcuts) - .^$. The meaning is: + + In addition to numbers, either side of the range can also contain + one of the special characters (shortcuts) .^$. + The meaning is: + Message Number Shortcuts @@ -7046,14 +7713,17 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"
- Lastly, you can also leave either side of the range blank, to - make it extend as far as possible. For example, - ~m ,1 has the same meaning as the last example in - . - Otherwise, if a MNR - doesn't contain a comma, the meaning is similar - to other ranges, except that the shortcuts are still available. - Examples: + + Lastly, you can also leave either side of the range blank, to make + it extend as far as possible. For example, ~m ,1 + has the same meaning as the last example in + . + + + Otherwise, if a MNR doesn't contain a comma, + the meaning is similar to other ranges, except that the shortcuts + are still available. Examples: + Absolute Message Number Ranges @@ -7121,29 +7791,29 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" Simple Searches - NeoMutt supports two versions of so called - simple searches. These are issued if the query entered - for searching, limiting and similar operations does not seem to contain - a valid pattern modifier (i.e. it does not contain one of these - characters: - ~, - =or - %). If the query is supposed to contain one of these - special characters, they must be escaped by prepending a backslash ( - \). - The first type is by checking whether the query string equals a - keyword case-insensitively from - : If that is the case, NeoMutt - will use the shown pattern modifier instead. If a keyword would - conflict with your search keyword, you need to turn it into a regular - expression to avoid matching the keyword table. For example, if you - want to find all messages matching - flag(using - $simple_search) but don't want to - match flagged messages, simply search for - - [f]lag - . + + NeoMutt supports two versions of so called + simple searches. These are issued if the query entered + for searching, limiting and similar operations does not seem to + contain a valid pattern modifier (i.e. it does not contain one of + these characters: ~, = or + %). If the query is supposed to contain one of these + special characters, they must be escaped by prepending a backslash + (\). + + + The first type is by checking whether the query string equals + a keyword case-insensitively from + : If that is the case, + NeoMutt will use the shown pattern modifier instead. If a keyword + would conflict with your search keyword, you need to turn it into + a regular expression to avoid matching the keyword table. For + example, if you want to find all messages matching + flag (using + $simple_search) but don't want + to match flagged messages, simply search for + [f]lag. +
Simple search keywords @@ -7202,102 +7872,114 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"
- The second type of simple search is to build a complex search - pattern using - $simple_search as a template. NeoMutt - will insert your query properly quoted and search for the composed - complex query. + + The second type of simple search is to build a complex search pattern + using $simple_search as + a template. NeoMutt will insert your query properly quoted and search + for the composed complex query. + Nesting and Boolean Operators - Logical AND is performed by specifying more than one criterion. - For example: + + Logical AND is performed by specifying more than one criterion. For + example: + ~t work ~f elkins - would select messages which contain the word - work in the list of recipients - and that have the word - elkins in the - From header field. - NeoMutt also recognizes the following operators to create more - complex search patterns: + + would select messages which contain the word work in + the list of recipients and that have the word + elkins in the From header field. + + + NeoMutt also recognizes the following operators to create more + complex search patterns: + - ! — logical NOT operator + + ! – logical NOT operator + - | — logical OR operator + + | – logical OR operator + - () — logical grouping operator + + () – logical grouping operator + - Here is an example illustrating a complex search pattern. This - pattern will select all messages which do not contain - work in the - To or - Cc field and which are from - elkins. + + Here is an example illustrating a complex search pattern. This + pattern will select all messages which do not contain + work in the To or Cc + field and which are from elkins. + Using boolean operators in patterns !(~t work|~c work) ~f elkins - Here is an example using white space in the regular expression - (note the - 'and - "delimiters). For this to match, the mail's subject must - match the - ^Junk +From +Me$and it must be from either - Jim +Somebody or - Ed +SomeoneElse: + + Here is an example using white space in the regular expression (note + the ' and " delimiters). For this to + match, the mail's subject must match the + ^Junk +From +Me$ and it must be from either + Jim +Somebody or Ed +SomeoneElse: + '~s "^Junk +From +Me$" ~f ("Jim +Somebody"|"Ed +SomeoneElse")' - If a regular expression contains parenthesis, or a vertical bar - ("|"), you - must enclose the expression in double or single - quotes since those characters are also used to separate different - parts of NeoMutt's pattern language. For example: - ~f "user@(home\.org|work\.com)"Without the - quotes, the parenthesis wouldn't end. This would be separated to two - OR'd patterns: - ~f user@(home\.org and - work\.com). They are never what you - want. + + If a regular expression contains parenthesis, or a vertical bar + ("|"), you must enclose the expression in + double or single quotes since those characters are also used to + separate different parts of NeoMutt's pattern language. For + example: ~f "user@(home\.org|work\.com)" Without + the quotes, the parenthesis wouldn't end. This would be separated + to two OR'd patterns: ~f user@(home\.org and + work\.com). They are never what you want. + Searching by Date - NeoMutt supports two types of dates, - absolute and - relative. + + NeoMutt supports two types of dates, absolute + and relative. + Absolute Dates - Dates - must be in DD/MM/YY format (month and year are - optional, defaulting to the current month and year). An example of a - valid range of dates is: + + Dates must be in DD/MM/YY format (month and + year are optional, defaulting to the current month and year). An + example of a valid range of dates is: + Limit to messages matching: ~d 20/1/95-31/10 - If you omit the minimum (first) date, and just specify - -DD/MM/YY, all messages - before the given date will be selected. If you - omit the maximum (second) date, and specify - DD/MM/YY-, all messages - after the given date will be selected. If you - specify a single date with no dash ( - -), only messages sent on the given date will be - selected. - You can add error margins to absolute dates. An error margin is - a sign (+ or -), followed by a digit, followed by one of the units in - . As a special case, you can replace - the sign by a - *character, which is equivalent to giving identical - plus and minus error margins. + + If you omit the minimum (first) date, and just specify + -DD/MM/YY, all messages before + the given date will be selected. If you omit the maximum (second) + date, and specify DD/MM/YY-, all messages + after the given date will be selected. If you + specify a single date with no dash (-), only + messages sent on the given date will be selected. + + + You can add error margins to absolute dates. An error margin is + a sign (+ or -), followed by a digit, followed by one of the units + in . As a special case, you can + replace the sign by a * character, which is + equivalent to giving identical plus and minus error margins. + Date units @@ -7328,49 +8010,59 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s"
- Example: To select any messages two weeks around January 15, - 2001, you'd use the following pattern: + + Example: To select any messages two weeks around January 15, 2001, + you'd use the following pattern: + Limit to messages matching: ~d 15/1/2001*2w Relative Dates - This type of date is relative to the current date, and may be - specified as: + + This type of date is relative to the current date, and may be + specified as: + - > - offset for messages older than - offset units + + > offset for messages older than + offset units + - < - offset for messages newer than - offset units + + < offset for messages newer than + offset units + - = - offset for messages exactly - offset units old + + = offset for messages exactly + offset units old + - offset is specified as a positive number with one - of the units from - . - Example: to select messages less than 1 month old, you would - use + offset is specified as a positive number with + one of the units from . + + + Example: to select messages less than 1 month old, you would use + Limit to messages matching: ~d <1m - All dates used when searching are relative to the - local time zone, so unless you change the - setting of your - $index_format to include a - %[...]format, these are - not the dates shown in the main index. + + All dates used when searching are relative to the + local time zone, so unless you change the + setting of your $index_format + to include a %[...] format, these are + not the dates shown in the main index. + + GMail Patterns @@ -7388,6 +8080,7 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" and enable "Show in IMAP" for "All Mail". When searching, visit that folder in NeoMutt to most closely match Gmail search semantics. + GMail Example Patterns @@ -7421,196 +8114,168 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%* %s" Marking Messages - There are times that it's useful to ask NeoMutt to "remember" which - message you're currently looking at, while you move elsewhere in your - mailbox. You can do this with the - mark-message operator, which is bound to the - ~key by default. Press this key to enter an identifier for - the marked message. When you want to return to this message, press - 'and the name that you previously entered. - (Message marking is really just a shortcut for defining a macro - that returns you to the current message by searching for its Message-ID. - You can choose a different prefix by setting the - - $mark_macro_prefix variable.) + + There are times that it's useful to ask NeoMutt to "remember" which + message you're currently looking at, while you move elsewhere in your + mailbox. You can do this with the mark-message operator, + which is bound to the ~ key by default. Press this key + to enter an identifier for the marked message. When you want to return + to this message, press ' and the name that you + previously entered. + + + (Message marking is really just a shortcut for defining a macro that + returns you to the current message by searching for its Message-ID. + You can choose a different prefix by setting the + $mark_macro_prefix variable.) + Using Tags - Sometimes it is desirable to perform an operation on a group of - messages all at once rather than one at a time. An example might be to - save messages to a mailing list to a separate folder, or to delete all - messages with a given subject. To tag all messages matching a pattern, - use the - <tag-pattern>function, which is bound to - shift-T by default. Or you can select individual messages - by hand using the - <tag-message>function, which is bound to - t by default. See - patterns for NeoMutt's pattern matching - syntax. - Once you have tagged the desired messages, you can use the - tag-prefix operator, which is the - ;(semicolon) key by default. When the - tag-prefix operator is used, the - next operation will be applied to all tagged messages - if that operation can be used in that manner. If the - $auto_tag variable is set, the next - operation applies to the tagged messages automatically, without requiring - the - tag-prefix. - In - - macrosor - - push - commands, you can use the - <tag-prefix-cond>operator. If there are no - tagged messages, NeoMutt will - eat the rest of the macro to abort it's execution. NeoMutt - 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. + + Sometimes it is desirable to perform an operation on a group of + messages all at once rather than one at a time. An example might be to + save messages to a mailing list to a separate folder, or to delete all + messages with a given subject. To tag all messages matching a pattern, + use the <tag-pattern> function, which is bound + to shift-T by default. Or you can select individual + messages by hand using the <tag-message> + function, which is bound to t by default. See + patterns for NeoMutt's pattern matching + syntax. + + + Once you have tagged the desired messages, you can use the + tag-prefix operator, which is the ; + (semicolon) key by default. When the tag-prefix operator + is used, the next operation will be applied to all + tagged messages if that operation can be used in that manner. If the + $auto_tag variable is set, the next + operation applies to the tagged messages automatically, without + requiring the tag-prefix. + + + In macros or + push commands, you can + use the <tag-prefix-cond> operator. If there + are no tagged messages, NeoMutt will eat the rest of the + macro to abort it's execution. NeoMutt 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 - hook is a concept found in many other programs which - allows you to execute arbitrary commands before performing some - operation. For example, you may wish to tailor your configuration based - upon which mailbox you are reading, or to whom you are sending mail. In - the NeoMutt world, a - hook consists of a - regular expression or - pattern along with a configuration - option/command. See: + + A hook is a concept found in many other programs + which allows you to execute arbitrary commands before performing some + operation. For example, you may wish to tailor your configuration based + upon which mailbox you are reading, or to whom you are sending mail. In + the NeoMutt world, a hook consists of a + regular expression or + pattern along with a configuration + option/command. See: + - - account-hook - + account-hook - - append-hook - + append-hook - - charset-hook - + charset-hook - - close-hook - + close-hook - - crypt-hook - + crypt-hook - - fcc-hook - + fcc-hook - - fcc-save-hook - + fcc-save-hook - - folder-hook - + folder-hook - - iconv-hook - + iconv-hook - - mbox-hook - + mbox-hook - - message-hook - + message-hook - - open-hook - + open-hook - - reply-hook - + reply-hook - - save-hook - + save-hook - - send-hook - + send-hook - - send2-hook - + send2-hook - for specific details on each type of - hook available. + + + for specific details on each type of hook + available. + - If a hook changes configuration settings, these changes remain - effective until the end of the current NeoMutt session. As this is - generally not desired, a - default hook needs to be added before all other hooks of - that type to restore configuration defaults. + + If a hook changes configuration settings, these changes remain + effective until the end of the current NeoMutt session. As this is + generally not desired, a default hook needs to be + added before all other hooks of that type to restore configuration + defaults. + - Specifying a - <quote>default</quote> hook + Specifying a <quote>default</quote> hook send-hook . 'unmy_hdr From:' @@ -7618,66 +8283,72 @@ send-hook ~C'^b@b\.b$' my_hdr from: c@c.c - In - , by default the value of - $from and - $realname is not overridden. When sending - messages either To: or Cc: to - <b@b.b>, the From: header is changed to - <c@c.c>. + + In , by default the value of + $from and + $realname is not overridden. When + sending messages either To: or Cc: to <b@b.b>, + the From: header is changed to <c@c.c>. + Message Matching in Hooks - Hooks that act upon messages ( - message-hook, - reply-hook, - send-hook, - send2-hook, - save-hook, - fcc-hook) are evaluated in a slightly different - manner. For the other types of hooks, a - regular expression is sufficient. But in - dealing with messages a finer grain of control is needed for matching - since for different purposes you want to match different - criteria. - NeoMutt allows the use of the - search pattern language for matching - messages in hook commands. This works in exactly the same way as it - would when - limiting or - searching the mailbox, except that you are - restricted to those operators which match information NeoMutt extracts - from the header of the message (i.e., from, to, cc, date, subject, - etc.). - For example, if you wanted to set your return address based upon - sending mail to a specific address, you could do something like: + + Hooks that act upon messages (message-hook, + reply-hook, send-hook, + send2-hook, save-hook, + fcc-hook) are evaluated in a slightly different + manner. For the other types of hooks, a + regular expression is sufficient. But in + dealing with messages a finer grain of control is needed for matching + since for different purposes you want to match different criteria. + + + NeoMutt allows the use of the + search pattern language for matching + messages in hook commands. This works in exactly the same way as it + would when limiting or + searching the mailbox, except that you are + restricted to those operators which match information NeoMutt + extracts from the header of the message (i.e., from, to, cc, date, + subject, etc.). + + + For example, if you wanted to set your return address based upon + sending mail to a specific address, you could do something like: + send-hook '~t ^user@work\.com$' 'my_hdr From: John Smith <user@host>' - which would execute the given command when sending mail to - user@work.com. - However, it is not required that you write the pattern to match - using the full searching language. You can still specify a simple - regular expression like the other hooks, in which - case NeoMutt will translate your pattern into the full language, using the - translation specified by the - $default_hook variable. The pattern - is translated at the time the hook is declared, so the value of - $default_hook that is in effect at - that time will be used. + + which would execute the given command when sending mail to + user@work.com. + + + However, it is not required that you write the pattern to match using + the full searching language. You can still specify a simple + regular expression like the other hooks, in + which case NeoMutt will translate your pattern into the full + language, using the translation specified by the + $default_hook variable. The + pattern is translated at the time the hook is declared, so the value + of $default_hook that is in + effect at that time will be used. + Mailbox Matching in Hooks - Hooks that match against mailboxes ( - folder-hook, - mbox-hook) apply both - regular expression syntax as well as - mailbox shortcut expansion on the - regex parameter. There is some overlap between these, so special - attention should be paid to the first character of the regex. + + Hooks that match against mailboxes (folder-hook, + mbox-hook) apply both + regular expression syntax as well as + mailbox shortcut expansion on the + regex parameter. There is some overlap between these, so special + attention should be paid to the first character of the regex. + # Here, ^ will expand to "the current mailbox" not "beginning of string": @@ -7693,25 +8364,27 @@ folder-hook (@imap.example.com) "set sort=threads" folder-hook '\@imap.example.com' "set sort=threads" - Keep in mind that mailbox shortcut expansion on the regex - parameter takes place when the hook is initially parsed, not when the - hook is matching against a mailbox. When NeoMutt starts up and is reading - the .neomuttrc, some mailbox shortcuts may not be usable. For example, the - "current mailbox" shortcut, ^, will expand to an empty string because - no mailbox has been opened yet. NeoMutt will issue an error for this case - or if the mailbox shortcut results in an empty regex. + + Keep in mind that mailbox shortcut expansion on the regex parameter + takes place when the hook is initially parsed, not when the hook is + matching against a mailbox. When NeoMutt starts up and is reading the + .neomuttrc, some mailbox shortcuts may not be usable. For example, + the "current mailbox" shortcut, ^, will expand to an empty string + because no mailbox has been opened yet. NeoMutt will issue an error + for this case or if the mailbox shortcut results in an empty regex. + Managing the Environment - You can alter the environment that NeoMutt passes on to its child - processes using the - setenv and - unsetenv operators. (N.B. These follow NeoMutt-style syntax, - not shell-style!) You can also query current environment values by - prefixing a - ?character. + + You can alter the environment that NeoMutt passes on to its child + processes using the setenv and unsetenv + operators. (N.B. These follow NeoMutt-style syntax, not shell-style!) + You can also query current environment values by prefixing + a ? character. + setenv TERM vt100 @@ -7724,19 +8397,25 @@ setenv ?LESS External Address Queries - NeoMutt supports connecting to external directory databases such as - LDAP, ph/qi, bbdb, or NIS through a wrapper script which connects to NeoMutt - using a simple interface. Using the - $query_command variable, you specify - the wrapper command to use. For example: + + NeoMutt supports connecting to external directory databases such as + LDAP, ph/qi, bbdb, or NIS through a wrapper script which connects to + NeoMutt using a simple interface. Using the + $query_command variable, you + specify the wrapper command to use. For example: + set query_command = "mutt_ldap_query.pl %s" - The wrapper script should accept the query on the command-line. It - should return a one line message, then each matching response on a single - line, each line containing a tab separated address then name then some - other optional information. On error, or if there are no matching - addresses, return a non-zero exit code and a one line error - message. - An example multiple response output: + + The wrapper script should accept the query on the command-line. It + should return a one line message, then each matching response on + a single line, each line containing a tab separated address then name + then some other optional information. On error, or if there are no + matching addresses, return a non-zero exit code and a one line error + message. + + + An example multiple response output: + Searching database ... 20 entries ... 3 matching: @@ -7745,93 +8424,101 @@ blong@fiction.net Brandon Long mutt and more roessler@does-not-exist.org Thomas Roessler mutt pgp - There are two mechanisms for accessing the query function of NeoMutt. - 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 addresses to mail, start a new - query, or have a new query appended to the current responses. - The other mechanism for accessing the query function is for address - completion, similar to the alias completion. In any prompt for address - entry, you can use the - <complete-query>function (default: ^T) to run a - query based on the current address you have typed. Like aliases, NeoMutt - will look for what you have typed back to the last space or comma. If - there is a single response for that query, NeoMutt will expand the address - in place. If there are multiple responses, NeoMutt will activate the query - menu. At the query menu, you can select one or more addresses to be added - to the prompt. + + There are two mechanisms for accessing the query function of NeoMutt. + 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 addresses to mail, + start a new query, or have a new query appended to the current + responses. + + + The other mechanism for accessing the query function is for address + completion, similar to the alias completion. In any prompt for address + entry, you can use the <complete-query> + function (default: ^T) to run a query based on the current address you + have typed. Like aliases, NeoMutt will look for what you have typed + back to the last space or comma. If there is a single response for that + query, NeoMutt will expand the address in place. If there are multiple + responses, NeoMutt will activate the query menu. At the query menu, you + can select one or more addresses to be added to the prompt. + Mailbox Formats - NeoMutt supports reading and writing of four different local mailbox - formats: mbox, MMDF, MH and Maildir. The mailbox type is auto detected, - so there is no need to use a flag for different mailbox types. When - creating new mailboxes, NeoMutt uses the default specified with the - $mbox_type variable. A short description - of the formats follows. - - mbox. This is a widely used mailbox format for UNIX. - All messages are stored in a single file. Each message has a line of the - form: + + NeoMutt supports reading and writing of four different local mailbox + formats: mbox, MMDF, MH and Maildir. The mailbox type is auto detected, + so there is no need to use a flag for different mailbox types. When + creating new mailboxes, NeoMutt uses the default specified with the + $mbox_type variable. A short + description of the formats follows. + + + mbox. This is a widely used mailbox format for + UNIX. All messages are stored in a single file. Each message has + a line of the form: + From me@cs.hmc.edu Fri, 11 Apr 1997 11:44:56 PST - to denote the start of a new message (this is often referred to as - the - From_ line). The mbox format requires mailbox locking, is - prone to mailbox corruption with concurrently writing clients or - misinterpreted From_ lines. Depending on the environment, new mail - detection can be unreliable. Mbox folders are fast to open and easy to - archive. - - MMDF. This is a variant of the - mbox format. Each message is surrounded by lines - containing - ^A^A^A^A(four times control-A's). The same problems as for - mbox apply (also with finding the right message separator as four - control-A's may appear in message bodies). - - MH. A radical departure from - mbox and - MMDF, a mailbox consists of a directory and each - message is stored in a separate file. The filename indicates the message - number (however, this is may not correspond to the message number NeoMutt - displays). Deleted messages are renamed with a comma ( - ,) prepended to the filename. NeoMutt detects this type of - mailbox by looking for either - .mh_sequences or - .xmhcache files (needed to distinguish normal - directories from MH mailboxes). MH is more robust with concurrent clients - writing the mailbox, but still may suffer from lost flags; message - corruption is less likely to occur than with mbox/mmdf. It's usually - slower to open compared to mbox/mmdf since many small files have to be - read (NeoMutt provides - to greatly speed this process up). - Depending on the environment, MH is not very disk-space efficient. - - Maildir. The newest of the mailbox formats, used by - the Qmail MTA (a replacement for sendmail). Similar to - MH, except that it adds three subdirectories of the - mailbox: - tmp, - new and - cur. Filenames for the messages are chosen in such a - way they are unique, even when two programs are writing the mailbox over - NFS, which means that no file locking is needed and corruption is very - unlikely. Maildir maybe slower to open without caching in NeoMutt, it too is - not very disk-space efficient depending on the environment. Since no - additional files are used for metadata (which is embedded in the message - filenames) and Maildir is locking-free, it's easy to sync across - different machines using file-level synchronization tools. + + to denote the start of a new message (this is often referred to as the + From_ line). The mbox format requires mailbox locking, + is prone to mailbox corruption with concurrently writing clients or + misinterpreted From_ lines. Depending on the environment, new mail + detection can be unreliable. Mbox folders are fast to open and easy to + archive. + + + MMDF. This is a variant of the + mbox format. Each message is surrounded by lines + containing ^A^A^A^A (four times control-A's). The same + problems as for mbox apply (also with finding the right message + separator as four control-A's may appear in message bodies). + + + MH. A radical departure from + mbox and MMDF, a mailbox + consists of a directory and each message is stored in a separate file. + The filename indicates the message number (however, this is may not + correspond to the message number NeoMutt displays). Deleted messages + are renamed with a comma (,) prepended to the filename. + NeoMutt detects this type of mailbox by looking for either + .mh_sequences or .xmhcache files + (needed to distinguish normal directories from MH mailboxes). MH is + more robust with concurrent clients writing the mailbox, but still may + suffer from lost flags; message corruption is less likely to occur than + with mbox/mmdf. It's usually slower to open compared to mbox/mmdf since + many small files have to be read (NeoMutt provides to greatly speed this process up). + Depending on the environment, MH is not very disk-space efficient. + + + Maildir. The newest of the mailbox formats, used + by the Qmail MTA (a replacement for sendmail). Similar to + MH, except that it adds three subdirectories of + the mailbox: tmp, new and + cur. Filenames for the messages are chosen in such + a way they are unique, even when two programs are writing the mailbox + over NFS, which means that no file locking is needed and corruption is + very unlikely. Maildir maybe slower to open without caching in NeoMutt, + it too is not very disk-space efficient depending on the environment. + Since no additional files are used for metadata (which is embedded in + the message filenames) and Maildir is locking-free, it's easy to sync + across different machines using file-level synchronization tools. + Mailbox Shortcuts - There are a number of built in shortcuts which refer to specific - mailboxes. These shortcuts can be used anywhere you are prompted for a - file or mailbox path or in path-related configuration variables. Note - that these only work at the beginning of a string. + + There are a number of built in shortcuts which refer to specific + mailboxes. These shortcuts can be used anywhere you are prompted for + a file or mailbox path or in path-related configuration variables. Note + that these only work at the beginning of a string. +
Mailbox shortcuts @@ -7901,124 +8588,128 @@ roessler@does-not-exist.org Thomas Roessler mutt pgp
- For example, to store a copy of outgoing messages in the folder - they were composed in, a - - folder-hook - can be used to set - $record: + + For example, to store a copy of outgoing messages in the folder they + were composed in, a + folder-hook can + be used to set $record: + folder-hook . 'set record=^' Handling Mailing Lists - NeoMutt has a few configuration options that make dealing with large - amounts of mail easier. The first thing you must do is to let NeoMutt know - what addresses you consider to be mailing lists (technically this does - not have to be a mailing list, but that is what it is most often used - for), and what lists you are subscribed to. This is accomplished through - the use of the - - lists and - subscribecommands in your - .neomuttrc. - Now that NeoMutt knows what your mailing lists are, it can do several - things, the first of which is the ability to show the name of a list - through which you received a message (i.e., of a subscribed list) in the - index menu display. This is useful to distinguish - between personal and list mail in the same mailbox. In the - $index_format variable, the expando - %L will print the string - To <list>when - list appears in the - To field, and - Cc <list>when it appears in the - Cc field (otherwise it prints the name of the - author). - Often times the - To and - Cc fields in mailing list messages tend to get quite large. - Most people do not bother to remove the author of the message they reply - to from the list, resulting in two or more copies being sent to that - person. The - <list-reply>function, which by default is bound - to - L in the - index menu and - pager, helps reduce the clutter by only replying to - the known mailing list addresses instead of all recipients (except as - specified by - Mail-Followup-To, see below). - NeoMutt also supports the - Mail-Followup-To header. When you send a message to a - list of recipients which includes one or several subscribed mailing - lists, and if the - $followup_to option is set, NeoMutt will - generate a Mail-Followup-To header which contains all the recipients to - whom you send this message, but not your address. This indicates that - group-replies or list-replies (also known as - followups) to this message should only be sent to the - original recipients of the message, and not separately to you - you'll - receive your copy through one of the mailing lists you are subscribed - to. - Conversely, when group-replying or list-replying to a message which - has a - Mail-Followup-To header, NeoMutt will respect this header - if the - $honor_followup_to configuration - variable is set. Using - list-reply will in this case also make - sure that the reply goes to the mailing list, even if it's not specified - in the list of recipients in the - Mail-Followup-To. + + NeoMutt has a few configuration options that make dealing with large + amounts of mail easier. The first thing you must do is to let NeoMutt + know what addresses you consider to be mailing lists (technically this + does not have to be a mailing list, but that is what it is most often + used for), and what lists you are subscribed to. This is accomplished + through the use of the + lists and + subscribe commands in + your .neomuttrc. + + + Now that NeoMutt knows what your mailing lists are, it can do several + things, the first of which is the ability to show the name of a list + through which you received a message (i.e., of a subscribed list) in + the index menu display. This is useful to + distinguish between personal and list mail in the same mailbox. In the + $index_format variable, the expando + %L will print the string To <list> + when list appears in the To field, and + Cc <list> when it appears in the Cc + field (otherwise it prints the name of the author). + + + Often times the To and Cc fields in + mailing list messages tend to get quite large. Most people do not + bother to remove the author of the message they reply to from the list, + resulting in two or more copies being sent to that person. The + <list-reply> function, which by default is + bound to L in the index menu and + pager, helps reduce the clutter by only replying + to the known mailing list addresses instead of all recipients (except + as specified by Mail-Followup-To, see below). + + + NeoMutt also supports the Mail-Followup-To header. + When you send a message to a list of recipients which includes one or + several subscribed mailing lists, and if the + $followup_to option is set, NeoMutt + will generate a Mail-Followup-To header which contains all the + recipients to whom you send this message, but not your address. This + indicates that group-replies or list-replies (also known as + followups) to this message should only be sent to the + original recipients of the message, and not separately to you – you'll + receive your copy through one of the mailing lists you are subscribed + to. + + + Conversely, when group-replying or list-replying to a message which has + a Mail-Followup-To header, NeoMutt will respect this + header if the + $honor_followup_to + configuration variable is set. Using + list-reply will in this case also + make sure that the reply goes to the mailing list, even if it's not + specified in the list of recipients in the + Mail-Followup-To. + - When header editing is enabled, you can create a - Mail-Followup-To header manually. NeoMutt will only - auto-generate this header if it doesn't exist when you send the - message. + + When header editing is enabled, you can create + a Mail-Followup-To header manually. NeoMutt will + only auto-generate this header if it doesn't exist when you send the + message. + - The other method some mailing list admins use is to generate a - Reply-To field which points back to the mailing list - address rather 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. NeoMutt uses the - $reply_to variable to help decide which - address to use. If set to - ask-yes or - ask-no, you will be prompted as to whether or not - you would like to use the address given in the - Reply-To field, or reply directly to the address given in - the - From field. When set to - yes, the - Reply-To field will be used when present. - You can change or delete the - X-Label:field within NeoMutt using the - edit-label command, bound to the - y key by default. This works for tagged messages, too. - While in the edit-label function, pressing the <complete> binding - (TAB, by default) will perform completion against all labels currently in - use. - Lastly, NeoMutt has the ability to - sort the mailbox into - threads. A thread is a group of messages - which all relate to the same subject. This is usually organized into a - tree-like structure where a message and all of its replies are - represented graphically. If you've ever used a threaded news client, this - is the same concept. It makes dealing with large volume mailing lists - easier because you can easily delete uninteresting threads and quickly - find topics of value. + + The other method some mailing list admins use is to generate + a Reply-To field which points back to the mailing list + address rather 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. NeoMutt uses the + $reply_to variable to help decide which + address to use. If set to ask-yes or + ask-no, you will be prompted as to whether or not + you would like to use the address given in the Reply-To + field, or reply directly to the address given in the + From field. When set to yes, the + Reply-To field will be used when present. + + + You can change or delete the X-Label: field within + NeoMutt using the edit-label command, bound to the + y key by default. This works for tagged messages, too. + While in the edit-label function, pressing the <complete> binding + (TAB, by default) will perform completion against all labels currently + in use. + + + Lastly, NeoMutt has the ability to sort the + mailbox into threads. A thread is + a group of messages which all relate to the same subject. This is + usually organized into a tree-like structure where a message and all of + its replies are represented graphically. If you've ever used a threaded + news client, this is the same concept. It makes dealing with large + volume mailing lists easier because you can easily delete uninteresting + threads and quickly find topics of value. + Display Munging - Working within the confines of a console or terminal window, it is - often useful to be able to modify certain information elements in a - non-destructive way -- to change how they display, without changing the - stored value of the information itself. This is especially so of message - subjects, which may often be polluted with extraneous metadata that - either is reproduced elsewhere, or is of secondary interest. + + Working within the confines of a console or terminal window, it is + often useful to be able to modify certain information elements in + a non-destructive way – to change how they display, without changing + the stored value of the information itself. This is especially so of + message subjects, which may often be polluted with extraneous metadata + that either is reproduced elsewhere, or is of secondary interest. + subjectrx @@ -8038,26 +8729,26 @@ roessler@does-not-exist.org Thomas Roessler mutt pgp - subjectrx specifies a regular expression - pattern which, if detected in a message subject, causes the - subject to be replaced with the - replacement value. The replacement is subject to - substitutions in the same way as for the - spam command: - %L for the text to the left of the match, - %R for text to the right of the match, and - %1 for the first subgroup in the match (etc). If you - simply want to erase the match, set it to - %L%R. Any number of - subjectrx commands may coexist. - Note this well: the - replacement value replaces the entire subject, not just the - match! - - unsubjectrx removes a given subjectrx from the - substitution list. If - *is used as the pattern, all substitutions will be - removed. + subjectrx specifies a regular expression + pattern which, if detected in a message subject, causes + the subject to be replaced with the replacement value. + The replacement is subject to substitutions in the same way as for the + spam command: %L for the + text to the left of the match, %R for text to the + right of the match, and %1 for the first subgroup in + the match (etc). If you simply want to erase the match, set it to + %L%R. Any number of subjectrx + commands may coexist. + + + Note this well: the replacement value replaces the + entire subject, not just the match! + + + unsubjectrx removes a given subjectrx from the + substitution list. If * is used as the pattern, all + substitutions will be removed. + Subject Munging @@ -8076,184 +8767,213 @@ subjectrx '\[[^]]*\]:? *' '%L%R' New Mail Detection - NeoMutt supports setups with multiple folders, allowing all of them to - be monitored for new mail (see - for details). + + NeoMutt supports setups with multiple folders, allowing all of them to + be monitored for new mail (see for + details). + How New Mail Detection Works - For Mbox and Mmdf folders, new mail is detected by comparing - access and/or modification times of files: NeoMutt assumes a folder has - new mail if it wasn't accessed after it was last modified. Utilities - like - biff or - frm or any other program which accesses the mailbox - might cause NeoMutt to never detect new mail for that mailbox if they do - not properly reset the access time. Other possible causes of NeoMutt not - detecting new mail in these folders are backup tools (updating access - times) or filesystems mounted without access time update support (for - Linux systems, see the - relatime option). + + For Mbox and Mmdf folders, new mail is detected by comparing access + and/or modification times of files: NeoMutt assumes a folder has new + mail if it wasn't accessed after it was last modified. Utilities like + biff or frm or any other + program which accesses the mailbox might cause NeoMutt to never + detect new mail for that mailbox if they do not properly reset the + access time. Other possible causes of NeoMutt not detecting new mail + in these folders are backup tools (updating access times) or + filesystems mounted without access time update support (for Linux + systems, see the relatime option). + - Contrary to older NeoMutt releases, it now maintains the new mail - status of a folder by properly resetting the access time if the - folder contains at least one message which is neither read, nor - deleted, nor marked as old. + + Contrary to older NeoMutt releases, it now maintains the new mail + status of a folder by properly resetting the access time if the + folder contains at least one message which is neither read, nor + deleted, nor marked as old. + - In cases where new mail detection for Mbox or Mmdf folders - appears to be unreliable, the - $check_mbox_size option can be - used to make NeoMutt track and consult file sizes for new mail detection - instead which won't work for size-neutral changes. - New mail for Maildir is assumed if there is one message in the - new/subdirectory which is not marked deleted (see - $maildir_trash). For MH folders, a - mailbox is considered having new mail if there's at least one message - in the - unseen sequence as specified by - $mh_seq_unseen. Optionally, - $new_mail_command can be - configured to execute an external program every time new mail is - detected in the current inbox. - NeoMutt does not poll POP3 folders for new mail, it only - periodically checks the currently opened folder (if it's a POP3 - folder). - For IMAP, by default NeoMutt uses recent message counts provided by - the server to detect new mail. If the - $imap_idle option is set, it'll use the - IMAP IDLE extension if advertised by the server. - The - $mail_check_recent option - changes whether NeoMutt will notify you of new mail in an already visited - mailbox. When set (the default) it will only notify you of new mail - received since the last time you opened the mailbox. When unset, NeoMutt - will notify you of any new mail in the mailbox. + + In cases where new mail detection for Mbox or Mmdf folders appears to + be unreliable, the + $check_mbox_size option can be + used to make NeoMutt track and consult file sizes for new mail + detection instead which won't work for size-neutral changes. + + + New mail for Maildir is assumed if there is one message in the + new/ subdirectory which is not marked deleted (see + $maildir_trash). For MH folders, + a mailbox is considered having new mail if there's at least one + message in the unseen sequence as specified by + $mh_seq_unseen. Optionally, + $new_mail_command can be + configured to execute an external program every time new mail is + detected in the current inbox. + + + NeoMutt does not poll POP3 folders for new mail, it only periodically + checks the currently opened folder (if it's a POP3 folder). + + + For IMAP, by default NeoMutt uses recent message counts provided by + the server to detect new mail. If the + $imap_idle option is set, it'll use + the IMAP IDLE extension if advertised by the server. + + + The $mail_check_recent + option changes whether NeoMutt will notify you of new mail in an + already visited mailbox. When set (the default) it will only notify + you of new mail received since the last time you opened the mailbox. + When unset, NeoMutt will notify you of any new mail in the mailbox. + Polling For New Mail - When in the index menu and being idle (also see - $timeout), NeoMutt periodically checks for - new mail in all folders which have been configured via the - mailboxes command. The interval depends on the folder - type: for local/IMAP folders it consults - $mail_check and - $pop_checkinterval for POP - folders. - Outside the index menu the directory browser supports checking - for new mail using the - <check-new>function which is unbound by - default. Pressing TAB will bring up a menu showing the files specified - by the - mailboxes command, and indicate which contain new - messages. NeoMutt will automatically enter this mode when invoked from the - command line with the - -y option. - For the pager, index and directory browser menus, NeoMutt contains - the - <buffy-list>function (bound to - .by default) which will print a list of folders with new - mail in the command line at the bottom of the screen. - For the index, by default NeoMutt displays the number of mailboxes - with new mail in the status bar, please refer to the - $status_format variable for - details. - When changing folders, NeoMutt fills the prompt with the first - folder from the mailboxes list containing new mail (if any), pressing - <Space>will cycle through folders with new - mail. The (by default unbound) function - <next-unread-mailbox>in the index can be used - to immediately open the next folder with unread mail (if any). + + When in the index menu and being idle (also see + $timeout), NeoMutt periodically checks + for new mail in all folders which have been configured via the + mailboxes command. The interval depends on the + folder type: for local/IMAP folders it consults + $mail_check and + $pop_checkinterval for POP + folders. + + + Outside the index menu the directory browser supports checking for + new mail using the <check-new> function + which is unbound by default. Pressing TAB will bring up a menu + showing the files specified by the mailboxes + command, and indicate which contain new messages. NeoMutt will + automatically enter this mode when invoked from the command line with + the -y option. + + + For the pager, index and directory browser menus, NeoMutt contains + the <buffy-list> function (bound to + . by default) which will print a list of folders with + new mail in the command line at the bottom of the screen. + + + For the index, by default NeoMutt displays the number of mailboxes + with new mail in the status bar, please refer to the + $status_format variable for + details. + + + When changing folders, NeoMutt fills the prompt with the first folder + from the mailboxes list containing new mail (if any), pressing + <Space> will cycle through folders with new + mail. The (by default unbound) function + <next-unread-mailbox> in the index can be + used to immediately open the next folder with unread mail (if any). + Calculating Mailbox Message Counts - If - $mail_check_stats is set, NeoMutt - will periodically calculate the unread, flagged, and total message - counts for each mailbox watched by the - mailboxes command. This calculation takes place at - the same time as new mail polling, but is controlled by a separate - timer: - - $mail_check_stats_interval. - The sidebar can display these message counts. See - $sidebar_format. + + If $mail_check_stats is set, + NeoMutt will periodically calculate the unread, flagged, and total + message counts for each mailbox watched by the + mailboxes command. This calculation takes place at + the same time as new mail polling, but is controlled by a separate + timer: + $mail_check_stats_interval. + + + The sidebar can display these message counts. See + $sidebar_format. + Editing Threads - NeoMutt has the ability to dynamically restructure threads that are - broken either by misconfigured software or bad behavior from some - correspondents. This allows to clean your mailboxes from these annoyances - which make it hard to follow a discussion. + + NeoMutt has the ability to dynamically restructure threads that are + broken either by misconfigured software or bad behavior from some + correspondents. This allows to clean your mailboxes 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 NeoMutt 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 children at once, tagging them and - using the - <tag-prefix>command ( - ;) or the - $auto_tag option. + + 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 NeoMutt 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 children 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. + + 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. - To support DSN, there are two variables. - $dsn_notify is used to request receipts - for different results (such as failed message, message delivered, etc.). - $dsn_return requests how much of your - message should be returned with the receipt (headers or full - message). - When using - $sendmail for mail delivery, you need to - use either Berkeley sendmail 8.8.x (or greater) a MTA supporting DSN - command line options compatible to Sendmail: The -N and -R options can be - used by the mail client to make requests as to what type of status - messages should be returned. Please consider your MTA documentation - whether DSN is supported. - For SMTP delivery using - $smtp_url, it depends on the capabilities - announced by the server whether NeoMutt will attempt to request DSN or - not. + + 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. + + + To support DSN, there are two variables. + $dsn_notify is used to request + receipts for different results (such as failed message, message + delivered, etc.). $dsn_return + requests how much of your message should be returned with the receipt + (headers or full message). + + + When using $sendmail for mail delivery, + you need to use either Berkeley sendmail 8.8.x (or greater) a MTA + supporting DSN command line options compatible to Sendmail: The -N and + -R options can be used by the mail client to make requests as to what + type of status messages should be returned. Please consider your MTA + documentation whether DSN is supported. + + + For SMTP delivery using $smtp_url, it + depends on the capabilities announced by the server whether NeoMutt + will attempt to request DSN or not. + Start a WWW Browser on URLs - If a message contains URLs, 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 retrieved at - - ftp://ftp.mutt.org/mutt/contrib/and the configuration - commands: + + If a message contains URLs, 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 retrieved at + ftp://ftp.mutt.org/mutt/contrib/ + and the configuration commands: + macro index \cb |urlview\n @@ -8264,35 +8984,40 @@ macro pager \cb |urlview\n Miscellany - This section documents various features that fit nowhere - else. + + This section documents various features that fit nowhere else. + Address normalization - NeoMutt normalizes all e-mail addresses to the simplest form - possible. If an address contains a realname, the form - Joe User <joe@example.com>is used and - the pure e-mail address without angle brackets otherwise, i.e. just - joe@example.com. - This normalization affects all headers NeoMutt generates - including aliases. + + NeoMutt normalizes all e-mail addresses to the simplest form + possible. If an address contains a realname, the form + Joe User <joe@example.com> is used and + the pure e-mail address without angle brackets otherwise, i.e. + just joe@example.com. + + + This normalization affects all headers NeoMutt generates + including aliases. + Initial folder selection - The folder NeoMutt opens at startup is determined as follows: - the folder specified in the - $MAIL environment variable if present. Otherwise, - the value of - $MAILDIR is taken into account. If that isn't - present either, NeoMutt takes the user's mailbox in the mailspool as - determined at compile-time (which may also reside in the home - directory). The - $spoolfile setting overrides this - selection. Highest priority has the mailbox given with the - -f command line option. + + The folder NeoMutt opens at startup is determined as follows: the + folder specified in the $MAIL environment + variable if present. Otherwise, the value of + $MAILDIR is taken into account. If that isn't + present either, NeoMutt takes the user's mailbox in the mailspool + as determined at compile-time (which may also reside in the home + directory). The $spoolfile + setting overrides this selection. Highest priority has the + mailbox given with the -f command line option. + @@ -8301,90 +9026,99 @@ macro pager \cb |urlview\n NeoMutt's MIME Support - Quite a bit of effort has been made to make NeoMutt the premier - text-mode MIME MUA. Every effort has been made to provide the functionality - that the discerning MIME user requires, and the conformance to the - standards wherever possible. When configuring NeoMutt for MIME, there are two - extra types of configuration files which NeoMutt uses. One is the - mime.types file, which contains the mapping of file - extensions to IANA MIME types. The other is the - mailcap file, which specifies the external commands to - use for handling specific MIME types. + + Quite a bit of effort has been made to make NeoMutt the premier text-mode + MIME MUA. Every effort has been made to provide the functionality that + the discerning MIME user requires, and the conformance to the standards + wherever possible. When configuring NeoMutt for MIME, there are two extra + types of configuration files which NeoMutt uses. One is the + mime.types file, which contains the mapping of file + extensions to IANA MIME types. The other is the + mailcap file, which specifies the external commands to + use for handling specific MIME types. + Using MIME in NeoMutt MIME Overview - MIME is short for - Multipurpose Internet Mail Extension and describes - mechanisms to internationalize and structure mail messages. Before the - introduction of MIME, messages had a single text part and were limited - to us-ascii header and content. With MIME, messages can have - attachments (and even attachments which itself have attachments and - thus form a tree structure), nearly arbitrary characters can be used - for sender names, recipients and subjects. - Besides the handling of non-ascii characters in message headers, - to NeoMutt the most important aspect of MIME are so-called MIME types. - These are constructed using a - major and - minor type separated by a forward slash. These - specify details about the content that follows. Based upon these, NeoMutt - decides how to handle this part. The most popular major type is - - text - with minor types for plain text, HTML and various other - formats. Major types also exist for images, audio, video and of course - general application data (e.g. to separate cryptographically signed - data with a signature, send office documents, and in general arbitrary - binary data). There's also the - multipart major type which represents the root of a - subtree of MIME parts. A list of supported MIME types can be found in - . - MIME also defines a set of encoding schemes for transporting MIME - content over the network: - 7bit, - 8bit, - quoted-printable, - base64 and - binary. There're some rules when to choose what for - encoding headers and/or body (if needed), and NeoMutt will in general make - a good choice. - NeoMutt does most of MIME encoding/decoding behind the scenes to - form messages conforming to MIME on the sending side. On reception, it - can be flexibly configured as to how what MIME structure is displayed - (and if it's displayed): these decisions are based on the content's - MIME type. There are three areas/menus in dealing with MIME: the pager - (while viewing a message), the attachment menu and the compose - menu. + + MIME is short for Multipurpose Internet Mail Extension + and describes mechanisms to internationalize and structure mail + messages. Before the introduction of MIME, messages had a single text + part and were limited to us-ascii header and content. With MIME, + messages can have attachments (and even attachments which itself have + attachments and thus form a tree structure), nearly arbitrary + characters can be used for sender names, recipients and subjects. + + + Besides the handling of non-ascii characters in message headers, to + NeoMutt the most important aspect of MIME are so-called MIME types. + These are constructed using a major and + minor type separated by a forward slash. These + specify details about the content that follows. Based upon these, + NeoMutt decides how to handle this part. The most popular major type + is text with minor types for + plain text, HTML and various other formats. Major types also exist + for images, audio, video and of course general application data (e.g. + to separate cryptographically signed data with a signature, send + office documents, and in general arbitrary binary data). There's also + the multipart major type which represents the root + of a subtree of MIME parts. A list of supported MIME types can be + found in . + + + MIME also defines a set of encoding schemes for transporting MIME + content over the network: 7bit, + 8bit, quoted-printable, + base64 and binary. There're + some rules when to choose what for encoding headers and/or body (if + needed), and NeoMutt will in general make a good choice. + + + NeoMutt does most of MIME encoding/decoding behind the scenes to form + messages conforming to MIME on the sending side. On reception, it can + be flexibly configured as to how what MIME structure is displayed + (and if it's displayed): these decisions are based on the content's + MIME type. There are three areas/menus in dealing with MIME: the + pager (while viewing a message), the attachment menu and the compose + menu. + Viewing MIME Messages in the Pager - When you select a message from the index and view it in the - pager, NeoMutt decodes as much of a message as possible to a text - representation. NeoMutt internally supports a number of MIME types, - including the - text major type (with all minor types), the - message/rfc822(mail messages) type and some - multipart types. In addition, it recognizes a variety - of PGP MIME types, including PGP/MIME and - application/pgp. - NeoMutt will denote attachments with a couple lines describing them. - These lines are of the form: + + When you select a message from the index and view it in the pager, + NeoMutt decodes as much of a message as possible to a text + representation. NeoMutt internally supports a number of MIME types, + including the text major type (with all minor + types), the message/rfc822 (mail messages) type + and some multipart types. In addition, it + recognizes a variety of PGP MIME types, including PGP/MIME and + application/pgp. + + + NeoMutt will denote attachments with a couple lines describing them. + These lines are of the form: + [-- Attachment #1: Description --] [-- Type: text/plain, Encoding: 7bit, Size: 10000 --] - Where the - Description is the description or filename given - for the attachment, and the - Encoding is one of the already mentioned content - encodings. - If NeoMutt cannot deal with a MIME type, it will display a message - like: + + Where the Description is the description or + filename given for the attachment, and the + Encoding is one of the already mentioned content + encodings. + + + If NeoMutt cannot deal with a MIME type, it will display a message + like: + [-- image/gif is unsupported (use 'v' to view this part) --] @@ -8394,87 +9128,98 @@ macro pager \cb |urlview\n The Attachment Menu - The default binding for - <view-attachments>is - v, which displays the attachment menu for a message. The - attachment menu displays a list of the attachments in a message. From - the attachment menu, you can save, print, pipe, delete, and view - attachments. You can apply these operations to a group of attachments - at once, by tagging the attachments and by using the - <tag-prefix>operator. You can also reply to - the current message from this menu, and only the current attachment (or - the attachments tagged) will be quoted in your reply. You can view - attachments as text, or view them using the mailcap viewer definition - (the mailcap mechanism is explained later in detail). - Finally, you can apply the usual message-related functions (like - - <resend-message> - , and the - <reply>and - <forward>functions) to attachments of type - message/rfc822. - See table - for all available - functions. + + The default binding for <view-attachments> + is v, which displays the attachment menu for + a message. The attachment menu displays a list of the attachments in + a message. From the attachment menu, you can save, print, pipe, + delete, and view attachments. You can apply these operations to + a group of attachments at once, by tagging the attachments and by + using the <tag-prefix> operator. You can + also reply to the current message from this menu, and only the + current attachment (or the attachments tagged) will be quoted in your + reply. You can view attachments as text, or view them using the + mailcap viewer definition (the mailcap mechanism is explained later + in detail). + + + Finally, you can apply the usual message-related functions (like + <resend-message>, + and the + <reply> and + <forward> functions) to attachments of type + message/rfc822. + + + See table for all + available functions. + The Compose Menu - The compose menu is the menu you see before you send a message. - It allows you to edit the recipient list, the subject, and other - aspects of your message. It also contains a list of the attachments of - your message, including the main body. From this menu, you can print, - copy, filter, pipe, edit, compose, review, and rename an attachment or - a list of tagged attachments. You can also modifying the attachment - information, notably the type, encoding and description. - Attachments appear as follows by default: + + The compose menu is the menu you see before you send a message. It + allows you to edit the recipient list, the subject, and other aspects + of your message. It also contains a list of the attachments of your + message, including the main body. From this menu, you can print, + copy, filter, pipe, edit, compose, review, and rename an attachment + or a list of tagged attachments. You can also modifying the + attachment information, notably the type, encoding and description. + + + Attachments appear as follows by default: + - 1 [text/plain, 7bit, 1K] /tmp/neomutt-euler-8082-0 <no description> 2 [applica/x-gunzip, base64, 422K] ~/src/neomutt-0.85.tar.gz <no description> - The - -denotes that NeoMutt will delete the file after sending - (or postponing, or canceling) the message. It can be toggled with the - <toggle-unlink>command (default: u). The next - field is the MIME content-type, and can be changed with the - <edit-type>command (default: ^T). The next - field is the encoding for the attachment, which allows a binary message - to be encoded for transmission on 7bit links. It can be changed with - the - <edit-encoding>command (default: ^E). The next - field is the size of the attachment, rounded to kilobytes or megabytes. - The next field is the filename, which can be changed with the - <rename-file>command (default: R). The final - field is the description of the attachment, and can be changed with the - <edit-description>command (default: d). See - $attach_format for a full list of - available expandos to format this display to your needs. + + The - denotes that NeoMutt will delete the file after + sending (or postponing, or canceling) the message. It can be toggled + with the <toggle-unlink> command (default: + u). The next field is the MIME content-type, and can be changed with + the <edit-type> command (default: ^T). The + next field is the encoding for the attachment, which allows a binary + message to be encoded for transmission on 7bit links. It can be + changed with the <edit-encoding> command + (default: ^E). The next field is the size of the attachment, rounded + to kilobytes or megabytes. The next field is the filename, which can + be changed with the <rename-file> command + (default: R). The final field is the description of the attachment, + and can be changed with the + <edit-description> command (default: d). See + $attach_format for a full list + of available expandos to format this display to your needs. + - MIME Type Configuration with - <literal>mime.types</literal> - To get most out of MIME, it's important that a MIME part's content - type matches the content as closely as possible so that the recipient's - client can automatically select the right viewer for the content. - However, there's no reliable for NeoMutt to know how to detect every - possible file type. Instead, it uses a simple plain text mapping file - that specifies what file extension corresponds to what MIME type. This - file is called - mime.types. - When you add an attachment to your mail message, NeoMutt searches your - personal - mime.types file at - $HOME/.mime.types, and then the system - mime.types file at - /usr/local/share/neomutt/mime.types or - /etc/mime.types - Each line starts with the full MIME type, followed by a space and - space-separated list of file extensions. For example you could - use: + MIME Type Configuration with <literal>mime.types</literal> + + To get most out of MIME, it's important that a MIME part's content type + matches the content as closely as possible so that the recipient's + client can automatically select the right viewer for the content. + However, there's no reliable for NeoMutt to know how to detect every + possible file type. Instead, it uses a simple plain text mapping file + that specifies what file extension corresponds to what MIME type. This + file is called mime.types. + + + When you add an attachment to your mail message, NeoMutt searches your + personal mime.types file at + $HOME/.mime.types, and then the system + mime.types file at + /usr/local/share/neomutt/mime.types or + /etc/mime.types + + + Each line starts with the full MIME type, followed by a space and + space-separated list of file extensions. For example you could use: + <literal>mime.types</literal> @@ -8487,26 +9232,28 @@ audio/x-aiff aif aifc aiff </screen> </example> - <para>A sample - <literal>mime.types</literal> file comes with the NeoMutt distribution, and - should contain most of the MIME types you are likely to use.</para> - <para>If NeoMutt can not determine the MIME type by the extension of the - file you attach, it will run the command specified in - <link linkend="mime-type-query-command">$mime_type_query_command</link>. - If that command is not specified, NeoMutt will look at the file. If the file - is free of binary information, NeoMutt will assume that the file is plain - text, and mark it as - <literal>text/plain</literal>. If the file contains binary information, - then NeoMutt will mark it as - <literal>application/octet-stream</literal>. You can change the MIME type - that NeoMutt assigns to an attachment by using the - <literal><edit-type></literal>command from the compose menu - (default: ^T), see - <xref linkend="supported-mime-types" />for supported major types. NeoMutt - recognizes all of these if the appropriate entry is found in the - <literal>mime.types</literal> file. Non-recognized mime types should only - be used if the recipient of the message is likely to be expecting such - attachments.</para> + <para> + A sample <literal>mime.types</literal> file comes with the NeoMutt + distribution, and should contain most of the MIME types you are likely + to use. + </para> + <para> + If NeoMutt can not determine the MIME type by the extension of the file + you attach, it will run the command specified in + <link linkend="mime-type-query-command">$mime_type_query_command</link>. + If that command is not specified, NeoMutt will look at the file. If the + file is free of binary information, NeoMutt will assume that the file + is plain text, and mark it as <literal>text/plain</literal>. If the + file contains binary information, then NeoMutt will mark it as + <literal>application/octet-stream</literal>. You can change the MIME + type that NeoMutt assigns to an attachment by using the + <literal><edit-type></literal> command from the compose menu + (default: ^T), see <xref linkend="supported-mime-types" /> for + supported major types. NeoMutt recognizes all of these if the + appropriate entry is found in the <literal>mime.types</literal> file. + Non-recognized mime types should only be used if the recipient of the + message is likely to be expecting such attachments. + </para> <table id="supported-mime-types"> <title>Supported MIME types @@ -8585,24 +9332,28 @@ audio/x-aiff aif aifc aiff - MIME types are not arbitrary, they need to be assigned by - - IANA. + + MIME types are not arbitrary, they need to be assigned by + IANA. + MIME Viewer Configuration with Mailcap - NeoMutt supports RFC 1524 MIME Configuration, in particular the Unix - specific format specified in Appendix A of RFC 1524. This file format is - commonly referred to as the - mailcap format. Many MIME compliant programs utilize the - mailcap format, allowing you to specify handling for all MIME types in - one place for all programs. Programs known to use this format include - Firefox, lynx and metamail. - In order to handle various MIME types that NeoMutt doesn't have - built-in support for, it parses a series of external configuration files - to find an external handler. The default search string for these files is - a colon delimited list containing the following files: + + NeoMutt supports RFC 1524 MIME Configuration, in particular the Unix + specific format specified in Appendix A of RFC 1524. This file format + is commonly referred to as the mailcap format. Many MIME + compliant programs utilize the mailcap format, allowing you to specify + handling for all MIME types in one place for all programs. Programs + known to use this format include Firefox, lynx and metamail. + + + In order to handle various MIME types that NeoMutt doesn't have + built-in support for, it parses a series of external configuration + files to find an external handler. The default search string for these + files is a colon delimited list containing the following files: + @@ -8635,86 +9386,107 @@ audio/x-aiff aif aifc aiff - where - $HOME is your home directory. The - $PKGDATADIR and the - $SYSCONFDIR directories depend on where NeoMutt is - installed: the former is the default for shared data, the latter for - system configuration files. - The default search path can be obtained by running the following - command: + + where $HOME is your home directory. The + $PKGDATADIR and the $SYSCONFDIR + directories depend on where NeoMutt is installed: the former is the + default for shared data, the latter for system configuration files. + + + The default search path can be obtained by running the following + command: + neomutt -nF /dev/null -Q mailcap_path - In particular, the metamail distribution will install a mailcap - file, usually as - /usr/local/etc/mailcap, which contains some baseline - entries. + + In particular, the metamail distribution will install a mailcap file, + usually as /usr/local/etc/mailcap, which contains + some baseline entries. + The Basics of the Mailcap File - A mailcap file consists of a series of lines which are comments, - blank, or definitions. - A comment line consists of a # character followed by anything you - want. - A blank line is blank. - A definition line consists of a content type, a view command, and - any number of optional fields. Each field of a definition line is - divided by a semicolon - ;character. - The content type is specified in the MIME standard - type/subtype notation. For example, - text/plain, - text/html, - image/gif, etc. In addition, the mailcap format - includes two formats for wildcards, one using the special - *subtype, the other is the implicit wild, where you only - include the major type. For example, - image/*, or - video will match all image types and video types, - respectively. - The view command is a Unix command for viewing the type - specified. There are two different types of commands supported. The - default is to send the body of the MIME message to the command on - stdin. You can change this behavior by using - %s as a parameter to your view command. This will - cause NeoMutt to save the body of the MIME message to a temporary file, - and then call the view command with the - %s replaced by the name of the temporary file. In - both cases, NeoMutt will turn over the terminal to the view program until - the program quits, at which time NeoMutt will remove the temporary file if - it exists. This means that mailcap does - not work out of the box with programs which detach - themselves from the terminal right after starting, like - open on Mac OS X. In order to nevertheless use these - programs with mailcap, you probably need custom shell scripts. - So, in the simplest form, you can send a - text/plain message to the external pager more on - standard input: + + A mailcap file consists of a series of lines which are comments, + blank, or definitions. + + + A comment line consists of a # character followed by anything you + want. + + + A blank line is blank. + + + A definition line consists of a content type, a view command, and any + number of optional fields. Each field of a definition line is divided + by a semicolon ; character. + + + The content type is specified in the MIME standard + type/subtype notation. For example, + text/plain, text/html, + image/gif, etc. In addition, the mailcap format + includes two formats for wildcards, one using the special + * subtype, the other is the implicit wild, where you + only include the major type. For example, image/*, + or video will match all image types and video + types, respectively. + + + The view command is a Unix command for viewing the type specified. + There are two different types of commands supported. The default is + to send the body of the MIME message to the command on stdin. You can + change this behavior by using %s as a parameter to + your view command. This will cause NeoMutt to save the body of the + MIME message to a temporary file, and then call the view command with + the %s replaced by the name of the temporary file. + In both cases, NeoMutt will turn over the terminal to the view + program until the program quits, at which time NeoMutt will remove + the temporary file if it exists. This means that mailcap does + not work out of the box with programs which + detach themselves from the terminal right after starting, like + open on Mac OS X. In order to nevertheless use + these programs with mailcap, you probably need custom shell scripts. + + + So, in the simplest form, you can send + a text/plain message to the external pager more on + standard input: + text/plain; more - Or, you could send the message as a file: + + Or, you could send the message as a file: + text/plain; more %s - Perhaps you would like to use lynx to interactively view a - text/html message: + + Perhaps you would like to use lynx to interactively view + a text/html message: + text/html; lynx %s - In this case, lynx does not support viewing a file from standard - input, so you must use the - %s syntax. + + In this case, lynx does not support viewing a file from standard + input, so you must use the %s syntax. + Some older versions of lynx contain a bug where they will - check the mailcap file for a viewer for - text/html. They will find the line which calls - lynx, and run it. This causes lynx to continuously spawn itself to - view the object. + check the mailcap file for a viewer for + text/html. They will find the line which calls + lynx, and run it. This causes lynx to continuously spawn itself + to view the object. - On the other hand, maybe you don't want to use lynx - interactively, you just want to have it convert the - text/html to - text/plain, then you can use: + + On the other hand, maybe you don't want to use lynx interactively, + you just want to have it convert the text/html to + text/plain, then you can use: + text/html; lynx -dump %s | more - Perhaps you wish to use lynx to view - text/html files, and a pager on all other text - formats, then you would use the following: + + Perhaps you wish to use lynx to view text/html + files, and a pager on all other text formats, then you would use the + following: + text/html; lynx %s @@ -8725,31 +9497,36 @@ text/*; more Secure Use of Mailcap - The interpretation of shell meta-characters embedded in MIME - parameters can lead to security problems in general. NeoMutt tries to - quote parameters in expansion of - %s syntaxes properly, and avoids risky characters by - substituting them, see the - - $mailcap_sanitize variable. - Although NeoMutt's procedures to invoke programs with mailcap seem - to be safe, there are other applications parsing mailcap, maybe taking - less care of it. Therefore you should pay attention to the following - rules: - - Keep the %-expandos away from shell quoting.Don't - quote them with single or double quotes. NeoMutt does this for you, the - right way, as should any other program which interprets mailcap. Don't - put them into backtick expansions. Be highly careful with evil - statements, and avoid them if possible at all. Trying to fix broken - behavior with quotes introduces new leaks — there is no alternative to - correct quoting in the first place. - If you have to use the %-expandos' values in context where you - need quoting or backtick expansions, put that value into a shell - variable and reference the shell variable where necessary, as in the - following example (using - $charset inside the backtick expansion is safe, since - it is not itself subject to any further expansion): + + The interpretation of shell meta-characters embedded in MIME + parameters can lead to security problems in general. NeoMutt tries to + quote parameters in expansion of %s syntaxes + properly, and avoids risky characters by substituting them, see the + $mailcap_sanitize variable. + + + Although NeoMutt's procedures to invoke programs with mailcap seem to + be safe, there are other applications parsing mailcap, maybe taking + less care of it. Therefore you should pay attention to the following + rules: + + + Keep the %-expandos away from shell quoting. + Don't quote them with single or double quotes. NeoMutt does this for + you, the right way, as should any other program which interprets + mailcap. Don't put them into backtick expansions. Be highly careful + with evil statements, and avoid them if possible at all. Trying to + fix broken behavior with quotes introduces new leaks – there is no + alternative to correct quoting in the first place. + + + If you have to use the %-expandos' values in context where you need + quoting or backtick expansions, put that value into a shell variable + and reference the shell variable where necessary, as in the following + example (using $charset inside the backtick + expansion is safe, since it is not itself subject to any further + expansion): + text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \ @@ -8763,141 +9540,161 @@ text/test-mailcap-bug; cat %s; copiousoutput; test=charset=%{charset} \ Optional Fields - In addition to the required content-type and view command - fields, you can add semi-colon - ;separated fields to set flags and other options. NeoMutt - recognizes the following optional fields: + + In addition to the required content-type and view command fields, + you can add semi-colon ; separated fields to set + flags and other options. NeoMutt recognizes the following optional + fields: + copiousoutput - This flag tells NeoMutt that the command passes possibly - large amounts of text on standard output. This causes NeoMutt to - invoke a pager (either the internal pager or the external pager - defined by the pager variable) on the output of the view - command. Without this flag, NeoMutt assumes that the command is - interactive. One could use this to replace the pipe to - more in the - lynx -dump example in the Basic - section: + + This flag tells NeoMutt that the command passes possibly + large amounts of text on standard output. This causes NeoMutt + to invoke a pager (either the internal pager or the external + pager defined by the pager variable) on the output of the + view command. Without this flag, NeoMutt assumes that the + command is interactive. One could use this to replace the + pipe to more in the + lynx -dump example in the Basic section: + text/html; lynx -dump %s ; copiousoutput - This will cause lynx to format the - text/html output as - text/plain and NeoMutt will use your standard - pager to display the results. - NeoMutt will set the - COLUMNS environment variable to the width of - the pager. Some programs make use of this environment variable - automatically. Others provide a command line argument that can - use this to set the output width: + + This will cause lynx to format the + text/html output as + text/plain and NeoMutt will use your + standard pager to display the results. + + + NeoMutt will set the COLUMNS environment + variable to the width of the pager. Some programs make use of + this environment variable automatically. Others provide + a command line argument that can use this to set the output + width: + text/html; lynx -dump -width ${COLUMNS:-80} %s; copiousoutput - Note that when using the built-in pager, - only entries with this flag will be - considered a handler for a MIME type — all other entries will - be ignored. + + Note that when using the built-in pager, + only entries with this flag will be + considered a handler for a MIME type – all other entries will + be ignored. + needsterminal - NeoMutt uses this flag when viewing attachments with - - auto_view - , in order to decide whether it should honor the setting - of the - $wait_key variable or not. When - an attachment is viewed using an interactive program, and the - corresponding mailcap entry has a - needsterminal flag, NeoMutt will use - $wait_key and the exit status of - the program to decide if it will ask you to press a key after - the external program has exited. In all other situations it - will not prompt you for a key. + + NeoMutt uses this flag when viewing attachments with + auto_view, + in order to decide whether it should honor the setting of the + $wait_key variable or not. + When an attachment is viewed using an interactive program, + and the corresponding mailcap entry has + a needsterminal flag, NeoMutt will use + $wait_key and the exit status + of the program to decide if it will ask you to press a key + after the external program has exited. In all other + situations it will not prompt you for a key. + compose=<command> - This flag specifies the command to use to create a new - attachment of a specific MIME type. NeoMutt supports this from the - compose menu. + + This flag specifies the command to use to create a new + attachment of a specific MIME type. NeoMutt supports this + from the compose menu. + composetyped=<command> - This flag specifies the command to use to create a new - attachment of a specific MIME type. This command differs from - the compose command in that NeoMutt will expect standard MIME - headers on the data. This can be used to specify parameters, - filename, description, etc. for a new attachment. NeoMutt supports - this from the compose menu. + + This flag specifies the command to use to create a new + attachment of a specific MIME type. This command differs from + the compose command in that NeoMutt will expect standard MIME + headers on the data. This can be used to specify parameters, + filename, description, etc. for a new attachment. NeoMutt + supports this from the compose menu. + print=<command> - This flag specifies the command to use to print a - specific MIME type. NeoMutt supports this from the attachment and - compose menus. + + This flag specifies the command to use to print a specific + MIME type. NeoMutt supports this from the attachment and + compose menus. + edit=<command> - This flag specifies the command to use to edit a specific - MIME type. NeoMutt supports this from the compose menu, and also - uses it to compose new attachments. NeoMutt will default to the - defined - $editor for text - attachments. + + This flag specifies the command to use to edit a specific + MIME type. NeoMutt supports this from the compose menu, and + also uses it to compose new attachments. NeoMutt will default + to the defined $editor for text + attachments. + nametemplate=<template> - This field specifies the format for the file denoted by - %s in the command fields. Certain programs - will require a certain file extension, for instance, to - correctly view a file. For instance, lynx will only interpret a - file as - text/html if the file ends in - .html. So, you would specify lynx as a - text/html viewer with a line in the mailcap - file like: + + This field specifies the format for the file denoted by + %s in the command fields. Certain programs + will require a certain file extension, for instance, to + correctly view a file. For instance, lynx will only interpret + a file as text/html if the file ends in + .html. So, you would specify lynx as + a text/html viewer with a line in the + mailcap file like: + text/html; lynx %s; nametemplate=%s.html test=<command> - This field specifies a command to run to test whether - this mailcap entry should be used. The command is defined with - the command expansion rules defined in the next section. If the - command returns 0, then the test passed, and NeoMutt uses this - entry. If the command returns non-zero, then the test failed, - and NeoMutt continues searching for the right entry. Note that the - content-type must match before NeoMutt performs the test. For - example: + + This field specifies a command to run to test whether this + mailcap entry should be used. The command is defined with the + command expansion rules defined in the next section. If the + command returns 0, then the test passed, and NeoMutt uses + this entry. If the command returns non-zero, then the test + failed, and NeoMutt continues searching for the right entry. + Note that the content-type must match before NeoMutt performs + the test. For example: + text/html; firefox -remote 'openURL(%s)' ; test=RunningX text/html; lynx %s - In this example, NeoMutt will run the program - RunningX which will return 0 if the X Window - manager is running, and non-zero if it isn't. If - RunningX returns 0, then NeoMutt will run - firefox to display the - text/html object. If RunningX doesn't return - 0, then NeoMutt will go on to the next entry and use lynx to - display the - text/html object. + + In this example, NeoMutt will run the program + RunningX which will return 0 if the + X Window manager is running, and non-zero if it isn't. If + RunningX returns 0, then NeoMutt will run + firefox to display the text/html object. + If RunningX doesn't return 0, then NeoMutt will go on to the + next entry and use lynx to display the + text/html object. + @@ -8905,12 +9702,13 @@ text/html; lynx %s Search Order - When searching for an entry in the mailcap file, NeoMutt will - search for the most useful entry for its purpose. For instance, if - you are attempting to print an - image/gif, and you have the following entries in - your mailcap file, NeoMutt will search for an entry with the print - command: + + When searching for an entry in the mailcap file, NeoMutt will + search for the most useful entry for its purpose. For instance, if + you are attempting to print an image/gif, and + you have the following entries in your mailcap file, NeoMutt will + search for an entry with the print command: + image/*; xv %s @@ -8918,19 +9716,20 @@ image/gif; ; print=anytopnm %s | pnmtops | lpr; \ nametemplate=%s.gif - NeoMutt will skip the - image/*entry and use the - image/gif entry with the print command. - In addition, you can use this with - - auto_view - to denote two commands for viewing an attachment, one to be - viewed automatically, the other to be viewed interactively from the - attachment menu using the - <view-mailcap>function (bound to - m by default). In addition, you can then use the test - feature to determine which viewer to use interactively depending on - your environment. + + NeoMutt will skip the image/* entry and use the + image/gif entry with the print command. + + + In addition, you can use this with + auto_view to + denote two commands for viewing an attachment, one to be viewed + automatically, the other to be viewed interactively from the + attachment menu using the <view-mailcap> + function (bound to m by default). In addition, you + can then use the test feature to determine which viewer to use + interactively depending on your environment. + text/html; firefox -remote 'openURL(%s)' ; test=RunningX @@ -8938,97 +9737,108 @@ text/html; lynx %s; nametemplate=%s.html text/html; lynx -dump %s; nametemplate=%s.html; copiousoutput - For - - auto_view - , NeoMutt will choose the third entry because of the - copiousoutput tag. For interactive viewing, NeoMutt - will run the program - RunningX to determine if it should use the first - entry. If the program returns non-zero, NeoMutt will use the second - entry for interactive viewing. The last entry is for inline display - in the pager and the - <view-attach>function in the attachment - menu. - Entries with the - copiousoutput tag should always be specified as the - last one per type. For non-interactive use, the last entry will then - actually be the first matching one with the tag set. For - non-interactive use, only - copiousoutput-tagged entries are considered. For - interactive use, NeoMutt ignores this tag and treats all entries - equally. Therefore, if not specified last, all following entries - without this tag would never be considered for - <view-attach>because the - copiousoutput before them matched already. + + For auto_view, + NeoMutt will choose the third entry because of the + copiousoutput tag. For interactive viewing, + NeoMutt will run the program RunningX to + determine if it should use the first entry. If the program returns + non-zero, NeoMutt will use the second entry for interactive + viewing. The last entry is for inline display in the pager and the + <view-attach> function in the attachment + menu. + + + Entries with the copiousoutput tag should always + be specified as the last one per type. For non-interactive use, the + last entry will then actually be the first matching one with the + tag set. For non-interactive use, only + copiousoutput-tagged entries are considered. For + interactive use, NeoMutt ignores this tag and treats all entries + equally. Therefore, if not specified last, all following entries + without this tag would never be considered for + <view-attach> because the + copiousoutput before them matched already. + Command Expansion - The various commands defined in the mailcap files are passed to - the - /bin/sh shell using the - system(3)function. Before the command is passed to - /bin/sh -c, it is parsed to expand various special - parameters with information from NeoMutt. The keywords NeoMutt expands - are: + + The various commands defined in the mailcap files are passed to the + /bin/sh shell using the + system(3) function. Before the command is passed + to /bin/sh -c, it is parsed to expand various + special parameters with information from NeoMutt. The keywords + NeoMutt expands are: + %s - As seen in the basic mailcap section, this variable is - expanded to a filename specified by the calling program. This - file contains the body of the message to view/print/edit or - where the composing program should place the results of - composition. In addition, the use of this keyword causes NeoMutt - to not pass the body of the message to the view/print/edit - program on stdin. + + As seen in the basic mailcap section, this variable is + expanded to a filename specified by the calling program. This + file contains the body of the message to view/print/edit or + where the composing program should place the results of + composition. In addition, the use of this keyword causes + NeoMutt to not pass the body of the message to the + view/print/edit program on stdin. + %t - NeoMutt will expand - %t to the text representation of the content - type of the message in the same form as the first parameter of - the mailcap definition line, i.e. - text/html or - image/gif. + + NeoMutt will expand %t to the text + representation of the content type of the message in the same + form as the first parameter of the mailcap definition line, + i.e. text/html or + image/gif. + %{<parameter>} - NeoMutt will expand this to the value of the specified - parameter from the Content-Type: line of the mail message. For - instance, if your mail message contains: + + NeoMutt will expand this to the value of the specified + parameter from the Content-Type: line of the mail message. + For instance, if your mail message contains: + Content-Type: text/plain; charset=iso-8859-1 - then NeoMutt will expand - %{charset}to - iso-8859-1. The default metamail mailcap file - uses this feature to test the charset to spawn an xterm using - the right charset to view the message. + + then NeoMutt will expand %{charset} to + iso-8859-1. The default metamail mailcap file + uses this feature to test the charset to spawn an xterm using + the right charset to view the message. + \% - This will be replaced by a literal - %. + + This will be replaced by a literal %. + - NeoMutt does not currently support the - %F and - %n keywords specified in RFC 1524. The main purpose - of these parameters is for multipart messages, which is handled - internally by NeoMutt. + + NeoMutt does not currently support the %F and + %n keywords specified in RFC 1524. The main + purpose of these parameters is for multipart messages, which is + handled internally by NeoMutt. + Example Mailcap Files - This mailcap file is fairly simple and standard: + + This mailcap file is fairly simple and standard: + # I'm always running X :) @@ -9038,7 +9848,9 @@ image/*; xv %s > /dev/null text/html; firefox -remote 'openURL(%s)' - This mailcap file shows quite a number of examples: + + This mailcap file shows quite a number of examples: + # Use xanim to view all videos Xanim produces a header on startup, @@ -9073,7 +9885,9 @@ application/ms-excel; open.pl %s MIME Autoview - Usage: + + Usage: + auto_view @@ -9092,29 +9906,34 @@ application/ms-excel; open.pl %s - In addition to explicitly telling NeoMutt to view an attachment with - the MIME viewer defined in the mailcap file from the attachments menu, - NeoMutt has support for automatically viewing MIME attachments while in the - pager. - For this to work, you must define a viewer in the mailcap file - which uses the - copiousoutput option to denote that it is - non-interactive. Usually, you also use the entry to convert the - attachment to a text representation which you can view in the - pager. - You then use the - auto_view configuration command to list the - content-types that you wish to view automatically. For instance, if you - set it to: + + In addition to explicitly telling NeoMutt to view an attachment with + the MIME viewer defined in the mailcap file from the attachments menu, + NeoMutt has support for automatically viewing MIME attachments while in + the pager. + + + For this to work, you must define a viewer in the mailcap file which + uses the copiousoutput option to denote that it is + non-interactive. Usually, you also use the entry to convert the + attachment to a text representation which you can view in the pager. + + + You then use the auto_view configuration command to + list the content-types that you wish to view automatically. For + instance, if you set it to: + auto_view text/html application/x-gunzip \ application/postscript image/gif application/x-tar-gz - ...NeoMutt would try to find corresponding entries for rendering - attachments of these types as text. A corresponding mailcap could look - like: + + ...NeoMutt would try to find corresponding entries for rendering + attachments of these types as text. A corresponding mailcap could look + like: + text/html; lynx -dump %s; copiousoutput; nametemplate=%s.html @@ -9126,33 +9945,35 @@ application/postscript; ps2ascii %s; copiousoutput - unauto_view can be used to remove previous entries from - the - auto_view list. This can be used with - - message-hook - to autoview messages based on size, etc. - - unauto_view*will remove all previous - entries. + unauto_view can be used to remove previous entries + from the auto_view list. This can be used with + message-hook to + autoview messages based on size, etc. + unauto_view * will remove all + previous entries. + MIME Multipart/Alternative - The - multipart/alternative container type only has child - MIME parts which represent the same content in an alternative way. This - is often used to send HTML messages which contain an alternative plain - text representation. - NeoMutt has some heuristics for determining which attachment of a - multipart/alternative type to display: + + The multipart/alternative container type only has + child MIME parts which represent the same content in an alternative + way. This is often used to send HTML messages which contain an + alternative plain text representation. + + + NeoMutt has some heuristics for determining which attachment of + a multipart/alternative type to display: + - First, NeoMutt will check the - alternative_order list to determine if one of the - available types is preferred. It consists of a number of MIME types - in order, including support for implicit and explicit wildcards. For - example: + + First, NeoMutt will check the alternative_order + list to determine if one of the available types is preferred. It + consists of a number of MIME types in order, including support for + implicit and explicit wildcards. For example: + alternative_order text/enriched text/plain text \ @@ -9161,41 +9982,52 @@ alternative_order text/enriched text/plain text \ - Next, NeoMutt will check if any of the types have a defined - - auto_view - , and use that. + + Next, NeoMutt will check if any of the types have a defined + auto_view, and + use that. + - Failing that, NeoMutt will look for any text type. + + Failing that, NeoMutt will look for any text type. + - As a last attempt, NeoMutt will look for any type it knows how to - handle. + + As a last attempt, NeoMutt will look for any type it knows how to + handle. + - To remove a MIME type from the - alternative_order list, use the - unalternative_order command. + + To remove a MIME type from the alternative_order + list, use the unalternative_order command. + Attachment Searching and Counting - If you ever lose track of attachments in your mailboxes, NeoMutt's - attachment-counting and -searching support might be for you. You can make - your message index display the number of qualifying attachments in each - message, or search for messages by attachment count. You also can - configure what kinds of attachments qualify for this feature with the - attachments and - unattachments commands. - In order to provide this information, NeoMutt needs to fully - MIME-parse all messages affected first. This can slow down operation - especially for remote mail folders such as IMAP because all messages have - to be downloaded first regardless whether the user really wants to view - them or not though using - usually means to download the message just - once. - The syntax is: + + If you ever lose track of attachments in your mailboxes, NeoMutt's + attachment-counting and -searching support might be for you. You can + make your message index display the number of qualifying attachments in + each message, or search for messages by attachment count. You also can + configure what kinds of attachments qualify for this feature with the + attachments and unattachments + commands. + + + In order to provide this information, NeoMutt needs to fully MIME-parse + all messages affected first. This can slow down operation especially + for remote mail folders such as IMAP because all messages have to be + downloaded first regardless whether the user really wants to view them + or not though using usually means to + download the message just once. + + + The syntax is: + attachments @@ -9217,46 +10049,43 @@ alternative_order text/enriched text/plain text \ - disposition is the attachment's Content-Disposition - type — either - inline or - attachment. You can abbreviate this to - I or - A. - Disposition is prefixed by either a - +symbol or a - -symbol. If it's a - +, you're saying that you want to allow this disposition - and MIME type to qualify. If it's a - -, you're saying that this disposition and MIME type is an - exception to previous - +rules. There are examples below of how this is - useful. - - mime-type is the MIME type of the attachment you want - the command to affect. A MIME type is always of the format - major/minor, where - major describes the broad category of document you're - looking at, and - minor describes the specific type within that category. - The major part of mime-type must be literal text (or the special token - - * - ), but the minor part may be a regular expression. (Therefore, - - */.* - matches any MIME type.) - The MIME types you give to the - attachments directive are a kind of pattern. When you - use the - attachments directive, the patterns you specify are - added to a list. When you use - unattachments, the pattern is removed from the list. - The patterns are not expanded and matched to specific MIME types at this - time — they're just text in a list. They're only matched when actually - evaluating a message. - Some examples might help to illustrate. The examples that are not - commented out define the default configuration of the lists. + disposition is the attachment's + Content-Disposition type – either inline or + attachment. You can abbreviate this to + I or A. + + + Disposition is prefixed by either a + symbol or + a - symbol. If it's a +, you're saying + that you want to allow this disposition and MIME type to qualify. If + it's a -, you're saying that this disposition and MIME + type is an exception to previous + rules. There are + examples below of how this is useful. + + + mime-type is the MIME type of the attachment you + want the command to affect. A MIME type is always of the format + major/minor, where major + describes the broad category of document you're looking at, and + minor describes the specific type within that + category. The major part of mime-type must be literal text (or the + special token *), but the minor + part may be a regular expression. (Therefore, + */.* matches any MIME type.) + + + The MIME types you give to the attachments directive + are a kind of pattern. When you use the attachments + directive, the patterns you specify are added to a list. When you use + unattachments, the pattern is removed from the list. + The patterns are not expanded and matched to specific MIME types at + this time – they're just text in a list. They're only matched when + actually evaluating a message. + + + Some examples might help to illustrate. The examples that are not + commented out define the default configuration of the lists. + Attachment counting @@ -9304,16 +10133,18 @@ attachments -I message/external-body - Entering the command - - attachments?as a command will list your - current settings in neomuttrc format, so that it can be pasted - elsewhere. + + Entering the command attachments ? as + a command will list your current settings in neomuttrc format, so that + it can be pasted elsewhere. + MIME Lookup - Usage: + + Usage: + mime_lookup @@ -9332,30 +10163,29 @@ attachments -I message/external-body - NeoMutt's - mime_lookup list specifies a list of MIME types that - should - not be treated according to their mailcap entry. This - option is designed to deal with binary types such as - application/octet-stream. When an attachment's MIME - type is listed in - mime_lookup, then the extension of the filename will - be compared to the list of extensions in the - mime.types file. The MIME type 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: + + NeoMutt's mime_lookup list specifies a list of MIME + types that should not be treated according to + their mailcap entry. This option is designed to deal with binary types + such as application/octet-stream. When an + attachment's MIME type is listed in mime_lookup, + then the extension of the filename will be compared to the list of + extensions in the mime.types file. The MIME type + 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 - In addition, the - unmime_lookup command may be used to disable this - feature for any particular MIME type if it had been set, for example, in - a global - .neomuttrc. + + In addition, the unmime_lookup command may be used + to disable this feature for any particular MIME type if it had been + set, for example, in a global .neomuttrc. + @@ -9367,59 +10197,64 @@ mime_lookup application/octet-stream application/X-Lotus-Manuscript Enabling/Disabling Features - NeoMutt supports several of optional features which can be enabled - or disabled at compile-time by giving the - configure script certain arguments. These are - listed in the - Optional features section of the - configure --help output. - Which features are enabled or disabled can later be determined - from the output of - neomutt -v. If a compile option starts with - +it is enabled and disabled if prefixed with - -. For example, if NeoMutt was compiled using GnuTLS for - encrypted communication instead of OpenSSL, - neomutt -v would contain: + + NeoMutt supports several of optional features which can be enabled or + disabled at compile-time by giving the configure + script certain arguments. These are listed in the + Optional features section of the + configure --help output. + + + Which features are enabled or disabled can later be determined from + the output of neomutt -v. If a compile option + starts with + it is enabled and disabled if prefixed + with -. For example, if NeoMutt was compiled using + GnuTLS for encrypted communication instead of OpenSSL, + neomutt -v would contain: + -openssl +gnutls URL Syntax - NeoMutt optionally supports the IMAP, POP3 and SMTP protocols which - require to access servers using URLs. The canonical syntax for - specifying URLs in NeoMutt is (an item enclosed in - []means it is optional and may be omitted): + + NeoMutt optionally supports the IMAP, POP3 and SMTP protocols which + require to access servers using URLs. The canonical syntax for + specifying URLs in NeoMutt is (an item enclosed in + [] means it is optional and may be omitted): + proto[s]://[username[:password]@]server[:port][/path] - proto is the communication protocol: - imap for IMAP, - pop for POP3 and - smtp for SMTP. If - s for - secure communication is appended, NeoMutt will attempt to - establish an encrypted communication using SSL or TLS. - Since all protocols supported by NeoMutt support/require - authentication, login credentials may be specified in the URL. This has - the advantage that multiple IMAP, POP3 or SMTP servers may be specified - (which isn't possible using, for example, - $imap_user). The username may contain - the - @symbol being used by many mail systems as part of the - login name. The special characters - /( - %2F), - :( - %3A) and - %( - %25) have to be URL-encoded in usernames using the - %-notation. - A password can be given, too but is not recommended if the URL is - specified in a configuration file on disk. - If no port number is given, NeoMutt will use the system's default - for the given protocol (usually consulting - /etc/services). - The optional path is only relevant for IMAP and ignored - elsewhere. + proto is the communication protocol: + imap for IMAP, pop for POP3 and + smtp for SMTP. If s for + secure communication is appended, NeoMutt will attempt + to establish an encrypted communication using SSL or TLS. + + + Since all protocols supported by NeoMutt support/require + authentication, login credentials may be specified in the URL. This + has the advantage that multiple IMAP, POP3 or SMTP servers may be + specified (which isn't possible using, for example, + $imap_user). The username may contain + the @ symbol being used by many mail systems as part + of the login name. The special characters / + (%2F), : (%3A) + and % (%25) have to be URL-encoded + in usernames using the %-notation. + + + A password can be given, too but is not recommended if the URL is + specified in a configuration file on disk. + + + If no port number is given, NeoMutt will use the system's default for + the given protocol (usually consulting + /etc/services). + + + The optional path is only relevant for IMAP and ignored elsewhere. + URLs @@ -9435,177 +10270,211 @@ smtp://user@host:587/ SSL/TLS Support - If NeoMutt is compiled with IMAP, POP3 and/or SMTP support, it can - also be compiled with support for SSL or TLS using either OpenSSL or - GnuTLS ( by running the - configure script with the - --enable-ssl=...option for OpenSSL or - --enable-gnutls=...for GnuTLS). NeoMutt can then - attempt to encrypt communication with remote servers if these protocols - are suffixed with - s for - secure communication. + + If NeoMutt is compiled with IMAP, POP3 and/or SMTP support, it can also + be compiled with support for SSL or TLS using either OpenSSL or GnuTLS + (by running the configure script with the + --enable-ssl=... option for OpenSSL or + --enable-gnutls=... for GnuTLS). NeoMutt can then + attempt to encrypt communication with remote servers if these protocols + are suffixed with s for + secure communication. + POP3 Support - NeoMutt has POP3 support and has the ability to work with mailboxes - located on a remote POP3 server and fetch mail for local - browsing. - Remote POP3 servers can be accessed using URLs with the - pop protocol for unencrypted and - pops for encrypted communication, see - for details. - Polling for new mail is more expensive over POP3 than locally. For - this reason the frequency at which NeoMutt will check for mail remotely can - be controlled by the - $pop_checkinterval variable, - which defaults to every 60 seconds. - POP is read-only which doesn't allow for some features like editing - messages or changing flags. However, using - and - NeoMutt simulates the new/old/read flags as - well as flagged and replied. NeoMutt applies some logic on top of remote - messages but cannot change them so that modifications of flags are lost - when messages are downloaded from the POP server (either by NeoMutt or other - tools). + + NeoMutt has POP3 support and has the ability to work with mailboxes + located on a remote POP3 server and fetch mail for local browsing. + + + Remote POP3 servers can be accessed using URLs with the + pop protocol for unencrypted and + pops for encrypted communication, see + for details. + + + Polling for new mail is more expensive over POP3 than locally. For this + reason the frequency at which NeoMutt will check for mail remotely can + be controlled by the + $pop_checkinterval variable, + which defaults to every 60 seconds. + + + POP is read-only which doesn't allow for some features like editing + messages or changing flags. However, using + and + NeoMutt simulates the new/old/read flags as well as flagged and + replied. NeoMutt applies some logic on top of remote messages but + cannot change them so that modifications of flags are lost when + messages are downloaded from the POP server (either by NeoMutt or other + tools). + - Another way to access your POP3 mail is the - <fetch-mail>function (default: G). It allows to - connect to - $pop_host, fetch all your new mail and - place it in the local - $spoolfile. After this point, NeoMutt runs - exactly as if the mail had always been local. + + Another way to access your POP3 mail is the + <fetch-mail> function (default: G). It allows + to connect to $pop_host, fetch all your + new mail and place it in the local + $spoolfile. After this point, NeoMutt + runs exactly as if the mail had always been local. + - If you only need to fetch all messages to a local mailbox you - should consider using a specialized program, such as - fetchmail(1), - getmail(1)or similar. + + If you only need to fetch all messages to a local mailbox you should + consider using a specialized program, such as + fetchmail(1), getmail(1) or + similar. + IMAP Support - NeoMutt has IMAP support and has the ability to work with folders - located on a remote IMAP server. - You can access the remote inbox by selecting the folder by its URL - (see - for details) using the - imap or - imaps protocol. Alternatively, a pine-compatible - notation is also supported, i.e. - - {[username@]imapserver[:port][/ssl]}path/to/folder - Note that not all servers use - /as the hierarchy separator. NeoMutt should correctly notice - which separator is being used by the server and convert paths - accordingly. - When browsing folders on an IMAP server, you can toggle whether to - look at only the folders you are subscribed to, or all folders with the - toggle-subscribed command. See also the - - $imap_list_subscribed variable. - Polling for new mail on an IMAP server can cause noticeable delays. - So, you'll want to carefully tune the - $mail_check and - $timeout variables. Reasonable values - are: + + NeoMutt has IMAP support and has the ability to work with folders + located on a remote IMAP server. + + + You can access the remote inbox by selecting the folder by its URL (see + for details) using the + imap or imaps protocol. + Alternatively, a pine-compatible notation is also supported, i.e. + {[username@]imapserver[:port][/ssl]}path/to/folder + + + Note that not all servers use / as the hierarchy + separator. NeoMutt should correctly notice which separator is being + used by the server and convert paths accordingly. + + + When browsing folders on an IMAP server, you can toggle whether to look + at only the folders you are subscribed to, or all folders with the + toggle-subscribed command. See also the + $imap_list_subscribed + variable. + + + Polling for new mail on an IMAP server can cause noticeable delays. + So, you'll want to carefully tune the + $mail_check and + $timeout variables. Reasonable values + are: + set mail_check=90 set timeout=15 - with relatively good results even over slow modem lines. + + with relatively good results even over slow modem lines. + - 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 selects the same folder. + + 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 selects the same folder. + The IMAP Folder Browser - As of version 1.2, NeoMutt supports browsing mailboxes on an IMAP - server. This is mostly the same as the local file browser, with the - following differences: + + As of version 1.2, NeoMutt 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, NeoMutt 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 subfolders. + + In lieu of file permissions, NeoMutt 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 subfolders. + - For the case where an entry can contain both messages and - subfolders, the selection key (bound to - enter by default) 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). + + For the case where an entry can contain both messages and + subfolders, the selection key (bound to enter + by default) 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 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). + + 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). + Authentication - NeoMutt supports four authentication methods with IMAP servers: - SASL, GSSAPI, CRAM-MD5, and LOGIN. There is also support for - the pseudo-protocol ANONYMOUS, which allows you to log in to a public - IMAP server without having an account. To use ANONYMOUS, simply make - your username blank or - anonymous. - SASL is a special super-authenticator, which selects among - several protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and - DIGEST-MD5) the most secure method available on your host and the - server. Using some of these methods (including DIGEST-MD5 and possibly - GSSAPI), your entire session will be encrypted and invisible to those - teeming network snoops. It is the best option if you have it. To use - it, you must have the Cyrus SASL library installed on your system and - compile NeoMutt with the - --with-sasl flag. - NeoMutt will try whichever methods are compiled in and available on - the server, in the following order: SASL, ANONYMOUS, GSSAPI, CRAM-MD5, - LOGIN. - There are a few variables which control authentication: + + NeoMutt supports four authentication methods with IMAP servers: SASL, + GSSAPI, CRAM-MD5, and LOGIN. There is also support for the + pseudo-protocol ANONYMOUS, which allows you to log in to a public + IMAP server without having an account. To use ANONYMOUS, simply make + your username blank or anonymous. + + + SASL is a special super-authenticator, which selects among several + protocols (including GSSAPI, CRAM-MD5, ANONYMOUS, and DIGEST-MD5) the + most secure method available on your host and the server. Using some + of these methods (including DIGEST-MD5 and possibly GSSAPI), your + entire session will be encrypted and invisible to those teeming + network snoops. It is the best option if you have it. To use it, you + must have the Cyrus SASL library installed on your system and compile + NeoMutt with the --with-sasl flag. + + + NeoMutt will try whichever methods are compiled in and available on + the server, in the following order: SASL, ANONYMOUS, GSSAPI, + CRAM-MD5, LOGIN. + + + There are a few variables which control authentication: + - $imap_user- 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 (i.e. by using a mailbox name of the form - {user@host}). + $imap_user – 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 (i.e. by using a mailbox name of the + form {user@host}). + - $imap_pass- a password which you - may preset, used by all authentication methods where a password is - needed. + $imap_pass – a password which + you may preset, used by all authentication methods where + a password is needed. + - $imap_authenticators- a - colon-delimited list of IMAP authentication methods to try, in the - order you wish to try them. If specified, this overrides NeoMutt's - default (attempt everything, in the order listed above). + $imap_authenticators + – a colon-delimited list of IMAP authentication methods to try, + in the order you wish to try them. If specified, this overrides + NeoMutt's default (attempt everything, in the order listed + above). + @@ -9613,27 +10482,36 @@ set timeout=15 SMTP Support - Besides supporting traditional mail delivery through a - sendmail-compatible program, NeoMutt supports delivery through SMTP. - If the configuration variable - $smtp_url is set, NeoMutt will contact the - given SMTP server to deliver messages; if it is unset, NeoMutt will use the - program specified by - $sendmail. - For details on the URL syntax, please see - . - The built-in SMTP support supports encryption (the - smtps protocol using SSL or TLS) as well as SMTP - authentication using SASL. The authentication mechanisms for SASL are - specified in - $smtp_authenticators defaulting - to an empty list which makes NeoMutt try all available methods from - most-secure to least-secure. + + Besides supporting traditional mail delivery through + a sendmail-compatible program, NeoMutt supports delivery through SMTP. + + + If the configuration variable $smtp_url + is set, NeoMutt will contact the given SMTP server to deliver messages; + if it is unset, NeoMutt will use the program specified by + $sendmail. + + + For details on the URL syntax, please see + . + + + The built-in SMTP support supports encryption (the + smtps protocol using SSL or TLS) as well as SMTP + authentication using SASL. The authentication mechanisms for SASL are + specified in + $smtp_authenticators + defaulting to an empty list which makes NeoMutt try all available + methods from most-secure to least-secure. + Managing Multiple Accounts - Usage: + + Usage: + account-hook @@ -9643,27 +10521,27 @@ set timeout=15 command - If you happen to have accounts on multiple IMAP, POP and/or SMTP - servers, you may find managing all the authentication settings - inconvenient and error-prone. The - - account-hook - command may help. This hook works like - - folder-hook - but is invoked whenever NeoMutt needs to access a remote mailbox - (including inside the folder browser), not just when you open the - mailbox. This includes (for example) polling for new mail, storing Fcc - messages and saving messages to a folder. As a consequence, - - account-hook - should only be used to set connection-related settings such as - passwords or tunnel commands but not settings such as sender address or - name (because in general it should be considered unpredictable which - - account-hook - was last used). - Some examples: + + If you happen to have accounts on multiple IMAP, POP and/or SMTP + servers, you may find managing all the authentication settings + inconvenient and error-prone. The + account-hook + command may help. This hook works like + folder-hook but + is invoked whenever NeoMutt needs to access a remote mailbox (including + inside the folder browser), not just when you open the mailbox. This + includes (for example) polling for new mail, storing Fcc messages and + saving messages to a folder. As a consequence, + account-hook + should only be used to set connection-related settings such as + passwords or tunnel commands but not settings such as sender address or + name (because in general it should be considered unpredictable which + account-hook was + last used). + + + Some examples: + account-hook . 'unset imap_user; unset imap_pass; unset tunnel' @@ -9672,14 +10550,13 @@ account-hook imap://host2/ 'set tunnel="ssh host2 /usr/libexec/imapd"' account-hook smtp://user@host3/ 'set tunnel="ssh host3 /usr/libexec/smtpd"' - To manage multiple accounts with, for example, different values of - $record or sender addresses, - - folder-hook - has to be be used together with the - - mailboxes - command. + + To manage multiple accounts with, for example, different values of + $record or sender addresses, + folder-hook has + to be be used together with the + mailboxes command. + Managing multiple accounts @@ -9691,162 +10568,187 @@ folder-hook imap://user@host2/ 'set folder=imap://host2/ ; set record=+INBOX/Sen - In example - the folders are defined using - - mailboxes - so NeoMutt polls them for new mail. Each - - folder-hook - triggers when one mailbox below each IMAP account is opened and - sets - $folder to the account's root folder. Next, - it sets - $record to the - INBOX/Sent folder below the newly set - $folder. Please notice that the value the - + - mailbox shortcut refers to depends on the - current value of - $folder and therefore has to be set - separately per account. Setting other values like - $from or - $signature is analogous to setting - $record. + + In example + the folders are defined using + mailboxes so + NeoMutt polls them for new mail. Each + folder-hook + triggers when one mailbox below each IMAP account is opened and sets + $folder to the account's root folder. + Next, it sets + $record to the + INBOX/Sent folder below the newly set + $folder. Please notice that the value the + + mailbox shortcut + refers to depends on the current value of + $folder and therefore has to be set + separately per account. Setting other values like + $from or + $signature is analogous to setting + $record. + Local Caching - NeoMutt contains two types of local caching: - (1)the so-called - header caching and - (2)the so-called - body caching which are both described in this - section. - Header caching is optional as it depends on external libraries, - body caching is always enabled if NeoMutt is compiled with POP and/or IMAP - support as these use it (body caching requires no external - library). + + NeoMutt contains two types of local caching: (1) + the so-called header caching and + (2) the so-called body caching + which are both described in this section. + + + Header caching is optional as it depends on external libraries, body + caching is always enabled if NeoMutt is compiled with POP and/or IMAP + support as these use it (body caching requires no external library). + Header Caching - NeoMutt provides optional support for caching message headers for - the following types of folders: IMAP, POP, Maildir and MH. Header - caching greatly speeds up opening large folders because for remote - folders, headers usually only need to be downloaded once. For Maildir - and MH, reading the headers from a single file is much faster than - looking at possibly thousands of single files (since Maildir and MH use - one file per message.) - Header caching can be enabled by configuring one of the database - backends. One of tokyocabinet, kyotocabinet, qdbm, gdbm, lmdb or - bdb. - If enabled, - $header_cache can be used to either - point to a file or a directory. If set to point to a file, one database - file for all folders will be used (which may result in lower - performance), but one file per folder if it points to a - directory. - Additionally, - $header_cache_backend can be - used to specify which backend to use. The list of available backends - can be specified at configure time with a set of --with-<backend> - options. Currently, the following backends are supported: tokyocabinet, - kyotocabinet, qdbm, gdbm, bdb, lmdb. + + NeoMutt provides optional support for caching message headers for the + following types of folders: IMAP, POP, Maildir and MH. Header caching + greatly speeds up opening large folders because for remote folders, + headers usually only need to be downloaded once. For Maildir and MH, + reading the headers from a single file is much faster than looking at + possibly thousands of single files (since Maildir and MH use one file + per message.) + + + Header caching can be enabled by configuring one of the database + backends. One of tokyocabinet, kyotocabinet, qdbm, gdbm, lmdb or bdb. + + + If enabled, $header_cache can be + used to either point to a file or a directory. If set to point to + a file, one database file for all folders will be used (which may + result in lower performance), but one file per folder if it points to + a directory. + + + Additionally, + $header_cache_backend can + be used to specify which backend to use. The list of available + backends can be specified at configure time with a set of + --with-<backend> options. Currently, the following backends are + supported: tokyocabinet, kyotocabinet, qdbm, gdbm, bdb, lmdb. + Body Caching - Both cache methods can be combined using the same directory for - storage (and for IMAP/POP even provide meaningful file names) which - simplifies manual maintenance tasks. - In addition to caching message headers only, NeoMutt can also cache - whole message bodies. This results in faster display of messages for - POP and IMAP folders because messages usually have to be downloaded - only once. - For configuration, the variable - $message_cachedir must point to - a directory. There, NeoMutt will create a hierarchy of subdirectories - named like the account and mailbox path the cache is for. + + Both cache methods can be combined using the same directory for + storage (and for IMAP/POP even provide meaningful file names) which + simplifies manual maintenance tasks. + + + In addition to caching message headers only, NeoMutt can also cache + whole message bodies. This results in faster display of messages for + POP and IMAP folders because messages usually have to be downloaded + only once. + + + For configuration, the variable + $message_cachedir must point + to a directory. There, NeoMutt will create a hierarchy of + subdirectories named like the account and mailbox path the cache is + for. + Cache Directories - For using both, header and body caching, - $header_cache and - $message_cachedir can be safely - set to the same value. - In a header or body cache directory, NeoMutt creates a directory - hierarchy named like: - proto:user@hostname where - proto is either - pop or - imap.Within there, for each folder, NeoMutt stores messages - in single files and header caches in files with the - .hcache extension. All files can be removed as needed if - the consumed disk space becomes an issue as NeoMutt will silently fetch - missing items again. Pathnames are always stored in UTF-8 - encoding. - For Maildir and MH, the header cache files are named after the - MD5 checksum of the path. + + For using both, header and body caching, + $header_cache and + $message_cachedir can be + safely set to the same value. + + + In a header or body cache directory, NeoMutt creates a directory + hierarchy named like: proto:user@hostname where + proto is either pop or + imap. Within there, for each folder, NeoMutt stores + messages in single files and header caches in files with the + .hcache extension. All files can be removed as needed + if the consumed disk space becomes an issue as NeoMutt will silently + fetch missing items again. Pathnames are always stored in UTF-8 + encoding. + + + For Maildir and MH, the header cache files are named after the MD5 + checksum of the path. + Maintenance - NeoMutt does not (yet) support maintenance features for header cache - database files so that files have to be removed in case they grow too - big. It depends on the database library used for header caching whether - disk space freed by removing messages is re-used. - For body caches, NeoMutt can keep the local cache in sync with the - remote mailbox if the - $message_cache_clean variable - is set. Cleaning means to remove messages from the cache which are no - longer present in the mailbox which only happens when other mail - clients or instances of NeoMutt using a different body cache location - delete messages (NeoMutt itself removes deleted messages from the cache - when syncing a mailbox). As cleaning can take a noticeable amount of - time, it should not be set in general but only occasionally. + + NeoMutt does not (yet) support maintenance features for header cache + database files so that files have to be removed in case they grow too + big. It depends on the database library used for header caching + whether disk space freed by removing messages is re-used. + + + For body caches, NeoMutt can keep the local cache in sync with the + remote mailbox if the + $message_cache_clean + variable is set. Cleaning means to remove messages from the cache + which are no longer present in the mailbox which only happens when + other mail clients or instances of NeoMutt using a different body + cache location delete messages (NeoMutt itself removes deleted + messages from the cache when syncing a mailbox). As cleaning can take + a noticeable amount of time, it should not be set in general but only + occasionally. + Sending Anonymous Messages via Mixmaster - You may also have compiled NeoMutt to co-operate with Mixmaster, an - anonymous remailer. Mixmaster permits you to send your messages - anonymously using a chain of remailers. Mixmaster support in NeoMutt is for - mixmaster version 2.04 or later. - To use it, you'll have to obey certain restrictions. Most - important, you cannot use the - Cc and - Bcc headers. To tell NeoMutt to use mixmaster, you have to - select a remailer chain, using the mix function on the compose - menu. - The chain selection screen is divided into two parts. In the - (larger) upper part, you get a list of remailers you may use. In the - lower part, you see the currently selected chain of remailers. - You can navigate in the chain using the - <chain-prev>and - <chain-next>functions, which are by default - bound to the left and right arrows and to the - h and - l keys (think vi keyboard bindings). To insert a - remailer at the current chain position, use the - <insert>function. To append a remailer behind - the current chain position, use - <select-entry>or - <append>. You can also delete entries from the - chain, using the corresponding function. Finally, to abandon your - changes, leave the menu, or - <accept>them pressing (by default) the - Return key. - Note that different remailers do have different capabilities, - indicated in the %c entry of the remailer menu lines (see - $mix_entry_format). Most - important is the - middleman capability, indicated by a capital - M: This means that the remailer in question cannot be used - as the final element of a chain, but will only forward messages to other - mixmaster remailers. For details on the other capabilities, please have a - look at the mixmaster documentation. + + You may also have compiled NeoMutt to co-operate with Mixmaster, an + anonymous remailer. Mixmaster permits you to send your messages + anonymously using a chain of remailers. Mixmaster support in NeoMutt is + for mixmaster version 2.04 or later. + + + To use it, you'll have to obey certain restrictions. Most important, + you cannot use the Cc and Bcc + headers. To tell NeoMutt to use mixmaster, you have to select + a remailer chain, using the mix function on the compose menu. + + + The chain selection screen is divided into two parts. In the (larger) + upper part, you get a list of remailers you may use. In the lower part, + you see the currently selected chain of remailers. + + + You can navigate in the chain using the + <chain-prev> and + <chain-next> functions, which are by default + bound to the left and right arrows and to the h and + l keys (think vi keyboard bindings). To insert + a remailer at the current chain position, use the + <insert> function. To append a remailer behind + the current chain position, use <select-entry> + or <append>. You can also delete entries from + the chain, using the corresponding function. Finally, to abandon your + changes, leave the menu, or <accept> them + pressing (by default) the Return key. + + + Note that different remailers do have different capabilities, indicated + in the %c entry of the remailer menu lines (see + $mix_entry_format). Most + important is the middleman capability, indicated by + a capital M: This means that the remailer in question + cannot be used as the final element of a chain, but will only forward + messages to other mixmaster remailers. For details on the other + capabilities, please have a look at the mixmaster documentation. + @@ -9857,27 +10759,31 @@ folder-hook imap://user@host2/ 'set folder=imap://host2/ ; set record=+INBOX/Sen Support - Since:NeoMutt 2016-09-10 + Since: NeoMutt 2016-09-10 + - Dependencies:None + Dependencies: None + Introduction - This feature allows specifying regexes to color attachment - headers just like the mail body would. The headers are the parts - colored by the - attachment color. Coloring them is useful to - highlight the results of GPGME's signature checks or simply the - mimetype or size of the attachment. Only the part matched by the regex - is colored. + + This feature allows specifying regexes to color attachment headers + just like the mail body would. The headers are the parts colored by + the attachment color. Coloring them is useful to + highlight the results of GPGME's signature checks or simply the + mimetype or size of the attachment. Only the part matched by the + regex is colored. + Usage - The - attach_headers color should be used just like the - body color. + + The attach_headers color should be used just like + the body color. + color attach_headers foreground background pattern @@ -9930,15 +10836,19 @@ color attach_headers brightmagenta default "invalid node with packet Known Bugs - None + + None + Credits - Guillaume Brogi - gui-gui@netcourrier.com + + Guillaume Brogi + gui-gui@netcourrier.com + @@ -9951,24 +10861,32 @@ color attach_headers brightmagenta default "invalid node with packet Support - Since:NeoMutt 2016-10-02 + Since: NeoMutt 2016-10-02 + - Dependencies:None + Dependencies: None + Introduction - The compose-to-sender feature adds a new command to start composing - a new email to the sender of the current message. This is not a reply, - but a new, separate, message. - It works on tagged messages too, sending one email to all of the - senders of the tagged messages. + + The compose-to-sender feature adds a new command to start composing + a new email to the sender of the current message. This is not + a reply, but a new, separate, message. + + + It works on tagged messages too, sending one email to all of the + senders of the tagged messages. + Functions - compose-to-sender adds the following function to NeoMutt. By - default, it is not bound to a key. + + compose-to-sender adds the following function to NeoMutt. By default, + it is not bound to a key. + compose-to-sender Functions @@ -10013,18 +10931,24 @@ bind index,pager @ compose-to-sender Known Bugs - None + + None + Credits - Brian Medley + + Brian Medley + - Guillaume Brogi - gui-gui@netcourrier.com + + Guillaume Brogi + gui-gui@netcourrier.com + @@ -10037,27 +10961,34 @@ bind index,pager @ compose-to-sender Support - Since:NeoMutt 2016-05-30 + Since: NeoMutt 2016-05-30 + - Dependencies:None + Dependencies: None + Introduction - The Compressed Folder feature allows NeoMutt to read mailbox files - that are compressed. But it isn't limited to compressed files. It works - well with encrypted files, too. In fact, if you can create a - program/script to convert to and from your format, then NeoMutt can read - it. - The feature adds three hooks to NeoMutt: - open-hook, - close-hook and - append-hook. They define commands to: uncompress a - file; compress a file; append messages to an already compressed - file. - There are some examples of both compressed and encrypted files, - later. For now, the documentation will just concentrate on compressed - files. + + The Compressed Folder feature allows NeoMutt to read mailbox files + that are compressed. But it isn't limited to compressed files. It + works well with encrypted files, too. In fact, if you can create + a program/script to convert to and from your format, then NeoMutt can + read it. + + + The feature adds three hooks to NeoMutt: + open-hook, close-hook and + append-hook. They define commands to: uncompress + a file; compress a file; append messages to an already compressed + file. + + + There are some examples of both compressed and encrypted files, + later. For now, the documentation will just concentrate on compressed + files. + @@ -10085,18 +11016,18 @@ bind index,pager @ compose-to-sender shell-command - The shell-command must contain two placeholders for filenames: - %f and - %t. These represent - from and - to filenames. These placeholders should be placed inside - single-quotes to prevent unintended shell expansions. - If you need the exact string - %f or - %t in your command, simply double up the - %character, e.g. - %%f or - %%t. + + The shell-command must contain two placeholders for filenames: + %f and %t. These represent + from and to filenames. These + placeholders should be placed inside single-quotes to prevent + unintended shell expansions. + + + If you need the exact string %f or %t + in your command, simply double up the % character, + e.g. %%f or %%t. +
Not all Hooks are Required @@ -10146,13 +11077,19 @@ bind index,pager @ compose-to-sender
- The command: + + The command: + - should return a non-zero exit status on failure + + should return a non-zero exit status on failure + - should not delete any files + + should not delete any files + @@ -10160,11 +11097,14 @@ bind index,pager @ compose-to-sender Read from compressed mailbox open-hook regex shell-command - If NeoMutt is unable to open a file, it then looks for - open-hook that matches the filename. - If your compression program doesn't have a well-defined - extension, then you can use - .as the regex. + + If NeoMutt is unable to open a file, it then looks for + open-hook that matches the filename. + + + If your compression program doesn't have a well-defined extension, + then you can use . as the regex. + Example of @@ -10176,18 +11116,22 @@ open-hook '\.gz$' "gzip --stdout --decompress '%f' > '%t'" <itemizedlist> <listitem> - <para>NeoMutt finds a file, - <quote>example.gz</quote>, that it can't read</para> + <para> + NeoMutt finds a file, <quote>example.gz</quote>, that it + can't read + </para> </listitem> <listitem> - <para>NeoMutt has an - <literal>open-hook</literal> whose regex matches the filename: - <literal>\.gz$</literal></para> + <para> + NeoMutt has an <literal>open-hook</literal> whose regex + matches the filename: <literal>\.gz$</literal> + </para> </listitem> <listitem> - <para>NeoMutt uses the command - <literal>gzip -cd</literal> to create a temporary file that it - <emphasis>can</emphasis> read</para> + <para> + NeoMutt uses the command <literal>gzip -cd</literal> to + create a temporary file that it <emphasis>can</emphasis> read + </para> </listitem> </itemizedlist> </sect4> @@ -10196,13 +11140,17 @@ open-hook '\.gz$' "gzip --stdout --decompress '%f' > '%t'" <sect3 id="close-hook"> <title>Write to a compressed mailbox close-hook regex shell-command - When NeoMutt has finished with a compressed mail folder, it will - look for a matching - close-hook to recompress the file. This hook is - optional. + + When NeoMutt has finished with a compressed mail folder, it will + look for a matching close-hook to recompress the + file. This hook is + optional. + - If the folder has not been modified, the - close-hook will not be called. + + If the folder has not been modified, the + close-hook will not be called. + @@ -10211,29 +11159,35 @@ open-hook '\.gz$' "gzip --stdout --decompress '%f' > '%t'" close-hook '\.gz$' "gzip --stdout '%t' > '%f'" - NeoMutt has finished with a folder, - example.gz, that it opened with - open-hook + + NeoMutt has finished with a folder, + example.gz, that it opened with + open-hook + - The folder has been modified + + The folder has been modified + - NeoMutt has a - close-hook whose regex matches the filename: - \.gz$ + + NeoMutt has a close-hook whose regex + matches the filename: \.gz$ + - NeoMutt uses the command - gzip -c to create a new compressed - file + + NeoMutt uses the command gzip -c to create + a new compressed file + - The - close-hook can also include extra options, e.g. - compression level: - --best + + The close-hook can also include extra + options, e.g. compression level: --best + @@ -10241,26 +11195,32 @@ open-hook '\.gz$' "gzip --stdout --decompress '%f' > '%t'" Append to a compressed mailbox append-hook regex shell-command - When NeoMutt wants to append an email to a compressed mail folder, - it will look for a matching - append-hook. This hook is - optional. - Using the - append-hook will save time, but NeoMutt won't be able - to determine the type of the mail folder inside the compressed - file. - NeoMutt will - assume the type to be that of the - $mbox_type variable. NeoMutt also uses this type for - temporary files. - NeoMutt will only use the - append-hook for existing files. The - close-hook will be used for empty, or missing - files. + + When NeoMutt wants to append an email to a compressed mail folder, + it will look for a matching append-hook. This + hook is optional. + + + Using the append-hook will save time, but + NeoMutt won't be able to determine the type of the mail folder + inside the compressed file. + + + NeoMutt will assume the type to be that of the + $mbox_type variable. NeoMutt also uses this type + for temporary files. + + + NeoMutt will only use the append-hook for + existing files. The close-hook will be used for + empty, or missing files. + - If your command writes to stdout, it is vital that you use - >>in the - append-hook. If not, data will be lost. + + If your command writes to stdout, it is vital that you use + >> in the append-hook. If + not, data will be lost. + @@ -10273,49 +11233,57 @@ append-hook '\.gz$' "gzip --stdout '%t' >> '%f'" - NeoMutt wants to append an email to a folder, - example.gz, that it opened with - open-hook + + NeoMutt wants to append an email to a folder, + example.gz, that it opened with + open-hook + - NeoMutt has an - append-hook whose regex matches the - filename: - \.gz$ + + NeoMutt has an append-hook whose regex + matches the filename: \.gz$ + - NeoMutt knows the mailbox type from the - $mbox variable + + NeoMutt knows the mailbox type from the + $mbox variable + - NeoMutt uses the command - gzip -c to append to an existing compressed - file + + NeoMutt uses the command gzip -c to append + to an existing compressed file + - The - append-hook can also include extra options, - e.g. compression level: - --best + + The append-hook can also include extra + options, e.g. compression level: --best + Empty Files - NeoMutt assumes that an empty file is not compressed. In this - situation, unset - $save_empty, so that the compressed - file will be removed if you delete all of the messages. + + NeoMutt assumes that an empty file is not compressed. In this + situation, unset $save_empty, so + that the compressed file will be removed if you delete all of the + messages. + Security - Encrypted files are decrypted into temporary files which are - stored in the - $tmpdir directory. This could be a - security risk. + + Encrypted files are decrypted into temporary files which are stored + in the $tmpdir directory. This could + be a security risk. + @@ -10395,25 +11363,34 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' & Credits - Roland Rosenfeld - roland@spinnaker.de + + Roland Rosenfeld + roland@spinnaker.de + - Alain Penders - Alain@Finale-Dev.com + + Alain Penders + Alain@Finale-Dev.com + - Christoph - Myon Berg - myon@debian.org + + Christoph Myon Berg + myon@debian.org + - Evgeni Golov - evgeni@debian.org + + Evgeni Golov + evgeni@debian.org + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -10426,7 +11403,8 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' & Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + @@ -10443,17 +11421,20 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' & Introduction - The - Conditional Dates feature allows you to construct - $index_format expressions based on - the age of the email. - NeoMutt's default - $index_format displays email dates in the form: - abbreviated-month day-of-month — - Jan 14. - The format is configurable but only per-mailbox. This feature - allows you to configure the display depending on the age of the - email. + + The Conditional Dates feature allows you to construct + $index_format expressions based + on the age of the email. + + + NeoMutt's default $index_format displays email + dates in the form: abbreviated-month day-of-month – + Jan 14. + + + The format is configurable but only per-mailbox. This feature allows + you to configure the display depending on the age of the email. + Potential Formatting Scheme @@ -10497,28 +11478,38 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' &
- For an explanation of the date formatting strings, see - strftime(3). - By carefully picking your formats, the dates can remain - unambiguous and compact. - NeoMutt's conditional format strings have the form: (whitespace - introduced for clarity) + + For an explanation of the date formatting strings, see + strftime(3). + + + By carefully picking your formats, the dates can remain unambiguous + and compact. + + + NeoMutt's conditional format strings have the form: (whitespace + introduced for clarity) + %? TEST ? TRUE & FALSE ? - The examples below use the test - %[— the date of the message in the local timezone. They - will also work with - %(— the local time that the message arrived. - The date tests are of the form: + + The examples below use the test %[ – the date of the + message in the local timezone. They will also work with + %( – the local time that the message arrived. + + + The date tests are of the form: + %[nX? TRUE & FALSE ? - n is an optional count (defaults to 1 if - missing) + n is an optional count (defaults to 1 if missing) + - X is the time period + X is the time period + @@ -10612,7 +11603,9 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' & Example 1 - We start with a one-condition test. + + We start with a one-condition test. + Example 1 @@ -10647,10 +11640,14 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' &
- The $index_format string would contain: + + The $index_format string would contain: + %?[1m?%[%b %d]&%[%Y-%m-%d]? - Reparsed a little, for clarity, you can see the test condition - and the two format strings. + + Reparsed a little, for clarity, you can see the test condition and + the two format strings. + %?[1m? & ? @@ -10662,8 +11659,9 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' & Example 2 - This example contains three test conditions and four date - formats. + + This example contains three test conditions and four date formats. + Example 2 @@ -10718,14 +11716,18 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' &
- The $index_format string would contain: + + The $index_format string would contain: + %<[y?%<[m?%<[d?%[%H:%M ]&%[%a %d]>&%[%b %d]>&%[%m/%y ]> - Reparsed a little, for clarity, you can see the test conditions - and the four format strings. + + Reparsed a little, for clarity, you can see the test conditions and + the four format strings. + %<[y? &%[%m/%y ]> Older @@ -10734,8 +11736,10 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' & %[%H:%M ] Today - This a another view of the same example, with some whitespace - for clarity. + + This a another view of the same example, with some whitespace for + clarity. + %<[y? %<[m? %<[d? AAA & BBB > & CCC > & DDD > @@ -10748,9 +11752,10 @@ close-hook '\.gpg$' "gpg --encrypt --recipient YourGpgUserIdOrKeyId < '%t' & Variables - The - Conditional Dates feature doesn't have any config of its own. - It modifies the behavior of the format strings. + + The Conditional Dates feature doesn't have any config + of its own. It modifies the behavior of the format strings. + @@ -10800,30 +11805,35 @@ set index_format='%4C %Z %<[y?%<[m?%<[d?%[%H:%M ]&%[%a %d]>& Known Bugs - Date parsing doesn't quite do what you expect. - 1w doesn't mean the - in the last 7 days, but - - this week. This doesn't match the normal - NeoMutt behavior: for example - ~d>1w means emails dated in the last 7 - days. + + Date parsing doesn't quite do what you expect. 1w + doesn't mean the in the last 7 days, but + this week. This doesn't match the + normal NeoMutt behavior: for example ~d>1w + means emails dated in the last 7 days. + Credits - Aaron Schrab - aaron@schrab.com + + Aaron Schrab + aaron@schrab.com + - Eric Davis - edavis@insanum.com + + Eric Davis + edavis@insanum.com + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -10836,40 +11846,50 @@ set index_format='%4C %Z %<[y?%<[m?%<[d?%[%H:%M ]&%[%a %d]>& Support - Since:NeoMutt 2016-07-23 + Since: NeoMutt 2016-07-23 + - Dependencies:None + Dependencies: None + Introduction - Once you encrypt an email to someone you cannot read it. This is - good for security, but bad for record-keeping. If you wanted to keep a - copy of an encrypted email you could set - $fcc_clear. - A better option is to enable - $smime_self_encrypt, then set - $smime_default_key to your - personal S/MIME key id. + + Once you encrypt an email to someone you cannot read it. This is good + for security, but bad for record-keeping. If you wanted to keep + a copy of an encrypted email you could set + $fcc_clear. + + + A better option is to enable + $smime_self_encrypt, then + set $smime_default_key to + your personal S/MIME key id. + set smime_self_encrypt = yes set smime_default_key = bb345e23.0 - Or, if you use PGP, - $pgp_self_encrypt, then set - $pgp_default_key to your personal - PGP key id. + + Or, if you use PGP, + $pgp_self_encrypt, then set + $pgp_default_key to your + personal PGP key id. + set pgp_self_encrypt = yes set pgp_default_key = A4AF18C5582473BD35A1E9CE78BB3D480042198E - If you have different key for signing, then you can set - $pgp_sign_as or - $smime_sign_as respectively. + + If you have different key for signing, then you can set + $pgp_sign_as or + $smime_sign_as respectively. + @@ -10959,23 +11979,31 @@ set smime_default_key = "SMIME-KEY" Known Bugs - None + + None + Credits - Omen Wild - omen@mandarb.com + + Omen Wild + omen@mandarb.com + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + - Guillaume Brogi - gui-gui@netcourrier.com + + Guillaume Brogi + gui-gui@netcourrier.com + @@ -10988,7 +12016,8 @@ set smime_default_key = "SMIME-KEY" Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + @@ -10996,29 +12025,37 @@ set smime_default_key = "SMIME-KEY" - open_memstream(), - fmemopen()from glibc + open_memstream(), + fmemopen() from glibc + - This feature can be enabled by running - configure with the option - --enable-fmemopen + + This feature can be enabled by running configure + with the option --enable-fmemopen + Introduction - The - fmemopen feature speeds up some searches. - This feature changes a few places where NeoMutt creates temporary - files. It replaces them with in-memory buffers. This should improve the - performance when searching the header or body using the - $thorough_search option. - There are no user-configurable parts. - This feature depends on - open_memstream()and - fmemopen(). They are provided by glibc. Without - them, NeoMutt will simply create temporary files. + + The fmemopen feature speeds up some searches. + + + This feature changes a few places where NeoMutt creates temporary + files. It replaces them with in-memory buffers. This should improve + the performance when searching the header or body using the + $thorough_search option. + + + There are no user-configurable parts. + + + This feature depends on open_memstream() and + fmemopen(). They are provided by glibc. Without + them, NeoMutt will simply create temporary files. + @@ -11026,8 +12063,7 @@ set smime_default_key = "SMIME-KEY" - Compile-Time - Features + Compile-Time Features @@ -11041,8 +12077,7 @@ set smime_default_key = "SMIME-KEY" Known Bugs - - debian bug 834408 + debian bug 834408 @@ -11050,12 +12085,16 @@ set smime_default_key = "SMIME-KEY" Credits - Julius Plenz - plenz@cis.fu-berlin.de + + Julius Plenz + plenz@cis.fu-berlin.de + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -11069,19 +12108,23 @@ set smime_default_key = "SMIME-KEY" Support - Since:NeoMutt 2016-09-10 + Since: NeoMutt 2016-09-10 + - Dependencies:None + Dependencies: None + Introduction - The forgotten-attachment feature provides a new - setting for NeoMutt that alerts the user if the message body contains a - certain keyword but there are no attachments added. This is meant to - ensure that the user does not forget to attach a file after promising - to do so in the mail. The attachment keyword will not be scanned in - text matched by $quote_regex. + + The forgotten-attachment feature provides a new + setting for NeoMutt that alerts the user if the message body contains + a certain keyword but there are no attachments added. This is meant + to ensure that the user does not forget to attach a file after + promising to do so in the mail. The attachment keyword will not be + scanned in text matched by + $quote_regex. @@ -11165,8 +12208,7 @@ set abort_noattach_regex = "\\<attach(|ed|ments?)\\>" - The Attachment Menu key - mappings + The Attachment Menu key mappings @@ -11174,27 +12216,37 @@ set abort_noattach_regex = "\\<attach(|ed|ments?)\\>" Known Bugs - None + + None + Credits - Darshit Shah - darnir@gmail.com + + Darshit Shah + darnir@gmail.com + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + - Johannes Weißl - jargon@molb.org + + Johannes Weißl + jargon@molb.org + - Steven! Ragnarök - steven@nuclearsandwich.com + + Steven! Ragnarök + steven@nuclearsandwich.com + @@ -11206,23 +12258,27 @@ set abort_noattach_regex = "\\<attach(|ed|ments?)\\>" Introduction - These hooks are called when global events take place in - NeoMutt. + + These hooks are called when global events take place in NeoMutt. + Run a command... - timeout-hook- periodically + timeout-hook – periodically + - startup-hook- when NeoMutt starts up, - before opening the first mailbox + startup-hook – when NeoMutt + starts up, before opening the first mailbox + - shutdown-hook- NeoMutt shuts down, - before closing the last mailbox + shutdown-hook – NeoMutt shuts + down, before closing the last mailbox + @@ -11230,22 +12286,28 @@ set abort_noattach_regex = "\\<attach(|ed|ments?)\\>" Timeout Hook Run a command periodically - Since:NeoMutt 2016-08-08 - This feature implements a new hook that is called periodically - when NeoMutt checks for new mail. This hook is called every - $timeout seconds. + Since: NeoMutt 2016-08-08 + + + This feature implements a new hook that is called periodically when + NeoMutt checks for new mail. This hook is called every + $timeout seconds. + Startup Hook - Run a command when NeoMutt starts up, before opening the first - mailbox + Run a command when NeoMutt starts up, before opening the + first mailbox + + Since: NeoMutt 2016-11-25 + - Since:NeoMutt 2016-11-25 - This feature implements a new hook that is called when NeoMutt - first starts up, but before opening the first mailbox. This is most - likely to be useful to users of - notmuch. + This feature implements a new hook that is called when NeoMutt + first starts up, but before opening the first mailbox. This is most + likely to be useful to users of + notmuch. + @@ -11253,11 +12315,13 @@ set abort_noattach_regex = "\\<attach(|ed|ments?)\\>" Run a command when NeoMutt shuts down, before closing the last mailbox - Since:NeoMutt 2016-11-25 - This feature implements a hook that is called when NeoMutt shuts - down, but before closing the first mailbox. This is most likely to be - useful to users of - notmuch. + Since: NeoMutt 2016-11-25 + + + This feature implements a hook that is called when NeoMutt shuts + down, but before closing the first mailbox. This is most likely to + be useful to users of notmuch. + @@ -11317,23 +12381,31 @@ shutdown-hook 'exec sync-mailbox' Known Bugs - None + + None + Credits - Armin Wolfermann - armin@wolfermann.org + + Armin Wolfermann + armin@wolfermann.org + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + - Thomas Adam - thomas@xteddy.org + + Thomas Adam + thomas@xteddy.org + @@ -11346,17 +12418,20 @@ shutdown-hook 'exec sync-mailbox' Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + - Dependencies:None + Dependencies: None + Introduction - The - ifdef feature introduces three new commands to NeoMutt and - allow you to share one config file between versions of NeoMutt that may - have different features compiled in. + + The ifdef feature introduces three new commands to + NeoMutt and allow you to share one config file between versions of + NeoMutt that may have different features compiled in. + ifdef symbol config-command [args...] # If a symbol is defined @@ -11364,17 +12439,21 @@ ifndef symbol config-command [args...] # If a symbol i finish # Finish reading the current file - Here a symbol can be a - $variable, - <function>, - command or compile-time symbol, such as - imap. - A list of compile-time symbols can be seen in the output of the - command neomutt -v (in the Compile options - section). - finish is particularly useful when combined with - ifndef. e.g. + Here a symbol can be a $variable, + <function>, + command or compile-time symbol, such + as imap. + + + A list of compile-time symbols can be seen in the output of the + command neomutt -v (in the + Compile options section). + + + finish is particularly useful when combined with + ifndef. e.g. + # Sidebar config file @@ -11445,23 +12524,31 @@ ifndef sidebar finish Known Bugs - None + + None + Credits - Cedric Duval - cedricduval@free.fr + + Cedric Duval + cedricduval@free.fr + - Matteo F. Vescovi - mfvescovi@gmail.com + + Matteo F. Vescovi + mfvescovi@gmail.com + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -11474,7 +12561,8 @@ ifndef sidebar finish Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + @@ -11491,25 +12579,34 @@ ifndef sidebar finish Introduction - The - index-color feature allows you to specify colors for - individual parts of the email index. e.g. Subject, Author, - Flags. - First choose which part of the index you'd like to color. Then, - if needed, pick a pattern to match. - Note: The pattern does not have to refer to the object you wish - to color. e.g. + + The index-color feature allows you to specify colors + for individual parts of the email index. e.g. Subject, Author, Flags. + + + First choose which part of the index you'd like to color. Then, if + needed, pick a pattern to match. + + + Note: The pattern does not have to refer to the object you wish to + color. e.g. + color index_author red default "~sneomutt" - The author appears red when the subject (~s) contains - neomutt. + + The author appears red when the subject (~s) contains + neomutt. + Colors - All the colors default to - default, i.e. unset. - The index objects can be themed using the - color command. Some objects require a pattern. + + All the colors default to default, i.e. unset. + + + The index objects can be themed using the color + command. Some objects require a pattern. + color index-object foreground background @@ -11663,36 +12760,49 @@ color index_size cyan default Known Bugs - None + + None + Credits - Christian Aichinger - Greek0@gmx.net + + Christian Aichinger + Greek0@gmx.net + - Christoph - Myon Berg - myon@debian.org + + Christoph Myon Berg + myon@debian.org + - Elimar Riesebieter - riesebie@lxtec.de + + Elimar Riesebieter + riesebie@lxtec.de + - Eric Davis - edavis@insanum.com + + Eric Davis + edavis@insanum.com + - Vladimir Marek - Vladimir.Marek@oracle.com + + Vladimir Marek + Vladimir.Marek@oracle.com + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -11705,28 +12815,34 @@ color index_size cyan default Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + - Dependencies:None + Dependencies: None + Introduction - The - initials feature adds an expando (%I) for an author's - initials. - The index panel displays a list of emails. Its layout is - controlled by the - $index_format variable. Using this - expando saves space in the index panel. This can be useful if you are - regularly working with a small set of people. + + The initials feature adds an expando (%I) for an + author's initials. + + + The index panel displays a list of emails. Its layout is controlled + by the $index_format variable. + Using this expando saves space in the index panel. This can be useful + if you are regularly working with a small set of people. + Variables - This feature has no config of its own. It adds an expando which - can be used in the - $index_format variable. + + This feature has no config of its own. It adds an expando which can + be used in the $index_format + variable. + @@ -11784,19 +12900,25 @@ set index_format='%4C %Z %{%b %d} %I (%?l?%4l&%4c?) %s' Known Bugs - None + + None + Credits - Vsevolod Volkov - vvv@mutt.org.ua + + Vsevolod Volkov + vvv@mutt.org.ua + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -11809,7 +12931,8 @@ set index_format='%4C %Z %{%b %d} %I (%?l?%4l&%4c?) %s' Support - Since:NeoMutt 2016-10-02 + Since: NeoMutt 2016-10-02 + @@ -11817,36 +12940,42 @@ set index_format='%4C %Z %{%b %d} %I (%?l?%4l&%4c?) %s' - Kyoto Cabinet - libraries + Kyoto Cabinet libraries - To check if NeoMutt supports Kyoto Cabinet, look for + + To check if NeoMutt supports Kyoto Cabinet, look for + - kyoto in the NeoMutt version. + kyoto in the NeoMutt version. + - +hcache in the compile options + +hcache in the compile options + - hcache backend: kyotocabinet in the NeoMutt - version + hcache backend: kyotocabinet in the NeoMutt + version + - + Introduction - This feature adds support for using Kyoto Cabinet, the successor - to Tokyo Cabinet, as a storage backend for NeoMutt's header cache - (hcache). It is enabled at configure time with the - --with-kyotocabinet=<path>switch. + + This feature adds support for using Kyoto Cabinet, the successor to + Tokyo Cabinet, as a storage backend for NeoMutt's header cache + (hcache). It is enabled at configure time with the + --with-kyotocabinet=<path> switch. + @@ -11859,8 +12988,7 @@ set index_format='%4C %Z %{%b %d} %I (%?l?%4l&%4c?) %s' - Kyoto - Cabinet + Kyoto Cabinet @@ -11868,15 +12996,19 @@ set index_format='%4C %Z %{%b %d} %I (%?l?%4l&%4c?) %s' Known Bugs - None + + None + Credits - Clemens Lang - neverpanic@gmail.com + + Clemens Lang + neverpanic@gmail.com + @@ -11889,25 +13021,31 @@ set index_format='%4C %Z %{%b %d} %I (%?l?%4l&%4c?) %s' Support - Since:NeoMutt 2016-03-28 + Since: NeoMutt 2016-03-28 + - Dependencies:None + Dependencies: None + Introduction - This feature adds a new way of using the - Limit Command. The - <limit-current-thread>function restricts the - view to just the current thread. Setting the limit (the - l key) to - all will restore the full email list. + + This feature adds a new way of using the + Limit Command. The + <limit-current-thread> function restricts + the view to just the current thread. Setting the limit (the + l key) to all will restore the full + email list. + Functions - Limit-current-thread adds the following function to NeoMutt. By - default, it is not bound to a key. + + Limit-current-thread adds the following function to NeoMutt. By + default, it is not bound to a key. + Limit-Current-Thread Functions @@ -11948,19 +13086,25 @@ bind index <esc>L limit-current-thread Known Bugs - None + + None + Credits - David Sterba - dsterba@suse.cz + + David Sterba + dsterba@suse.cz + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -11973,19 +13117,24 @@ bind index <esc>L limit-current-thread Support - Since:NeoMutt 2016-07-23 + Since: NeoMutt 2016-07-23 + - Dependencies:None + Dependencies: None + Introduction - This feature adds support for using LMDB as a storage backend for - NeoMutt's header cache (hcache). It is enabled at configure time with the - --with-lmdb=<path>switch. + + This feature adds support for using LMDB as a storage backend for + NeoMutt's header cache (hcache). It is enabled at configure time with + the --with-lmdb=<path> switch. + - It is not recommended to store the lmdb database on a shared - drive. + + It is not recommended to store the lmdb database on a shared drive. + @@ -12002,23 +13151,31 @@ bind index <esc>L limit-current-thread Known Bugs - None + + None + Credits - Pietro Cerutti - gahr@gahr.ch + + Pietro Cerutti + gahr@gahr.ch + - Jan-Piet Mens - jp@mens.de + + Jan-Piet Mens + jp@mens.de + - Clemens Lang - neverpanic@gmail.com + + Clemens Lang + neverpanic@gmail.com + @@ -12031,29 +13188,38 @@ bind index <esc>L limit-current-thread Support - Since:NeoMutt 2016-08-08 + Since: NeoMutt 2016-08-08 + - Dependencies:None + Dependencies: None + Introduction - This feature allows the user to save outgoing emails in multiple - folders. - Folders should be listed separated by commas, - but no spaces. - The - fcc field of an email can be set in two ways: + + This feature allows the user to save outgoing emails in multiple + folders. + + + Folders should be listed separated by commas, + but no spaces. + + + The fcc field of an email can be set in two ways: + - The <edit-fcc> command in the compose menu (default - key: - f) + + The <edit-fcc> command in the compose menu (default key: + f) + - Creating a - fcc-hook in your - .neomuttrc + + Creating a fcc-hook in your + .neomuttrc + @@ -12076,19 +13242,25 @@ bind index <esc>L limit-current-thread Known Bugs - None + + None + Credits - Omen Wild - omen@mandarb.com + + Omen Wild + omen@mandarb.com + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -12101,34 +13273,47 @@ bind index <esc>L limit-current-thread Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + - Dependencies:None + Dependencies: None + Introduction - NeoMutt's format strings can contain embedded if-then-else - conditions. They are of the form: + + NeoMutt's format strings can contain embedded if-then-else + conditions. They are of the form: + %?VAR?TRUE&FALSE? - If the variable - VAR has a value greater than zero, print the - TRUE string, otherwise print the - FALSE string. - e.g. - %?S?Size: %S&Empty? - Which can be read as: + + If the variable VAR has a value greater than zero, + print the TRUE string, otherwise print the + FALSE string. + + + e.g. %?S?Size: %S&Empty? + + + Which can be read as: + if (%S > 0) { print "Size: %S" } else { print "Empty" } - These conditions are useful, but in NeoMutt they cannot be nested - within one another. This feature uses the notation - %<VAR?TRUE&FALSE>and allows them to be - nested. - The - %<...>notation was used to format the current - local time. but that's not really very useful since NeoMutt has no means - of refreshing the screen periodically. - A simple nested condition might be: (Some whitespace has been - introduced for clarity) + + These conditions are useful, but in NeoMutt they cannot be nested + within one another. This feature uses the notation + %<VAR?TRUE&FALSE> and allows them to be + nested. + + + The %<...> notation was used to format the + current local time. but that's not really very useful since NeoMutt + has no means of refreshing the screen periodically. + + + A simple nested condition might be: (Some whitespace has been + introduced for clarity) + %<x? %<y? XY & X > & %<y? Y & NONE > > Conditions @@ -12144,7 +13329,9 @@ bind index <esc>L limit-current-thread NONE x=0,y=0 - Equivalent to: + + Equivalent to: + if (x > 0) { if (y > 0) { print 'XY' @@ -12158,7 +13345,9 @@ bind index <esc>L limit-current-thread print 'NONE' } } - Examples: + + Examples: + set index_format='%4C %Z %{%b %d} %-25.25n %s%> %<M?%M Msgs &%<l?%l Lines&%c Bytes>>' @@ -12177,18 +13366,20 @@ else if we know how many lines are in the message display subject (%s) and the l else display the subject (%s) and the size of the message in bytes (%c) - If you wish to use angle brackets < > - in a nested condition, then it's necessary to escape them, e.g. + + If you wish to use angle brackets < > in + a nested condition, then it's necessary to escape them, e.g. + set index_format='%<M?\<%M\>&%s>' - Variables - The - nested-if feature doesn't have any config of its own. It - modifies the behavior of the format strings. + + The nested-if feature doesn't have any config of its + own. It modifies the behavior of the format strings. + @@ -12246,23 +13437,31 @@ set index_format='%4C %Z %{%b %d} %-25.25n %<M?[%M] %s&%s%* %<l?%l& Known Bugs - This feature is hard to understand + + This feature is hard to understand + Credits - David Champion - dgc@uchicago.edu + + David Champion + dgc@uchicago.edu + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + - Aleksa Sarai - cyphar@cyphar.com + + Aleksa Sarai + cyphar@cyphar.com + @@ -12275,35 +13474,47 @@ set index_format='%4C %Z %{%b %d} %-25.25n %<M?[%M] %s&%s%* %<l?%l& Support - Since:NeoMutt 2016-07-23 + Since: NeoMutt 2016-07-23 + - Dependencies:None + Dependencies: None + Introduction - This feature enables the new_mail_command setting, which can be - used to execute a custom script (e.g. a notification handler) upon - receiving a new mail. - The command string can contain expandos, such as - %n for the number of new messages. For a complete list, see: - $status_format. + + This feature enables the new_mail_command setting, which can be used + to execute a custom script (e.g. a notification handler) upon + receiving a new mail. + + + The command string can contain expandos, such as + %n for the number of new messages. For a complete + list, see: $status_format. + - When the notification is sent, the folder of the new mail is no longer known. - This is a limitation of NeoMutt. The `%f` expando will show the open folder. + + When the notification is sent, the folder of the new mail is no + longer known. This is a limitation of NeoMutt. The `%f` expando + will show the open folder. + - For example in Linux you can use (most distributions already - provide notify-send): + + For example in Linux you can use (most distributions already provide + notify-send): + set new_mail_command="notify-send --icon='/home/santiago/Pictures/neomutt.png' \ 'New Email' '%n new messages, %u unread.' &" - And in OS X you will need to install a command line interface for - Notification Center, for example - - terminal-notifier: + + And in OS X you will need to install a command line interface for + Notification Center, for example + terminal-notifier: + set new_mail_command="terminal-notifier -title '%v' -subtitle 'New Mail' \ @@ -12375,23 +13586,31 @@ set new_mail_command = "" Known Bugs - None + + None + Credits - Yoshiki Vazquez-Baeza - yoshiki@ucsd.edu + + Yoshiki Vazquez-Baeza + yoshiki@ucsd.edu + - Santiago Torres-Arias - santiago@nyu.edu + + Santiago Torres-Arias + santiago@nyu.edu + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -12404,29 +13623,38 @@ set new_mail_command = "" Support - Since:NeoMutt 2016-05-30 + Since: NeoMutt 2016-05-30 + - Dependencies:None + Dependencies: None + Introduction - Reading news via NNTP - NeoMutt can read from a news server using NNTP. - The default news server can be obtained from the - $NNTPSERVER environment variable or from the - /etc/nntpserver file. Like in other news readers, - information about the subscribed newsgroups is saved in the file - specified by the - $newsrc variable. You can open a newsgroup - with the function - <change-newsgroup> - The variable - $news_cache_dir can be used to - point to a directory. NeoMutt will create a hierarchy of subdirectories - named like the account and newsgroup the cache is for. The hierarchy is - also used to store header cache if NeoMutt was compiled with - header cache support. + + Reading news via NNTP + + + NeoMutt can read from a news server using NNTP. + + + The default news server can be obtained from the + $NNTPSERVER environment variable or from the + /etc/nntpserver file. Like in other news readers, + information about the subscribed newsgroups is saved in the file + specified by the $newsrc variable. You + can open a newsgroup with the function + <change-newsgroup> + + + The variable $news_cache_dir + can be used to point to a directory. NeoMutt will create a hierarchy + of subdirectories named like the account and newsgroup the cache is + for. The hierarchy is also used to store header cache if NeoMutt was + compiled with header cache + support. + @@ -12647,8 +13875,10 @@ set new_mail_command = "" Functions - NNTP adds the following functions to NeoMutt. By default, none of - them are bound to keys. + + NNTP adds the following functions to NeoMutt. By default, none of + them are bound to keys. +
NNTP Functions @@ -12881,23 +14111,31 @@ bind index \CG get-message Known Bugs - None + + None + Credits - Vsevolod Volkov - vvv@mutt.org.ua + + Vsevolod Volkov + vvv@mutt.org.ua + - Felix von Leitner - leitner@fefe.de + + Felix von Leitner + leitner@fefe.de + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -12910,7 +14148,8 @@ bind index \CG get-message Support - Since:NeoMutt 2017-10-16 + Since: NeoMutt 2017-10-16 + Dependencies: @@ -12930,10 +14169,12 @@ bind index \CG get-message Introduction - Some backends allow to index and tags mail without storing the - tags within the mail envelope. Two backends are currently - implementing this feature. Notmuch handles them natively and IMAP stores them - in custom IMAP keywords. + + Some backends allow to index and tags mail without storing the tags + within the mail envelope. Two backends are currently implementing + this feature. Notmuch handles them natively and IMAP stores them in + custom IMAP keywords. + @@ -12967,8 +14208,10 @@ bind index \CG get-message Functions - Notmuch adds the following functions to NeoMutt. By default, none of - them are bound to keys. + + Notmuch adds the following functions to NeoMutt. By default, none of + them are bound to keys. +
Notmuch/IMAP Functions @@ -13050,7 +14293,9 @@ bind index \CG get-message Colors - Adds these to index-color feature: + + Adds these to index-color feature: +
Index Colors @@ -13154,16 +14399,22 @@ color index_tags green default Credits - Mehdi Abaakouk - sileht@sileht.net + + Mehdi Abaakouk + sileht@sileht.net + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + - Bernard 'Guyzmo' Pratz - guyzmo+github+pub@m0g.net + + Bernard 'Guyzmo' Pratz + guyzmo+github+pub@m0g.net + @@ -13176,7 +14427,8 @@ color index_tags green default Support - Since:NeoMutt 2016-03-17 + Since: NeoMutt 2016-03-17 + Dependencies: @@ -13192,24 +14444,30 @@ color index_tags green default - Notmuch libraries + + Notmuch libraries + Introduction - Notmuch is an email fulltext indexing and tagging engine. + + Notmuch is an email fulltext indexing and tagging engine. + - For more information, see: - - https://notmuchmail.org/ + + For more information, see: + https://notmuchmail.org/ + - More examples: - - https://notmuchmail.org/mutttips/ + + More examples: + https://notmuchmail.org/mutttips/ + @@ -13220,18 +14478,20 @@ color index_tags green default Folders URI - - notmuch://[<path>][?<item>=<name>[& - ...]] + notmuch://[<path>][?<item>=<name>[& ...]] + + + The <path> is an absolute path to the directory where the + notmuch database is found as returned by + notmuch config get database.path command. Note that + the <path> should NOT include .notmuch + directory name. + + + If the "<path>" is not defined then + $nm_default_uri or $folder is + used, for example: - The <path> is an absolute path to the directory where the - notmuch database is found as returned by - notmuch config get database.path command. Note that the - <path> should NOT include - .notmuch directory name. - If the "<path>" is not defined then - $nm_default_uri or - $folder is used, for example: set nm_default_uri = "notmuch:///home/foo/maildir" @@ -13245,47 +14505,62 @@ virtual-mailboxes "My INBOX" "notmuch://?query=tag:inbox" query=<string> - See SEARCH SYNTAX in notmuch man page. Don't forget to use - operators ( - and/ - or) in your queries. - Note that proper URI should not contain blank space and all - bad chars should be encoded, for example - tag:AAA and tag:BBB--encoding-> - tag:AAA%20and%20tag:BBB - but NeoMutt config file parser is smart enough to accept space in - quoted strings. It means that you can use + See SEARCH SYNTAX in notmuch man page. Don't forget to use + operators (and/or) in your queries. + + + Note that proper URI should not contain blank space and all + bad chars should be encoded, for example + + + tag:AAA and tag:BBB – encoding -> + tag:AAA%20and%20tag:BBB + + + but NeoMutt config file parser is smart enough to accept space in + quoted strings. It means that you can use + notmuch:///foo?query=tag:AAA and tag:BBB - in your config files to keep things readable. - For more details about Xapian queries, see: - - https://xapian.org/docs/queryparser.html + + in your config files to keep things readable. + + + For more details about Xapian queries, see: + https://xapian.org/docs/queryparser.html + limit=<number> - Restricts number of messages/threads in the result. The default - limit is nm_db_limit. + + Restricts number of messages/threads in the result. The default + limit is nm_db_limit. + type=<threads|messages> - Reads all matching messages or whole-threads. The default is - 'messages' or nm_query_type. + + Reads all matching messages or whole-threads. The default is + 'messages' or nm_query_type. + Format String for the Notmuch Browser - Default: - - %2C %?n?%4n/& ?%4m %f - - This variable allows you to customize the browser display to - your personal taste. This string is similar to - $index_format, but has its own - set of - printf(3)-like sequences: + + Default: + + %2C %?n?%4n/& ?%4m %f + + + + This variable allows you to customize the browser display to your + personal taste. This string is similar to + $index_format, but has its own + set of printf(3)-like sequences: + @@ -13328,11 +14603,13 @@ virtual-mailboxes "My INBOX" "notmuch://?query=tag:inbox" - For an explanation of - soft-fill, see the - - $index_format documentation. - * = can be optionally printed if nonzero + + For an explanation of soft-fill, see the + $index_format documentation. + + + * = can be optionally printed if nonzero + @@ -13445,8 +14722,10 @@ virtual-mailboxes "My INBOX" "notmuch://?query=tag:inbox" Functions - Notmuch adds the following functions to NeoMutt. By default, none of - them are bound to keys. + + Notmuch adds the following functions to NeoMutt. By default, none of + them are bound to keys. +
Notmuch Functions @@ -13555,7 +14834,8 @@ virtual-mailboxes "My INBOX" "notmuch://?query=tag:inbox" Colors - See Custom backend Tags colors + See + Custom backend Tags colors @@ -13645,8 +14925,7 @@ bind index,pager > vfolder-window-forward - Compile-Time - Features + Compile-Time Features @@ -13654,111 +14933,163 @@ bind index,pager > vfolder-window-forward Known Bugs - None + + None + Credits - Karel Zak - kzak@redhat.com + + Karel Zak + kzak@redhat.com + - Chris Mason - clm@fb.com + + Chris Mason + clm@fb.com + - Christoph Rissner - cri@visotech.at + + Christoph Rissner + cri@visotech.at + - David Riebenbauer - davrieb@liegesta.at + + David Riebenbauer + davrieb@liegesta.at + - David Sterba - dsterba@suse.cz + + David Sterba + dsterba@suse.cz + - David Wilson - dw@botanicus.net + + David Wilson + dw@botanicus.net + - Don Zickus - dzickus@redhat.com + + Don Zickus + dzickus@redhat.com + - Eric Davis - edavis@insanum.com + + Eric Davis + edavis@insanum.com + - Jan Synacek - jsynacek@redhat.com + + Jan Synacek + jsynacek@redhat.com + - Jeremiah C. Foster - jeremiah@jeremiahfoster.com + + Jeremiah C. Foster + jeremiah@jeremiahfoster.com + - Josh Poimboeuf - jpoimboe@redhat.com + + Josh Poimboeuf + jpoimboe@redhat.com + - Kirill A. Shutemov - kirill@shutemov.name + + Kirill A. Shutemov + kirill@shutemov.name + - Luke Macken - lmacken@redhat.com + + Luke Macken + lmacken@redhat.com + - Mantas Mikulėnas - grawity@gmail.com + + Mantas Mikulėnas + grawity@gmail.com + - Patrick Brisbin - pbrisbin@gmail.com + + Patrick Brisbin + pbrisbin@gmail.com + - Philippe Le Brouster - plb@nebkha.net + + Philippe Le Brouster + plb@nebkha.net + - Raghavendra D Prabhu - rprabhu@wnohang.net + + Raghavendra D Prabhu + rprabhu@wnohang.net + - Sami Farin - hvtaifwkbgefbaei@gmail.com + + Sami Farin + hvtaifwkbgefbaei@gmail.com + - Stefan Assmann - sassmann@kpanic.de + + Stefan Assmann + sassmann@kpanic.de + - Stefan Kuhn - p_regius@gmx.ch + + Stefan Kuhn + p_regius@gmx.ch + - Tim Stoakes - tim@stoakes.net + + Tim Stoakes + tim@stoakes.net + - Vladimir Marek - Vladimir.Marek@oracle.com + + Vladimir Marek + Vladimir.Marek@oracle.com + - Víctor Manuel Jáquez Leal - vjaquez@igalia.com + + Víctor Manuel Jáquez Leal + vjaquez@igalia.com + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + - Bernard 'Guyzmo' Pratz - guyzmo+github+pub@m0g.net + + Bernard 'Guyzmo' Pratz + guyzmo+github+pub@m0g.net + @@ -13771,16 +15102,19 @@ bind index,pager > vfolder-window-forward Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + - Dependencies:None + Dependencies: None + Introduction - The - progress feature shows a visual progress bar on slow - tasks, such as indexing a large folder over the net. + + The progress feature shows a visual progress bar on + slow tasks, such as indexing a large folder over the net. + @@ -13840,31 +15174,43 @@ color progress white red Known Bugs - None + + None + Credits - Rocco Rutte - pdmef@gmx.net + + Rocco Rutte + pdmef@gmx.net + - Vincent Lefevre - vincent@vinc17.org + + Vincent Lefevre + vincent@vinc17.org + - Stefan Kuhn - wuodan@hispeed.ch + + Stefan Kuhn + wuodan@hispeed.ch + - Karel Zak - kzak@redhat.com + + Karel Zak + kzak@redhat.com + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -13877,20 +15223,25 @@ color progress white red Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + - Dependencies:None + Dependencies: None + Introduction - The - quasi-delete function marks an email that should be - hidden from the index, but NOT deleted. The email will disappear from - the index when <sync-mailbox> is - called. - On its own, this feature isn't very useful. It forms a useful - part of the notmuch plugin. + + The quasi-delete function marks an email that should + be hidden from the index, but NOT deleted. The email will disappear + from the index when + <sync-mailbox> is called. + + + On its own, this feature isn't very useful. It forms a useful part of + the notmuch plugin. + @@ -13949,19 +15300,25 @@ bind index,pager Q quasi-delete Known Bugs - None + + None + Credits - Karel Zak - kzak@redhat.com + + Karel Zak + kzak@redhat.com + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -13974,17 +15331,20 @@ bind index,pager Q quasi-delete Support - Since:NeoMutt 2016-09-10 + Since: NeoMutt 2016-09-10 + - Dependencies:None + Dependencies: None + Introduction - Adds a reply_with_xorig for NeoMutt configuration files. If enabled, - allows to reply to an email using the email address in the first - X-Original-To: header of a mail as the From: header of the - answer. + + Adds a reply_with_xorig for NeoMutt configuration files. If enabled, + allows to reply to an email using the email address in the first + X-Original-To: header of a mail as the From: header of the answer. + @@ -14037,8 +15397,10 @@ set reply_with_xorig = "yes" Credits - Pierre-Elliott Bécue - becue@crans.org + + Pierre-Elliott Bécue + becue@crans.org + @@ -14051,25 +15413,31 @@ set reply_with_xorig = "yes" Support - Since:NeoMutt 2016-09-10 + Since: NeoMutt 2016-09-10 + - Dependencies:None + Dependencies: None + Introduction - The - sensible browser is a set of small changes to NeoMutt's - mailbox browser which make the browser behave in a more predictable - way. - The behavior is divided into two use cases: Fixed Order; Variable - Order. + + The sensible browser is a set of small changes to + NeoMutt's mailbox browser which make the browser behave in a more + predictable way. + + + The behavior is divided into two use cases: Fixed Order; Variable + Order. + A Fixed Order of Mailboxes - This is for users who like their mailboxes in a fixed order, - e.g. alphabetical, or unsorted (in the order of the config - file). + + This is for users who like their mailboxes in a fixed order, e.g. + alphabetical, or unsorted (in the order of the config file). + # Fixed order @@ -14077,20 +15445,27 @@ set sort_browser="alpha" set sort_browser="unsorted" - When you first start the browser, e.g. - c?your current mailbox will be highlighted. - When you navigate to a parent mailbox ( - ..) your old mailbox will be highlighted. - ..will always be listed at the top, however the rest - of the list is sorted. + When you first start the browser, e.g. c? your + current mailbox will be highlighted. + + + When you navigate to a parent mailbox (..) your old + mailbox will be highlighted. + + + .. will always be listed at the top, however the + rest of the list is sorted. + A Variable Order of Mailboxes - This is for users who like their mailboxes sorted by a - characteristic that changes, e.g. count of new mail, or the size of - mailbox. + + This is for users who like their mailboxes sorted by + a characteristic that changes, e.g. count of new mail, or the size + of mailbox. + # Variable order @@ -14098,14 +15473,19 @@ set sort_browser="reverse-count" set sort_browser="reverse-size" - When you first start the browser, e.g. - c?the highlight will be on the first mailbox, e.g. - the one with the most new mail. - When you navigate to a parent mailbox ( - ..) your old mailbox will be highlighted. - ..will always be listed at the top, however the rest - of the list is sorted. + When you first start the browser, e.g. c? the + highlight will be on the first mailbox, e.g. the one with the most + new mail. + + + When you navigate to a parent mailbox (..) your old + mailbox will be highlighted. + + + .. will always be listed at the top, however the + rest of the list is sorted. + @@ -14122,23 +15502,31 @@ set sort_browser="reverse-size" Known Bugs - None + + None + Credits - Pierre-Elliott Bécue - becue@crans.org + + Pierre-Elliott Bécue + becue@crans.org + - Haakon Riiser - haakon.riiser@fys.uio.no + + Haakon Riiser + haakon.riiser@fys.uio.no + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -14151,22 +15539,28 @@ set sort_browser="reverse-size" Support - Since:NeoMutt 2016-09-10, NeoMutt - 1.7.0 + Since: NeoMutt 2016-09-10, NeoMutt + 1.7.0 + - Dependencies:None + Dependencies: None + Introduction - The Sidebar shows a list of all your mailboxes. The list can be - turned on and off, it can be themed and the list style can be - configured. - This part of the manual is a reference guide. If you want a - simple introduction with examples see the - Sidebar Howto. If you just want to - get started, you could use the sample - Sidebar neomuttrc. + + The Sidebar shows a list of all your mailboxes. The list can be + turned on and off, it can be themed and the list style can be + configured. + + + This part of the manual is a reference guide. If you want a simple + introduction with examples see the + Sidebar Howto. If you just want + to get started, you could use the sample + Sidebar neomuttrc. + @@ -14302,15 +15696,19 @@ set sort_browser="reverse-size"
- For more details, and examples, about the - $sidebar_format, see the - Sidebar Intro. + + For more details, and examples, about the + $sidebar_format, see the + Sidebar Intro. + Functions - Sidebar adds the following functions to NeoMutt. By default, none of - them are bound to keys. + + Sidebar adds the following functions to NeoMutt. By default, none of + them are bound to keys. + Sidebar Functions @@ -14407,14 +15805,17 @@ set sort_browser="reverse-size" - This command specifies mailboxes that will always be displayed in - the sidebar, even if - $sidebar_new_mail_only is - set and the mailbox does not contain new mail. - The - unsidebar_whitelist command is used to remove a mailbox - from the list of whitelisted mailboxes. Use - unsidebar_whitelist *to remove all mailboxes. + + This command specifies mailboxes that will always be displayed in the + sidebar, even if + $sidebar_new_mail_only + is set and the mailbox does not contain new mail. + + + The unsidebar_whitelist command is used to remove + a mailbox from the list of whitelisted mailboxes. Use + unsidebar_whitelist * to remove all mailboxes. + @@ -14485,10 +15886,11 @@ set sort_browser="reverse-size"
- If the - sidebar_indicator color isn't set, then the default - NeoMutt indicator color will be used (the color used in the index - panel). + + If the sidebar_indicator color isn't set, then the + default NeoMutt indicator color will be used (the color used in the + index panel). + @@ -14687,55 +16089,79 @@ color sidebar_ordinary color245 default Known Bugs - None + + None + Credits - Justin Hibbits - jrh29@po.cwru.edu + + Justin Hibbits + jrh29@po.cwru.edu + - Thomer M. Gil - mutt@thomer.com + + Thomer M. Gil + mutt@thomer.com + - David Sterba - dsterba@suse.cz + + David Sterba + dsterba@suse.cz + - Evgeni Golov - evgeni@debian.org + + Evgeni Golov + evgeni@debian.org + - Fabian Groffen - grobian@gentoo.org + + Fabian Groffen + grobian@gentoo.org + - Jason DeTiberus - jdetiber@redhat.com + + Jason DeTiberus + jdetiber@redhat.com + - Stefan Assmann - sassmann@kpanic.de + + Stefan Assmann + sassmann@kpanic.de + - Steve Kemp - steve@steve.org.uk + + Steve Kemp + steve@steve.org.uk + - Terry Chan - tchan@lunar-linux.org + + Terry Chan + tchan@lunar-linux.org + - Tyler Earnest - tylere@rne.st + + Tyler Earnest + tylere@rne.st + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -14748,20 +16174,25 @@ color sidebar_ordinary color245 default Support - Since:NeoMutt 2016-03-28 + Since: NeoMutt 2016-03-28 + - Dependencies:None + Dependencies: None + Introduction - When viewing an email, the - <skip-to-quoted>function (by default the - S key) will scroll past any email headers or quoted - text. Sometimes, a little context is useful. - By setting the - $skip_quoted_offset variable, you can select how much - of the quoted text is left visible. + + When viewing an email, the <skip-to-quoted> + function (by default the S key) will scroll past + any email headers or quoted text. Sometimes, a little context is + useful. + + + By setting the $skip_quoted_offset variable, you + can select how much of the quoted text is left visible. + @@ -14810,19 +16241,25 @@ set skip_quoted_offset = 3 Known Bugs - None + + None + Credits - David Sterba - dsterba@suse.cz + + David Sterba + dsterba@suse.cz + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -14835,19 +16272,23 @@ set skip_quoted_offset = 3 Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + - Dependencies:None + Dependencies: None + Introduction - The - status-color feature allows you to theme different parts - of the status bar (also when it's used by the index). - Unlike normal color commands, - color status can now take up to 2 extra parameters - (regex, num). + + The status-color feature allows you to theme different + parts of the status bar (also when it's used by the index). + + + Unlike normal color commands, color status can now + take up to 2 extra parameters (regex, num). + @@ -14874,12 +16315,18 @@ set skip_quoted_offset = 3 - With zero parameters, NeoMutt will set the default color for the - entire status bar. - With one parameter, NeoMutt will only color the parts matching the - regex. - With two parameters, NeoMutt will only color the num'th sub-match of - the regex. + + With zero parameters, NeoMutt will set the default color for the + entire status bar. + + + With one parameter, NeoMutt will only color the parts matching the + regex. + + + With two parameters, NeoMutt will only color the num'th sub-match of + the regex. + @@ -14959,8 +16406,7 @@ color status brightwhite default 'NeoMutt: ([^ ]+)' 1 - Compile-Time - Features + Compile-Time Features @@ -14988,27 +16434,37 @@ color status brightwhite default 'NeoMutt: ([^ ]+)' 1 Known Bugs - None + + None + Credits - David Sterba - dsterba@suse.cz + + David Sterba + dsterba@suse.cz + - Thomas Glanzmann - thomas@glanzmann.de + + Thomas Glanzmann + thomas@glanzmann.de + - Kirill A. Shutemov - kirill@shutemov.name + + Kirill A. Shutemov + kirill@shutemov.name + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -15021,14 +16477,17 @@ color status brightwhite default 'NeoMutt: ([^ ]+)' 1 Support - Since:NeoMutt 2016-03-07 + Since: NeoMutt 2016-03-07 + Dependencies: - OpenSSL + + OpenSSL + @@ -15036,17 +16495,24 @@ color status brightwhite default 'NeoMutt: ([^ ]+)' 1 Introduction - The - TLS-SNI feature adds support for TLS virtual hosting. If - your mail server doesn't support this everything will still work - normally. - TLS supports sending the expected server hostname during the - handshake, via the SNI extension. This can be used to select a server - certificate to issue to the client, permitting virtual-hosting without - requiring multiple IP addresses. - This has been tested against Exim 4.80, which optionally logs SNI - and can perform vhosting. - To verify TLS SNI support by a server, you can use: + + The TLS-SNI feature adds support for TLS virtual + hosting. If your mail server doesn't support this everything will + still work normally. + + + TLS supports sending the expected server hostname during the + handshake, via the SNI extension. This can be used to select a server + certificate to issue to the client, permitting virtual-hosting + without requiring multiple IP addresses. + + + This has been tested against Exim 4.80, which optionally logs SNI and + can perform vhosting. + + + To verify TLS SNI support by a server, you can use: + openssl s_client -host <imap server> -port <port> -tls1 -servername <imap server> @@ -15056,23 +16522,31 @@ openssl s_client -host <imap server> -port <port> -tls1 -servername Known Bugs - None + + None + Credits - Jeremy Katz - katzj@linuxpower.org + + Jeremy Katz + katzj@linuxpower.org + - Phil Pennock - mutt-dev@spodhuis.demon.nl + + Phil Pennock + mutt-dev@spodhuis.demon.nl + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -15085,16 +16559,18 @@ openssl s_client -host <imap server> -port <port> -tls1 -servername Support - Since:NeoMutt 2016-09-10, NeoMutt - 1.7.0 + Since: NeoMutt 2016-09-10, NeoMutt + 1.7.0 + Dependencies: - If IMAP is enabled, the trash folder will use it - wisely + + If IMAP is enabled, the trash folder will use it wisely + @@ -15102,27 +16578,32 @@ openssl s_client -host <imap server> -port <port> -tls1 -servername Introduction - In NeoMutt, when you - delete an email it is first marked deleted. The email - isn't really gone until - <sync-mailbox>is called. This - happens when the user leaves the folder, or the function is called - manually. - After - <sync-mailbox>has been called the email is - gone forever. - The - $trash variable defines a folder in which - to keep old emails. As before, first you mark emails for deletion. When - <sync-mailbox> is called the emails are moved to the trash - folder. - The - $trash path can be either a full directory, or be - relative to the - $folder variable, like the - mailboxes command. + + In NeoMutt, when you delete an email it is first + marked deleted. The email isn't really gone until + <sync-mailbox> is called. This + happens when the user leaves the folder, or the function is called + manually. + + + After <sync-mailbox> has been called the + email is gone forever. + + + The $trash variable defines a folder in + which to keep old emails. As before, first you mark emails for + deletion. When <sync-mailbox> is called the emails are moved to + the trash folder. + + + The $trash path can be either a full directory, or + be relative to the $folder variable, + like the mailboxes command. + - Emails deleted from the trash folder are gone forever. + + Emails deleted from the trash folder are gone forever. + @@ -15215,27 +16696,37 @@ bind index D purge-message Known Bugs - None + + None + Credits - Cedric Duval - cedricduval@free.fr + + Cedric Duval + cedricduval@free.fr + - Benjamin Kuperman - kuperman@acm.org + + Benjamin Kuperman + kuperman@acm.org + - Paul Miller - paul@voltar.org + + Paul Miller + paul@voltar.org + - Richard Russon - rich@flatcap.org + + Richard Russon + rich@flatcap.org + @@ -15244,32 +16735,39 @@ bind index D purge-message Security Considerations - First of all, NeoMutt contains no security holes included by intention - but may contain unknown security holes. As a consequence, please run NeoMutt - only with as few permissions as possible. Especially, do not run NeoMutt as - the super user. - When configuring NeoMutt, there're some points to note about secure - setups so please read this chapter carefully. + + First of all, NeoMutt contains no security holes included by intention + but may contain unknown security holes. As a consequence, please run + NeoMutt only with as few permissions as possible. Especially, do not run + NeoMutt as the super user. + + + When configuring NeoMutt, there're some points to note about secure + setups so please read this chapter carefully. + Passwords - Although NeoMutt can be told the various passwords for accounts, - please never store passwords in configuration files. Besides the fact - that the system's operator can always read them, you could forget to mask - it out when reporting a bug or asking for help via a mailing list. Even - worse, your mail including your password could be archived by internet - search engines, mail-to-news gateways etc. It may already be too late - before you notice your mistake. + + Although NeoMutt can be told the various passwords for accounts, please + never store passwords in configuration files. Besides the fact that the + system's operator can always read them, you could forget to mask it out + when reporting a bug or asking for help via a mailing list. Even worse, + your mail including your password could be archived by internet search + engines, mail-to-news gateways etc. It may already be too late before + you notice your mistake. + Temporary Files - NeoMutt uses many temporary files for viewing messages, verifying - digital signatures, etc. As long as being used, these files are visible - by other users and maybe even readable in case of misconfiguration. Also, - a different location for these files may be desired which can be changed - via the - $tmpdir variable. + + NeoMutt uses many temporary files for viewing messages, verifying + digital signatures, etc. As long as being used, these files are visible + by other users and maybe even readable in case of misconfiguration. + Also, a different location for these files may be desired which can be + changed via the $tmpdir variable. + @@ -15277,63 +16775,74 @@ bind index D purge-message Message-Id: headers - Message-Id: headers contain a local part that is to be created in - a unique fashion. In order to do so, NeoMutt will - leak some information to the outside world when sending - messages: the generation of this header includes a step counter which - is increased (and rotated) with every message sent. In a longer running - NeoMutt session, others can make assumptions about your mailing habits - depending on the number of messages sent. If this is not desired, the - header can be manually provided using - $edit_headers(though not - recommended). + + Message-Id: headers contain a local part that is to be created in + a unique fashion. In order to do so, NeoMutt will leak + some information to the outside world when sending messages: the + generation of this header includes a step counter which is increased + (and rotated) with every message sent. In a longer running NeoMutt + session, others can make assumptions about your mailing habits + depending on the number of messages sent. If this is not desired, the + header can be manually provided using + $edit_headers (though not + recommended). + - - <literal>mailto:</literal>-style Links - As NeoMutt be can be set up to be the mail client to handle - mailto:style links in websites, there're security - considerations, too. Arbitrary header fields can be embedded in these - links which could override existing header fields or attach arbitrary - files using - the Attach: pseudoheader. This may - be problematic if the - $edit-headers variable is - unset, i.e. the user doesn't want to see header - fields while editing the message and doesn't pay enough attention to - the compose menu's listing of attachments. - For example, following a link like + <literal>mailto:</literal>-style Links + + As NeoMutt be can be set up to be the mail client to handle + mailto: style links in websites, there're security + considerations, too. Arbitrary header fields can be embedded in these + links which could override existing header fields or attach arbitrary + files using + the Attach: pseudoheader. This + may be problematic if the + $edit-headers variable is + unset, i.e. the user doesn't want to see header + fields while editing the message and doesn't pay enough attention to + the compose menu's listing of attachments. + + + For example, following a link like + mailto:joe@host?Attach=~/.gnupg/secring.gpg - will send out the user's private gnupg keyring to - joe@host if the user doesn't follow the information - on screen carefully enough. - To prevent these issues, NeoMutt by default only accepts the - Subject and - Body headers. Allowed headers can be adjusted with - the - - mailto_allow - and - - unmailto_allow - commands. + + will send out the user's private gnupg keyring to + joe@host if the user doesn't follow the + information on screen carefully enough. + + + To prevent these issues, NeoMutt by default only accepts the + Subject and Body headers. + Allowed headers can be adjusted with the + mailto_allow + and + unmailto_allow + commands. + External Applications - NeoMutt in many places has to rely on external applications or for - convenience supports mechanisms involving external applications. - One of these is the - mailcap mechanism as defined by RFC1524. Details about - a secure use of the mailcap mechanisms is given in - . - Besides the mailcap mechanism, NeoMutt uses a number of other external - utilities for operation, for example to provide crypto support, in - backtick expansion in configuration files or format string filters. The - same security considerations apply for these as for tools involved via - mailcap. + + NeoMutt in many places has to rely on external applications or for + convenience supports mechanisms involving external applications. + + + One of these is the mailcap mechanism as defined by + RFC1524. Details about a secure use of the mailcap mechanisms is given + in . + + + Besides the mailcap mechanism, NeoMutt uses a number of other external + utilities for operation, for example to provide crypto support, in + backtick expansion in configuration files or format string filters. The + same security considerations apply for these as for tools involved via + mailcap. + @@ -15342,29 +16851,35 @@ bind index D purge-message Reading and Writing Mailboxes - NeoMutt's performance when reading mailboxes can be improved in two - ways: + + NeoMutt's performance when reading mailboxes can be improved in two + ways: + - For remote folders (IMAP and POP) as well as folders using - one-file-per message storage (Maildir and MH), NeoMutt's performance can - be greatly improved using - header caching. using a single - database per folder. + + For remote folders (IMAP and POP) as well as folders using + one-file-per message storage (Maildir and MH), NeoMutt's + performance can be greatly improved using + header caching. using + a single database per folder. + - NeoMutt provides the - $read_inc and - $write_inc variables to specify at - which rate to update progress counters. If these values are too low, - NeoMutt may spend more time on updating the progress counter than it - spends on actually reading/writing folders. - For example, when opening a maildir folder with a few thousand - messages, the default value for - $read_inc may be too low. It can be - tuned on on a folder-basis using - - folder-hooks: + + NeoMutt provides the $read_inc and + $write_inc variables to specify at + which rate to update progress counters. If these values are too + low, NeoMutt may spend more time on updating the progress counter + than it spends on actually reading/writing folders. + + + For example, when opening a maildir folder with a few thousand + messages, the default value for + $read_inc may be too low. It can be + tuned on on a folder-basis using + folder-hooks: + # use very high $read_inc to speed up reading hcache'd maildirs @@ -15377,48 +16892,60 @@ folder-hook ^pop 'set read_inc=1' - These settings work on a per-message basis. However, as messages - may greatly differ in size and certain operations are much faster than - others, even per-folder settings of the increment variables may not be - desirable as they produce either too few or too much progress updates. - Thus, NeoMutt allows to limit the number of progress updates per second - it'll actually send to the terminal using the - $time_inc variable. + + These settings work on a per-message basis. However, as messages may + greatly differ in size and certain operations are much faster than + others, even per-folder settings of the increment variables may not be + desirable as they produce either too few or too much progress updates. + Thus, NeoMutt allows to limit the number of progress updates per second + it'll actually send to the terminal using the + $time_inc variable. + Reading Messages from Remote Folders - Reading messages from remote folders such as IMAP an POP can be - slow especially for large mailboxes since NeoMutt only caches a very limited - number of recently viewed messages (usually 10) per session (so that it - will be gone for the next session.) - To improve performance and permanently cache whole messages, please - refer to NeoMutt's so-called - body caching for details. + + Reading messages from remote folders such as IMAP an POP can be slow + especially for large mailboxes since NeoMutt only caches a very limited + number of recently viewed messages (usually 10) per session (so that it + will be gone for the next session.) + + + To improve performance and permanently cache whole messages, please + refer to NeoMutt's so-called + body caching for details. + Searching and Limiting - When searching mailboxes either via a search or a limit action, for - some patterns NeoMutt distinguishes between regular expression and string - searches. For regular expressions, patterns are prefixed with - ~and with - =for string searches. - Even though a regular expression search is fast, it's several times - slower than a pure string search which is noticeable especially on large - folders. As a consequence, a string search should be used instead of a - regular expression search if the user already knows enough about the - search pattern. - For example, when limiting a large folder to all messages sent to - or by an author, it's much faster to search for the initial part of an - e-mail address via - =Luser@instead of - ~Luser@. This is especially true for searching message - bodies since a larger amount of input has to be searched. - As for regular expressions, a lower case string search pattern - makes NeoMutt perform a case-insensitive search except for IMAP (because for - IMAP NeoMutt performs server-side searches which don't support - case-insensitivity). + + When searching mailboxes either via a search or a limit action, for + some patterns NeoMutt distinguishes between regular expression and + string searches. For regular expressions, patterns are prefixed with + ~ and with = for string searches. + + + Even though a regular expression search is fast, it's several times + slower than a pure string search which is noticeable especially on + large folders. As a consequence, a string search should be used instead + of a regular expression search if the user already knows enough about + the search pattern. + + + For example, when limiting a large folder to all messages sent to or by + an author, it's much faster to search for the initial part of an e-mail + address via =Luser@ instead of + ~Luser@. This is especially true for searching + message bodies since a larger amount of input has to be searched. + + + As for regular expressions, a lower case string search pattern makes + NeoMutt perform a case-insensitive search except for IMAP (because for + IMAP NeoMutt performs server-side searches which don't support + case-insensitivity). + @@ -15427,10 +16954,11 @@ folder-hook ^pop 'set read_inc=1' Command-Line Options - Running - neomutt with no arguments will make NeoMutt attempt to read - your spool mailbox. However, it is possible to read other mailboxes and - to send messages from the command line as well. + + Running neomutt with no arguments will make NeoMutt + attempt to read your spool mailbox. However, it is possible to read + other mailboxes and to send messages from the command line as well. + Command line options @@ -15554,7 +17082,9 @@ folder-hook ^pop 'set read_inc=1'
- To read messages in a mailbox + + To read messages in a mailbox + neomutt @@ -15573,7 +17103,9 @@ folder-hook ^pop 'set read_inc=1' mailbox - To compose a new message + + To compose a new message + neomutt @@ -15608,50 +17140,60 @@ folder-hook ^pop 'set read_inc=1' - NeoMutt also supports a - batch mode to send prepared messages. Simply redirect input - from the file you wish to send. For example, + + NeoMutt also supports a batch mode to send prepared + messages. Simply redirect input from the file you wish to send. For + example, + neomutt -s "data set for run #2" professor@bigschool.edu < ~/run2.dat - will send a message to - <professor@bigschool.edu>with a subject of - data set for run #2. In the body of the message will be - the contents of the file - ~/run2.dat. - An include file passed with - -i will be used as the body of the message. When - combined with - -E, the include file will be directly edited during - message composition. The file will be modified regardless of whether the - message is sent or aborted. - A draft file passed with - -H will be used as the initial header and body for the - message. Multipart messages can be used as a draft file. When combined - with - -E, the draft file will be updated to the final state - of the message after composition, regardless of whether the message is - sent, aborted, or even postponed. Note that if the message is sent - encrypted or signed, the draft file will be saved that way too. - All files passed with - -a - file will be attached as a MIME part to the message. - To attach a single or several files, use - --to separate files and recipient addresses: + + will send a message to + <professor@bigschool.edu> with a subject of + data set for run #2. In the body of the message will be + the contents of the file ~/run2.dat. + + + An include file passed with -i will be used as the + body of the message. When combined with -E, the + include file will be directly edited during message composition. The + file will be modified regardless of whether the message is sent or + aborted. + + + A draft file passed with -H will be used as the + initial header and body for the message. Multipart messages can be used + as a draft file. When combined with -E, the draft + file will be updated to the final state of the message after + composition, regardless of whether the message is sent, aborted, or + even postponed. Note that if the message is sent encrypted or signed, + the draft file will be saved that way too. + + + All files passed with -a file + will be attached as a MIME part to the message. To attach a single or + several files, use -- to separate files and recipient + addresses: + neomutt -a image.png -- some@one.org - or + + or + neomutt -a *.png -- some@one.org - The - -a option must be last in the option list. + + The -a option must be last in the option list. + - In addition to accepting a list of email addresses, NeoMutt also - accepts a URL with the - mailto:schema as specified in RFC2368. This is useful - when configuring a web browser to launch NeoMutt when clicking on mailto - links. + + In addition to accepting a list of email addresses, NeoMutt also + accepts a URL with the mailto: schema as specified + in RFC2368. This is useful when configuring a web browser to launch + NeoMutt when clicking on mailto links. + neomutt mailto:some@one.org?subject=test&cc=other@one.org @@ -15661,7 +17203,9 @@ neomutt mailto:some@one.org?subject=test&cc=other@one.org Configuration Commands - The following are the commands understood by NeoMutt: + + The following are the commands understood by NeoMutt: + diff --git a/doc/manual.xml.tail b/doc/manual.xml.tail index 04bafa41b..abc1da5b3 100644 --- a/doc/manual.xml.tail +++ b/doc/manual.xml.tail @@ -1,12 +1,14 @@ - Functions - The following is the list of available functions listed by the - mapping in which they are available. The default key setting is given, and - an explanation of what the function does. The key bindings of these - functions can be changed with the - bind command. + Functions + + The following is the list of available functions listed by the mapping + in which they are available. The default key setting is given, and an + explanation of what the function does. The key bindings of these + functions can be changed with the bind + command. + __print_map(generic) __print_map(index) @@ -30,191 +32,277 @@ __print_map(editor) Acknowledgements - Kari Hurtta - kari.hurtta@fmi.fi co-developed the original MIME parsing - code back in the ELM-ME days. - The following people have been very helpful to the development of - Mutt: + + Kari Hurtta kari.hurtta@fmi.fi co-developed the original + MIME parsing code back in the ELM-ME days. + + + The following people have been very helpful to the development of Mutt: + - Vikas Agnihotri - vikasa@writeme.com + + Vikas Agnihotri + vikasa@writeme.com + - Francois Berjon - Francois.Berjon@aar.alcatel-alsthom.fr + + Francois Berjon + Francois.Berjon@aar.alcatel-alsthom.fr + - Aric Blumer - aric@fore.com + + Aric Blumer + aric@fore.com + - John Capo - jc@irbs.com + + John Capo + jc@irbs.com + - David Champion - dgc@uchicago.edu + + David Champion + dgc@uchicago.edu + - Brendan Cully - brendan@kublai.com + + Brendan Cully + brendan@kublai.com + - Liviu Daia - daia@stoilow.imar.ro + + Liviu Daia + daia@stoilow.imar.ro + - Thomas E. Dickey - dickey@herndon4.his.com + + Thomas E. Dickey + dickey@herndon4.his.com + - David DeSimone - fox@convex.hp.com + + David DeSimone + fox@convex.hp.com + - Nickolay N. Dudorov - nnd@wint.itfs.nsk.su + + Nickolay N. Dudorov + nnd@wint.itfs.nsk.su + - Ruslan Ermilov - ru@freebsd.org + + Ruslan Ermilov + ru@freebsd.org + - Edmund Grimley Evans - edmundo@rano.org + + Edmund Grimley Evans + edmundo@rano.org + - Michael Finken - finken@conware.de + + Michael Finken + finken@conware.de + - Sven Guckes - guckes@math.fu-berlin.de + + Sven Guckes + guckes@math.fu-berlin.de + - Lars Hecking - lhecking@nmrc.ie + + Lars Hecking + lhecking@nmrc.ie + - Mark Holloman - holloman@nando.net + + Mark Holloman + holloman@nando.net + - Andreas Holzmann - holzmann@fmi.uni-passau.de + + Andreas Holzmann + holzmann@fmi.uni-passau.de + - Marco d'Itri - md@linux.it + + Marco d'Itri + md@linux.it + - Björn Jacke - bjacke@suse.com + + Björn Jacke + bjacke@suse.com + - Byrial Jensen - byrial@image.dk + + Byrial Jensen + byrial@image.dk + - David Jeske - jeske@igcom.net + + David Jeske + jeske@igcom.net + - Christophe Kalt - kalt@hugo.int-evry.fr + + Christophe Kalt + kalt@hugo.int-evry.fr + - Tommi Komulainen - Tommi.Komulainen@iki.fi + + Tommi Komulainen + Tommi.Komulainen@iki.fi + - Felix von Leitner (a.k.a - Fefe) - leitner@math.fu-berlin.de + + Felix von Leitner (a.k.a Fefe) + leitner@math.fu-berlin.de + - Brandon Long - blong@fiction.net + + Brandon Long + blong@fiction.net + - Jimmy Mäkelä - jmy@flashback.net + + Jimmy Mäkelä + jmy@flashback.net + - Lars Marowsky-Bree - lmb@pointer.in-minden.de + + Lars Marowsky-Bree + lmb@pointer.in-minden.de + - Thomas - Mike Michlmayr - mike@cosy.sbg.ac.at + + Thomas Mike Michlmayr + mike@cosy.sbg.ac.at + - Andrew W. Nosenko - awn@bcs.zp.ua + + Andrew W. Nosenko + awn@bcs.zp.ua + - David O'Brien - obrien@Nuxi.cs.ucdavis.edu + + David O'Brien + obrien@Nuxi.cs.ucdavis.edu + - Clint Olsen - olsenc@ichips.intel.com + + Clint Olsen + olsenc@ichips.intel.com + - Park Myeong Seok - pms@romance.kaist.ac.kr + + Park Myeong Seok + pms@romance.kaist.ac.kr + - Thomas Parmelan - tom@ankh.fr.eu.org + + Thomas Parmelan + tom@ankh.fr.eu.org + - Ollivier Robert - roberto@keltia.freenix.fr + + Ollivier Robert + roberto@keltia.freenix.fr + - Thomas Roessler - roessler@does-not-exist.org + + Thomas Roessler + roessler@does-not-exist.org + - Roland Rosenfeld - roland@spinnaker.de + + Roland Rosenfeld + roland@spinnaker.de + - Rocco Rutte - pdmef@gmx.net + + Rocco Rutte + pdmef@gmx.net + - TAKIZAWA Takashi - taki@luna.email.ne.jp + + TAKIZAWA Takashi + taki@luna.email.ne.jp + - Allain Thivillon - Allain.Thivillon@alma.fr + + Allain Thivillon + Allain.Thivillon@alma.fr + - Gero Treuner - gero@70t.de + + Gero Treuner + gero@70t.de + - Vsevolod Volkov - vvv@lucky.net + + Vsevolod Volkov + vvv@lucky.net + - Ken Weinert - kenw@ihs.com + + Ken Weinert + kenw@ihs.com + About This Document - This document was written in - DocBook, and then - rendered using the - Gnome XSLT toolkit. + + This document was written in + DocBook, and then + rendered using the + Gnome XSLT toolkit. +