annotate conf/doc/show.rf @ 0:bce86c4163a3

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