X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/278a48ef53b5dde10d7c88f67f51ce15ad11c0c0..07661005b9a36338ab158bcbe7762788a1df4030:/man/mhshow.man diff --git a/man/mhshow.man b/man/mhshow.man index 79a4899d..9cc44c1b 100644 --- a/man/mhshow.man +++ b/man/mhshow.man @@ -1,12 +1,12 @@ +.TH MHSHOW %manext1% "May 4, 2013" "%nmhversion%" .\" .\" %nmhwarning% -.\" $Id$ .\" -.TH MHSHOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mhshow \- display MIME messages .SH SYNOPSIS .HP 5 +.na .B mhshow .RI [ +folder ] .RI [ msgs ] @@ -29,6 +29,7 @@ mhshow \- display MIME messages .RB [ \-check " | " \-nocheck ] .RB [ \-version ] .RB [ \-help ] +.ad .SH DESCRIPTION The .B mhshow @@ -37,11 +38,11 @@ message or collection of messages. .PP .B mhshow manipulates multi-media messages as specified in -RFC\-2045 thru RFC\-2049. Currently +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. +message headers as specified in RFC 2047. .PP By default .B mhshow @@ -75,7 +76,7 @@ be in mail drop format (to convert a file in mail drop format to a folder of .B nmh messages, see -.BR inc (1)). +.IR inc (1)). .PP A part specification consists of a series of numbers separated by dots. For example, in a multipart content containing three parts, these @@ -91,7 +92,7 @@ switch will not prevent the content from being acted upon. .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. +be found in RFC 2046. .PP A list of commonly used contents is briefly reproduced here: .PP @@ -263,7 +264,7 @@ redirected from the terminal to the content. .PP If a display string is not found, .B mhshow -has several default values: +behaves as if these profile entries were supplied and supported: .PP .RS 5 .nf @@ -272,6 +273,9 @@ mhshow-show-message/rfc822: %pshow -file '%F' .fi .RE .PP +Note that \*(lqmoreproc\*(rq is not supported in user profile display +strings. +.PP If a subtype of type text doesn't have a profile entry, it will be treated as text/plain. .PP @@ -324,15 +328,15 @@ encounters a \*(lqcharset\*(rq parameter for this content, it checks if your terminal can display this character set natively. .B mhn -checks this by examining the the environment -variable -.BR $MM_CHARSET . -If the value of this environment variable is equal +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 to the value of the charset parameter, then .B mhshow assumes it can -display this content without any additional setup. If this environment -variable is not set, +display this content without any additional setup. If the locale is not +set properly, .B mhshow will assume a value of \*(lqUS-ASCII\*(rq. If the character set cannot be displayed natively, then @@ -408,7 +412,7 @@ profile entry to and it will get called automatically. (To handle other single-octet character sets, look at the -.BR less (1) +.IR less (1) manual entry for information about the .B $LESSCHARDEF environment variable.) @@ -418,7 +422,7 @@ cannot directly display messages of type partial. You must reassemble them first into a normal message using .BR mhstore . Check the man page for -.BR mhstore (1) +.IR mhstore (1) for details. .SS "External Access" For contents of type message/external-body, @@ -435,6 +439,8 @@ ftp local-file .IP \(bu 4 mail-server +.IP \(bu 4 +url .PP For the \*(lqanon-ftp\*(rq and \*(lqftp\*(rq access types, .B mhshow @@ -464,10 +470,13 @@ 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 -If this entry is not provided, then +For the \*(lqurl\*(rq access\-type, .B mhshow -will use a simple -built-in FTP client to perform the retrieval. +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 @@ -527,7 +536,7 @@ operates may vary for different machines, .B mhshow will look for the environment variable -.BE $MHSHOW . +.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 @@ -554,17 +563,24 @@ e.g., which is created automatically during .B nmh installation. - .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 +is checked. +.PP .fc ^ ~ .nf -.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u +.ta \w'%etcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile ^$MHSHOW~^Additional profile entries ^%etcdir%/mhn.defaults~^System default MIME profile entries ^%etcdir%/mhl.headers~^The headers template .fi - .SH "PROFILE COMPONENTS" .fc ^ ~ .nf @@ -575,30 +591,30 @@ installation. ^Unseen\-Sequence:~^To name sequences denoting unseen messages ^mhlproc:~^Default program to display message headers ^nmh-access-ftp:~^Program to retrieve contents via FTP +^nmh-access-url:~^Program to retrieve contents via HTTP ^nmh-cache~^Public directory to store cached external contents ^nmh-private-cache~^Personal directory to store cached external contents ^mhshow-charset-~^Template for environment to render character sets ^mhshow-show-*~^Template for displaying contents ^moreproc:~^Default program to display text/plain content .fi - .SH "SEE ALSO" -mhbuild(1), mhl(1), mhlist(1), mhstore(1), sendfiles(1) - +.IR mhbuild (1), +.IR mhl (1), +.IR mhlist (1), +.IR mhstore (1), +.IR sendfiles (1) .SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" .RB ` msgs "' defaults to cur" .RB ` \-nocheck ' -.RB ` \-form mhl.headers ' +.RB ` \-form\ mhl.headers ' .RB ` \-pause ' -.RB ` \-rcache ask ' -.RB ` \-realsize ' +.RB ` \-rcache\ ask ' .RB ` \-noserialonly ' -.RB ` \-noverbose ' -.RB ` \-wcache ask ' +.RB ` \-wcache\ ask ' .fi - .SH CONTEXT If a folder is given, it will become the current folder. The last message selected will become the current message.