Mercurial > hg > Applications > mh

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