X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/19bf8698eeb0ab3d7694232af115fa3f007d5c7b..ec173fd2c:/man/mhshow.man?ds=sidebyside diff --git a/man/mhshow.man b/man/mhshow.man index fd696e08..4cbbd191 100644 --- a/man/mhshow.man +++ b/man/mhshow.man @@ -1,13 +1,15 @@ -.TH MHSHOW %manext1% "April 9, 2014" "%nmhversion%" -.\" +.TH MHSHOW %manext1% 2015-02-08 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .SH NAME -mhshow \- display MIME messages +mhshow \- display nmh MIME messages .SH SYNOPSIS .HP 5 .na .B mhshow +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder ] .RI [ msgs ] .RB [ \-file @@ -18,9 +20,14 @@ mhshow \- display MIME messages .RB [ \-type .IR content ] \&... +.RB [ \-prefer +.IR content ] +\&... +.RB [ \-noprefer ] .RB [ \-concat " | " \-noconcat ] .RB [ \-textonly " | " \-notextonly ] .RB [ \-inlineonly " | " \-noinlineonly ] +.RB [ \-header " | " \-noheader ] .RB [ \-form .IR formfile ] .RB [ \-markform @@ -30,87 +37,133 @@ mhshow \- display MIME messages .RB [ \-wcache .IR policy ] .RB [ \-check " | " \-nocheck ] -.RB [ \-version ] -.RB [ \-help ] .ad .SH DESCRIPTION The .B mhshow -command display contents of a MIME (multi-media) -message or collection of messages. +command displays contents of a MIME (multi-media) message, or collection +of messages. .PP .B mhshow -manipulates multi-media messages as specified in -RFC 2045 to RFC 2049. Currently +manipulates multi-media messages as specified in RFC 2045 to RFC 2049. +Currently .B mhshow -only supports -encodings in message bodies, and does not support the encoding of -message headers as specified in RFC 2047. +only supports encodings in message bodies, and does not support the +encoding of message headers as specified in RFC 2047. .PP -By default +By default, .B mhshow -will display only text parts of a message that are not marked as attachments. -This behavior can be changed by the +will display only the 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 +.BR \-part , +.BR \-type , and -.B \-type -switches, you may -further limit the scope of -.B mhshow -to particular subparts (of a -multipart content) and/or particular content types. The inclusion of any +.B \-prefer +switches, you may limit and reorder the set of parts to be displayed, +based on part number and/or content type. +The inclusion of any .B \-part or .B \-type switches will override the default settings of .B \-textonly and -.BR \-inlineonly. +.BR \-inlineonly . +.PP +The +.B \-header +switch controls whether +.B mhshow +will print a message separator header before each message that it +displays. The header format can be controlled using +.BR \-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 +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 +will concatenate all content under one pager. If you want each part to +be displayed separately, you can override the default behavior with .B \-noconcat. .PP -The option +The .B \-file .I file -directs +switch directs .B mhshow -to use the specified file as -the source message, rather than a message from a folder. If you specify -this file as \*(lq-\*(rq, then +to use the specified file as the source message, rather than a message +from a folder. If you specify this file as \*(lq-\*(rq, then .B mhshow -will accept the source message -on the standard input. Note that the file, or input from standard input -should be a validly formatted message, just like any other +will accept the source message on the standard input. Note that the +file, or input from standard input, should be a validly formatted message, +just like any other .B nmh message. It should -.B NOT +.I not be in mail drop format (to convert a file in mail drop format to a folder of .B nmh messages, see .IR inc (1)). .PP +The +.B \-part +switch can be given (one or more times) to restrict the set of +subparts that will be displayed. (Obviously with no +.B \-part +switches, all parts will be considered.) If a +.B \-part +switch specifies a specific subpart (i.e., a "leaf" in the tree of +MIME parts), then that part will always be displayed. If a +.B \-part +switch references a multipart/alternative part, then (in +the absence of a +.B \-type +switch) only the default subpart of that multipart will be displayed. +.PP A part specification consists of a series of numbers separated by dots. For example, in a multipart content containing three parts, these would be named as 1, 2, and 3, respectively. If part 2 was also a multipart content containing two parts, these would be named as 2.1 and 2.2, respectively. Note that the .B \-part -switch is effective for only -messages containing a multipart content. If a message has some other -kind of content, or if the part is itself another multipart content, the +switch is effective only for messages containing a multipart content. +If a message has some other kind of content, or if the part is itself +another multipart content, the .B \-part switch will not prevent the content from being acted upon. .PP +The +.B \-type +switch can also be used to restrict (or, when used in conjunction with +.BR \-part , +to further restrict) the display of parts according to content type. +One or more +.B \-type +switches part will only select the first match from a multipart/alternative, +even if there is more than one subpart that matches (one of) the given +content type(s). +.PP +Using either +.B \-part +or +.B -type +switches alone will cause either switch to select the part(s) they match. +Using them together will select only the part(s) matched by both (sets of) +switches. In other words, the result is the intersection, and not the union, +of their separate match results. +.PP A content specification consists of a content type and a subtype. The initial list of \*(lqstandard\*(rq content types and subtypes can be found in RFC 2046. @@ -137,43 +190,86 @@ A legal MIME message must contain a subtype specification. To specify a content, regardless of its subtype, just use the name of the content, e.g., \*(lqaudio\*(rq. To specify a specific subtype, separate the two with a slash, e.g., \*(lqaudio/basic\*(rq. -Note that regardless of the values given to the `\-type' switch, a -multipart content (of any subtype listed above) is always acted upon. -Further note that if the `\-type' switch is used, and it is desirable to -act on a message/external-body content, then the `\-type' switch must -be used twice: once for message/external-body and once for the content -externally referenced. +Note that regardless of the values given to the +.B \-type +switch, a multipart content (of any subtype listed above) is always +acted upon. Further note that if the +.B \-type +switch is used, and it is desirable to act on a message/external-body +content, then the +.B \-type +switch must be used twice: once for message/external-body and once +for the content externally referenced. +.PP +In the absence of +.BR \-prefer , +.B mhshow +will select the "best" displayable subpart from multipart/alternative +content. The +.B \-prefer +switch can be used (one or more times, in order of ascending +preference) to let MH know which content types from a +multipart/alternative MIME part are preferred by the user, in order to +override the default selection for display. For example, mail is +often sent containing both plaintext and HTML-formatted versions of +the same content, and the HTML version is usually indicated to be the +"best" format for viewing. Using \*(lq-prefer text/plain\*(rq will +cause the plaintext version to be displayed if possible, but still +allow display of the HTML part if there is no plaintext subpart +available. Using \*(lq-prefer text/plain -prefer image/png\*(rq +would add a preference for PNG images, which might or might not +ever appear in the same multipart/alternative section with text/plain. +Implementation note: RFC 2046 requires that the subparts +of a multipart/alternative be ordered according to "faithfulness to +the original content", and MH by default selects the subpart ranked +most "faithful" by that ordering. The +.B \-prefer +switch reorders the alternative parts (only internally, never changing +the message file) to move the user's preferred part(s) to the "most +faithful" position. Thus, when viewed by +.BR mhlist , +the ordering of multipart/alternative parts will appear to change when +invoked with or without various +.B \-prefer +switches. Since the last of multiple +.B \-prefer +options "wins", a +.B \-prefer +on the command line will override any in a profile entry. +.PP +The +.B \-noprefer +switch will cancel any previous +.B \-prefer +switches. .SS "Unseen Sequence" If the profile entry \*(lqUnseen\-Sequence\*(rq is present and -non\-empty, then +non-empty, then .B mhshow -will remove each of the messages shown -from each sequence named by the profile entry. +will remove each of the messages shown from each sequence named by +the profile entry. .SS "Checking the Contents" The .B \-check switch tells .B mhshow -to check each content for an -integrity checksum. If a content has such a checksum (specified as a -Content-MD5 header field), then +to check each content for an integrity checksum. If a content has such +a checksum (specified as a Content-MD5 header field), then .B mhshow -will attempt to verify the -integrity of the content. +will attempt to verify the integrity of the content. .SS "Showing the Contents" The headers of each message are displayed with the .I mhlproc (usually .BR mhl ), -using the standard format file +using the standard format file, .IR mhl.headers . -You may specify an alternate format file with the +You may specify an alternative format file with the .B \-form .I formfile switch. If the format file .I mhl.null -is specified, then the display -of the message headers is suppressed. +is specified, then the display of the message headers is suppressed. .PP Next, the contents are extracted from the message and are stored in a temporary file. Usually, the name of the temporary file is the @@ -184,11 +280,10 @@ 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. -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 -the default temporary file. +command append a \*(lq.ps\*(rq suffix to the filename if one was missing. +As a result, these cannot be used to read the default temporary file. .PP To get around this, your profile can contain lines of the form: .PP @@ -216,6 +311,9 @@ mhshow-suffix-application/PostScript: .ps .PP to automatically append a suffix to the temporary files. .PP +The matching with the content type identifier is case-insensitive, both in +mhshow-suffix- and mhshow-show- (below) profile entries. +.PP The method used to display the different contents in the messages bodies will be determined by a \*(lqdisplay string\*(rq. To find the display string, @@ -226,7 +324,7 @@ will first search your profile for an entry of the form: mhshow-show-/ .RE .PP -to determine the display string. If this isn't found, +If this isn't found, .B mhshow will search for an entry of the form: .PP @@ -237,8 +335,7 @@ mhshow-show- to determine the display string. .PP If a display string is found, any escapes (given below) will be expanded. -The result will be executed under -\*(lq/bin/sh\*(rq, with the standard input +The result will be executed under \*(lq/bin/sh\*(rq, with the standard input set to the content. .PP The display string may contain the following escapes: @@ -257,21 +354,20 @@ The display string may contain the following escapes: .fi .RE .PP -.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 -display string. +.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 display string. .PP 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. +that should only be present if it has a non-null value. It is highly +recommended that the entire escape be wrapped in double quotes. 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}; +mhshow-show-text/html: charset="%{charset}"; w3m ${charset:+-I $charset} -T text/html %F .fi .RE @@ -285,7 +381,7 @@ 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 -filenames, one for each subordinate content. Further, stdin is not +filenames, one for each subordinate content. Furthermore, stdin is not redirected from the terminal to the content. .PP If a display string is not found, @@ -312,8 +408,8 @@ multipart (without a profile entry), will be treated as multipart/mixed. .PP If none of these apply, then .B mhshow -will check to see if the message -has an application/octet-stream content with parameter \*(lqtype=tar\*(rq. +will check to see if the message has an application/octet-stream content +with parameter \*(lqtype=tar\*(rq. If so, .B mhshow will use an appropriate command. If not, @@ -335,23 +431,22 @@ 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 -current message have terminated. +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. .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. See the -.BR mhparam (1) -man page for how determine whether your +the character set of the current locale. See +.IR mhparam (1) +for how to determine whether your .B nmh installation includes .IR iconv (3) -support. To convert text parts other -than text/plain, or if +support. To convert text parts other than text/plain, or if .B mhshow was not built with .IR iconv , @@ -360,14 +455,12 @@ an external program can be used, as described next. Because a content of type text might be in a non-ASCII character set, when .B mhshow -encounters a \*(lqcharset\*(rq parameter for -this content, it checks if your terminal can display this character -set natively. -.B mhn +encounters a \*(lqcharset\*(rq parameter for this content, it checks +if your terminal can display this character set natively. +.B mhshow checks this by examining the current character set defined by the .IR locale (1) -environment variables. -If the value of the locale character set is equal +environment variables. If the value of the locale character set is equal to the value of the charset parameter, then .B mhshow assumes it can @@ -404,19 +497,19 @@ The first example tells .B mhshow to start .B xterm -and load the -appropriate character set for that message content. The second example +and load the appropriate character set for that message content. +The second example tells .B mhshow -that your pager (or other program handling that content -type) can handle that character set, and that no special processing is +that your pager (or other program handling that content type) can +handle that character set, and that no special processing is needed beforehand. .PP -Note that many pagers strip off the high-order bit or have problems +Note that many pagers strip off the high-order bit, or have problems displaying text with the high-order bit set. However, the pager .B less has support for single-octet character sets. For example, messages -encoded in the ISO-8859-1 character set can be view using +encoded in the ISO-8859-1 character set can be viewed using .BR less , with these environment variable settings: .PP @@ -430,36 +523,31 @@ LESS -f .PP The first setting tells .B less -to use the ISO-8859-1 definition for -determining whether a character is \*(lqnormal\*(rq, \*(lqcontrol\*(lq, -or \*(lqbinary\*(rq. The second setting tells +to use the ISO-8859-1 definition to determine whether a character is +\*(lqnormal\*(rq, \*(lqcontrol\*(lq, or \*(lqbinary\*(rq. +The second setting tells .B less -not to warn you -if it encounters a file that has non-ASCII characters. Then, simply -set the +not to warn you if it encounters a file that has non-ASCII characters. +Then, simply set the .I moreproc profile entry to .BR less , -and it will get -called automatically. (To handle other single-octet character sets, -look at the +and it will get called automatically. (To handle other single-octet +character sets, look at the .IR less (1) -manual entry for information about the -.B $LESSCHARDEF -environment variable.) +manual entry for information about the LESSCHARDEF environment variable.) .SS "Messages of Type message/partial" .B mhshow cannot directly display messages of type partial. -You must reassemble them first into a normal message using +You must first reassemble them into a normal message using .BR mhstore . -Check the man page for +Check .IR mhstore (1) for details. .SS "External Access" For contents of type message/external-body, .B mhshow supports these access-types: -.PP .IP \(bu 4 afs .IP \(bu 4 @@ -475,8 +563,7 @@ url .PP For the \*(lqanon-ftp\*(rq and \*(lqftp\*(rq access types, .B mhshow -will look for the \*(lqnmh-access-ftp\*(rq -profile entry, e.g., +will look for the \*(lqnmh-access-ftp\*(rq profile entry, e.g., .PP .RS 5 nmh-access-ftp: myftp.sh @@ -501,19 +588,16 @@ local filename The program should terminate with an exit status of zero if the retrieval is successful, and a non-zero exit status otherwise. .PP -For the \*(lqurl\*(rq access\-type, +For the \*(lqurl\*(rq access-type, .B mhshow -will look for the \*(lqnmh-access-url\*(rq -profile entry. See +will look for the \*(lqnmh-access-url\*(rq profile entry. See .IR mhstore (1) for more details. -.PP .SS "The Content Cache" When .B mhshow -encounters an external content containing a -\*(lqContent-ID:\*(rq field, and if the content allows caching, then -depending on the caching behavior of +encounters an external content containing a \*(lqContent-ID:\*(rq field, +and if the content allows caching, then depending on the caching behavior of .BR mhshow , the content might be read from or written to a cache. .PP @@ -523,27 +607,24 @@ is controlled with the .B \-rcache and .B \-wcache -switches, which define the policy for reading from, -and writing to, the cache, respectively. One of four policies may be -specified: \*(lqpublic\*(rq, indicating that +switches, which define the policy for reading from, and writing to, the cache, +respectively. One of four policies may be specified: \*(lqpublic\*(rq, +indicating that .B mhshow -should make use -of a publically-accessible content cache; \*(lqprivate\*(rq, indicating -that +should make use of a publicly-accessible content cache; \*(lqprivate\*(rq, +indicating that .B mhshow should make use of the user's private content cache; \*(lqnever\*(rq, indicating that .B mhshow -should never make use of -caching; and, \*(lqask\*(rq, indicating that +should never make use of caching; and, \*(lqask\*(rq, indicating that .B mhshow should ask the user. .PP There are two directories where contents may be cached: the profile entry \*(lqnmh-cache\*(rq names a directory containing world-readable contents, and, the profile entry \*(lqnmh-private-cache\*(rq names a directory containing -private contents. The former should be an absolute (rooted) directory -name. +private contents. The former should be an absolute (rooted) directory name. .PP For example, .PP @@ -563,15 +644,13 @@ nmh-private-cache: .cache .SS "User Environment" Because the display environment in which .B mhshow -operates may vary for -different machines, +operates may vary for different machines, .B mhshow -will look for the environment variable -.BR $MHSHOW . -If present, this specifies the name of an additional -user profile which should be read. Hence, when a user logs in on a -particular display device, this environment variable should be set to -refer to a file containing definitions useful for the given display device. +will look for the environment variable MHSHOW. If present, this specifies +the name of an additional user profile which should be read. +Hence, when a user logs in on a particular display device, this environment +variable should be set to refer to a file containing definitions useful +for the given display device. Normally, only entries that deal with the methods to display different content type and subtypes .PP @@ -582,35 +661,31 @@ mhshow-show- .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 one other additional user profile, -e.g., +will attempt to consult .PP .RS 5 -%etcdir%/mhn.defaults +%nmhetcdir%/mhn.defaults .RE .PP which is created automatically during .B nmh installation. .PP -SS Content\-Type Marker -If +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 -decides to not display a particular part due to the switches of -.B \-textonly -or -.B \-inlineonly -it will display a marker containing information about the part. This -marker is processed via -.IR mh\-format (5) -and can be changed by the use of the +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 the +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 @@ -627,30 +702,38 @@ disposition string Content disposition (attachment or inline) ctype- string Value of from Content\-Type header cdispo- string Value of 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 +RFC 2231 decoding applied and be converted to the local character set. .SH FILES .B mhshow looks for all format files and mhn.defaults in multiple locations: absolute pathnames are accessed directly, tilde expansion is done on usernames, and files are searched for in the user's .I Mail -directory as specified in their profile. If not found there, the directory -.RI \*(lq %etcdir% \*(rq +directory, as specified in their profile. If not found there, the directory +.RI \*(lq %nmhetcdir% \*(rq is checked. .PP .fc ^ ~ .nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile +.ta \w'%nmhetcdir%/ExtraBigFileName 'u +^$HOME/.mh_profile~^The user profile ^$MHSHOW~^Additional profile entries -^%etcdir%/mhn.defaults~^System default MIME profile entries -^%etcdir%/mhl.headers~^The headers template -^%etcdir%/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 ^ ~