Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / conf / doc / bboards5.rf
1 .\"     @(MHWARNING)
2 .\" @(#)$Id: bboards5.rf,v 1.5 90/04/05 15:11:49 sources Exp $
3 .SC BBOARDS 5
4 .NA
5 BBoards \- BBoards database
6 .SY
7 @(BBHOME)/BBoards
8 .DE
9 The BBoards database
10 contains for each BBoard the following information:
11
12 .nf
13 .ta \w'encrypted password  'u
14 \fIfield\fR     \fIvalue\fR
15 name    the name of the BBoard
16 aliases local aliases for the BBoard
17         (separated by commas)
18 primary file    the .mbox file
19 encrypted password      leadership password
20 leaders local list maintainers (separated by commas)
21         usernames from the \fIpasswd\fR\0(5) file,
22         or groupnames preceded by `=' from the
23         \fIgroup\fR\0(5) file
24 network address the list address
25 request address the list maintainer's address
26 relay   the host acting as relay for the local domain
27 distribution sites      (separated by commas)
28 flags   special flags (see <bboards.h>)
29 .re
30 .fi
31
32 This is an ASCII file.  Each field within each BBoard's entry
33 is separated from the next by a colon.
34 Each BBoard entry is separated from the next by a new-line.
35 If the password field is null, no password is demanded;
36 if it contains a single asterisk, then no password is valid.
37
38 This file resides in the home directory of the login \*(lqbboards\*(rq.
39 Because of the encrypted passwords,
40 it can and does have general read permission.
41 .Fi
42 ^@(BBHOME)/BBoards~^BBoards database
43 .Sa
44 bbaka(8), bbexp(8), bboards (8), bbtar(8)
45 .Bu
46 A binary indexed file format should be available for fast access.
47
48 Appropriate precautions must be taken to lock the file against changes
49 if it is to be edited with a text editor.
50 A \fIvibb\fR program is needed.
51 .En