X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fscan.man;h=7510505cdf7e07aef87d801eb2e81d6401c963d8;hb=5e5e8b753acc7ff1e16c7fca172a2151a6c01353;hp=d4e12e0759eb1fdf1492f75f25a99bfb026cd98a;hpb=fc25a4f840747685117a482f9a0cf6296224ea1a;p=mmh diff --git a/man/scan.man b/man/scan.man index d4e12e0..7510505 100644 --- a/man/scan.man +++ b/man/scan.man @@ -1,4 +1,4 @@ -.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH SCAN %manext1% "November 6, 2012" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -158,11 +158,11 @@ or switches are used. This permits individual fields of the scan listing to be extracted with ease. The string is simply a format string and the file is simply a format file. See -.BR mh\-format (5) +.IR mh\-format (5) for the details. .PP In addition to the standard -.BR mh\-format (5) +.IR mh\-format (5) escapes, .B scan also recognizes the following additional @@ -189,6 +189,12 @@ modification of the message file itself. This feature is handy for scanning a draft folder, as message drafts usually aren't allowed to have dates in them. .PP +The +.B %etcdir% +directory contains several format files as examples of customized +.B scan +output. +.PP .B scan will update the .B nmh @@ -198,14 +204,12 @@ so interrupting a long listing preserves the new context. .B nmh purists hate this idea. - .SH FILES .fc ^ ~ .nf .ta \w'%etcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile .fi - .SH "PROFILE COMPONENTS" .fc ^ ~ .nf @@ -215,10 +219,10 @@ purists hate this idea. ^Alternate\-Mailboxes:~^To determine the user's mailboxes ^Current\-Folder:~^To find the default current folder .fi - .SH "SEE ALSO" -inc(1), pick(1), show(1), mh\-format(5) - +.IR pick (1), +.IR show (1), +.IR mh\-format (5) .SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" @@ -227,26 +231,15 @@ inc(1), pick(1), show(1), mh\-format(5) .RB ` \-noheader ' .RB ` \-width "' defaulted to the width of the terminal" .fi - .SH CONTEXT If a folder is given, it will become the current folder. - .SH HISTORY Prior to using the format string mechanism, .B \-header used to generate a heading saying what each column in the listing was. Format strings prevent this from happening. - .SH BUGS -The argument to the -.B \-format -switch must be interpreted as a single -token by the shell that invokes -.BR scan . -Therefore, one must usually -place the argument to this switch inside quotes. -.PP The value of each .I component escape is set by