diplodocus.org Git - nmh/blob - man/show.man

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