git.marmaro.de Git - mmh/blob - man/show.man

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