.\" %nmhwarning%
.\" $Id$
.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
.TH SHOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
show \- show (display) messages
.SH SYNOPSIS
-.in +.5i
-.ti -.5i
-show
-\%[+folder] \%[msgs]
-\%[\-showproc\ program]
-.br
-\%[\-showmimeproc\ program]
-\%[\-header] \%[\-noheader]
-.br
-\%[\-draft]
-\%[\-checkmime] \%[\-nocheckmime]
-.br
-\%[switches\ for\ \fIshowproc\fR or \fIshowmimeproc\fR]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.B show
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-draft ]
+.RB [\-showproc
+.IR program ]
+.RB [ \-showmimeproc
+.IR program ]
+.RB [ \-header " | " \-noheader ]
+.RB [ \-checkmime " | " \-nocheckmime ]
+[switches\ for
+.I showproc
+or
+.IR showmimeproc ]
+.RB [ \-version ]
+.RB [ \-help ]
.SH DESCRIPTION
-\fIShow\fR lists each of the specified messages to the standard output
+.B Show
+lists each of the specified messages to the standard output
(typically, the terminal).
-
+.PP
By default, text (non-MIME) messages are filtered and displayed by
-the \fInmh\fR command \fImhl\fR. This command will display text
+the
+.B nmh
+command
+.BR mhl .
+This command will display text
messages in a nice, uniform format. It also allows you to configure
the format of the displayed messages and which headers fields are
-shown. See the \fImhl\fR(1) manual page for the details about this
-command. This default can be changed by defining the \fIshowproc\fR
-profile component. Any switches not recognized by \fIshow\fR are
+shown. See the
+.BR mhl (1)
+manual page for the details about this
+command. This default can be changed by defining the
+.I showproc
+profile component. Any switches not recognized by
+.B show
+are
passed along to that program. To override the default and the
-\fIshowproc\fR profile component, use the `\-showproc\ program'
-switch. For example, `\-showproc\ more' will cause the \fImore\fR(1)
+.I showproc
+profile component, use the
+.B \-showproc
+.I program
+switch. For example,
+.B \-showproc
+.I more
+will cause the
+.B more
program to list the messages with no reformatting. Normally, this
-program is specified as the \fIshowproc\fR in the user's
-\&.mh\(ruprofile, rather than using a command line switch.
-
+program is specified as the
+.I showproc
+in the user's
+.IR \&.mh\(ruprofile ,
+rather than using a command line switch.
+.PP
By default, non-text messages (MIME messages with multi-media
-contents) are processed and displayed by the \fInmh\fR command
-\fImhshow\fR. See the \fImhshow\fR(1) manual page for details
+contents) are processed and displayed by the
+.B nmh
+command
+.BR mhshow .
+See the
+.BR mhshow (1)
+manual page for details
about this command. This default can changed by defining the
-\fIshowmimeproc\fR profile component. Any switches not recognized
-by \fIshow\fR are passed along to that program. To override this
-default and the \fIshowmimeproc\fR profile component, use the
-`\-showmimeproc\ program' switch.
-
-Note that in some cases, \fIshow\fR may invoke the \fIshowmimeproc\fR
+.I showmimeproc
+profile component. Any switches not recognized
+by
+.B show
+are passed along to that program. To override this
+default and the
+.B showmimeproc
+profile component, use the
+.B \-showmimeproc
+.I program
+switch.
+.PP
+Note that in some cases,
+.B show
+may invoke the
+.I showmimeproc
even for textual contents. This will happen for text messages that
specify a transfer encoding (such as MIME quoted-printable or
-base64) or specify a character set that \fIshow\fR doesn't believe
-can be displayed natively. The environment variable MM_CHARSET
+base64) or specify a character set that
+.B show
+doesn't believe
+can be displayed natively. The environment variable
+.B $MM_CHARSET
should be set to the terminal's native character set to avoid
-gratuitous invocations of the \fIshowmimeproc\fR. See the
-mh-profile(5) man page for details about this environment variable.
-
-The option `\-checkmime' (set by default) instructs \fIshow\fR to
+gratuitous invocations of the
+.IR showmimeproc .
+See the
+.BR mh-profile (5)
+man page for details about this environment variable.
+.PP
+The option
+.B \-checkmime
+(set by default) instructs
+.B show
+to
test if any of the messages to be displayed are non-text (MIME)
messages. If any are non-text, they are displayed by the program
-\fIshowmimeproc\fR, else they are displayed by the program
-\fIshowproc\fR. The option `-nocheckmime' disables this test and
-instructs \fIshow\fR to use \fIshowproc\fR, regardless of whether
+.IR showmimeproc ,
+else they are displayed by the program
+.IR showproc .
+The option
+.B \-nocheckmime
+disables this test and instructs
+.B show
+to use
+.IR showproc ,
+regardless of whether
any of the messages are non-text (MIME) messages.
-
-The `\-noshowproc' switch will disable any formatting or paging of
-messages. It is equivalent to `-nocheckmime\ -showproc\ cat'. It
-is still accepted, but should be considered (somewhat) obsolete.
-
-If the environment variable \fBNOMHNPROC\fR is set, the test for
+.P
+The
+.B \-noshowproc
+switch will disable any formatting or paging of
+messages. It is equivalent to
+.B \-nocheckmime
+.B \-showproc
+.IR cat .
+It is still accepted, but should be considered (somewhat) obsolete.
+.PP
+If the environment variable
+.B $NOMHNPROC
+is set, the test for
non-text (MIME) messages will be disabled. This method is obsolete.
-Use the `-nocheckmime' switch instead.
-
-The `\-header' switch tells \fIshow\fR to display a one\-line
+Use the
+.B \-nocheckmime
+switch instead.
+.PP
+The
+.B \-header
+switch tells
+.B show
+to display a one\-line
description of the message being shown. This description includes
the folder and the message number.
-
+.PP
If no `msgs' are specified, the current message is used. Although
-it depends on the specific \fIshowproc\fR or \fIshowmimeproc\fR,
+it depends on the specific
+.I showproc
+or
+.IR showmimeproc ,
in the default setup when more than one message is specified, you
will be prompted for a <RETURN> prior to listing each message.
Each message will be listed a page at a time, and when the end of
page is reached, the program will wait for a <SPACE> or <RETURN>.
If a <RETURN> is entered, it will print the next line, whereas
<SPACE> will print the next screenful.
-
+.PP
If the standard output is not a terminal, no queries are made, and
each file is listed with a one\-line header and two lines of
separation.
-
-\*(lqshow \-draft\*(rq will list the file <mh\-dir>/draft if it
+.PP
+.RB \*(lq "show \-draft" \*(rq
+will list the file <mh\-dir>/draft if it
exists.
-
+.PP
If the profile entry \*(lqUnseen\-Sequence\*(rq is present and
-non\-empty, then \fIshow\fR will remove each of the messages shown
+non\-empty, then
+.B show
+will remove each of the messages shown
from each sequence named by the profile entry.
-.Fi
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u
^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
+.fi
+
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName 'u
^Path:~^To determine the user's nmh directory
-.Ps
^Current\-Folder:~^To find the default current folder
-.Ps
^Unseen\-Sequence:~^To name sequences denoting unseen messages
-.Ps
^showproc:~^Program to show text (non-MIME) messages
-.Ps
^showmimeproc:~^Program to show non-text (MIME) messages
-.Sa
+.fi
+
+.SH "SEE ALSO"
mhl(1), mhshow(1), more(1), next(1), prev(1), scan(1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msgs' defaults to cur
-.Ds
-`\-checkmime'
-.Ds
-`\-header'
-.Co
+
+.SH DEFAULTS
+.nf
+.RB ` +folder "' defaults to the current folder"
+.RB ` msgs "' defaults to cur"
+.RB ` \-checkmime '
+.RB ` \-header '
+.fi
+
+.SH CONTEXT
If a folder is given, it will become the current folder. The last
message shown will become the current message.
-.Bu
-The `\-header' switch doesn't work when `msgs' expands to more than
-one message. If the \fIshowproc\fR is \fImhl\fR, then is problem can
-be circumvented by referencing the \*(lqmessagename\*(rq field in the
-\fImhl\fR format file.
-\fIShow\fR updates the user's context before showing the message.
-Hence \fIshow\fR will mark messages as seen prior to the user actually
+.SH BUGS
+The
+.B \-header
+switch doesn't work when `msgs' expands to more than
+one message. If the
+.I showproc
+is
+.BR mhl ,
+then this problem can
+be circumvented by referencing the \*(lqmessagename\*(rq field in the
+.B mhl
+format file.
+.PP
+.B Show
+updates the user's context before showing the message.
+Hence
+.B show
+will mark messages as seen prior to the user actually
seeing them. This is generally not a problem, unless the user relies
-on the \*(lqunseen\*(rq messages mechanism, and interrupts \fIshow\fR
+on the \*(lqunseen\*(rq messages mechanism, and interrupts
+.B show
while it is showing \*(lqunseen\*(rq messages.
-
-If your \fIshowproc\fR is \fImhl\fR (the default), then \fIshow\fR uses
-a built\-in \fImhl\fR: it does not actually run the \fImhl\fR program.
-Hence, if you define your own \fIshowproc\fR, don't call it \fImhl\fR
-since \fIshow\fR won't run it.
-
-If your \fIshowproc\fR is the pager \fImore\fR, then avoid running
-\fIshow\fR in the background with only its standard output piped to
+.PP
+If your
+.I showproc
+is
+.B mhl
+(the default), then
+.B show
+uses
+a built\-in
+.BR mhl :
+it does not actually run the
+.B mhl
+program.
+Hence, if you define your own
+.B showproc ,
+don't call it
+.B mhl
+since
+.B show
+won't run it.
+.PP
+If your
+.I showproc
+is the pager
+.BR more ,
+then avoid running
+.B show
+in the background with only its standard output piped to
another process, as in
-
-.ti +.5i
+.PP
+.RS 5
show | imprint &
-
-Due to a bug in \fImore\fR, show will go into a \*(lqtty input\*(rq state.
-To avoid this problem, re\-direct \fIshow\fR's diagnostic output as well.
-For users of \fIcsh\fR:
-
-.ti +.5i
+.RE
+.PP
+Due to a bug in
+.BR more ,
+show will go into a \*(lqtty input\*(rq state.
+To avoid this problem, re\-direct
+.BR show 's
+diagnostic output as well.
+For users of
+.BR csh :
+.PP
+.RS 5
show |& imprint &
-
-For users of \fIsh\fR:
-
-.ti +.5i
+.RE
+.PP
+For users of
+.BR sh :
+.PP
+.RS 5
show 2>&1 | imprint &
-.En
+.RE
projects / mmh / blobdiff