git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/doc/show.me

   1 .\"     This file is automatically generated.  Do not edit!
   2 .\" @(#)$Id: show.rf,v 1.9 1995/12/06 22:48:30 jromine Exp $
   3 .SC SHOW 1
   4 .NA
   5 show \- show (list) messages
   6 .SY
   7 show
   8 \%[+folder] \%[msgs]
   9 \%[\-draft]
  10 \%[\-header] \%[\-noheader]
  11 \%[\-showproc\ program] \%[\-noshowproc]
  12 \%[switches\ for\ \fIshowproc\fR]
  13 \%[\-help]
  14 .DE
  15 \fIShow\fR lists each of the specified messages to the standard
  16 output (typically, the terminal).
  17 Typically, the messages are listed exactly
  18 as they are, with no reformatting.
  19 A program named by the \fIshowproc\fR profile component is
  20 invoked to do the listing, and any switches not recognized by
  21 \fIshow\fR are passed along to that program.
  22 The default program is known as \fImore\fR\0(1).
  23 To override the default and the \fIshowproc\fR profile component,
  24 use the `\-showproc\ program' switch.
  25 For example, `\-show\ pr' will cause the \fIpr\fR\0(1) program to list the
  26 messages.
  27 The \fIMH\fR command \fImhl\fR can be used as a \fIshowproc\fR
  28 to show messages in a more uniform format.
  29 Normally, this program is specified as the \fIshowproc\fR is the user's
  30 \&.mh\(ruprofile.
  31 See \fImhl\fR\0(1) for the details.
  32 If the `\-noshowproc' option is specified,
  33 `/bin/cat' is used instead of \fIshowproc\fR.
  34
  35 If you have messages with multi-media contents,
  36 the profile entry \fImhnproc\fR defines the name of a program to
  37 manipulate multi-media messages.
  38 (The \fImhn\fR\0(1) program,
  39 which is suitable for this purpose,
  40 is the default.)
  41 If the `\-noshowproc' option is NOT specified,
  42 and if one or more named messages has a multi-media content,
  43 then the program indicated by \fImhnproc\fR will be run instead of
  44 \fIshowproc\fR.
  45 The use of the \fImhnproc\fR can also be disabled if the
  46 environment variable \fBNOMHNPROC\fR is set.
  47 Note that the \fImhnproc\fR may be invoked even for textual contents,
  48 depending on the character set involved.
  49 The environment variable \fBMM_CHARSET\fP should be set to the terminal's
  50 character set to avoid gratuitous invocations of the \fImhnproc\fR.
  51
  52 The `\-header' switch tells \fIshow\fR to display a one\-line
  53 description of the message being shown.
  54 This description includes the folder and the message number.
  55
  56 If no `msgs' are specified, the current message is used.
  57 If more than one message is specified,
  58 \fImore\fR will prompt for a <RETURN> prior to listing each message.
  59 \fImore\fR will list each message, a page at a time.
  60 When the end of
  61 page is reached, \fImore\fR will ring the bell and wait for a <SPACE>
  62 or <RETURN>.
  63 If a <RETURN> is entered, \fImore\fR will print the next line,
  64 whereas <SPACE> will print the next screenful.
  65 To exit \fImore\fR, type \*(lqq\*(rq.
  66
  67 If the standard output is not a terminal, no queries are made,
  68 and each file is listed with a one\-line header and two lines of
  69 separation.
  70
  71 \*(lqshow \-draft\*(rq will list the file <mh\-dir>/draft if it
  72 exists.
  73
  74 If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
  75 then \fIshow\fR will remove each of the messages shown from each
  76 sequence named by the profile entry.
  77 This is similar to the \*(lqPrevious\-Sequence\*(rq profile entry supported
  78 by all \fIMH\fR commands which take `msgs' or `msg' arguments.
  79 .Fi
  80 ^$HOME/\&.mh\(ruprofile~^The user profile
  81 .Pr
  82 ^Path:~^To determine the user's MH directory
  83 .Ps
  84 ^Current\-Folder:~^To find the default current folder
  85 .Ps
  86 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
  87 .Ps
  88 ^showproc:~^Program to show messages
  89 .Ps
  90 ^mhnproc:~^Program to show messages with multi-media content
  91 .Sa
  92 mhl(1), more(1), next(1), pick(1), prev(1), scan(1)
  93 .De
  94 `+folder' defaults to the current folder
  95 .Ds
  96 `msgs' defaults to cur
  97 .Ds
  98 `\-header'
  99 .Co
 100 If a folder is given, it will become the current folder.
 101 The last message shown will become the current message.
 102 .Bu
 103 The `\-header' switch doesn't work when `msgs' expands to more than
 104 one message.
 105 If the \fIshowproc\fR is \fImhl\fR,
 106 then is problem can be circumvented by referencing
 107 the \*(lqmessagename\*(rq field in the \fImhl\fR format file.
 108
 109 \fIShow\fR updates the user's context before showing the message.
 110 Hence \fIshow\fR will mark messages as seen prior to the user
 111 actually seeing them.
 112 This is generally not a problem,
 113 unless the user relies on the \*(lqunseen\*(rq messages mechanism,
 114 and interrupts \fIshow\fR while it is showing \*(lqunseen\*(rq messages.
 115
 116 If \fIshowproc\fR is \fImhl\fR,
 117 then \fIshow\fR uses a built\-in \fImhl\fR:
 118 it does not actually run the \fImhl\fR program.
 119 Hence, if you define your own \fIshowproc\fR,
 120 don't call it \fImhl\fR since \fIshow\fR won't run it.
 121
 122 If \fImore\fR\0(1) is your showproc (the default),
 123 then avoid running \fIshow\fR in the background
 124 with only its standard output piped to another process, as in
 125
 126 .ti +.5i
 127 show | imprint &
 128
 129 Due to a bug in \fImore\fR,
 130 show will go into a \*(lqtty input\*(rq state.
 131 To avoid this problem,
 132 re\-direct \fIshow\fR's diagnostic output as well.
 133 For users of \fIcsh\fR:
 134
 135 .ti +.5i
 136 show |& imprint &
 137
 138 For users of \fIsh\fR:
 139
 140 .ti +.5i
 141 show 2>&1 | imprint &
 142 .En