doc: buserver manpage fixes
[openafs.git] / doc / man-pages / pod8 / buserver.pod
1 =head1 NAME
2
3 buserver - Initializes the Backup Server
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<buserver> S<<< [B<-database> <I<database directory>>] >>>
11     S<<< [B<-auditlog> <I<log path>>] >>>
12     S<<< [B<-audit-interface> (file | sysvmq)] >>>
13     S<<< [B<-cellservdb> <I<cell configuration directory>>] >>> [B<-resetdb>]
14     [B<-noauth>] [B<-smallht>]
15     S<<< [B<-servers> <I<list of ubik database servers>>+] >>>
16     [B<-rxbind>]
17     [B<-p> <I<number of threads>>] [B<-ubikbuffers> <I<# of buffers>>]
18     [B<-help>]
19
20 =for html
21 </div>
22
23 =head1 DESCRIPTION
24
25 The B<buserver> command initializes the Backup Server, which runs on
26 database server machines and maintains the Backup Database. In the
27 conventional configuration, the binary file is located in the
28 F</usr/afs/bin> directory on a file server machine.
29
30 The B<buserver> command is not normally issued at the command shell
31 prompt, but rather placed into a database server machine's
32 F</usr/afs/local/BosConfig> file with the B<bos create> command. If it is
33 ever issued at the command shell prompt, the issuer must be logged onto a
34 file server machine as the local superuser C<root>.
35
36 As it initializes, the Backup Server process creates the two files that
37 constitute the Backup Database, F<bdb.DB0> and F<bdb.DBSYS1>, in the
38 F</usr/afs/db> directory if they do not already exist. The Backup Database
39 houses information about volume sets and entries, the dump hierarchy, Tape
40 Coordinators, and previously performed dump sets. Use the commands in the
41 B<backup> suite to administer the database.
42
43 The Backup Server records a trace of its activity in the
44 F</usr/afs/logs/BackupLog> file. Use the B<bos getlog> command to display
45 the contents of the file.
46
47 This command does not use the syntax conventions of the AFS command
48 suites. Provide the command name and all option names in full.
49
50 =head1 CAUTIONS
51
52 The B<buserver> process reserves port 7021 for its use. Unexpected
53 behavior can occur if another process tries to reserve this port while the
54 B<buserver> process is running.
55
56 =head1 OPTIONS
57
58 =over 4
59
60 =item B<-database> <I<database directory>>
61
62 Specifies the pathname of an alternate directory for the Backup Database
63 files, ending in a final slash (C</>). If this argument is not provided,
64 the default is the F</usr/afs/db> directory.
65
66 =item B<-auditlog> <I<log path>>
67
68 Turns on audit logging, and sets the path for the audit log.  The audit
69 log records information about RPC calls, including the name of the RPC
70 call, the host that submitted the call, the authenticated entity (user)
71 that issued the call, the parameters for the call, and if the call
72 succeeded or failed.
73
74 =item B<-audit-interface> (file | sysvmq)
75
76 Specifies what audit interface to use. Defaults to C<file>. See
77 L<fileserver(8)> for an explanation of each interface.
78
79 =item B<-cellservdb> <I<cell configuration directory>>
80
81 Specifies the pathname of the directory from which the Backup Server reads
82 in an alternate version of the F<CellServDB> file. This argument is
83 mandatory for correct functioning when the Backup Server is running on a
84 subset of the cell's database server machines that is not a majority of
85 the machines listed in the standard F</usr/afs/etc/CellServDB> file (which
86 the Backup Server consults if this argument is not provided). It is not
87 appropriate in any other circumstances.
88
89 =item B<-resetdb>
90
91 Removes all of the information in the Backup Database files in the
92 F</usr/afs/db> directory, leaving zero-length versions of them.  The
93 backup operator must recreate the configuration entries in the database
94 (for volume sets, the dump hierarchy and so on) before performing backup
95 operations.
96
97 =item B<-noauth>
98
99 Turns off all authorization checks, and allows all connecting users to act as
100 administrators, even unauthenticated users. The use of this option is
101 inherently insecure, and should only be used in controlled environments for
102 experimental or debug purposes. See L<NoAuth(5)>.
103
104 =item B<-smallht>
105
106 Directs the Backup Server to use smaller internal hash tables for the
107 Backup Database, which reduces memory requirements but can make data
108 access take longer.
109
110 =item B<-servers> <I<list of ubik database servers>>+
111
112 Specifies the database server machines on which to start the Backup
113 Server. Use this argument if running the Backup Server on a subset of the
114 database server machines that is not a majority of the machines listed in
115 the F</usr/afs/etc/CellServDB> file.
116
117 =item B<-rxbind>
118
119 Bind the Rx socket to the primary interface only.  (If not specified, the
120 Rx socket will listen on all interfaces.)
121
122 =item B<-p> <I<number of threads>>
123
124 Sets the number of server lightweight processes (LWPs or pthreads) to run.
125 Provide a positive integer from the range 3 to 16. The default value is 3.
126
127 =item B<-ubikbuffers> <I<# of buffers>>
128
129 Sets the number of internal buffers used for maintaining the ubik database.
130 The default is 400. If the buserver runs out of free buffers, errors can occur
131 while trying to modify ubik data. It is not recommended to change this setting.
132
133 =item B<-help>
134
135 Prints the online help for this command. All other valid options are
136 ignored.
137
138 =back
139
140 =head1 EXAMPLES
141
142 The following example B<bos create> command creates a C<buserver> process
143 on the file server machine C<fs3.example.com>. It appears here on two lines
144 only for legibility.
145
146    % bos create -server fs3.example.com -instance buserver \
147                 -type simple -cmd /usr/afs/bin/buserver
148
149 =head1 PRIVILEGE REQUIRED
150
151 The issuer must be logged in as the superuser C<root> on a file server
152 machine to issue the command at a command shell prompt. It is conventional
153 instead to create and start the process by issuing the B<bos create>
154 command.
155
156 =head1 SEE ALSO
157
158 L<BackupLog(5)>,
159 L<BosConfig(5)>,
160 L<CellServDB(5)>,
161 L<bdb.DB0(5)>,
162 L<backup(8)>,
163 L<bos_create(8)>,
164 L<bos_getlog(8)>
165
166 =head1 COPYRIGHT
167
168 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
169
170 This documentation is covered by the IBM Public License Version 1.0.  It was
171 converted from HTML to POD by software written by Chas Williams and Russ
172 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.