Defined show(mime)proc locally and removed their profile entries.
[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.  Any switches not recognized by
43 .B show
44 are
45 passed along to that program.  To override the default, use the
46 .B \-showproc
47 .I program
48 switch.  For example,
49 .B \-showproc
50 .I more
51 will cause the
52 .B more
53 program to list the messages with no reformatting.
54 .PP
55 By default, non-text messages (MIME messages with multi-media
56 contents) are processed and displayed by the
57 .B nmh
58 command
59 .BR mhshow .
60 See the
61 .BR mhshow (1)
62 manual page for details
63 about this command.
64 Any switches not recognized
65 by
66 .B show
67 are passed along to that program.  To override this
68 default, use the
69 .B \-showmimeproc
70 .I program
71 switch.
72 .PP
73 Note that in some cases,
74 .B show
75 may invoke the
76 .I showmimeproc
77 even for textual contents.  This will happen for text messages that
78 specify a transfer encoding (such as MIME quoted-printable or
79 base64) or specify a character set that
80 .B show
81 doesn't believe
82 can be displayed natively.  The environment variable
83 .B $MM_CHARSET
84 should be set to the terminal's native character set to avoid
85 gratuitous invocations of the
86 .IR showmimeproc .
87 See the
88 .BR mh-profile (5)
89 man page for details about this environment variable.
90 .PP
91 The option
92 .B \-checkmime
93 (set by default) instructs
94 .B show
95 to
96 test if any of the messages to be displayed are non-text (MIME)
97 messages.  If any are non-text, they are displayed by the
98 .IR showmimeproc ,
99 else they are displayed by the
100 .BR showproc .
101 The option
102 .B \-nocheckmime
103 disables this test and instructs
104 .B show
105 to use
106 .IR showproc ,
107 regardless of whether
108 any of the messages are non-text (MIME) messages.
109 .PP
110 The
111 .B \-header
112 switch tells
113 .B show
114 to display a one\-line
115 description of the message being shown.  This description includes
116 the folder and the message number.
117 .PP
118 If no `msgs' are specified, the current message is used.  Although
119 it depends on the specific
120 .I showproc
121 or
122 .IR showmimeproc ,
123 in the default setup when more than one message is specified, you
124 will be prompted for a <RETURN> prior to listing each message.
125 Each message will be listed a page at a time, and when the end of
126 page is reached, the program will wait for a <SPACE> or <RETURN>.
127 If a <RETURN> is entered, it will print the next line, whereas
128 <SPACE> will print the next screenful.
129 .PP
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), next(1), prev(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