annotate conf/doc/bbc.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 BBC 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 bbc \- check on BBoards
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 bbc
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[bboards\ ...]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-topics] \%[\-check] \%[\-read]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-quiet] \%[\-verbose]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \%[\-archive] \%[\-noarchive]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 \%[\-protocol] \%[\-noprotocol]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 \%[\-mshproc\ program]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 \%[switches\ for\ \fImshproc\fR]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 \%[\-rcfile rcfile] \%[\-norcfile]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 \%[\-file\ BBoardsfile] \%[\-user\ BBoardsuser]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 @BEGIN: BPOP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 \%[\-host\ host]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 \%[\-rpop] \%[\-norpop]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 @END: BPOP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 @BEGIN: NNTP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 \%[\-host\ host]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 @END: NNTP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 \fIbbc\fR is a BBoard
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 reading/checking program that interfaces to the BBoard
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 channel.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 The \fIbbc\fR program has three action switches which direct its operation:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 The `\-read' switch invokes the \fImsh\fR program on the named
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 \fIBBoards\fR. If you also specify
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 the `\-archive' switch, then \fIbbc\fR will invoke the \fImsh\fR program on
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 the archives of the named \fIBBoards\fR. If no \fIBBoards\fR are given
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 on the command line, and you specified `\-archive',
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 \fIbbc\fR will not read your `bboards' profile entry, but will
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 read the archives of the \*(lqsystem\*(rq \fIBBoard\fR instead.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 The `\-check' switch types out status information for the named \fIBBoards\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 \fIbbc\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 can print one of several messages depending on the status of both the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 BBoard
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 and the user's reading habits.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 As with each of these messages, the number
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 given is the item number of the last item placed in the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 BBoard.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 This number (which is marked in the messages as the \*(lqBBoard\-Id\*(rq) is
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 ever increasing. Hence, when \fIbbc\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 says \*(lqn items\*(rq, it really means that the highest BBoard\-Id is \*(lqn\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 There may, or may not actually be \*(lqn\*(rq items in the BBoard.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 Some common messages are:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 .in +1i
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 \fBBBoard \-\- n items unseen\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 This message tells how many items the user has not yet seen.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 When invoked with the `\-quiet' switch,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 this is the only informative line that \fIbbc\fR will possibly print out.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 .ti -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 \fBBBoard \-\- empty\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 The BBoard is empty.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 .ti -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 \fBBBoard \-\- n items (none seen)\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 The BBoard has items in it, but the user hasn't seen any.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 .ti -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 \fBBBoard \-\- n items (all seen)\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 The BBoard is non\-empty, and the user has seen everything in it.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 .ti -.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 \fBBBoard \-\- n items seen out of m\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 .br
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80 The BBoard has at most m\-n items that the user has not seen.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 .in -1i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 The `\-topics' switch directs \fIbbc\fR to print three items about the named
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 \fIBBoards\fR:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 it's official name,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 the number of items present,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 and the date and time of the last update.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 If no \fIBBoards\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 are named, then all BBoards
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90 are listed. If the `\-verbose' switch is given, more information is output.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 The `\-quiet' switch specifies that \fIbbc\fR should be silent if no
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 \fIBBoards\fR are found with new information.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 The `\-verbose' switch specifies that \fIbbc\fR is to consider you to be
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 interested in \fIBBoards\fR that you've already seen everything in.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 To override the default \fImshproc\fR and the profile entry,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 use the `\-mshproc\ program' switch.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 Any arguments not understood by \fIbbc\fR are passed to this program.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 The `\-protocol' switch tells \fIbbc\fR that your \fImshproc\fR knows about
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 the special \fIbbc\fR protocol for reporting back information.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
102 \fImsh\fR\0(1), the default \fImshproc\fR, knows all about this.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
103
bce86c4163a3 Initial revision
kono
parents:
diff changeset
104 The `\-file\ BBoardsfile' switch tells \fIbbc\fR to use a non\-standard
bce86c4163a3 Initial revision
kono
parents:
diff changeset
105 \fIBBoards\fR file when performing its calculations.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
106 Similarly, the `\-user BBoardsuser' switch tells \fIbbc\fR to use a
bce86c4163a3 Initial revision
kono
parents:
diff changeset
107 non\-standard username.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
108 Both of these switches are useful for debugging a new \fIBBoards\fR or
bce86c4163a3 Initial revision
kono
parents:
diff changeset
109 \fIPOP\fR file.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
110 @BEGIN: BPOP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
111
bce86c4163a3 Initial revision
kono
parents:
diff changeset
112 If the local host is configured as a POP BBoards client,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
113 or if the `\-host\ host' switch is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
114 then \fIbbc\fR will query the POP service host as to the status of the BBoards.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
115 The `\-user\ user' switch then takes on a new meaning:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
116 it refers to the name of the guest account for BBoards on the service host.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
117 The `\-rpop' switch uses the UNIX \fIrPOP\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
118 (authentication done via trusted connections).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
119 In contrast, the `\-norpop' switch uses the ARPA \fIPOP\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
120 (in which case \fIbbc\fR will prompt for a password,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
121 unless the \-user specifies the guest account).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
122 @END: BPOP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
123 @BEGIN: NNTP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
124
bce86c4163a3 Initial revision
kono
parents:
diff changeset
125 If the local host is configured as an NNTP BBoards client,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
126 or if the `\-host\ host' switch is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
127 then \fIbbc\fR will query the NNTP service host
bce86c4163a3 Initial revision
kono
parents:
diff changeset
128 as to the status of the BBoards.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
129 For NNTP BBoards clients,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
130 the `\-user\ user' and the `\-rpop' switches are ignored.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
131 @END: NNTP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
132
bce86c4163a3 Initial revision
kono
parents:
diff changeset
133 The \fI\&.bbrc\fR file in the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
134 user's \fB$HOME\fR directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
135 is used to keep track of what messages have been read.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
136 The `\-rcfile\ rcfile' switch overrides the use of \fI\&.bbrc\fR for
bce86c4163a3 Initial revision
kono
parents:
diff changeset
137 this purpose.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
138 If the value given to the switch is not absolute,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
139 (i.e., does not begin with a \fB/\fR\0),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
140 it will be presumed to start from the current working directory.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
141 If this switch is not given (or the `\-norcfile' switch is given),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
142 then \fIbbc\fR consults the envariable \fBMHBBRC\fR,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
143 and honors it similarly.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
144 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
145 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
146 ^$HOME/\&.bbrc~^BBoard \*(lqcurrent\*(rq message information
bce86c4163a3 Initial revision
kono
parents:
diff changeset
147 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
148 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
149 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
150 ^bboards:~^To specify interesting BBoards
bce86c4163a3 Initial revision
kono
parents:
diff changeset
151 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
152 ^mshproc:~^Program to read a given BBoard
bce86c4163a3 Initial revision
kono
parents:
diff changeset
153 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
154 bbl(1), bboards(1), msh(1)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
155 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
156 `\-read'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
157 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
158 `\-noarchive'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
159 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
160 `\-protocol'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
161 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
162 `bboards' defaults to \*(lqsystem\*(rq
bce86c4163a3 Initial revision
kono
parents:
diff changeset
163 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
164 `\-file @(BBHOME)/BBoards'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
165 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
166 `\-user bboards'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
167 @BEGIN: BPOP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
168 `\-rpop' unless the guest account for BBoards is used
bce86c4163a3 Initial revision
kono
parents:
diff changeset
169 @END: BPOP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
170 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
171 None
bce86c4163a3 Initial revision
kono
parents:
diff changeset
172 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
173 The `\-user' switch takes effect only if followed by the `\-file' switch.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
174 .En