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

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