doc: vos manpage fixes
[openafs.git] / doc / man-pages / pod1 / vos_syncserv.pod
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<-cell> <I<cell name>>
68
69 Names the cell in which to run the command. Do not combine this argument
70 with the B<-localauth> flag. For more details, see L<vos(1)>.
71
72 =item B<-dryrun>
73
74 Show the actions which would be taken, but do not make changes.
75
76 =item B<-noauth>
77
78 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
79 combine this flag with the B<-localauth> flag. For more details, see
80 L<vos(1)>.
81
82 =item B<-localauth>
83
84 Constructs a server ticket using a key from the local
85 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
86 to the Volume Server and Volume Location Server during mutual
87 authentication. Do not combine this flag with the B<-cell> argument or
88 B<-noauth> flag. For more details, see L<vos(1)>.
89
90 =item B<-verbose>
91
92 Produces on the standard output stream a detailed trace of the command's
93 execution. If this argument is omitted, only warnings and error messages
94 appear.
95
96 =item B<-encrypt>
97
98 Encrypts the command so that the operation's results are not transmitted
99 across the network in clear text. This option is available in OpenAFS
100 versions 1.4.11 or later and 1.5.60 or later.
101
102 =item B<-noresolve>
103
104 Shows all servers as IP addresses instead of the DNS name. This is very
105 useful when the server address is registered as 127.0.0.1 or when dealing
106 with multi-homed servers. This option is available in OpenAFS
107 versions 1.4.8 or later and 1.5.35 or later.
108
109 =item B<-help>
110
111 Prints the online help for this command. All other valid options are
112 ignored.
113
114 =back
115
116 =head1 EXAMPLES
117
118 The following example verifies the VLDB entries in which a site definition
119 mentions the file server machine C<fs3.example.com>.
120
121    % vos syncserv -server fs3.example.com
122
123 =head1 PRIVILEGE REQUIRED
124
125 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
126 machine specified with the B<-server> argument and on each database server
127 machine. If the B<-localauth> flag is included, the issuer must instead be
128 logged on to a server machine as the local superuser C<root>.
129
130 =head1 SEE ALSO
131
132 L<vos(1)>,
133 L<vos_syncvldb(1)>
134
135 =head1 COPYRIGHT
136
137 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
138
139 This documentation is covered by the IBM Public License Version 1.0.  It was
140 converted from HTML to POD by software written by Chas Williams and Russ
141 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.