From d429fb95fd9cccef9ab85560d2c36fbdb83c9790 Mon Sep 17 00:00:00 2001 From: Rocco Rutte Date: Thu, 2 Jul 2009 20:35:22 +0200 Subject: [PATCH] Manual: Render comments in examples a lighter for readability --- ChangeLog | 9 +++ doc/manual.xml.head | 137 +++++++++++++++++++++++--------------------- doc/mutt.css | 1 + 3 files changed, 81 insertions(+), 66 deletions(-) diff --git a/ChangeLog b/ChangeLog index f36bd6856..9d9d5e7bc 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,12 @@ +2009-07-02 20:13 +0200 Rocco Rutte (a7ef17e2e493) + + * doc/manual.xml.head, doc/manual.xml.tail: Manual: Reformat + paragraphs, fix ˜ -> ~ breakage + +2009-07-02 19:36 +0200 Rocco Rutte (d40e288e3fbf) + + * doc/manual.xml.head: Manual: rework MIME chapter a bit + 2009-07-02 16:20 +0200 Rocco Rutte (705534ee1479) * doc/gen-map-doc, doc/manual.xml.tail, functions.h: Manual: Generate diff --git a/doc/manual.xml.head b/doc/manual.xml.head index f54d0d297..6a7b04261 100644 --- a/doc/manual.xml.head +++ b/doc/manual.xml.head @@ -1758,7 +1758,7 @@ the line is ignored. Commenting configuration files -my_hdr X-Disclaimer: Why are you listening to me? # This is a comment +my_hdr X-Disclaimer: Why are you listening to me? # This is a comment @@ -2832,7 +2832,7 @@ x-mailer. Header weeding -# Sven's draconian header weeding +# Sven's draconian header weeding ignore * unignore from date subject to cc unignore organization organisation x-mailer: x-newsreader: x-mailing-list: @@ -3337,13 +3337,13 @@ of $index_format to Using %-expandos in <command>save-hook</command> -# default: save all to ~/Mail/<author name> +# default: save all to ~/Mail/<author name> save-hook . ~/Mail/%F -# save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins +# save from me@turing.cs.hmc.edu and me@cs.hmc.edu to $folder/elkins save-hook me@(turing\\.)?cs\\.hmc\\.edu$ +elkins -# save from aol.com to $folder/spam +# save from aol.com to $folder/spam save-hook aol\\.com$ +spam @@ -4155,7 +4155,7 @@ set my_cfgdir = $HOME/mutt/config source $my_cfgdir/hooks source $my_cfgdir/macros -# more source commands... +# more source commands... @@ -4231,14 +4231,14 @@ conversions. Type conversions using variables -set my_lines = "5" # value is string "5" -set pager_index_lines = $my_lines # value is integer 5 +set my_lines = "5" # value is string "5" +set pager_index_lines = $my_lines # value is integer 5 -set my_sort = "date-received" # value is string "date-received" -set sort = "last-$my_sort" # value is sort last-date-received +set my_sort = "date-received" # value is string "date-received" +set sort = "last-$my_sort" # value is sort last-date-received -set my_inc = $read_inc # value is string "10" (default of $read_inc) -set my_foo = $my_inc # value is string "10" +set my_inc = $read_inc # value is string "10" (default of $read_inc) +set my_foo = $my_inc # value is string "10" @@ -4261,7 +4261,7 @@ considered just a single token. A working example is: set my_pattern = "~A" set my_number = "10" -# same as: score ~A +10 +# same as: score ~A +10 score $my_pattern +$my_number @@ -6817,11 +6817,11 @@ This mailcap file is fairly simple and standard: -# I'm always running X :) +# I'm always running X :) video/*; xanim %s > /dev/null image/*; xv %s > /dev/null -# I'm always running firefox (if my computer had more memory, maybe) +# I'm always running firefox (if my computer had more memory, maybe) text/html; firefox -remote 'openURL(%s)' @@ -6830,40 +6830,40 @@ This mailcap file shows quite a number of examples: -# Use xanim to view all videos Xanim produces a header on startup, -# send that to /dev/null so I don't see it +# Use xanim to view all videos Xanim produces a header on startup, +# send that to /dev/null so I don't see it video/*; xanim %s > /dev/null -# Send html to a running firefox by remote +# Send html to a running firefox by remote text/html; firefox -remote 'openURL(%s)'; test=RunningFirefox -# If I'm not running firefox but I am running X, start firefox on the -# object +# If I'm not running firefox but I am running X, start firefox on the +# object text/html; firefox %s; test=RunningX -# Else use lynx to view it as text +# Else use lynx to view it as text text/html; lynx %s -# This version would convert the text/html to text/plain +# This version would convert the text/html to text/plain text/html; lynx -dump %s; copiousoutput -# I use enscript to print text in two columns to a page +# I use enscript to print text in two columns to a page text/*; more %s; print=enscript -2Gr %s -# Firefox adds a flag to tell itself to view jpegs internally +# Firefox adds a flag to tell itself to view jpegs internally image/jpeg;xv %s; x-mozilla-flags=internal -# Use xv to view images if I'm running X -# In addition, this uses the \ to extend the line and set my editor -# for images +# Use xv to view images if I'm running X +# In addition, this uses the \ to extend the line and set my editor +# for images image/*;xv %s; test=RunningX; \ edit=xpaint %s -# Convert images to text using the netpbm tools +# Convert images to text using the netpbm tools image/*; (anytopnm %s | pnmscale -xysize 80 46 | ppmtopgm | pgmtopbm | pbmtoascii -1x2 ) 2>&1 ; copiousoutput -# Send excel spreadsheets to my NT box +# Send excel spreadsheets to my NT box application/ms-excel; open.pl %s @@ -7098,49 +7098,54 @@ commented out define the default configuration of the lists. Attachment counting -## Removing a pattern from a list removes that pattern literally. It -## does not remove any type matching the pattern. -## -## attachments +A */.* -## attachments +A image/jpeg -## unattachments +A */.* -## -## This leaves "attached" image/jpeg files on the allowed attachments -## list. It does not remove all items, as you might expect, because the -## second */.* is not a matching expression at this time. -## -## Remember: "unattachments" only undoes what "attachments" has done! -## It does not trigger any matching on actual messages. - -## Qualify any MIME part with an "attachment" disposition, EXCEPT for -## text/x-vcard and application/pgp parts. (PGP parts are already known -## to mutt, and can be searched for with ~g, ~G, and ~k.) -## -## I've added x-pkcs7 to this, since it functions (for S/MIME) -## analogously to PGP signature attachments. S/MIME isn't supported -## in a stock mutt build, but we can still treat it specially here. -## + +# Removing a pattern from a list removes that pattern literally. It +# does not remove any type matching the pattern. +# +# attachments +A */.* +# attachments +A image/jpeg +# unattachments +A */.* +# +# This leaves "attached" image/jpeg files on the allowed attachments +# list. It does not remove all items, as you might expect, because the +# second */.* is not a matching expression at this time. +# +# Remember: "unattachments" only undoes what "attachments" has done! +# It does not trigger any matching on actual messages. + +# Qualify any MIME part with an "attachment" disposition, EXCEPT for +# text/x-vcard and application/pgp parts. (PGP parts are already known +# to mutt, and can be searched for with ~g, ~G, and ~k.) +# +# I've added x-pkcs7 to this, since it functions (for S/MIME) +# analogously to PGP signature attachments. S/MIME isn't supported +# in a stock mutt build, but we can still treat it specially here. +# + attachments +A */.* attachments -A text/x-vcard application/pgp.* attachments -A application/x-pkcs7-.* -## Discount all MIME parts with an "inline" disposition, unless they're -## text/plain. (Why inline a text/plain part unless it's external to the -## message flow?) -## + +# Discount all MIME parts with an "inline" disposition, unless they're +# text/plain. (Why inline a text/plain part unless it's external to the +# message flow?) + attachments +I text/plain -## These two lines make Mutt qualify MIME containers. (So, for example, -## a message/rfc822 forward will count as an attachment.) The first -## line is unnecessary if you already have "attach-allow */.*", of -## course. These are off by default! The MIME elements contained -## within a message/* or multipart/* are still examined, even if the -## containers themselves don't qualify. -## + +# These two lines make Mutt qualify MIME containers. (So, for example, +# a message/rfc822 forward will count as an attachment.) The first +# line is unnecessary if you already have "attach-allow */.*", of +# course. These are off by default! The MIME elements contained +# within a message/* or multipart/* are still examined, even if the +# containers themselves don't qualify. + #attachments +A message/.* multipart/.* #attachments +I message/.* multipart/.* + -## You probably don't really care to know about deleted attachments. +## You probably don't really care to know about deleted attachments. attachments -A message/external-body attachments -I message/external-body @@ -7993,11 +7998,11 @@ linkend="folder-hook">folder-hooks: -# use very high $read_inc to speed up reading hcache'd maildirs +# use very high $read_inc to speed up reading hcache'd maildirs folder-hook . 'set read_inc=1000' -# use lower value for reading slower remote IMAP folders +# use lower value for reading slower remote IMAP folders folder-hook ^imap 'set read_inc=100' -# use even lower value for reading even slower remote POP folders +# use even lower value for reading even slower remote POP folders folder-hook ^pop 'set read_inc=1' diff --git a/doc/mutt.css b/doc/mutt.css index 73da38cd7..5a37b3cc4 100644 --- a/doc/mutt.css +++ b/doc/mutt.css @@ -22,3 +22,4 @@ div.note { margin-bottom: 5px; } .command { font-family: monospace; font-weight: normal; } .command strong { font-weight: normal; } tr { vertical-align: top; } +.comment { color:#707070; } -- 2.40.0