Remove the rcvstoreproc/rcvpackproc vars.
[mmh] / man / show.man1
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH SHOW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 show \- show (display) messages
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B show
11 .RI [ +folder ]
12 .RI [ msgs ]
13 .RB [ \-showproc
14 .IR program ]
15 .RB [ \-showmimeproc
16 .IR program ]
17 .RB [ \-header " | " \-noheader ]
18 .RB [ \-checkmime " | " \-nocheckmime ]
19 [switches\ for
20 .I showproc
21 or
22 .IR showmimeproc ]
23 .RB [ \-version ]
24 .RB [ \-help ]
25 .ad
26 .SH DESCRIPTION
27 .B Show
28 lists each of the specified messages to the standard output
29 (typically, the terminal).
30 .PP
31 By default, text (non-MIME) messages are filtered and displayed by
32 the
33 .B nmh
34 command
35 .BR mhl .
36 This command will display text
37 messages in a nice, uniform format.  It also allows you to configure
38 the format of the displayed messages and which headers fields are
39 shown.  See the
40 .BR mhl (1)
41 manual page for the details about this
42 command.  This default can be changed by defining the
43 .I showproc
44 profile component.  Any switches not recognized by
45 .B show
46 are
47 passed along to that program.  To override the default and the
48 .I showproc
49 profile component, use the
50 .B \-showproc
51 .I program
52 switch.  For example,
53 .B \-showproc
54 .I more
55 will cause the
56 .B more
57 program to list the messages with no reformatting.  Normally, this
58 program is specified as the
59 .I showproc
60 in the user's profile,
61 rather than using a command line switch.
62 .PP
63 By default, non-text messages (MIME messages with multi-media
64 contents) are processed and displayed by the
65 .B nmh
66 command
67 .BR mhshow .
68 See the
69 .BR mhshow (1)
70 manual page for details
71 about this command.  This default can changed by defining the
72 .I showmimeproc
73 profile component.  Any switches not recognized
74 by
75 .B show
76 are passed along to that program.  To override this
77 default and the
78 .B showmimeproc
79 profile component, use the
80 .B \-showmimeproc
81 .I program
82 switch.
83 .PP
84 Note that in some cases,
85 .B show
86 may invoke the
87 .I showmimeproc
88 even for textual contents.  This will happen for text messages that
89 specify a transfer encoding (such as MIME quoted-printable or
90 base64) or specify a character set that
91 .B show
92 doesn't believe
93 can be displayed natively.  The environment variable
94 .B $MM_CHARSET
95 should be set to the terminal's native character set to avoid
96 gratuitous invocations of the
97 .IR showmimeproc .
98 See the
99 .BR mh-profile (5)
100 man page for details about this environment variable.
101 .PP
102 The option
103 .B \-checkmime
104 (set by default) instructs
105 .B show
106 to
107 test if any of the messages to be displayed are non-text (MIME)
108 messages.  If any are non-text, they are displayed by the program
109 .IR showmimeproc ,
110 else they are displayed by the program
111 .IR showproc .
112 The option
113 .B \-nocheckmime
114 disables this test and instructs
115 .B show
116 to use
117 .IR showproc ,
118 regardless of whether
119 any of the messages are non-text (MIME) messages.
120 .PP
121 The
122 .B \-header
123 switch tells
124 .B show
125 to display a one\-line
126 description of the message being shown.  This description includes
127 the folder and the message number.
128 .PP
129 If no `msgs' are specified, the current message is used.  Although
130 it depends on the specific
131 .I showproc
132 or
133 .IR showmimeproc ,
134 in the default setup when more than one message is specified, you
135 will be prompted for a <RETURN> prior to listing each message.
136 Each message will be listed a page at a time, and when the end of
137 page is reached, the program will wait for a <SPACE> or <RETURN>.
138 If a <RETURN> is entered, it will print the next line, whereas
139 <SPACE> will print the next screenful.
140 .PP
141 If the standard output is not a terminal, no queries are made, and
142 each file is listed with a one\-line header and two lines of
143 separation.
144 .PP
145 If the profile entry \*(lqUnseen\-Sequence\*(rq is present and
146 non\-empty, then
147 .B show
148 will remove each of the messages shown
149 from each sequence named by the profile entry.
150
151 .SH FILES
152 .fc ^ ~
153 .nf
154 .ta \w'%etcdir%/ExtraBigFileName  'u
155 ^$HOME/.mmh/profile~^The user profile
156 .fi
157
158 .SH "PROFILE COMPONENTS"
159 .fc ^ ~
160 .nf
161 .ta 2.4i
162 .ta \w'ExtraBigProfileName  'u
163 ^Path:~^To determine the user's mail storage
164 ^Current\-Folder:~^To find the default current folder
165 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
166 ^showproc:~^Program to show text (non-MIME) messages
167 ^showmimeproc:~^Program to show non-text (MIME) messages
168 .fi
169
170 .SH "SEE ALSO"
171 mhl(1), mhshow(1), more(1), next(1), prev(1), scan(1)
172
173 .SH DEFAULTS
174 .nf
175 .RB ` +folder "' defaults to the current folder"
176 .RB ` msgs "' defaults to cur"
177 .RB ` \-checkmime '
178 .RB ` \-header '
179 .fi
180
181 .SH CONTEXT
182 If a folder is given, it will become the current folder.  The last
183 message shown will become the current message.
184
185 .SH BUGS
186 The
187 .B \-header
188 switch doesn't work when `msgs' expands to more than
189 one message.  If the
190 .I showproc
191 is
192 .BR mhl ,
193 then this problem can
194 be circumvented by referencing the \*(lqmessagename\*(rq field in the
195 .B mhl
196 format file.
197 .PP
198 .B Show
199 updates the user's context before showing the message.
200 Hence
201 .B show
202 will mark messages as seen prior to the user actually
203 seeing them.  This is generally not a problem, unless the user relies
204 on the \*(lqunseen\*(rq messages mechanism, and interrupts
205 .B show
206 while it is showing \*(lqunseen\*(rq messages.
207 .PP
208 If your
209 .I showproc
210 is the pager
211 .BR more ,
212 then avoid running
213 .B show
214 in the background with only its standard output piped to
215 another process, as in
216 .PP
217 .RS 5
218 show | imprint &
219 .RE
220 .PP
221 Due to a bug in
222 .BR more ,
223 show will go into a \*(lqtty input\*(rq state.
224 To avoid this problem, re\-direct
225 .BR show 's
226 diagnostic output as well.
227 For users of
228 .BR csh :
229 .PP
230 .RS 5
231 show |& imprint &
232 .RE
233 .PP
234 For users of
235 .BR sh :
236 .PP
237 .RS 5
238 show 2>&1 | imprint &
239 .RE