doc: vos manpage fixes
[openafs.git] / doc / man-pages / pod1 / vos_syncserv.pod.in
1 =head1 NAME
2
3 vos_syncserv - Verifies VLDB entries that mention a specified site
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos syncserv> S<<< B<-server> <I<machine name>> >>>
11     S<<< [B<-partition> <I<partition name>>] >>>
12     S<<< [B<-cell> <I<cell name>>] >>>
13     [B<-dryrun>]
14     [B<-noauth>] [B<-localauth>]
15     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
16     S<<< [B<-config> <I<config directory>>] >>>
17     [B<-help>]
18
19 B<vos syncs> S<<< B<-s> <I<machine name>> >>>
20     S<<< [B<-p> <I<partition name>>] >>>
21     S<<< [B<-c> <I<cell name>>] >>> [B<-d>]
22     [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
23     S<<< [B<-co> <I<config directory>>] >>>
24     [B<-h>]
25
26 =for html
27 </div>
28
29 =head1 DESCRIPTION
30
31 The B<vos syncserv> command verifies that each volume mentioned in a VLDB
32 entry actually exists at the site indicated in the entry. It checks all
33 VLDB entries that mention a read/write, read-only, or backup site either
34 on any partition on the file server machine specified by the B<-server>
35 argument, or on the one partition specified by the B<-server> and
36 B<-partition> arguments. Note that the command can end up inspecting sites
37 other than those specified by the B<-server> and B<-partition> arguments,
38 if there are versions of the volume at sites other than the one specified.
39
40 The command alters any incorrect information in the VLDB, unless there is
41 an irreconcilable conflict with other VLDB entries. In that case, it
42 writes a message to the standard error stream instead. The command never
43 removes volumes from file server machines.
44
45 To achieve complete VLDB consistency, first run the B<vos syncvldb>
46 command on all file server machines in the cell, then run this command on
47 all file server machines in the cell.
48
49 =head1 OPTIONS
50
51 =over 4
52
53 =item B<-server> <I<server name>>
54
55 Identifies the file server machine mentioned in each VLDB entry to
56 check. Provide the machine's IP address or its host name (either fully
57 qualified or using an unambiguous abbreviation). For details, see
58 L<vos(1)>.
59
60 =item B<-partition> <I<partition name>>
61
62 Identifies the partition mentioned in each VLDB entry to check.  Provide
63 the partition's complete name with preceding slash (for example,
64 C</vicepa>) or use one of the three acceptable abbreviated forms. For
65 details, see L<vos(1)>.
66
67 =item B<-dryrun>
68
69 Show the actions which would be taken, but do not make changes.
70
71 =include fragments/vos-common.pod
72
73 =back
74
75 =head1 EXAMPLES
76
77 The following example verifies the VLDB entries in which a site definition
78 mentions the file server machine C<fs3.example.com>.
79
80    % vos syncserv -server fs3.example.com
81
82 =head1 PRIVILEGE REQUIRED
83
84 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
85 machine specified with the B<-server> argument and on each database server
86 machine. If the B<-localauth> flag is included, the issuer must instead be
87 logged on to a server machine as the local superuser C<root>.
88
89 =head1 SEE ALSO
90
91 L<vos(1)>,
92 L<vos_syncvldb(1)>
93
94 =head1 COPYRIGHT
95
96 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
97
98 This documentation is covered by the IBM Public License Version 1.0.  It was
99 converted from HTML to POD by software written by Chas Williams and Russ
100 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.