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