Mercurial > hg > Applications > mh

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

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