Fixed typo reported by Ralph.
[mmh] / docs / historical / mh-6.8.5 / conf / doc / RCS / bbc.rf,v
1 head    2.6;
2 access;
3 symbols;
4 locks; strict;
5
6
7 2.6
8 date    95.12.06.22.48.30;      author jromine; state Exp;
9 branches;
10 next    2.5;
11
12 2.5
13 date    92.02.05.21.00.33;      author jromine; state Exp;
14 branches;
15 next    2.4;
16
17 2.4
18 date    90.04.05.15.07.52;      author sources; state Exp;
19 branches;
20 next    2.3;
21
22 2.3
23 date    90.03.22.11.30.51;      author sources; state Exp;
24 branches;
25 next    2.2;
26
27 2.2
28 date    90.03.20.19.41.27;      author sources; state Exp;
29 branches;
30 next    2.1;
31
32 2.1
33 date    90.03.20.17.35.45;      author sources; state Exp;
34 branches;
35 next    2.0;
36
37 2.0
38 date    89.11.17.15.56.33;      author sources; state Exp;
39 branches;
40 next    1.1;
41
42 1.1
43 date    89.06.02.11.27.08;      author sources; state Exp;
44 branches;
45 next    ;
46
47
48 desc
49 @@
50
51
52 2.6
53 log
54 @fixup some envar references
55 @
56 text
57 @.\"    @@(MHWARNING)
58 .\" @@(#)$Id: bbc.rf,v 2.5 1992/02/05 21:00:33 jromine Exp jromine $
59 .SC BBC 1
60 .NA
61 bbc \- check on BBoards
62 .SY
63 bbc
64 \%[bboards\ ...]
65 \%[\-topics] \%[\-check] \%[\-read]
66 \%[\-quiet] \%[\-verbose]
67 \%[\-archive] \%[\-noarchive]
68 \%[\-protocol] \%[\-noprotocol]
69 \%[\-mshproc\ program]
70 \%[switches\ for\ \fImshproc\fR]
71 \%[\-rcfile rcfile] \%[\-norcfile]
72 \%[\-file\ BBoardsfile] \%[\-user\ BBoardsuser]
73 @@BEGIN: BPOP
74 \%[\-host\ host]
75 \%[\-rpop] \%[\-norpop]
76 @@END: BPOP
77 @@BEGIN: NNTP
78 \%[\-host\ host]
79 @@END: NNTP
80 \%[\-help]
81 .DE
82 \fIbbc\fR is a BBoard
83 reading/checking program that interfaces to the BBoard
84 channel.
85
86 The \fIbbc\fR program has three action switches which direct its operation:
87
88 The `\-read' switch invokes the \fImsh\fR program on the named
89 \fIBBoards\fR.  If you also specify
90 the `\-archive' switch, then  \fIbbc\fR will invoke the \fImsh\fR program on
91 the archives of the named \fIBBoards\fR.  If no \fIBBoards\fR are given
92 on the command line, and you specified `\-archive',
93 \fIbbc\fR will not read your `bboards' profile entry, but will
94 read the archives of the \*(lqsystem\*(rq \fIBBoard\fR instead.
95
96 The `\-check' switch types out status information for the named \fIBBoards\fR.
97 \fIbbc\fR
98 can print one of several messages depending on the status of both the 
99 BBoard
100 and the user's reading habits.  
101 As with each of these messages, the number
102 given is the item number of the last item placed in the 
103 BBoard.
104 This number (which is marked in the messages as the \*(lqBBoard\-Id\*(rq) is
105 ever increasing.  Hence, when \fIbbc\fR
106 says \*(lqn items\*(rq, it really means that the highest BBoard\-Id is \*(lqn\*(rq.
107 There may, or may not actually be \*(lqn\*(rq items in the BBoard.
108 Some common messages are:
109 .in +1i
110
111 .ti -.5i
112 \fBBBoard \-\- n items unseen\fR
113 .br
114 This message tells how many items the user has not yet seen.  
115 When invoked with the `\-quiet' switch,
116 this is the only informative line that \fIbbc\fR will possibly print out.
117
118 .ti -.5i
119 \fBBBoard \-\- empty\fR
120 .br
121 The BBoard is empty.
122
123 .ti -.5i
124 \fBBBoard \-\- n items (none seen)\fR
125 .br
126 The BBoard has items in it, but the user hasn't seen any.
127
128 .ti -.5i
129 \fBBBoard \-\- n items (all seen)\fR
130 .br
131 The BBoard is non\-empty, and the user has seen everything in it.
132
133 .ti -.5i
134 \fBBBoard \-\- n items seen out of m\fR
135 .br
136 The BBoard has at most m\-n items that the user has not seen.
137 .in -1i
138
139 The `\-topics' switch directs \fIbbc\fR to print three items about the named
140 \fIBBoards\fR:
141 it's official name,
142 the number of items present,
143 and the date and time of the last update.
144 If no \fIBBoards\fR
145 are named, then all BBoards
146 are listed.  If the `\-verbose' switch is given, more information is output.
147
148 The `\-quiet' switch specifies that \fIbbc\fR should be silent if no
149 \fIBBoards\fR are found with new information.
150 The `\-verbose' switch specifies that \fIbbc\fR is to consider you to be 
151 interested in \fIBBoards\fR that you've already seen everything in.
152
153 To override the default \fImshproc\fR and the profile entry,
154 use the `\-mshproc\ program' switch.
155 Any arguments not understood by \fIbbc\fR are passed to this program.
156 The `\-protocol' switch tells \fIbbc\fR that your \fImshproc\fR knows about
157 the special \fIbbc\fR protocol for reporting back information.
158 \fImsh\fR\0(1), the default \fImshproc\fR, knows all about this.
159
160 The `\-file\ BBoardsfile' switch tells \fIbbc\fR to use a non\-standard
161 \fIBBoards\fR file when performing its calculations.
162 Similarly, the `\-user BBoardsuser' switch tells \fIbbc\fR to use a
163 non\-standard username.
164 Both of these switches are useful for debugging a new \fIBBoards\fR or
165 \fIPOP\fR file.
166 @@BEGIN: BPOP
167
168 If the local host is configured as a POP BBoards client,
169 or if the `\-host\ host' switch is given,
170 then \fIbbc\fR will query the POP service host as to the status of the BBoards.
171 The `\-user\ user' switch then takes on a new meaning:
172 it refers to the name of the guest account for BBoards on the service host.
173 The `\-rpop' switch uses the UNIX \fIrPOP\fR
174 (authentication done via trusted connections).
175 In contrast, the `\-norpop' switch uses the ARPA \fIPOP\fR
176 (in which case \fIbbc\fR will prompt for a password,
177 unless the \-user specifies the guest account).
178 @@END: BPOP
179 @@BEGIN: NNTP
180
181 If the local host is configured as an NNTP BBoards client,
182 or if the `\-host\ host' switch is given,
183 then \fIbbc\fR will query the NNTP service host
184 as to the status of the BBoards.
185 For NNTP BBoards clients,
186 the `\-user\ user' and the `\-rpop' switches are ignored.
187 @@END: NNTP
188
189 The \fI\&.bbrc\fR file in the 
190 user's \fB$HOME\fR directory
191 is used to keep track of what messages have been read.
192 The `\-rcfile\ rcfile' switch overrides the use of \fI\&.bbrc\fR for
193 this purpose.
194 If the value given to the switch is not absolute,
195 (i.e., does not begin with a \fB/\fR\0),
196 it will be presumed to start from the current working directory.
197 If this switch is not given (or the `\-norcfile' switch is given),
198 then \fIbbc\fR consults the envariable \fBMHBBRC\fR,
199 and honors it similarly.
200 .Fi
201 ^$HOME/\&.mh\(ruprofile~^The user profile
202 ^$HOME/\&.bbrc~^BBoard \*(lqcurrent\*(rq message information
203 .Pr
204 ^Path:~^To determine the user's MH directory
205 .Ps
206 ^bboards:~^To specify interesting BBoards
207 .Ps
208 ^mshproc:~^Program to read a given BBoard
209 .Sa
210 bbl(1), bboards(1), msh(1)
211 .De
212 `\-read'
213 .Ds
214 `\-noarchive'
215 .Ds
216 `\-protocol'
217 .Ds
218 `bboards' defaults to \*(lqsystem\*(rq
219 .Ds
220 `\-file @@(BBHOME)/BBoards'
221 .Ds
222 `\-user bboards'
223 @@BEGIN: BPOP
224 `\-rpop' unless the guest account for BBoards is used
225 @@END: BPOP
226 .Co
227 None
228 .Bu
229 The `\-user' switch takes effect only if followed by the `\-file' switch.
230 .En
231 @
232
233
234 2.5
235 log
236 @describe .bbrc a little better
237 @
238 text
239 @d2 1
240 a2 1
241 .\" @@(#)$Id: bbc.rf,v 2.4 1990/04/05 15:07:52 sources Exp jromine $
242 d142 1
243 a142 1
244 then \fIbbc\fR consults the envariable \fB$MHBBRC\fR,
245 @
246
247
248 2.4
249 log
250 @add ID
251 @
252 text
253 @d2 1
254 a2 1
255 .\" @@(#)$Id:$
256 d133 3
257 d137 1
258 a137 1
259 user\-specific BBoards information.
260 a143 2
261 If this envariable is not set,
262 then the file \fI\&.bbrc\fR in the user's \fB$HOME\fR directory is used.
263 d146 1
264 a146 1
265 ^$HOME/\&.bbrc~^BBoard information
266 @
267
268
269 2.3
270 log
271 @put things back, do .NA stuff another way
272 @
273 text
274 @d2 1
275 @
276
277
278 2.2
279 log
280 @typo
281 @
282 text
283 @d2 2
284 a3 2
285 .TH BBC 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
286 .SH .NA
287 d5 1
288 a5 1
289 .SH .SY
290 @
291
292
293 2.1
294 log
295 @fixup for makewhatis
296 @
297 text
298 @d2 1
299 a2 1
300 .TH BBC 1 [mh.6] MH
301 @
302
303
304 2.0
305 log
306 @changes for SUN40 shared libraries and NNTP under bbc
307 @
308 text
309 @d2 2
310 a3 2
311 .SC BBC 1
312 .NA
313 d5 1
314 a5 1
315 .SY
316 @
317
318
319 1.1
320 log
321 @Initial revision
322 @
323 text
324 @d20 3
325 d122 9
326 @