Use variable-size (but in one case, fixed but larger) buffers for the SASL

[nmh] / man / mhshow.man

diff --git a/man/mhshow.man b/man/mhshow.man
index 7cb76cf11b780391f8e8c854e8fe3ffde60daa20..ac228f06bec8e076bac1014f0ce3545457813f11 100644 (file)
--- a/man/mhshow.man
+++ b/man/mhshow.man
@@ -1,4 +1,4 @@
-.TH MHSHOW %manext1% "February 9, 2014" "%nmhversion%"
+.TH MHSHOW %manext1% "April 9, 2014" "%nmhversion%"

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


@@ -18,10 +18,13 @@ mhshow \- display MIME messages
 .RB [ \-type
 .IR content ]
 \&...
 .RB [ \-type
 .IR content ]
 \&...

-.RB [ \-serialonly " | " \-noserialonly ]
-.RB [ \-pause " | " \-nopause ]
+.RB [ \-concat " | " \-noconcat ]
+.RB [ \-textonly " | " \-notextonly ]
+.RB [ \-inlineonly " | " \-noinlineonly ]

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

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

 .RB [ \-rcache
 .IR policy ]
 .RB [ \-wcache
 .RB [ \-rcache
 .IR policy ]
 .RB [ \-wcache


@@ -46,16 +49,34 @@ message headers as specified in RFC 2047.
 .PP
 By default
 .B mhshow
 .PP
 By default
 .B mhshow

-will display all parts of a multipart
-message.  By using the
+will display only text parts of a message that are not marked as attachments.
+This behavior can be changed by the
+.B \-notextonly
+and
+.B \-noinlineonly
+switches.
+In addition, by using the

 .B \-part
 and
 .B \-type
 switches, you may
 .B \-part
 and
 .B \-type
 switches, you may

-limit the scope of
+further limit the scope of

 .B mhshow
 to particular subparts (of a
 .B mhshow
 to particular subparts (of a

-multipart content) and/or particular content types.
+multipart content) and/or particular content types.  The inclusion of any
+.B \-part
+or
+.B \-type
+switches will override the default settings of
+.B \-textonly
+and
+.BR \-inlineonly.
+.PP
+By default
+.B mhshow
+will concatenate all content under one pager.  If you which each part to
+displayed separately, you can override the default behavior with
+.B \-noconcat.

 .PP
 The option
 .B \-file
 .PP
 The option
 .B \-file


@@ -224,38 +245,43 @@ The display string may contain the following escapes:
 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-.ta \w'%F  'u
-%a     Insert parameters from Content-Type field
-%e     exclusive execution
-%f     Insert filename containing content
-%F     %e, %f, and stdin is terminal not content
-%l     display listing prior to displaying content
-%p     %l, and ask for confirmation
-%s     Insert content subtype
-%d     Insert content description
-%%     Insert the character %
+.ta \w'%F        'u
+%a        Insert parameters from Content-Type field
+%{parameter} Insert the parameter value from the Content-Type field
+%f        Insert filename containing content
+%F        %f, and stdin is terminal not content
+%l        display listing prior to displaying content
+%s        Insert content subtype
+%d        Insert content description
+%%        Insert the character %

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-For those display strings containing the e- or F-escape,
-.B mhshow
+.B Mhshow

 will
 will

-execute at most one of these at any given time.  Although the F-escape
-expands to be the filename containing the content, the e-escape has no
-expansion as far as the shell is concerned.
+execute at most one display string at any given time, and wait for the
+current display string to finish execution before executing the next
+display string.

 .PP
 .PP

-When the p-escape prompts for confirmation, typing INTR (usually
-control-C) will tell
-.B mhshow
-not to display that content.
-The p-escape can be disabled by specifying the switch
-.BR \-nopause .
-Further, when
-.B mhshow
-is display a content, typing QUIT (usually
-control-\\) will tell
-.B mhshow
-to wrap things up immediately.
+The {parameter} escape is typically used in a command line argument
+that should only be present if it has a non-null value.  Its value
+will be wrapped with single quotes if the escape is not so wrapped.
+Shell parameter expansion can construct the argument only when it is
+non-null, e.g.,
+.PP
+.RS 5
+.nf
+mhshow-show-text/html: charset=%{charset};
+  w3m ${charset:+-I $charset} -T text/html %F
+.fi
+.RE
+.PP
+That example also shows the use of indentation to signify continuation:
+the two text lines combine to form a single entry.  Note that when
+dealing with text that has been converted internally by
+.IR iconv (3),
+the \*(lqcharset\*(rq parameter will reflect the target character set
+of the text, rather than the original character set in the message.

 .PP
 Note that if the content being displayed is multipart, but not one of
 the subtypes listed above, then the f- and F-escapes expand to multiple
 .PP
 Note that if the content being displayed is multipart, but not one of
 the subtypes listed above, then the f- and F-escapes expand to multiple


@@ -268,8 +294,8 @@ behaves as if these profile entries were supplied and supported:
 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-mhshow-show-text/plain: %pmoreproc '%F'
-mhshow-show-message/rfc822: %pshow -file '%F'
+mhshow-show-text/plain: %lmoreproc %F
+mhshow-show-message/rfc822: %lshow -file %F

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP


@@ -299,34 +325,32 @@ Example entries might be:
 .RS 5
 .nf
 mhshow-show-audio/basic: raw2audio 2>/dev/null | play
 .RS 5
 .nf
 mhshow-show-audio/basic: raw2audio 2>/dev/null | play

-mhshow-show-image: xv '%f'
+mhshow-show-image: xv %f

 mhshow-show-application/PostScript: lpr -Pps
 .fi
 .RE
 .PP
 mhshow-show-application/PostScript: lpr -Pps
 .fi
 .RE
 .PP

-Note that when using the f- or F-escape, it's a good idea to use
-single-quotes around the escape.  This prevents misinterpretation by
-the shell of any funny characters that might be present in the filename.
+If an f- or F-escape is not quoted with single quotes, its expansion
+will be wrapped with single quotes.

 .PP
 Finally,
 .B mhshow
 will process each message serially\0--\0it won't start
 showing the next message until all the commands executed to display the
 .PP
 Finally,
 .B mhshow
 will process each message serially\0--\0it won't start
 showing the next message until all the commands executed to display the

-current message have terminated.  In the case of a multipart content
-(of any subtype listed above), the content contains advice indicating if
-the parts should be displayed serially or in parallel.  Because this may
-cause confusion, particularly on uni-window displays, the
-.B \-serialonly
-switch can be given to tell
-.B mhshow
-to never display parts in parallel.
+current message have terminated.

 .SS "Showing Alternate Character Sets"
 If
 .B mhshow
 was built with
 .IR iconv (3),
 then all text/plain parts of the message(s) will be displayed using
 .SS "Showing Alternate Character Sets"
 If
 .B mhshow
 was built with
 .IR iconv (3),
 then all text/plain parts of the message(s) will be displayed using

-the character set of the current locale.  To convert text parts other
+the character set of the current locale.  See the
+.BR mhparam (1)
+man page for how determine whether your
+.B nmh
+installation includes
+.IR iconv (3)
+support.  To convert text parts other

 than text/plain, or if
 .B mhshow
 was not built with
 than text/plain, or if
 .B mhshow
 was not built with


@@ -339,7 +363,7 @@ set, when
 encounters a \*(lqcharset\*(rq parameter for
 this content, it checks if your terminal can display this character
 set natively.
 encounters a \*(lqcharset\*(rq parameter for
 this content, it checks if your terminal can display this character
 set natively.

-.B mhn
+.B mhshow

 checks this by examining the current character set defined by the
 .IR locale (1)
 environment variables.
 checks this by examining the current character set defined by the
 .IR locale (1)
 environment variables.


@@ -560,8 +584,7 @@ mhshow-show-<type>
 .PP
 need be present in this additional profile. Finally,
 .B mhshow
 .PP
 need be present in this additional profile. Finally,
 .B mhshow

-will attempt to consult one other additional user profile,
-e.g.,
+will attempt to consult

 .PP
 .RS 5
 %etcdir%/mhn.defaults
 .PP
 .RS 5
 %etcdir%/mhn.defaults


@@ -570,6 +593,50 @@ e.g.,
 which is created automatically during
 .B nmh
 installation.
 which is created automatically during
 .B nmh
 installation.

+.PP
+See "Profile Lookup" in
+.IR mh-profile (5)
+for the profile search order, and for how duplicate entries are treated.
+.SS Content\-Type Marker
+.B mhshow
+will display a marker containing information about the part being displayed
+next.  The default marker can be changed using the
+.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
+.IR mh\-format (5)
+instructions, the following
+.I component
+escapes are supported:
+.PP
+.RS 5
+.nf
+.ta \w'cdispo-<PARAM>  'u +\w'Returns   'u
+.I "Escape     Returns Description"
+part   string  MIME part number
+content\-type  string  MIME Content\-Type of part
+description    string  Content\-Description header
+disposition    string  Content disposition (attachment or inline)
+ctype-<PARAM>  string  Value of <PARAM> from Content\-Type header
+cdispo-<PARAM> string  Value of <PARAM> from
+               Content\-Disposition header
+%(size)        integer The size of the decoded part, in bytes
+%(unseen)      boolean Returns true for suppressed parts
+.fi
+In this context, the %(unseen) function indicates whether
+.B mhshow
+has decided to not display a particular part due to the
+.B \-textonly
+or
+.B \-inlineonly
+switches.
+.RE
+All MIME parameters and the \*(lqContent-Description\*(rq header will have
+RFC 2231 decoding applied and be converted
+to the local character set.
+.PP

 .SH FILES
 .B mhshow
 looks for all format files and mhn.defaults in multiple locations:
 .SH FILES
 .B mhshow
 looks for all format files and mhn.defaults in multiple locations:


@@ -587,6 +654,7 @@ is checked.
 ^$MHSHOW~^Additional profile entries
 ^%etcdir%/mhn.defaults~^System default MIME profile entries
 ^%etcdir%/mhl.headers~^The headers template
 ^$MHSHOW~^Additional profile entries
 ^%etcdir%/mhn.defaults~^System default MIME profile entries
 ^%etcdir%/mhl.headers~^The headers template

+^%etcdir%/mhshow.marker~^Example content marker

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


@@ -610,6 +678,7 @@ is checked.
 .IR mhbuild (1),
 .IR mhl (1),
 .IR mhlist (1),
 .IR mhbuild (1),
 .IR mhl (1),
 .IR mhlist (1),

+.IR mhparam (1),

 .IR mhstore (1),
 .IR sendfiles (1)
 .SH DEFAULTS
 .IR mhstore (1),
 .IR sendfiles (1)
 .SH DEFAULTS


@@ -617,10 +686,11 @@ is checked.
 .RB ` +folder "' defaults to the current folder"
 .RB ` msgs "' defaults to cur"
 .RB ` \-nocheck '
 .RB ` +folder "' defaults to the current folder"
 .RB ` msgs "' defaults to cur"
 .RB ` \-nocheck '

+.RB ` \-concat '
+.RB ` \-textonly '
+.RB ` \-inlineonly '

 .RB ` \-form\ mhl.headers '
 .RB ` \-form\ mhl.headers '

-.RB ` \-pause '

 .RB ` \-rcache\ ask '
 .RB ` \-rcache\ ask '

-.RB ` \-noserialonly '

 .RB ` \-wcache\ ask '
 .fi
 .SH CONTEXT
 .RB ` \-wcache\ ask '
 .fi
 .SH CONTEXT