doc: volscan man page
[openafs.git] / doc / man-pages / pod1 / afs.pod
index 609f9d9..66fcd5a 100644 (file)
@@ -31,7 +31,7 @@ Interface for tracing Cache Manager operations when debugging problems.
 =item kas
 
 Interface to the Authentication Server for administering security and
-authentication information.
+authentication information. This aspect of OpenAFS has been deprecated.
 
 =item pts
 
@@ -40,7 +40,9 @@ membership information.
 
 =item uss
 
-Interface for automated administration of user accounts.
+Interface for automated administration of user accounts. Deprecated, may
+be removed from a future version of OpenAFS. See B<uss> man page for more
+detail.
 
 =item vos
 
@@ -66,14 +68,14 @@ name>.
 The I<command_suite> specifies the group of related commands to which the
 command belongs, and indicates which command interpreter and server
 process perform the command.  AFS has several command suites, including
-B<bos>, B<fs>, B<kas>, B<package>, B<pts>, B<uss> and B<vos>.  Some of
-these suites have an interactive mode in which the issuer omits the
+B<bos>, B<fs>, B<kas>, B<package>, B<pts>, B<uss> (deprecated) and B<vos>.
+Some of these suites have an interactive mode in which the issuer omits the
 I<operation_code> portion of the command name.
 
 The I<operation_code> tells the command interpreter and server process
 which action to perform. Most command suites include several operation
 codes. The man pages for each command name describe each operation code in
-detail, and the I<IBM AFS Administration Guide> describes how to use them
+detail, and the I<OpenAFS Administration Guide> describes how to use them
 in the context of performing administrative tasks.
 
 Several AFS commands do not belong to a suite and so their names do not
@@ -108,7 +110,7 @@ the rules outlined in L<"Conditions for Omitting Switches">.
 
 The I<value> names a particular entity of the type specified by the
 preceding switch. For example, the proper value for a B<-server> switch is
-a server machine name like C<fs3.abc.com>. Unlike switches (which have a
+a server machine name like C<fs3.example.com>. Unlike switches (which have a
 required form), values vary depending on what the issuer wants to
 accomplish. Values appear surrounded by angle brackets (C<< <> >>) in
 command descriptions and the online help to show that they are
@@ -142,7 +144,7 @@ argument. Flags are always optional.
 The following example illustrates the different parts of a command that
 belongs to an AFS command suite.
 
-   % bos getdate -server fs1.abc.com -file ptserver kaserver
+   % bos getdate -server fs1.example.com -file ptserver kaserver
 
 where
 
@@ -156,13 +158,13 @@ in this suite.
 =item *
 
 B<getdate> is the operation code. It tells the BOS Server on the specified
-server machine (in this case C<fs1.abc.com>) to report the modification
+server machine (in this case C<fs1.example.com>) to report the modification
 dates of binary files in the local F</usr/afs/bin> directory.
 
 =item *
 
-C<-server fs1.abc.com> is one argument, with B<-server> as the switch and
-C<fs1.abc.com> as the value. This argument specifies the server machine on
+C<-server fs1.example.com> is one argument, with B<-server> as the switch and
+C<fs1.example.com> as the value. This argument specifies the server machine on
 which BOS Server is to collect and report binary dates.
 
 =item *
@@ -271,18 +273,18 @@ the preceding argument.
 
 Consider again the example command from L<"An Example Command">.
 
-   % bos getdate -server fs1.abc.com -file ptserver kaserver
+   % bos getdate -server fs1.example.com -file ptserver kaserver
 
 This command has two required arguments: the server machine name
 (identified by the B<-server> switch) and binary file name (identified by
 the B<-file> switch). The second argument accepts multiple values. By
 complying with all three conditions, the issuer can omit the switches:
 
-   % bos getdate fs1.abc.com ptserver kaserver
+   % bos getdate fs1.example.com ptserver kaserver
 
 Because there are no switches, the bos command interpreter relies on the
 order of arguments. It assumes that the first element following the
-operation code, C<fs1.abc.com>, is the server machine name, and that the
+operation code, C<fs1.example.com>, is the server machine name, and that the
 next argument, C<ptserver>, is a binary file name. Then, because the
 command's second (and last) argument accepts multiple values, the command
 interpreter correctly interprets C<kaserver> as an additional value for
@@ -294,7 +296,7 @@ there is only one value per argument, the arguments do not appear in the
 prescribed order, and a switch is provided for one argument but not the
 other.
 
-   % bos getdate ptserver -server fs1.abc.com
+   % bos getdate ptserver -server fs1.example.com
 
 =head3 Rules for Using Abbreviations and Aliases
 
@@ -376,7 +378,7 @@ conditions listed in L<"Conditions for Omitting Switches">.
 =head4 Abbreviating Server Machine Names
 
 AFS server machines must have fully-qualified Internet-style host names
-(for example, C<fs1.abc.com>), but it is not always necessary to type the
+(for example, C<fs1.example.com>), but it is not always necessary to type the
 full name on the command line. AFS commands accept unambiguous shortened
 forms, but depend on the cell's name service (such as the Domain Name
 Service) or a local host table to resolve a shortened name to the
@@ -391,7 +393,7 @@ Partitions that house AFS volumes must have names of the form
 F</vicepI<x>> or F</vicepI<xx>>, where the variable final portion is one
 or two lowercase letters. By convention, the first server partition
 created on a file server machine is called F</vicepa>, the second
-F</vicepb>, and so on.  The I<IBM AFS Quick Beginnings> explains how to
+F</vicepb>, and so on.  The I<OpenAFS QuickStart Guide> explains how to
 configure and name a file server machine's partitions in preparation for
 storing AFS volumes on them.
 
@@ -410,10 +412,13 @@ and so on through
 
    /vicepiv    =     vicepiv     =      iv     =      255
 
+F</vicepiv> is the last permissible AFS partition name. In practice it
+will not work well; stopping with F</vicepiu> is highly recommended.
+
 =head4 Abbreviating Cell Names
 
 A cell's full name usually matches its Internet domain name (such as
-B<stateu.edu> for the State University or C<abc.com> for ABC
+B<example.org> for the Example Organization or C<example.com> for Example
 Corporation). Some AFS commands accept unambiguous shortened forms,
 usually with respect to the local F</usr/vice/etc/CellServDB file> but
 sometimes depending on the ability of the local name service to resolve
@@ -504,8 +509,6 @@ privilege. See the reference page for each command.
 
 =head1 SEE ALSO
 
-=over 4
-
 L<afsd(8)>,
 L<afsmonitor(1)>,
 L<backup(8)>,
@@ -546,13 +549,12 @@ L<uss(8)>,
 L<vldb_check(8)>,
 L<vlserver(8)>,
 L<volinfo(8)>,
+L<volscan(8)>,
 L<volserver(8)>,
 L<vos(1)>,
 L<xfs_size_check(8)>,
-L<xstat_cm_test(8)>,
-L<xstat_fs_test(8)>
-
-=back
+L<xstat_cm_test(1)>,
+L<xstat_fs_test(1)>
 
 =head1 COPYRIGHT