From cfa5c0822c45d6d73578cb767d944dc50bc0db83 Mon Sep 17 00:00:00 2001 From: Rocco Rutte Date: Sat, 6 Dec 2008 15:06:21 +0100 Subject: [PATCH] Manual: Fixup configuration command synopsis and switch to --- ChangeLog | 13 + doc/manual.xml.head | 1794 ++++++++++++++++++++++++++++++++++--------- doc/mutt.css | 1 + 3 files changed, 1462 insertions(+), 346 deletions(-) diff --git a/ChangeLog b/ChangeLog index 871db5450..b7a577a1d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2008-12-06 15:04 +0100 Rocco Rutte (5799811e0821) + + * doc/makedoc.c: makedoc: use and in string + default values + + The goal is to improve readability of settings where spaces are + relevant. + +2008-12-06 11:41 +0100 Rocco Rutte (ec45eb382402) + + * ChangeLog, doc/Makefile.am, doc/chunk.xsl, doc/html.xsl, + doc/mutt.css: Manual: Add simple and clean stylesheet, see #3109. + 2008-12-02 16:10 +0100 Rocco Rutte (3a8e5756613c) * init.c: Include mutt_menu.h in init.c for mutt_menu_init() prototype diff --git a/doc/manual.xml.head b/doc/manual.xml.head index 68eccbc05..18baf6d38 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -4,18 +4,18 @@ - The Mutt E-Mail Client - - MichaelElkins - me@cs.hmc.edu - - version @VERSION@ - - - - All mail clients suck. This one just sucks less. -me, circa 1995 - - +The Mutt E-Mail Client + +MichaelElkins +me@cs.hmc.edu + +version @VERSION@ + + + +All mail clients suck. This one just sucks less. -me, circa 1995 + + @@ -1550,9 +1550,46 @@ question marks into regular expressions). Address groups - -Usage: group [ -group name [ ... ] ] [ -rx EXPR [ ... ] ] [ -addr EXPR [ ... ] ] - +Usage: + + +group + + +name + + + + +expr + + + +expr + + + + + +ungroup + + +name + + + +* + + + +expr + + + +expr + + + group is used to directly add either addresses or @@ -1578,10 +1615,6 @@ Once defined, these address groups can be used in display to messages matching a group. - -Usage: ungroup [ -group name [ ... ] ] [ * | [ [ -rx EXPR [ ... ] ] [ -addr EXPR [ ... ] ] ] - - ungroup is used to remove addresses or regular expressions from the specified group or groups. The syntax is similar to @@ -1595,9 +1628,24 @@ contents. Defining/Using aliases - -Usage: alias [ -group name [ ... ] ] key address [ , address, ... ] - +Usage: + + +alias + + +name + + +key + + +address + + +address + + It's usually very cumbersome to remember or type out the address of someone @@ -1620,9 +1668,21 @@ the named group. To remove an alias or aliases (* means all aliases): - -unalias [ * | key ... ] - + +unalias + + +name + + + +* + + +key + + + @@ -1689,9 +1749,20 @@ In the alias menu, you can select as many aliases as you want with the Changing the default key bindings - -Usage: bind map key function - +Usage: + + +bind + +map + + +key + + +function + + This command allows you to change the default key bindings (operation @@ -1867,12 +1938,27 @@ sequence. Defining aliases for character sets - - -Usage: charset-hook alias charset -Usage: iconv-hook charset local-charset - - +Usage: + + +charset-hook + +alias + + +charset + + + + +iconv-hook + +charset + + +local-charset + + The charset-hook command defines an alias for a character set. @@ -1892,9 +1978,17 @@ for character sets. Setting variables based upon mailbox - -Usage: folder-hook [!]regexp command - +Usage: + + +folder-hook + +[!]regexp + + +command + + It is often desirable to change settings based on which mailbox you are @@ -1947,9 +2041,23 @@ folder-hook mutt set sort=threads Keyboard macros - -Usage: macro menu key sequence [ description ] - +Usage: + + +macro + +menu + + +key + + +sequence + + +description + + Macros are useful when you would like a single key to perform a series of @@ -2001,14 +2109,72 @@ silently truncated at the screen width, and are not wrapped. Using color and mono video attributes - - -Usage: color object foreground background -Usage: color (header | body) foreground background regexp -Usage: color index foreground background pattern -Usage: uncolor index pattern [ pattern ... ] - - +Usage: + + +color + +object + + +foreground + + +background + + + + +color + + + + + + + + + +foreground + + +background + + +regexp + + + + +color + + + + +foreground + + +background + + +pattern + + + + +uncolor + + + + + +* + + +pattern + + + If your terminal supports color, you can spice up Mutt by creating your own @@ -2115,14 +2281,64 @@ If your terminal does not support color, it is still possible change the video attributes through the use of the mono command: - - -Usage: mono object attribute -Usage: mono (header | body) attribute regexp -Usage: mono index attribute pattern -Usage: unmono index pattern [ pattern ... ] - - + +Usage: + + +mono + +object + + +attribute + + + + +mono + + + + + + + + + +attribute + + +regexp + + + + +mono + + + + +attribute + + +pattern + + + + +unmono + + + + + +* + + +pattern + + + For object, see the color command. attribute @@ -2144,11 +2360,29 @@ can be one of the following: Message header display - - -Usage: [un]ignore pattern [ pattern ... ] - - +Usage: + + +ignore + +pattern + + +pattern + + + + +unignore + + +* + + +pattern + + + Messages often have many header fields added by automatic processing systems, @@ -2187,9 +2421,29 @@ unignore posted-to: - -Usage: hdr_order header1 header2 header3 - +Usage: + + +hdr_order + +header + + +header + + + + +unhdr_order + + +* + + +header + + + With the hdr_order command you can specify an order in @@ -2212,9 +2466,37 @@ hdr_order From Date: From: To: Cc: Subject: Alternative addresses - -Usage: [un]alternates [ -group name [ ... ] ] regexp [ regexp ... ] - +Usage: + + +alternates + + +name + + +regexp + + +regexp + + + + +unalternates + + +name + + + +* + + +regexp + + + With various functions, mutt will treat messages differently, @@ -2282,12 +2564,67 @@ is *, all entries on alternatesMailing lists - - -Usage: [un]lists [ -group name [ ... ] ] regexp [ regexp ... ] -Usage: [un]subscribe [ -group name [ ... ] ] regexp [ regexp ... ] - - +Usage: + + +lists + + +name + + +regexp + + +regexp + + + + +unlists + + +name + + + +* + + +regexp + + + + + +subscribe + + +name + + +regexp + + +regexp + + + + +unsubscribe + + +name + + + +* + + +regexp + + + Mutt has a few nice features for handling mailing lists. In order to take advantage of them, you must @@ -2352,9 +2689,17 @@ but keep it on the list of known mailing lists, use unsubscribe. Using Multiple spool mailboxes - -Usage: mbox-hook [!]pattern mailbox - +Usage: + + +mbox-hook + +[!]pattern + + +mailbox + + This command is used to move read messages from a specified mailbox to a @@ -2375,9 +2720,29 @@ mailbox). Monitoring incoming mail - -Usage: [un]mailboxes folder [ folder ... ] - +Usage: + + +mailboxes + +mailbox + + +mailbox + + + + +unmailboxes + + +* + + +mailbox + + + This command specifies folders which can receive mail and @@ -2440,12 +2805,26 @@ mail detection instead. User defined headers - - -Usage: my_hdr string -Usage: unmy_hdr field [ field [... ] ] - - +Usage: + + +my_hdr + +string + + + + +unmy_hdr + + +* + + +field + + + The my_hdr command allows you to create your own header @@ -2498,9 +2877,17 @@ unmy_hdr to cc Specify default save mailbox - -Usage: save-hook [!]pattern mailbox - +Usage: + + +save-hook + +[!]pattern + + +mailbox + + This command is used to override the default mailbox used when saving @@ -2541,9 +2928,17 @@ Also see the fcc-save-hook command. Specify default Fcc: mailbox when composing - -Usage: fcc-hook [!]pattern mailbox - +Usage: + + +fcc-hook + +[!]pattern + + +mailbox + + This command is used to save outgoing mail in a mailbox other than @@ -2577,9 +2972,17 @@ the `+spammers' mailbox by default. Also see the Specify default save filename and default Fcc: mailbox at once - -Usage: fcc-save-hook [!]pattern mailbox - +Usage: + + +fcc-save-hook + +[!]pattern + + +mailbox + + This command is a shortcut, equivalent to doing both a fcc-hook @@ -2595,13 +2998,38 @@ to $index_format. - - -Usage: reply-hook [!]pattern command -Usage: send-hook [!]pattern command -Usage: send2-hook [!]pattern command - - + +Usage: + + +reply-hook + +[!]pattern + + +command + + + + +send-hook + +[!]pattern + + +command + + + + +send2-hook + +[!]pattern + + +command + + These commands can be used to execute arbitrary configuration commands based @@ -2657,9 +3085,17 @@ from a send-hook. Change settings before formatting a message - -Usage: message-hook [!]pattern command - +Usage: + + +message-hook + +[!]pattern + + +command + + This command can be used to execute arbitrary configuration commands @@ -2689,9 +3125,17 @@ message-hook '~f freshmeat-news' 'set pager="less \"+/^ subject: .*\""' Choosing the cryptographic key of the recipient - -Usage: crypt-hook pattern keyid - +Usage: + + +crypt-hook + +pattern + + +keyid + + When encrypting messages with PGP/GnuPG or OpenSSL, you may want to associate a certain @@ -2714,9 +3158,14 @@ just a real name. Adding key sequences to the keyboard buffer - -Usage: push string - +Usage: + + +push + +string + + This command adds the named string to the keyboard buffer. The string may @@ -2736,9 +3185,17 @@ folder-hook . 'push <collapse-all>' Executing functions - -Usage: exec function [ function ... ] - +Usage: + + +exec + +function + + +function + + This command can be used to execute any function. Functions are @@ -2751,12 +3208,29 @@ listed in the function reference. Message Scoring - - -Usage: score pattern value -Usage: unscore pattern [ pattern ... ] - - +Usage: + + +score + +pattern + + +value + + + + +unscore + + +* + + +pattern + + + The score commands adds value to a message's score if pattern @@ -2781,12 +3255,29 @@ of all score entries. Spam detection - - -Usage: spam pattern format -Usage: nospam pattern - - +Usage: + + +spam + +pattern + + +format + + + + +nospam + + +* + + +pattern + + + Mutt has generalized support for external spam-scoring filters. @@ -2923,14 +3414,54 @@ spam "^From: .*MAILER-DAEMON" "999" The following commands are available to manipulate and query variables: - - -Usage: set [no|inv]variable[=value] [ variable ... ] -Usage: toggle variable [variable ... ] -Usage: unset variable [variable ... ] -Usage: reset variable [variable ... ] - - +Usage: + + +set + + + + + + +variable + + +variable=value + + + + + + +toggle + +variable + + +variable + + + + +unset + +variable + + +variable + + + + +reset + +variable + + +variable + + This command is used to set (and unset) configuration variables. There are four basic types of variables: @@ -3108,9 +3639,14 @@ recording the macro's commands into its history. Reading initialization commands from another file - -Usage: source filename - +Usage: + + +source + +filename + + This command allows the inclusion of initialization commands @@ -3135,9 +3671,19 @@ considered to be an executable program from which to read input (eg. Removing hooks - -Usage: unhook [ * | hook-type ] - +Usage: + + +unhook + + +* + + +hook-type + + + This command permits you to flush hooks you have previously defined. @@ -6066,18 +6612,55 @@ to send messages from the command line as well. To read messages in a mailbox - -mutt [ -nz ] [ -F muttrc ] [ -m type ] [ -f mailbox ] - + +mutt + + +muttrc + + +type + + +mailbox + + To compose a new message - -mutt [ -n ] [ -F muttrc ] [ -a file ] [ -c address ] [ -i filename ] [ -s subject ] -[ [ file ... ] -- ] address [ address ... ] - + +mutt + + +muttrc + + +file + + +address + + +filename + + +subject + + + +file + +-- + + +address + + +address + + Mutt also supports a batch mode to send prepared messages. Simply redirect @@ -6113,317 +6696,836 @@ The following are the commands understood by mutt. - - -account-hook pattern command - - - - -alias [ -group name [ ... ] ] key address [ , address, ... ] - + +account-hook + +pattern +command + + - - -unalias [ * | key ... ] - - - - -alternates [ -group name [ ... ] ] regexp [ regexp ... ] - + +alias + + +name + + +key + + +address + + +address + + - - -unalternates [ * | regexp ... ] - - - - -alternative-order mimetype [ mimetype ... ] - + +unalias + + +name + + + +* + + +key + + + - - -unalternative-order mimetype [ mimetype ... ] - - - - -auto_view mimetype [ mimetype ... ] - + +alternates + + +name + + +regexp + + +regexp + + - - -unauto_view mimetype [ mimetype ... ] - - - - -bind map key function - + +unalternates + + +name + + + +* + + +regexp + + + - - -charset-hook alias charset - - - - -iconv-hook charset local-charset - + +alternative-order + +mimetype + + +mimetype + + - - -color object foreground background [ regexp ] - - - - -uncolor index pattern [ pattern ... ] - + +unalternative-order + + +* + + +mimetype + + + - - -exec function [ function ... ] - - - - -fcc-hook pattern mailbox - + +auto-view + +mimetype + + +mimetype + + - -fcc-save-hook pattern mailbox - + +unauto-view + + +* + + +mimetype + + + - - -folder-hook pattern command - - - - -hdr_order header [ header ... ] - + +bind + +map + + +key + + +function + + - - -unhdr_order header [ header ... ] - - - - -ignore pattern [ pattern ... ] - + +charset-hook + +alias + + +charset + + - - -unignore pattern [ pattern ... ] - - - - -lists [ -group name [ ... ] ] regexp [ regexp ... ] - + +iconv-hook + +charset + + +local-charset + + - - -unlists regexp [ regexp ... ] - - - -macro menu key sequence [ description ] + +color + +object + + +foreground + + +background + + + + + +color + + + + + + + + + +foreground + + +background + + +regexp + + + + + +color + + + + +foreground + + +background + + +pattern + + - - -mailboxes filename [ filename ... ] - - - - -mbox-hook pattern mailbox - + +uncolor + + + + +pattern + + - - -message-hook pattern command - - - - -mime_lookup mimetype [ mimetype ... ] - + +exec + +function + + +function + + - - -unmime_lookup mimetype [ mimetype ... ] - - - - -mono object attribute [ regexp ] - + +fcc-hook + +[!]pattern + + +mailbox + + - - -unmono index pattern [ pattern ... ] - - + +fcc-save-hook + +[!]pattern + + +mailbox + + + - -my_hdr string - + + +folder-hook + +[!]regexp + + +command + + + + +group + + +name + + + + +expr + + + +expr + + + + - -unmy_hdr field [ field ... ] - + + +ungroup + + +name + + + +* + + + +expr + + + +expr + + + + + +hdr_order + +header + + +header + + + - -crypt-hook pattern key-id - + + +unhdr_order + + +* + + +header + + + + + +ignore + +pattern + + +pattern + + + - -push string - + + +unignore + + +* + + +pattern + + + + + +lists + + +name + + +regexp + + +regexp + + + - -reset variable [variable ... ] - + + +unlists + + +name + + + +* + + +regexp + + + + + +macro + +menu + + +key + + +sequence + + +description + + + - -save-hook regexp filename - + + +mailboxes + +mailbox + + +mailbox + + + + +unmailboxes + + +* + + +mailbox + + + + - -score pattern value - + + +mbox-hook + +[!]pattern + + +mailbox + + + + +message-hook + +[!]pattern + + +command + + + - -unscore pattern [ pattern ... ] - + + +mime-lookup + +mimetype + + +mimetype + + + + +unmime-lookup + + +* + + +mimetype + + + + + -reply-hook pattern command + +mono + +object + + +attribute + + + + + +mono + + + + + + + + + +attribute + + +regexp + + + + + +mono + + + + +attribute + + +pattern + + - - -send-hook pattern command - + + +unmono + + + + + +* + + +pattern + + + + + +my_hdr + +string + + + - -send2-hook pattern command - + + +unmy_hdr + + +* + + +field + + + + + +crypt-hook + +pattern + + +keyid + + + - -set [no|inv]variable[=value] [ variable ... ] - + + +push + +string + + + + +reset + +variable + + +variable + + + - -unset variable [variable ... ] - + + +save-hook + +[!]pattern + + +mailbox + + + + +score + +pattern + + +value + + + - -source filename - + + +unscore + + +* + + +pattern + + + + + +reply-hook + +[!]pattern + + +command + + + - -spam pattern format - + + +send-hook + +[!]pattern + + +command + + + + +send2-hook + +[!]pattern + + +command + + + - -nospam pattern - + + +set + + + + + + +variable + + +variable=value + + + + + + +unset + +variable + + +variable + + + - -subscribe [ -group name [ ... ] ] regexp [ regexp ... ] - + + +source + +filename + + + + +spam + +pattern + + +format + + + - -unsubscribe regexp [ regexp ... ] - + + +nospam + + +* + + +pattern + + + + + +subscribe + + +name + + +regexp + + +regexp + + + - -toggle variable [variable ... ] - + + +unsubscribe + + +name + + + +* + + +regexp + + + + + +toggle + +variable + + +variable + + + - -unhook hook-type - + + +unhook + + +* + + +hook-type + + + diff --git a/doc/mutt.css b/doc/mutt.css index 58212a034..82045eb1b 100644 --- a/doc/mutt.css +++ b/doc/mutt.css @@ -2,6 +2,7 @@ body { margin-left:2%; margin-right:2%; font-family:serif; } .toc a, .list-of-tables a { font-family:sans-serif; } h1, h2, h3, h4, h5, h6 { font-family:sans-serif; } + em.replaceable code { font-family:sans-serif; } p { text-align:justify; } div.table p.title { font-size:smaller; } div.table p.title b { font-weight:normal; } -- 2.40.0