Use result, because (void) didn't prevent warning on FreeBSD 10.

[nmh] / man / mhshow.man

diff --git a/man/mhshow.man b/man/mhshow.man
index 0d34d22f99650fe7a960975fad8e4c4f6eb8bba9..0df1fcf1a6b267e11894d75570b4c5a1bd7d130c 100644 (file)
--- a/man/mhshow.man
+++ b/man/mhshow.man
@@ -1,4 +1,4 @@
-.TH MHSHOW %manext1% "February 6, 2015" "%nmhversion%"
+.TH MHSHOW %manext1% "March 24, 2016" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"


@@ -8,6 +8,8 @@ mhshow \- display MIME messages
 .HP 5
 .na
 .B mhshow
 .HP 5
 .na
 .B mhshow

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-file
 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-file


@@ -24,6 +26,7 @@ mhshow \- display MIME messages
 .RB [ \-concat " | " \-noconcat ]
 .RB [ \-textonly " | " \-notextonly ]
 .RB [ \-inlineonly " | " \-noinlineonly ]
 .RB [ \-concat " | " \-noconcat ]
 .RB [ \-textonly " | " \-notextonly ]
 .RB [ \-inlineonly " | " \-noinlineonly ]

+.RB [ \-header " | " \-noheader ]

 .RB [ \-form
 .IR formfile ]
 .RB [ \-markform
 .RB [ \-form
 .IR formfile ]
 .RB [ \-markform


@@ -33,8 +36,6 @@ mhshow \- display MIME messages
 .RB [ \-wcache
 .IR policy ]
 .RB [ \-check " | " \-nocheck ]
 .RB [ \-wcache
 .IR policy ]
 .RB [ \-check " | " \-nocheck ]

-.RB [ \-version ]
-.RB [ \-help ]

 .ad
 .SH DESCRIPTION
 The
 .ad
 .SH DESCRIPTION
 The


@@ -74,9 +75,25 @@ switches will override the default settings of
 and
 .BR \-inlineonly.
 .PP
 and
 .BR \-inlineonly.
 .PP

+The
+.B \-header
+switch control whether
+.B mhshow
+will print a message separator header before each message that it
+displays.  The header format can be controlled using
+.B \-headerform
+to specify a file containing
+.IR mh\-format (5)
+instructions.  A copy of the built-in default
+headerform can be found in %nmhetcdir%/mhshow.header, for reference.
+In addition to the normal set of
+.IR mh\-format (5)
+instructions, a "%{folder}" escape provides a
+string representing the current folder.
+.PP

 By default
 .B mhshow
 By default
 .B mhshow

-will concatenate all content under one pager.  If you which each part to
+will concatenate all content under one pager.  If you want each part to

 displayed separately, you can override the default behavior with
 .B \-noconcat.
 .PP
 displayed separately, you can override the default behavior with
 .B \-noconcat.
 .PP


@@ -260,7 +277,7 @@ the file end in a specific suffix.  For example, the
 command (part of the StarOffice package) can be used to display
 Microsoft Word content, but it uses the suffix to determine how to display
 the file.  If no suffix is present, the file is not correctly loaded.
 command (part of the StarOffice package) can be used to display
 Microsoft Word content, but it uses the suffix to determine how to display
 the file.  If no suffix is present, the file is not correctly loaded.

-Similarily, older versions of the
+Similarly, older versions of the

 .B gs
 command append a \*(lq.ps\*(rq suffix to
 the filename if one was missing.  As a result, these cannot be used to read
 .B gs
 command append a \*(lq.ps\*(rq suffix to
 the filename if one was missing.  As a result, these cannot be used to read


@@ -333,7 +350,7 @@ The display string may contain the following escapes:
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-.B Mhshow
+.B mhshow

 will
 execute at most one display string at any given time, and wait for the
 current display string to finish execution before executing the next
 will
 execute at most one display string at any given time, and wait for the
 current display string to finish execution before executing the next


@@ -604,7 +621,7 @@ and writing to, the cache, respectively.  One of four policies may be
 specified: \*(lqpublic\*(rq, indicating that
 .B mhshow
 should make use
 specified: \*(lqpublic\*(rq, indicating that
 .B mhshow
 should make use

-of a publically-accessible content cache; \*(lqprivate\*(rq, indicating
+of a publicly-accessible content cache; \*(lqprivate\*(rq, indicating

 that
 .B mhshow
 should make use of the user's private content cache;
 that
 .B mhshow
 should make use of the user's private content cache;


@@ -658,7 +675,7 @@ mhshow-show-<type>
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-need be present in this additional profile. Finally,
+need be present in this additional profile.  Finally,

 .B mhshow
 will attempt to consult
 .PP
 .B mhshow
 will attempt to consult
 .PP


@@ -680,8 +697,9 @@ next.  The default marker can be changed using the
 .B \-markform
 switch to specify a file containing
 .IR mh\-format (5)
 .B \-markform
 switch to specify a file containing
 .IR mh\-format (5)

-instructions to use when displaying the content marker.  In addition to
-the normal set of
+instructions to use when displaying the content marker.  A copy of the
+default markform can be found in %nmhetcdir%/mhshow.marker, for
+reference.  In addition to the normal set of

 .IR mh\-format (5)
 instructions, the following
 .I component
 .IR mh\-format (5)
 instructions, the following
 .I component


@@ -731,6 +749,7 @@ is checked.
 ^%nmhetcdir%/mhn.defaults~^System default MIME profile entries
 ^%nmhetcdir%/mhl.headers~^The headers template
 ^%nmhetcdir%/mhshow.marker~^Example content marker
 ^%nmhetcdir%/mhn.defaults~^System default MIME profile entries
 ^%nmhetcdir%/mhl.headers~^The headers template
 ^%nmhetcdir%/mhshow.marker~^Example content marker

+^%nmhetcdir%/mhshow.header~^Example message separator header

 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~