Added all of the MH sources, including RCS files, in

[mmh] / docs / historical / mh-6.8.5 / conf / doc / RCS / show.rf,v

head    1.9;
access;
symbols;
locks; strict;


1.9
date    95.12.06.22.48.30;      author jromine; state Exp;
branches;
next    1.8;

1.8
date    93.10.26.20.09.07;      author jromine; state Exp;
branches;
next    1.7;

1.7
date    92.05.19.21.57.39;      author jromine; state Exp;
branches;
next    1.6;

1.6
date    92.01.31.16.41.16;      author jromine; state Exp;
branches;
next    1.5;

1.5
date    90.04.05.15.15.20;      author sources; state Exp;
branches;
next    1.4;

1.4
date    90.03.22.11.31.52;      author sources; state Exp;
branches;
next    1.3;

1.3
date    90.03.20.19.42.35;      author sources; state Exp;
branches;
next    1.2;

1.2
date    90.03.20.17.36.49;      author sources; state Exp;
branches;
next    1.1;

1.1
date    90.03.20.17.21.30;      author sources; state Exp;
branches;
next    ;


desc
@@


1.9
log
@fixup some envar references
@
text
@.\"    @@(MHWARNING)
.\" @@(#)$Id: show.rf,v 1.8 1993/10/26 20:09:07 jromine Exp jromine $
.SC SHOW 1
.NA
show \- show (list) messages
.SY
show
\%[+folder] \%[msgs]
\%[\-draft]
\%[\-header] \%[\-noheader]
\%[\-showproc\ program] \%[\-noshowproc]
\%[switches\ for\ \fIshowproc\fR]
\%[\-help]
.DE
\fIShow\fR lists each of the specified messages to the standard
output (typically, the terminal).
Typically, the messages are listed exactly
as they are, with no reformatting.
A program named by the \fIshowproc\fR profile component is
invoked to do the listing, and any switches not recognized by
\fIshow\fR are passed along to that program.
The default program is known as \fImore\fR\0(1).
To override the default and the \fIshowproc\fR profile component,
use the `\-showproc\ program' switch.
For example, `\-show\ pr' will cause the \fIpr\fR\0(1) program to list the
messages.
The \fIMH\fR command \fImhl\fR can be used as a \fIshowproc\fR
to show messages in a more uniform format.
Normally, this program is specified as the \fIshowproc\fR is the user's
\&.mh\(ruprofile.
See \fImhl\fR\0(1) for the details.
If the `\-noshowproc' option is specified,
`/bin/cat' is used instead of \fIshowproc\fR.
@@BEGIN: MIME

If you have messages with multi-media contents,
the profile entry \fImhnproc\fR defines the name of a program to
manipulate multi-media messages.
(The \fImhn\fR\0(1) program,
which is suitable for this purpose,
is the default.)
If the `\-noshowproc' option is NOT specified,
and if one or more named messages has a multi-media content,
then the program indicated by \fImhnproc\fR will be run instead of
\fIshowproc\fR.
The use of the \fImhnproc\fR can also be disabled if the
environment variable \fBNOMHNPROC\fR is set.
Note that the \fImhnproc\fR may be invoked even for textual contents,
depending on the character set involved.
The environment variable \fBMM_CHARSET\fP should be set to the terminal's
character set to avoid gratuitous invocations of the \fImhnproc\fR.
@@END: MIME

The `\-header' switch tells \fIshow\fR to display a one\-line
description of the message being shown.
This description includes the folder and the message number.

If no `msgs' are specified, the current message is used.
If more than one message is specified,
\fImore\fR will prompt for a <RETURN> prior to listing each message.
\fImore\fR will list each message, a page at a time.
When the end of
page is reached, \fImore\fR will ring the bell and wait for a <SPACE>
or <RETURN>.
If a <RETURN> is entered, \fImore\fR will print the next line,
whereas <SPACE> will print the next screenful.
To exit \fImore\fR, type \*(lqq\*(rq.

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
exists.

If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
then \fIshow\fR will remove each of the messages shown from each
sequence named by the profile entry.
This is similar to the \*(lqPrevious\-Sequence\*(rq profile entry supported
by all \fIMH\fR commands which take `msgs' or `msg' arguments.
.Fi
^$HOME/\&.mh\(ruprofile~^The user profile
.Pr
^Path:~^To determine the user's MH directory
.Ps
^Current\-Folder:~^To find the default current folder
.Ps
^Unseen\-Sequence:~^To name sequences denoting unseen messages
.Ps
^showproc:~^Program to show messages
@@BEGIN: MIME
.Ps
^mhnproc:~^Program to show messages with multi-media content
@@END: MIME
.Sa
mhl(1), more(1), next(1), pick(1), prev(1), scan(1)
.De
`+folder' defaults to the current folder
.Ds
`msgs' defaults to cur
.Ds
`\-header'
.Co
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 seeing them.
This is generally not a problem,
unless the user relies on the \*(lqunseen\*(rq messages mechanism,
and interrupts \fIshow\fR while it is showing \*(lqunseen\*(rq messages.

If \fIshowproc\fR is \fImhl\fR,
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 \fImore\fR\0(1) is your showproc (the default),
then avoid running \fIshow\fR in the background
with only its standard output piped to another process, as in

.ti +.5i
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
show |& imprint &

For users of \fIsh\fR:

.ti +.5i
show 2>&1 | imprint &
.En
@


1.8
log
@mention MM_CHARSET
@
text
@d2 1
a2 1
.\" @@(#)$Id: show.rf,v 1.7 1992/05/19 21:57:39 jromine Exp $
d47 1
a47 1
environment variable \fB$NOMHNPROC\fR is set.
d50 1
a50 1
The environment variable $MM_CHARSET should be set to the terminal's
@


1.7
log
@MIME
@
text
@d2 1
a2 1
.\" @@(#)$Id: show.rf,v 1.6 1992/01/31 16:41:16 jromine Exp jromine $
d36 7
a42 6
If you have messages with multi-media content,
you should define the profile entry \fImhnproc\fR,
which is the name of a program to manipulate multi-media messages.
The \fImhn\fR\0(1) program is suitable for this purpose.
Note that if the \fImhnproc\fR profile entry is defined,
the `\-noshowproc' option is NOT specified,
d48 4
@


1.6
log
@Multimedia MH
@
text
@d2 1
a2 1
.\" @@(#)$Id: show.rf,v 1.5 90/04/05 15:15:20 sources Exp $
d34 1
d47 1
d86 1
d89 1
@


1.5
log
@add ID
@
text
@d2 1
a2 1
.\" @@(#)$Id:$
d35 12
d84 2
@


1.4
log
@put things back, do .NA stuff another way
@
text
@d2 1
@


1.3
log
@typo
@
text
@d2 2
a3 2
.TH SHOW 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
.SH .NA
d5 1
a5 1
.SH .SY
@


1.2
log
@fixup for makewhatis
@
text
@d2 1
a2 1
.TH SHOW 1 [mh.6] MH
@


1.1
log
@Initial revision
@
text
@d2 2
a3 2
.SC SHOW 1
.NA
d5 1
a5 1
.SY
@