83c735192861809bb4b16337e5a878cfbc6e074c
[mmh] / man / show.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .\" include the -mh macro file
6 .so %etcdir%/tmac.h
7 .\"
8 .TH SHOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
9 .SH NAME
10 show \- show (display) messages
11 .SH SYNOPSIS
12 .in +.5i
13 .ti -.5i
14 show
15 \%[+folder] \%[msgs]
16 \%[\-showproc\ program]
17 .br
18 \%[\-showmimeproc\ program]
19 \%[\-header] \%[\-noheader]
20 .br
21 \%[\-draft]
22 \%[\-checkmime] \%[\-nocheckmime]
23 .br
24 \%[switches\ for\ \fIshowproc\fR or \fIshowmimeproc\fR]
25 .br
26 \%[\-version]
27 \%[\-help]
28 .in -.5i
29 .SH DESCRIPTION
30 \fIShow\fR lists each of the specified messages to the standard output
31 (typically, the terminal).
32
33 By default, text (non-MIME) messages are filtered and displayed by
34 the \fInmh\fR command \fImhl\fR.  This command will display text
35 messages in a nice, uniform format.  It also allows you to configure
36 the format of the displayed messages and which headers fields are
37 shown.  See the \fImhl\fR(1) manual page for the details about this
38 command.  This default can be changed by defining the \fIshowproc\fR
39 profile component.  Any switches not recognized by \fIshow\fR are
40 passed along to that program.  To override the default and the
41 \fIshowproc\fR profile component, use the `\-showproc\ program'
42 switch.  For example, `\-showproc\ more' will cause the \fImore\fR(1)
43 program to list the messages with no reformatting.  Normally, this
44 program is specified as the \fIshowproc\fR in the user's
45 \&.mh\(ruprofile, rather than using a command line switch.
46
47 By default, non-text messages (MIME messages with multi-media
48 contents) are processed and displayed by the \fInmh\fR command
49 \fImhshow\fR.  See the \fImhshow\fR(1) manual page for details
50 about this command.  This default can changed by defining the
51 \fIshowmimeproc\fR profile component.  Any switches not recognized
52 by \fIshow\fR are passed along to that program.  To override this
53 default and the \fIshowmimeproc\fR profile component, use the
54 `\-showmimeproc\ program' switch.
55
56 Note that in some cases, \fIshow\fR may invoke the \fIshowmimeproc\fR
57 even for textual contents.  This will happen for text messages that
58 specify a transfer encoding (such as MIME quoted-printable or
59 base64) or specify a character set that \fIshow\fR doesn't believe
60 can be displayed natively.  The environment variable MM_CHARSET
61 should be set to the terminal's native character set to avoid
62 gratuitous invocations of the \fIshowmimeproc\fR.  See the
63 mh-profile(5) man page for details about this environment variable.
64
65 The option `\-checkmime' (set by default) instructs \fIshow\fR to
66 test if any of the messages to be displayed are non-text (MIME)
67 messages.  If any are non-text, they are displayed by the program
68 \fIshowmimeproc\fR, else they are displayed by the program
69 \fIshowproc\fR.  The option `-nocheckmime' disables this test and
70 instructs \fIshow\fR to use \fIshowproc\fR, regardless of whether
71 any of the messages are non-text (MIME) messages.
72
73 The `\-noshowproc' switch will disable any formatting or paging of
74 messages.  It is equivalent to `-nocheckmime\ -showproc\ cat'.  It
75 is still accepted, but should be considered (somewhat) obsolete.
76
77 If the environment variable \fBNOMHNPROC\fR is set, the test for
78 non-text (MIME) messages will be disabled.  This method is obsolete.
79 Use the `-nocheckmime' switch instead.
80
81 The `\-header' switch tells \fIshow\fR to display a one\-line
82 description of the message being shown.  This description includes
83 the folder and the message number.
84
85 If no `msgs' are specified, the current message is used.  Although
86 it depends on the specific \fIshowproc\fR or \fIshowmimeproc\fR,
87 in the default setup when more than one message is specified, you
88 will be prompted for a <RETURN> prior to listing each message.
89 Each message will be listed a page at a time, and when the end of
90 page is reached, the program will wait for a <SPACE> or <RETURN>.
91 If a <RETURN> is entered, it will print the next line, whereas
92 <SPACE> will print the next screenful.
93
94 If the standard output is not a terminal, no queries are made, and
95 each file is listed with a one\-line header and two lines of
96 separation.
97
98 \*(lqshow \-draft\*(rq will list the file <mh\-dir>/draft if it
99 exists.
100
101 If the profile entry \*(lqUnseen\-Sequence\*(rq is present and
102 non\-empty, then \fIshow\fR will remove each of the messages shown
103 from each sequence named by the profile entry.
104 .Fi
105 ^$HOME/\&.mh\(ruprofile~^The user profile
106 .Pr
107 ^Path:~^To determine the user's nmh directory
108 .Ps
109 ^Current\-Folder:~^To find the default current folder
110 .Ps
111 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
112 .Ps
113 ^showproc:~^Program to show text (non-MIME) messages
114 .Ps
115 ^showmimeproc:~^Program to show non-text (MIME) messages
116 .Sa
117 mhl(1), mhshow(1), more(1), next(1), prev(1), scan(1)
118 .De
119 `+folder' defaults to the current folder
120 .Ds
121 `msgs' defaults to cur
122 .Ds
123 `\-checkmime'
124 .Ds
125 `\-header'
126 .Co
127 If a folder is given, it will become the current folder.  The last
128 message shown will become the current message.
129 .Bu
130 The `\-header' switch doesn't work when `msgs' expands to more than
131 one message.  If the \fIshowproc\fR is \fImhl\fR, then is problem can
132 be circumvented by referencing the \*(lqmessagename\*(rq field in the
133 \fImhl\fR format file.
134
135 \fIShow\fR updates the user's context before showing the message.
136 Hence \fIshow\fR will mark messages as seen prior to the user actually
137 seeing them.  This is generally not a problem, unless the user relies
138 on the \*(lqunseen\*(rq messages mechanism, and interrupts \fIshow\fR
139 while it is showing \*(lqunseen\*(rq messages.
140
141 If your \fIshowproc\fR is \fImhl\fR (the default), then \fIshow\fR uses
142 a built\-in \fImhl\fR: it does not actually run the \fImhl\fR program.
143 Hence, if you define your own \fIshowproc\fR, don't call it \fImhl\fR
144 since \fIshow\fR won't run it.
145
146 If your \fIshowproc\fR is the pager \fImore\fR, then avoid running
147 \fIshow\fR in the background with only its standard output piped to
148 another process, as in
149
150 .ti +.5i
151 show | imprint &
152
153 Due to a bug in \fImore\fR, show will go into a \*(lqtty input\*(rq state.
154 To avoid this problem, re\-direct \fIshow\fR's diagnostic output as well.
155 For users of \fIcsh\fR:
156
157 .ti +.5i
158 show |& imprint &
159
160 For users of \fIsh\fR:
161
162 .ti +.5i
163 show 2>&1 | imprint &
164 .En