don't just report the deficiency again, but any contributions towards
fixing it are greatly appreciated.
- * All of the manual references refer to the "IBM" manual. We should
- decide how to handle this terminology-wise.
-
* The salvager actually creates a bunch of SalvageLog files and then
combines them, but the SalvageLog man page doesn't reflect this.
- * The references to the other OpenAFS manuals, such as the Quick Start
- guide and the Admin Guide, should be links, probably to the documents
- on openafs.org.
-
* There's no mention of the Kerberos v5 support. At least, we need
some disclaimers under klog and friends talking about sites without
kaserver (and possibly without fakeka), and deprecation warnings
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
There are 271 available File Server statistics and 571 available Cache
Manager statistics, listed in the appendix about B<afsmonitor> statistics
-in the I<IBM AFS Administration Guide>. By default, the command displays
+in the I<OpenAFS Administration Guide>. By default, the command displays
all of the relevant statistics for the file server machines named by the
B<-fshosts> argument and the client machines named by the B<-cmhosts>
argument. To limit the display to only the statistics of interest, list
argument if not providing the B<-fshosts> argument, B<-cmhosts> argument,
or neither. For instructions on creating this file, see the preceding
B<DESCRIPTION> section, and the section on the B<afsmonitor> program in
-the I<IBM AFS Administration Guide>.
+the I<OpenAFS Administration Guide>.
=item B<-frequency> <I<poll frequency>>
Names the file to which the afsmonitor program writes all of the
statistics that it collects. By default, no output file is created. See
-the section on the B<afsmonitor> command in the I<IBM AFS Administration
+the section on the B<afsmonitor> command in the I<OpenAFS Administration
Guide> for information on this file.
=item B<-detailed>
=head1 EXAMPLES
For examples of commands, display screens, and configuration files, see
-the section about the B<afsmonitor> program in the I<IBM AFS
+the section about the B<afsmonitor> program in the I<OpenAFS
Administration Guide>.
=head1 PRIVILEGE REQUIRED
L<fstrace(8)>,
L<scout(1)>
+The I<OpenAFS Administration Guide> at
+L<http://docs.openafs.org/AdminGuide/>.
+
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
When using this command to copy ACLs between objects in DFS filespace
accessed via the AFS/DFS Migration Toolkit Protocol Translator, it is
possible to specify files, as well as directories, with the B<-fromdir>
-and B<-todir> arguments. For more information on copying ACLs between DFS
-directories and files, refer to the I<IBM AFS/DFS Migration Toolkit
-Administration Guide and Reference>.
+and B<-todir> arguments.
=head1 CAUTIONS
L<fs_mkmount(1)>,
L<fs_setacl(1)>
-I<IBM AFS/DFS Migration Toolkit Administration Guide and Reference>
-
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
is no DFS equivalent to the AFS C<k> (lock) permission. The meanings of
the various permissions also differ slightly, and DFS does not implement
negative permissions. For a complete description of DFS permissions, see
-the DFS documentation and the I<IBM AFS/DFS Migration Toolkit
-Administration Guide and Reference>.
+the DFS documentation.
=head1 EXAMPLES
L<fs_copyacl(1)>,
L<fs_setacl(1)>
-I<IBM AFS/DFS Migration Toolkit Administration Guide and Reference>
-
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
mkmount> command. It is conventional to create only one read/write mount
point in a cell's filespace, using it to mount the cell's C<root.cell>
volume just below the AFS filespace root (by convention,
-F</afs/.I<cellname>>). See the I<IBM AFS Quick Beginnings> for
-instructions and the chapter about volume management in the I<IBM AFS
+F</afs/.I<cellname>>). See the I<OpenAFS Quick Start Guide> for
+instructions and the chapter about volume management in the I<OpenAFS
Administration Guide> for further discussion.
Creating a read/write mount point for a read-only or backup volume is
If the B<-name> argument names a DCE cell, then the B<-servers> argument
names DFS Fileset Location (FL) Server machines. The B<-linkedcell>
argument specifies the name of the AFS cell to link to a DCE cell for the
-purpose of DFS fileset location. Refer to the I<IBM AFS/DFS Migration
-Toolkit Administration Guide and Reference> for more information on
-linking AFS clients to DCE cells using this command or by editing the
-F</usr/vice/etc/CellServDB> file.
+purpose of DFS fileset location.
=head1 CAUTIONS
L<CellServDB(5)>,
L<fs_listcells(1)>
-I<IBM AFS/DFS Migration Toolkit Administration Guide and Reference>
-
-I<IBM AFS/DFS Migration Toolkit Administration Installation and
-Configuration Guide>
-
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
If the B<-dir> argument designates a pathname in DFS filespace (accessed
via the AFS/DFS Migration Toolkit Protocol Translator), it can be a file
as well as a directory. The ACL must already include an entry for
-C<mask_obj>, however. For more details, refer to the I<IBM AFS/DFS
-Migration Toolkit Administration Guide and Reference>.
+C<mask_obj>, however.
Only user and group entries are acceptable values for the B<-acl>
argument. Do not place machine entries (IP addresses) directly on an ACL;
entries that use the shorthand words, but not use both types of notation
within an individual pairing of user or group and permissions.
-To learn the proper format and acceptable values for DFS ACL entries, see
-the I<IBM AFS/DFS Migration Toolkit Administration Guide and Reference>.
+If setting ACLs on a pathname in DFS filespace, see the DFS documentation
+for the proper format and acceptable values for DFS ACL entries.
=item B<-clear>
L<fs_listacl(1)>,
L<fs_mkmount(1)>
-I<IBM AFS/DFS Migration Toolkit Administration Guide and Reference>
-
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
The Cache Manager stores a preference rank in kernel memory as a paired IP
address and numerical rank. If a file server machine is multihomed, the
Cache Manager assigns a distinct rank to each of the machine's addresses
-(up to the number of addresses that the VLDB can store per machine, which
-is specified in the I<IBM AFS Release Notes>). Once calculated, a rank
-persists until the machine reboots, or until this command is used to
-change it.
+(up to the number of addresses that the VLDB can store per machine). Once
+calculated, a rank persists until the machine reboots, or until this
+command is used to change it.
The Cache Manager sets default VL Server preference ranks as it
initializes, randomly assigning a rank from the range 10,000 to 10,126 to
L<fs_exportafs(1)>,
L<sys(1)>
-I<OpenAFS Quick Beginnings>
-L<http://www.openafs.org/pages/doc/QuickStartUnix/auqbg000.htm>
+The I<OpenAFS Quick Start Guide> at
+L<http://docs.openafs.org/QuickStartUnix/>.
-I<OpenAFS Administration Guide>
-L<http://www.openafs.org/pages/doc/AdminGuide/auagd000.htm>
+The I<OpenAFS Administration Guide>
+L<http://docs.openafs.org/AdminGuide/>.
For the list of assigned standard sysname values, see
L<http://grand.central.org/numbers/systypes.html>
indicates the local machine's CPU/operating system (OS) type,
conventionally called the I<sysname>. The Cache Manager substitutes this
string for the I<@sys> variable which can occur in AFS pathnames; the
-I<IBM AFS Quick Beginnings> and I<IBM AFS Administration Guide> explain
+I<OpenAFS Quick Start Guides> and I<OpenAFS Administration Guide> explain
how using I<@sys> can simplify cell configuration.
To set a new value in kernel memory, use the B<fs sysname> command, which
L<fs_sysname(1)>,
L<sys(1)>
-I<IBM AFS Quick Beginnings>
+The I<OpenAFS Quick Start Guides> at L<http://docs.openafs.org/>.
-I<IBM AFS Administration Guide>
+The I<OpenAFS Administration Guide> at
+L<http://docs.openafs.org/AdminGuide/>.
=head1 COPYRIGHT
possible access permissions they have for the directory and the files it
contains. (It is still possible to set a directory or file's mode bits,
but AFS interprets them in its own way; see the chapter on protection in
-the I<IBM AFS Administration Guide> for details.)
+the I<OpenAFS Administration Guide> for details.)
AFS enables users to define groups in the Protection Database and place
them on ACLs to extend a set of rights to multiple users simultaneously.
L<pts_sleep(1)>,
L<pts_source(1)>
+The I<OpenAFS Administration Guide> at
+L<http://docs.openafs.org/AdminGuide/>.
+
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
Database entry, volume, and mount point. When using this command to change
a user name, also change the names of all related entities to maintain
consistency. For instructions, see the chapter on user accounts in the
-I<IBM AFS Administration Guide>.
+I<OpenAFS Administration Guide>.
=head1 OPTIONS
=head1 EXAMPLES
-See the chapter on monitoring tools in the I<IBM AFS Administration
+See the chapter on monitoring tools in the I<OpenAFS Administration
Guide>, which illustrates the displays that result from different
combinations of options.
the local machine's CPU/operating system (OS) type, conventionally called
the I<sysname>. This string is the default for the value stored in kernel
memory. The Cache Manager substitutes this string for the I<@sys>
-variable which can occur in AFS pathnames; the I<IBM AFS Quick Beginnings>
-and I<IBM AFS Administration Guide> explain how using I<@sys> can simplify
-cell configuration.
+variable which can occur in AFS pathnames; the I<OpenAFS Quick Start
+Guide> and I<OpenAFS Administration Guide> explain how using I<@sys> can
+simplify cell configuration.
To set a new value in kernel memory, use the B<fs sysname> command. To
view the current value set in the kernel, use either B<fs sysname> or
L<fs_sysname(1)>,
L<livesys(1)>
-I<OpenAFS Quick Beginnings>
+The I<OpenAFS Quick Start Guides> at L<http://docs.openafs.org/>.
-I<OpenAFS Administration Guide>
+The I<OpenAFS Administration Guide> at
+L<http://docs.openafs.org/AdminGuide/>.
=head1 COPYRIGHT
=head1 CAUTIONS
-A volume's VLDB entry accommodates a maximum number of site definitions,
-as defined in the I<IBM AFS Release Notes>. The site housing the
-read/write and backup versions of the volume counts as one site, and each
-read-only site counts as an additional site (even the read-only site
-defined on the same file server machine and partition as the read/write
-site counts as a separate site). The limit in the VLDB entry effectively
-determines the maximum number of copies of the volume that are available
-to AFS clients.
+A volume's VLDB entry accommodates a maximum number of 16 site
+definitions. The site housing the read/write and backup versions of the
+volume counts as one site, the backup snapshot counts as one site, and one
+site should be reserved for a transient clone for volume moves and similar
+operations. Each read-only site counts as an additional site (even the
+read-only site defined on the same file server machine and partition as
+the read/write site counts as a separate site). The limit in the VLDB
+entry effectively determines the maximum number of copies of the volume
+that are available to AFS clients.
Attempts to create additional sites by using this command fail with an
error.
The Authentication Server is possibly unable to create these files on some
operating systems that AFS otherwise supports, making the B<kdb> command
-inoperative. See the I<IBM AFS Release Notes> for details.
+inoperative.
=head1 SEE ALSO
L<upserver(8)>
The I<OpenAFS Administration Guide> at
-L<http://docs.openafs.org/AdminGuide/index.html>.
+L<http://docs.openafs.org/AdminGuide/>.
=head1 COPYRIGHT
=item *
-During installation of the machine, as instructed in the I<IBM AFS Quick
-Beginnings>.
+During installation of the machine, as instructed in the I<OpenAFS Quick
+Start Guide>.
=item *
During correction of a server encryption key emergency, as discussed in
-the I<IBM AFS Administration Guide>.
+the I<OpenAFS Administration Guide>.
=back
edit the file and reboot the machine.
The file is in ASCII format and contains a character string on a single
-line. The I<IBM AFS Quick Beginnings> instructs the administrator to
+line. The I<OpenAFS Quick Start Guide> instructs the administrator to
create it during the installation of each client machine.
The client machine's cell membership determines three defaults important
The file is in ASCII format and contains a character string on a single
line. The initial version of the file is created with the B<bos
setcellname> command during the installation of the cell's first file
-server machine, and the I<IBM AFS Quick Beginnings> includes instructions
+server machine, and the I<OpenAFS Quick Start Guide> includes instructions
for copying it over to additional server machine during their
installation.
Specifies which individual statistic, group of statistics, or section of
statistics to display on the C<File Servers> screen (C<fs>) or C<Cache
Managers> screen (C<cm>) and the order in which to display them. The
-appendix of B<afsmonitor> statistics in the I<IBM AFS Administration
+appendix of B<afsmonitor> statistics in the I<OpenAFS Administration
Guide> specifies the group and section to which each statistic
belongs. Include as many C<show> lines as necessary to customize the
screen display as desired, and place them anywhere in the file. The
For a list of the values that can appear in the I<field/group/section>
field of a C<show> instruction, see the B<afsmonitor> statistics appendix
-to the I<IBM AFS Administration Guide>.
+to the I<OpenAFS Administration Guide>.
=head1 SEE ALSO
F<sysid> file from the new machine before starting the C<fs> trio of
processes, which includes the B<fileserver> process.
-Some versions of AFS limit how many of a file server machine's interface
-addresses that can be registered. Consult the I<IBM AFS Release Notes>.
+A maximum of 15 file server interface addresses can be registered in the
+VLDB.
=head1 SEE ALSO
System tape label to track how much space remains as it writes data to a
tape or backup data file. The appropriate value to record for a tape
depends on the size of the tapes usually used in the device and whether it
-has a compression mode; for suggested values, see the I<IBM AFS
+has a compression mode; for suggested values, see the I<OpenAFS
Administration Guide> chapter on configuring the Backup System. If using a
value obtained from the B<fms> command, reduce it by 10% to 15% before
recording it in the file.
The appropriate value to record for a tape depends on the size of the
tapes usually used in the device and whether it has a compression mode;
-for suggested values, see the I<IBM AFS Administration Guide> chapter on
+for suggested values, see the I<OpenAFS Administration Guide> chapter on
configuring the Backup System. If using a value obtained from the B<fms>
command, increase it by 10% to 15% before recording it in the file.
The C<A> instruction in a uss template file enhances cell security by
imposing the following restrictions on users' password choice and
authentication attempts. For further information on these limits, see the
-I<IBM AFS Administration Guide> and the B<kas setfields> reference page.
+I<OpenAFS Administration Guide> and the B<kas setfields> reference page.
=over 4
directories under a single parent directory potentially slows directory
lookup, or where a workplace-based division results in unevenly sized
directories such that some users consistently experience slower directory
-lookup than others. See the chapter on B<uss> in the I<IBM AFS
+lookup than others. See the chapter on B<uss> in the I<OpenAFS
Administration Guide> for more information.
Any number of C<G> instructions can appear in the template file. If the
and every file server machine that houses affected volumes. By convention,
a common F<UserList> file is distributed to all database server and file
server machines in the cell. See the chapter on privileged users in the
-I<IBM AFS Administration Guide> for more information on this type of
+I<OpenAFS Administration Guide> for more information on this type of
privilege.
If the B<-localauth> flag is included, the user must instead be logged on
% backup addvolentry -name fs2 -server fs2.abc.com \
-partition /vicepb -volumes ".*"
-The chapter in the I<IBM AFS Administration Guide> about configuring the
+The chapter in the I<OpenAFS Administration Guide> about configuring the
AFS Backup System presents additional examples as well as advice on
grouping volumes.
The database is damaged. You can use the backup savedb command to repair
many kinds of corruption as it creates a backup copy. For more detailed
-instructions, see the I<IBM AFS Administration Guide> chapter about
+instructions, see the I<OpenAFS Administration Guide> chapter about
performing backup operations.
=back
on. If dumps are on multiple incompatible tape types, use the B<backup
volrestore> command to restore individual volumes, or the B<backup
volsetrestore> command after defining groups of volumes that were dumped
-to compatible tape types. For further discussion, see the I<IBM AFS
+to compatible tape types. For further discussion, see the I<OpenAFS
Administration Guide>.
By default, the Backup System restores the contents of the specified
If a dump operation is interrupted or fails for any reason, data from all
volumes written to tape before the interrupt are valid can be used in a
restore operation. The Backup Database includes an entry for the failed
-dump and for each volume that was successfully dumped. See the I<IBM AFS
+dump and for each volume that was successfully dumped. See the I<OpenAFS
Administration Guide> for information on dealing with interrupted dumps.
If dumping to tape rather than a backup data file, it is best to use only
If the database is corrupted, do not attempt to restore a saved database
on top of it. Instead, use the instructions for repairing a corrupted
-database in the I<IBM AFS Administration Guide> chapter about performing
+database in the I<OpenAFS Administration Guide> chapter about performing
backup operations.
=head1 OPTIONS
L<backup_savedb(8)>,
L<butc(8)>
-I<IBM AFS Administration Guide>
+The I<OpenAFS Administration Guide> at
+L<http://docs.openafs.org/AdminGuide/>.
=head1 COPYRIGHT
must apply to all of them. If not, either issue this command separately
for each volume, or use the B<vos volsetrestore> command after defining
groups of volumes that were dumped to compatible tape types. For further
-discussion, see the I<IBM AFS Administration Guide>.
+discussion, see the I<OpenAFS Administration Guide>.
The Tape Coordinator's default response to this command is to access the
first tape it needs by invoking the B<MOUNT> instruction in the local
tape types, use the B<backup volrestore> command to restore individual
volumes, or use this command after defining new volume sets that group
together volumes that were dumped to compatible tape types. For further
-discussion, see the I<IBM AFS Administration Guide>.
+discussion, see the I<OpenAFS Administration Guide>.
By default, the Backup System overwrites the contents of an existing
volume with the restored data. To create a new volume to house the
One way to generate a file for use as input to the B<-file> argument is to
combine the B<-name> and B<-n> options, directing the output to a
-file. The I<IBM AFS Administration Guide> section on using the Backup
+file. The I<OpenAFS Administration Guide> section on using the Backup
System to restore data explains how to edit the file as necessary before
using it as input to the B<-file> argument.
propagate the changes, if it is used), restart the database server
processes on all database server machines to force election of a quorum
that includes the new set of machines listed in the
-F</usr/afs/etc/CellServDB> file. The I<IBM AFS Quick Beginnings> explains
+F</usr/afs/etc/CellServDB> file. The I<OpenAFS Quick Start Guide> explains
in more detail how to add and remove database server machines.
It is best to maintain a one-to-one mapping between hostnames and IP
L<bos_listhosts(8)>,
L<bos_removehost(8)>
-I<IBM AFS Quick Beginnings>
+The I<OpenAFS Quick Start Guide> at
+L<http://docs.openafs.org/QuickStartUnix/>.
=head1 COPYRIGHT
propagate the changes, if it is used), restart the database server
processes on all database server machines to force election of a quorum
that includes the new set of machines listed in the
-F</usr/afs/etc/CellServDB> file. The I<IBM AFS Quick Beginnings> explains
+F</usr/afs/etc/CellServDB> file. The I<OpenAFS Quick Start Guide> explains
in more detail how to add and remove database server machines.
=head1 OPTIONS
L<bos_addhost(8)>,
L<bos_listhosts(8)>
-I<IBM AFS Quick Beginnings>
+The I<OpenAFS Quick Start Guide> at
+L<http://docs.openafs.org/QuickStartUnix/>.
=head1 COPYRIGHT
=head1 CAUTIONS
Running this command can result in data loss if the Salvager process can
-repair corruption only by removing the offending data. Consult the I<IBM
-AFS Administration Guide> for more information.
+repair corruption only by removing the offending data. Consult the
+I<OpenAFS Administration Guide> for more information.
=head1 OPTIONS
L<vos_remove(1)>,
L<vos_zap(1)>
-I<IBM AFS Administration Guide>
+The I<OpenAFS Administration Guide> at
+L<http://docs.openafs.org/AdminGuide/>.
=head1 COPYRIGHT
=head1 CAUTIONS
Issue this command only when the installing the cell's first AFS server
-machine. The I<IBM AFS Quick Beginnings> explains how to copy over the
+machine. The I<OpenAFS Quick Start Guide> explains how to copy over the
F<ThisCell> and F<CellServDB> files from this or another appropriate
machine during installation of additional server machines.
Be sure to choose a satisfactory cell name when issuing this command,
because changing a cell's name is very complicated; for one thing, it
requires changing every password in the Authentication Database. Consult
-the I<IBM AFS Administration Guide> for advice on choosing a cell name.
+the I<OpenAFS Administration Guide> for advice on choosing a cell name.
=head1 OPTIONS
L<UserList(5)>,
L<bos(8)>
-I<IBM AFS Quick Beginnings>
+The I<OpenAFS Quick Start Guide> at
+L<http://docs.openafs.org/QuickStartUnix/>.
-I<IBM AFS Administration Guide>
+The I<OpenAFS Administration Guide> at
+L<http://docs.openafs.org/AdminGuide/>.
=head1 COPYRIGHT
set the device's block size to 0 (zero), indicating variable block
size. Otherwise, tape devices attached to machines running other operating
systems sometimes cannot read tapes written on AIX machines. For
-instructions, see the I<IBM AFS Administration Guide> chapter about
+instructions, see the I<OpenAFS Administration Guide> chapter about
configuring the Backup System.
=head1 OPTIONS
filemark size values that can be specified in a tape device's entry in the
F</usr/afs/backup/tapeconfig> file. For certain types of tape drives, the
Tape Coordinator operates more efficiently when the F<tapeconfig> file
-lists accurate values. For further discussion, see the I<IBM AFS
+lists accurate values. For further discussion, see the I<OpenAFS
Administration Guide> chapter on configuring the Backup System.
Insert a tape in the drive before issuing this command.
with tape devices that handle tapes of multigigabyte (or multiterabyte)
capacity. It does not produce accurate results in those cases. For
alternate suggestions on the values to record in the B<tapeconfig> file
-for compressing drives, see the I<IBM AFS Administration Guide> chapter on
+for compressing drives, see the I<OpenAFS Administration Guide> chapter on
configuring the Backup System.
Running the command completely overwrites the tape, so use a blank one or
ones). If an operation of particular interest occurs, the administrator
can afterward display the log on the standard output stream or write it to
a file for later study. For more specific procedural instructions, see the
-I<IBM AFS Administration Guide>.
+I<OpenAFS Administration Guide>.
There are several categories of commands in the B<fstrace> command suite:
by encrypting a constant with the key. In the case of the C<afs> entry,
this number must match the checksum with the corresponding key version
number in the output of the B<bos listkeys> command; if not, follow the
-instructions in the I<IBM AFS Administration Guide> for creating a new
+instructions in the I<OpenAFS Administration Guide> for creating a new
server encryption key.
=item *
When changing the B<afs> server key, also issue B<bos addkey> command to
add the key (with the same key version number) to the
-F</usr/afs/etc/KeyFile> file. See the I<IBM AFS Administration Guide> for
+F</usr/afs/etc/KeyFile> file. See the I<OpenAFS Administration Guide> for
instructions.
The command interpreter checks the password string subject to the
It is possible that on some operating systems that AFS otherwise supports,
the Authentication Server cannot create the F</usr/afs/logs/AuthLog.dir>
-and F</usr/afs/logs/AuthLog.pag> files, making this command
-inoperative. See the I<IBM AFS Release Notes> for details.
+and F</usr/afs/logs/AuthLog.pag> files, making this command inoperative.
=head1 OPTIONS
=back
-See the chapter on uss in the I<IBM AFS Administration Guide> for further
+See the chapter on uss in the I<OpenAFS Administration Guide> for further
explanation.
=item B<-cell> <I<cell name>>
git://git.openafs.org / openafs.git / commitdiff