Mercurial > hg > Applications > mh

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