annotate conf/doc/bbl.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 BBL 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 bbl \- manage a BBoard
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 bbl
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[+folder]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-shell\ program]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-verbose] \%[\-noverbose]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 bboard
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 \fIbbl\fR allows a \fIBBleader\fR to manage a BBoard.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 The process is relatively simple: a \fIBBleader\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 invokes the \fIbbl\fR program to set\-up an environment in which the messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 contained in the BBoard
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 may be accessed as if they were messages in an \fIMH\fR folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 To do this, \fIbbl\fR, \fIincs\fR the \fIBBoard\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 to the folder \*(lq+bbl\*(rq, and \fIincs\fR the archives for the \fIBBoard\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 to the folder \*(lq+bbl/arc\*(rq. The \fIBBleader\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 then gets a new shell in which \fIMH\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 commands (among others) may be executed. When the \fIBBleader\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 is done, CTRL\-D is typed, which terminates the shell. \fIbbl\fR then
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 asks the \fIBBleader\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 as to how the BBoard
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 should be reconstructed.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 Usually, this results in zeroing the existing \fIBBoard\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 file, and \fIpack\fRing the \*(lq+bbl\*(rq folder into the \fIBBoard\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 file. Similar actions are taken for the archive.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 The `\-shell' switch specifies what process that \fIbbl\fR should invoke
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 as your command interpreter. This need not be a rooted filename.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 If this switch is not specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 \fIbbl\fR looks at the envariable \fB$SHELL\fR for a value.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 If this envariable is not set, then \fIbbl\fR uses your login shell.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 The `\-verbose' switch directs \fIbbl\fR to type the shell commands that it
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 executes to get the job done (e.g., \fIchmod\fR\0s, \fIinc\fR\0s, etc.)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 As \fIbbl\fR processing is most likely not intuitively obvious to most
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 prospective BBoard\-leaders, a short diatribe is in order. As pointed out in
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 \fIBBleader\fR(1),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 a BBoard\-leader (of the fictitious BBoard \*(lqhacks\*(rq)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 has three primary maintenance functions:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 .in +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 .ti -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 \fBRead the BBoard\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 You don't need \fIbbl\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 to do this, use \fIbbc\fR instead.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 .ti -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 \fBRemove inappropriate material\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 Do this by running \fIbbl\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 An example of this might be:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 .sp
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 .nf
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 \01 % bbl hacks
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 \02 [ Working folder is +bbl, Archive folder is +bbl/arc ]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64 \03 [ Type CTRL\-D to finish ]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 \04 % scan
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 .ta \w'\05 'u +\w'20 'u +\w'10/14 'u +\w'1345-PDT 'u +\w'Reasonable Person 'u
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 \05 20 10/14 1345-PDT Silly User Nonsensical message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 \06 21 10/14 1707-PDT Silly User Another one
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 \07 22 10/14 2144-PDT Reasonable Person Legit message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 .re
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 \09 % rmm 20 21
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 \10 % \^D
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 \11 Incorporate changes? y
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74 \12 Remove +bbl? y
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 \13 Update archives? n
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 \14 Remove +bbl/arc? y
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 \15 [+inbox now current]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 \16 %
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 .fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80 .sp
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 In item 1, the BBoard\-Leader invokes \fIbbl\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 on the BBoard called \*(lqhacks\*(rq. The \fIbbl\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 program responds by typing items 2 and 3 which tell the user what \fIMH\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 folders are being used and that a sub\-shell is now in use (respectively).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 The user does a scan of the +bbl folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 (\fIbbl\fR sets the current\-folder to be the one with the BBoard in it.)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 and finds two messages that should be removed (numbers 20 and 21).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 The user then removes these using the \fIrmm\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 program (item 9) and then types a CTRL\-D to return to
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90 \fIbbl\fR (item 10).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91 At this point,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 \fIbbl\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 asks how the BBoard should be reconstructed. Item 11 asks if the contents of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 the +bbl folder should OVERWRITE the contents of the BBoard. The user
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 responds `yes',
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96 that it should (hence the two \fIrmm\fR'd messages disappear).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 Next on item 12,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 the user is asked if the +bbl folder should be killed, since the BBoards
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 have been successfully updated, the user answers `yes'.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 On item 13, the user is
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 asked if the archives should be updated. Since the user made no changes, the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
102 answer `no' is made. (The user could have answered `yes' with no disastrous
bce86c4163a3 Initial revision
kono
parents:
diff changeset
103 effects, but knew that nothing had been updated). Finally, on item 14, the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
104 user indicates that the +bbl/arc subfolder should be killed, by answering
bce86c4163a3 Initial revision
kono
parents:
diff changeset
105 `yes'.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
106
bce86c4163a3 Initial revision
kono
parents:
diff changeset
107 .ti -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
108 \fBArchive non\-recent material\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
109 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
110 Do this by running \fIbbl\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
111 An example of this might be:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
112 .sp
bce86c4163a3 Initial revision
kono
parents:
diff changeset
113 .nf
bce86c4163a3 Initial revision
kono
parents:
diff changeset
114 \01 % bbl hacks
bce86c4163a3 Initial revision
kono
parents:
diff changeset
115 \02 [ Working folder is +bbl, Archive folder is +bbl/arc ]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
116 \03 [ Type CTRL\-D to finish ]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
117 \04 % scan
bce86c4163a3 Initial revision
kono
parents:
diff changeset
118 .ta \w'\05 'u +\w'20 'u +\w'10/14 'u +\w'1345-PDT 'u +\w'GFISHER@UCI-20B 'u
bce86c4163a3 Initial revision
kono
parents:
diff changeset
119 \05 11 10/12 1905-PST Marshall Rose New MMail/BBck
bce86c4163a3 Initial revision
kono
parents:
diff changeset
120 \06 12 10/12 1916-PST Stephen Willson PATH, nfinger, and ls
bce86c4163a3 Initial revision
kono
parents:
diff changeset
121 \07 13 10/12 2329-PDT G@UCI-20A 833-5122 hours
bce86c4163a3 Initial revision
kono
parents:
diff changeset
122 \08 14 10/13 1045-PDT MELLON@UCI-20B Reporting line
bce86c4163a3 Initial revision
kono
parents:
diff changeset
123 \09 15 10/13 1112-PST Tim Shimeall Re: 833-5122 hours
bce86c4163a3 Initial revision
kono
parents:
diff changeset
124 \10 16 10/13 1045-PDT MELLON@UCI-20B Reporting line
bce86c4163a3 Initial revision
kono
parents:
diff changeset
125 \11 17 10/13 2042-PST Dana Roode Ucifinger
bce86c4163a3 Initial revision
kono
parents:
diff changeset
126 \12 18 10/13 2045-PST Dana Roode Files in /usr/restores
bce86c4163a3 Initial revision
kono
parents:
diff changeset
127 \13 19 10/14 1028-PDT WILLSON@UCI-20B Re: term no pause
bce86c4163a3 Initial revision
kono
parents:
diff changeset
128 \14 20 10/14 1345-PDT Martin Katz Re: term no pause
bce86c4163a3 Initial revision
kono
parents:
diff changeset
129 \15 21 10/14 1707-PDT SCRIBE@UCI-20A Scribe Use
bce86c4163a3 Initial revision
kono
parents:
diff changeset
130 \16 22 10/14 2144-PDT GFISHER@UCI-20B New Twemacs
bce86c4163a3 Initial revision
kono
parents:
diff changeset
131 \17 23 10/15 1227-PDT Rob Rittenhouse Re: New Twemacs
bce86c4163a3 Initial revision
kono
parents:
diff changeset
132 .re
bce86c4163a3 Initial revision
kono
parents:
diff changeset
133 \18 % file +bbl/arc \-src +bbl 11\-12 17\-20 21
bce86c4163a3 Initial revision
kono
parents:
diff changeset
134 \19 % ^D
bce86c4163a3 Initial revision
kono
parents:
diff changeset
135 \20 Incorporate changes? y
bce86c4163a3 Initial revision
kono
parents:
diff changeset
136 \21 Remove +bbl? y
bce86c4163a3 Initial revision
kono
parents:
diff changeset
137 \22 Update archives? y
bce86c4163a3 Initial revision
kono
parents:
diff changeset
138 \23 Remove +bbl/arc? y
bce86c4163a3 Initial revision
kono
parents:
diff changeset
139 \24 [+inbox now current]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
140 \25 %
bce86c4163a3 Initial revision
kono
parents:
diff changeset
141 .fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
142 .sp
bce86c4163a3 Initial revision
kono
parents:
diff changeset
143 The important command given is in item 18, in which the user \fIfiles\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
144 some messages from +bbl into +bbl/arc. When CTRL\-D is typed, the user
bce86c4163a3 Initial revision
kono
parents:
diff changeset
145 directs \fIbbl\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
146 to update both the BBoard and its archives, which does the proper action.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
147 As an alternate to this scenario,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
148 some creative \fIBBleaders\fR might use the \fIpick\fR command to do all of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
149 the work:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
150
bce86c4163a3 Initial revision
kono
parents:
diff changeset
151 .in +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
152 .nf
bce86c4163a3 Initial revision
kono
parents:
diff changeset
153 pick \-sequence select \-before \-12 \-datefield BB-Posted \-zero
bce86c4163a3 Initial revision
kono
parents:
diff changeset
154 pick \-sequence select \-before \-20 \-nozero
bce86c4163a3 Initial revision
kono
parents:
diff changeset
155 scan select
bce86c4163a3 Initial revision
kono
parents:
diff changeset
156 refile select +bbl/arc
bce86c4163a3 Initial revision
kono
parents:
diff changeset
157 .fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
158 .in -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
159
bce86c4163a3 Initial revision
kono
parents:
diff changeset
160 In order to facilitate the use of automation shell scripts,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
161 if the standard input for \fIbbl\fR is \fInot\fR a tty,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
162 then \fIbbl\fR will not ask any questions and will proceed as if
bce86c4163a3 Initial revision
kono
parents:
diff changeset
163 the user's answer was \*(lqyes\*(rq for all questions.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
164 Hence, \fIbbl\fR may be run under \fIcron\fR\0(8) to provide for
bce86c4163a3 Initial revision
kono
parents:
diff changeset
165 automatic archiving.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
166 .in -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
167 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
168 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
169 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
170 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
171 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
172 ^incproc:~^Program to incorporate a mail drop into a folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
173 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
174 ^packproc:~^Program to pack a folder into a msgbox
bce86c4163a3 Initial revision
kono
parents:
diff changeset
175 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
176 ^rmfproc:~^Program to remove a folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
177 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
178 bbc(1), bbleader(1), bboards(1)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
179 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
180 `+folder' defaults to \*(lqbbl\*(rq
bce86c4163a3 Initial revision
kono
parents:
diff changeset
181 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
182 `\-nofile'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
183 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
184 `\-shell' defaults to \fB$SHELL\fR or your login shell
bce86c4163a3 Initial revision
kono
parents:
diff changeset
185 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
186 None
bce86c4163a3 Initial revision
kono
parents:
diff changeset
187 .Hi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
188 In the early days of the UCI BBoards facility,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
189 \fIBBleaders\fR actually used to run this program by hand.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
190 Now, this \fIbbl\fR is often run automatically by the system to perform
bce86c4163a3 Initial revision
kono
parents:
diff changeset
191 automatic archiving.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
192 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
193 Note that \fIbbl\fR executes a lot of \fIMH\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
194 commands, and as such, each of these commands can and will read
bce86c4163a3 Initial revision
kono
parents:
diff changeset
195 your \fI\&.mh\(ruprofile\fR for defaults.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
196 Please read the \fBBUGS\fR section of \fImh\-profile\fR\0(5)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
197 for some hints to help you avoid many silly problems.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
198
bce86c4163a3 Initial revision
kono
parents:
diff changeset
199 Also, \fIbbl\fR is unforgiving in doing exactly what it is told,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
200 so take special care in answering \fIbbl\fR's questions.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
201 .En