From 5f70221b2c9eb08afbbb6e0c43f6c0276cebbcf3 Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Wed, 26 May 2010 12:20:57 -0500 Subject: [PATCH] Remove references to IBM AFS Change references to the documentation sets that we still ship to reference the OpenAFS manuals instead of the IBM AFS manuals. Remove references to the IBM AFS/DFS Migration documentation, since that doesn't appear to be available anywhere any more, replacing them where relevant to more generic references to the DFS documentation. Add links to docs.openafs.org for mentions of the manuals in SEE ALSO, and standardize on one link format. Replace a few references to the IBM AFS Release Notes with the actual information in those notes, or drop the reference if it doesn't seem particularly useful. Change-Id: Ie9666842f1315891c6a9c37c0424200f4b78bff7 Reviewed-on: http://gerrit.openafs.org/2031 Reviewed-by: Derrick Brashear Tested-by: Derrick Brashear --- doc/man-pages/README | 7 ------- doc/man-pages/pod1/afs.pod | 2 +- doc/man-pages/pod1/afsmonitor.pod | 11 +++++++---- doc/man-pages/pod1/fs_copyacl.pod | 6 +----- doc/man-pages/pod1/fs_listacl.pod | 5 +---- doc/man-pages/pod1/fs_mkmount.pod | 4 ++-- doc/man-pages/pod1/fs_newcell.pod | 10 +--------- doc/man-pages/pod1/fs_setacl.pod | 9 +++------ doc/man-pages/pod1/fs_setserverprefs.pod | 7 +++---- doc/man-pages/pod1/fs_sysname.pod | 8 ++++---- doc/man-pages/pod1/livesys.pod | 7 ++++--- doc/man-pages/pod1/pts.pod | 5 ++++- doc/man-pages/pod1/pts_rename.pod | 2 +- doc/man-pages/pod1/scout.pod | 2 +- doc/man-pages/pod1/sys.pod | 11 ++++++----- doc/man-pages/pod1/vos_addsite.pod | 17 +++++++++-------- doc/man-pages/pod5/AuthLog.dir.pod | 2 +- doc/man-pages/pod5/KeyFile.pod | 2 +- doc/man-pages/pod5/NoAuth.pod | 6 +++--- doc/man-pages/pod5/ThisCell.pod | 4 ++-- doc/man-pages/pod5/afsmonitor.pod | 4 ++-- doc/man-pages/pod5/sysid.pod | 4 ++-- doc/man-pages/pod5/tapeconfig.pod | 4 ++-- doc/man-pages/pod5/uss.pod | 4 ++-- doc/man-pages/pod8/backup.pod | 2 +- doc/man-pages/pod8/backup_addvolentry.pod | 2 +- doc/man-pages/pod8/backup_dbverify.pod | 2 +- doc/man-pages/pod8/backup_diskrestore.pod | 2 +- doc/man-pages/pod8/backup_dump.pod | 2 +- doc/man-pages/pod8/backup_restoredb.pod | 5 +++-- doc/man-pages/pod8/backup_volrestore.pod | 2 +- doc/man-pages/pod8/backup_volsetrestore.pod | 4 ++-- doc/man-pages/pod8/bos_addhost.pod | 5 +++-- doc/man-pages/pod8/bos_removehost.pod | 5 +++-- doc/man-pages/pod8/bos_salvage.pod | 7 ++++--- doc/man-pages/pod8/bos_setcellname.pod | 10 ++++++---- doc/man-pages/pod8/butc.pod | 2 +- doc/man-pages/pod8/fms.pod | 4 ++-- doc/man-pages/pod8/fstrace.pod | 2 +- doc/man-pages/pod8/kas_examine.pod | 2 +- doc/man-pages/pod8/kas_setpassword.pod | 2 +- doc/man-pages/pod8/kdb.pod | 3 +-- doc/man-pages/pod8/uss_add.pod | 2 +- 43 files changed, 98 insertions(+), 110 deletions(-) diff --git a/doc/man-pages/README b/doc/man-pages/README index fb1f017d2..dbf7675a9 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -230,16 +230,9 @@ Known Problems 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 diff --git a/doc/man-pages/pod1/afs.pod b/doc/man-pages/pod1/afs.pod index 764366fa1..c991c7822 100644 --- a/doc/man-pages/pod1/afs.pod +++ b/doc/man-pages/pod1/afs.pod @@ -73,7 +73,7 @@ I portion of the command name. The I 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 describes how to use them +detail, and the I 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 diff --git a/doc/man-pages/pod1/afsmonitor.pod b/doc/man-pages/pod1/afsmonitor.pod index 63d02e20a..23d9ed179 100644 --- a/doc/man-pages/pod1/afsmonitor.pod +++ b/doc/man-pages/pod1/afsmonitor.pod @@ -36,7 +36,7 @@ local and foreign cells. There are 271 available File Server statistics and 571 available Cache Manager statistics, listed in the appendix about B statistics -in the I. By default, the command displays +in the I. 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 @@ -115,7 +115,7 @@ interpreted relative to the current working directory. Provide this argument if not providing the B<-fshosts> argument, B<-cmhosts> argument, or neither. For instructions on creating this file, see the preceding B section, and the section on the B program in -the I. +the I. =item B<-frequency> > @@ -131,7 +131,7 @@ frequency plus the time required for all hosts to respond. 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 command in the I command in the I for information on this file. =item B<-detailed> @@ -398,7 +398,7 @@ the B<-detail> flag formats the data in a more easily readable form. =head1 EXAMPLES For examples of commands, display screens, and configuration files, see -the section about the B program in the I program in the I. =head1 PRIVILEGE REQUIRED @@ -411,6 +411,9 @@ L L, L +The I at +L. + =head1 COPYRIGHT IBM Corporation 2000. All Rights Reserved. diff --git a/doc/man-pages/pod1/fs_copyacl.pod b/doc/man-pages/pod1/fs_copyacl.pod index 6228ec2ff..bacf54e50 100644 --- a/doc/man-pages/pod1/fs_copyacl.pod +++ b/doc/man-pages/pod1/fs_copyacl.pod @@ -50,9 +50,7 @@ the source ACL completely replaces the destination ACL. 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. +and B<-todir> arguments. =head1 CAUTIONS @@ -165,8 +163,6 @@ L, L, L -I - =head1 COPYRIGHT IBM Corporation 2000. All Rights Reserved. diff --git a/doc/man-pages/pod1/fs_listacl.pod b/doc/man-pages/pod1/fs_listacl.pod index b1d040fb3..8046f311d 100644 --- a/doc/man-pages/pod1/fs_listacl.pod +++ b/doc/man-pages/pod1/fs_listacl.pod @@ -150,8 +150,7 @@ permission, DFS C (control) replaces AFS C (administer), and there is no DFS equivalent to the AFS C (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. +the DFS documentation. =head1 EXAMPLES @@ -202,8 +201,6 @@ L, L, L -I - =head1 COPYRIGHT IBM Corporation 2000. All Rights Reserved. diff --git a/doc/man-pages/pod1/fs_mkmount.pod b/doc/man-pages/pod1/fs_mkmount.pod index fd74d9b50..8e747c8a4 100644 --- a/doc/man-pages/pod1/fs_mkmount.pod +++ b/doc/man-pages/pod1/fs_mkmount.pod @@ -110,8 +110,8 @@ To create a read/write mount point, include the B<-rw> flag on the B 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 volume just below the AFS filespace root (by convention, -F>). See the I for -instructions and the chapter about volume management in the I>). See the I for +instructions and the chapter about volume management in the I for further discussion. Creating a read/write mount point for a read-only or backup volume is diff --git a/doc/man-pages/pod1/fs_newcell.pod b/doc/man-pages/pod1/fs_newcell.pod index 3c56f5682..44d2ecf45 100644 --- a/doc/man-pages/pod1/fs_newcell.pod +++ b/doc/man-pages/pod1/fs_newcell.pod @@ -41,10 +41,7 @@ the F file and reboot the machine. 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 for more information on -linking AFS clients to DCE cells using this command or by editing the -F file. +purpose of DFS fileset location. =head1 CAUTIONS @@ -105,11 +102,6 @@ The issuer must be logged in as the local superuser root. L, L -I - -I - =head1 COPYRIGHT IBM Corporation 2000. All Rights Reserved. diff --git a/doc/man-pages/pod1/fs_setacl.pod b/doc/man-pages/pod1/fs_setacl.pod index fa0562e1e..17e857484 100644 --- a/doc/man-pages/pod1/fs_setacl.pod +++ b/doc/man-pages/pod1/fs_setacl.pod @@ -28,8 +28,7 @@ the B<-dir> argument. 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, however. For more details, refer to the I. +C, 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; @@ -169,8 +168,8 @@ It is acceptable to mix entries that combine the individual letters with 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. +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> @@ -280,8 +279,6 @@ L, L, L -I - =head1 COPYRIGHT IBM Corporation 2000. All Rights Reserved. diff --git a/doc/man-pages/pod1/fs_setserverprefs.pod b/doc/man-pages/pod1/fs_setserverprefs.pod index 299f840f7..4b06e2bb8 100644 --- a/doc/man-pages/pod1/fs_setserverprefs.pod +++ b/doc/man-pages/pod1/fs_setserverprefs.pod @@ -44,10 +44,9 @@ defaults. 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). 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 diff --git a/doc/man-pages/pod1/fs_sysname.pod b/doc/man-pages/pod1/fs_sysname.pod index b3026a646..47792cda7 100644 --- a/doc/man-pages/pod1/fs_sysname.pod +++ b/doc/man-pages/pod1/fs_sysname.pod @@ -105,11 +105,11 @@ as the local superuser C. L, L -I -L +The I at +L. -I -L +The I +L. For the list of assigned standard sysname values, see L diff --git a/doc/man-pages/pod1/livesys.pod b/doc/man-pages/pod1/livesys.pod index c70e13142..80203dd9f 100644 --- a/doc/man-pages/pod1/livesys.pod +++ b/doc/man-pages/pod1/livesys.pod @@ -18,7 +18,7 @@ The B command displays the string stored in kernel memory that indicates the local machine's CPU/operating system (OS) type, conventionally called the I. The Cache Manager substitutes this string for the I<@sys> variable which can occur in AFS pathnames; the -I and I explain +I and I explain how using I<@sys> can simplify cell configuration. To set a new value in kernel memory, use the B command, which @@ -60,9 +60,10 @@ None L, L -I +The I at L. -I +The I at +L. =head1 COPYRIGHT diff --git a/doc/man-pages/pod1/pts.pod b/doc/man-pages/pod1/pts.pod index e21341202..aa9d1ea38 100644 --- a/doc/man-pages/pod1/pts.pod +++ b/doc/man-pages/pod1/pts.pod @@ -16,7 +16,7 @@ directory. The ACL lists users and groups and specifies which of seven 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 for details.) +the I 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. @@ -209,6 +209,9 @@ L, L, L +The I at +L. + =head1 COPYRIGHT IBM Corporation 2000. All Rights Reserved. diff --git a/doc/man-pages/pod1/pts_rename.pod b/doc/man-pages/pod1/pts_rename.pod index 3d461e818..83ed4b7ed 100644 --- a/doc/man-pages/pod1/pts_rename.pod +++ b/doc/man-pages/pod1/pts_rename.pod @@ -44,7 +44,7 @@ the user's Protection Database entry, including the Authentication 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. +I. =head1 OPTIONS diff --git a/doc/man-pages/pod1/scout.pod b/doc/man-pages/pod1/scout.pod index 43d1dfd9c..e4370e1f2 100644 --- a/doc/man-pages/pod1/scout.pod +++ b/doc/man-pages/pod1/scout.pod @@ -317,7 +317,7 @@ of 60 seconds. =head1 EXAMPLES -See the chapter on monitoring tools in the I, which illustrates the displays that result from different combinations of options. diff --git a/doc/man-pages/pod1/sys.pod b/doc/man-pages/pod1/sys.pod index 7a094dbf1..f9556ee7d 100644 --- a/doc/man-pages/pod1/sys.pod +++ b/doc/man-pages/pod1/sys.pod @@ -18,9 +18,9 @@ The B command displays the string set at compile time that indicates the local machine's CPU/operating system (OS) type, conventionally called the I. 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 -and I explain how using I<@sys> can simplify -cell configuration. +variable which can occur in AFS pathnames; the I and I explain how using I<@sys> can +simplify cell configuration. To set a new value in kernel memory, use the B command. To view the current value set in the kernel, use either B or @@ -60,9 +60,10 @@ None L, L -I +The I at L. -I +The I at +L. =head1 COPYRIGHT diff --git a/doc/man-pages/pod1/vos_addsite.pod b/doc/man-pages/pod1/vos_addsite.pod index 9b98eef6a..5bc39733f 100644 --- a/doc/man-pages/pod1/vos_addsite.pod +++ b/doc/man-pages/pod1/vos_addsite.pod @@ -37,14 +37,15 @@ one. =head1 CAUTIONS -A volume's VLDB entry accommodates a maximum number of site definitions, -as defined in the I. 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. diff --git a/doc/man-pages/pod5/AuthLog.dir.pod b/doc/man-pages/pod5/AuthLog.dir.pod index d618b8657..fe366d61a 100644 --- a/doc/man-pages/pod5/AuthLog.dir.pod +++ b/doc/man-pages/pod5/AuthLog.dir.pod @@ -18,7 +18,7 @@ superuser C. The Authentication Server is possibly unable to create these files on some operating systems that AFS otherwise supports, making the B command -inoperative. See the I for details. +inoperative. =head1 SEE ALSO diff --git a/doc/man-pages/pod5/KeyFile.pod b/doc/man-pages/pod5/KeyFile.pod index 875be0e61..b31f9a086 100644 --- a/doc/man-pages/pod5/KeyFile.pod +++ b/doc/man-pages/pod5/KeyFile.pod @@ -85,7 +85,7 @@ L, L The I at -L. +L. =head1 COPYRIGHT diff --git a/doc/man-pages/pod5/NoAuth.pod b/doc/man-pages/pod5/NoAuth.pod index 94c3346de..de2b988fb 100644 --- a/doc/man-pages/pod5/NoAuth.pod +++ b/doc/man-pages/pod5/NoAuth.pod @@ -17,13 +17,13 @@ there are normally only two circumstances in which the file is present: =item * -During installation of the machine, as instructed in the I. +During installation of the machine, as instructed in the I. =item * During correction of a server encryption key emergency, as discussed in -the I. +the I. =back diff --git a/doc/man-pages/pod5/ThisCell.pod b/doc/man-pages/pod5/ThisCell.pod index 1dc128ca8..1d7e7b91a 100644 --- a/doc/man-pages/pod5/ThisCell.pod +++ b/doc/man-pages/pod5/ThisCell.pod @@ -16,7 +16,7 @@ on every AFS client machine. To change a client machine's cell membership, edit the file and reboot the machine. The file is in ASCII format and contains a character string on a single -line. The I instructs the administrator to +line. The I instructs the administrator to create it during the installation of each client machine. The client machine's cell membership determines three defaults important @@ -78,7 +78,7 @@ every AFS server machine. 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 command during the installation of the cell's first file -server machine, and the I includes instructions +server machine, and the I includes instructions for copying it over to additional server machine during their installation. diff --git a/doc/man-pages/pod5/afsmonitor.pod b/doc/man-pages/pod5/afsmonitor.pod index da00e43f5..fff626352 100644 --- a/doc/man-pages/pod5/afsmonitor.pod +++ b/doc/man-pages/pod5/afsmonitor.pod @@ -77,7 +77,7 @@ line. Specifies which individual statistic, group of statistics, or section of statistics to display on the C screen (C) or C screen (C) and the order in which to display them. The -appendix of B statistics in the I statistics in the I specifies the group and section to which each statistic belongs. Include as many C lines as necessary to customize the screen display as desired, and place them anywhere in the file. The @@ -101,7 +101,7 @@ the line. For a list of the values that can appear in the I field of a C instruction, see the B statistics appendix -to the I. +to the I. =head1 SEE ALSO diff --git a/doc/man-pages/pod5/sysid.pod b/doc/man-pages/pod5/sysid.pod index 0480276e7..7b30431e4 100644 --- a/doc/man-pages/pod5/sysid.pod +++ b/doc/man-pages/pod5/sysid.pod @@ -32,8 +32,8 @@ file server machine to a newly installed one, be sure to remove the F file from the new machine before starting the C trio of processes, which includes the B process. -Some versions of AFS limit how many of a file server machine's interface -addresses that can be registered. Consult the I. +A maximum of 15 file server interface addresses can be registered in the +VLDB. =head1 SEE ALSO diff --git a/doc/man-pages/pod5/tapeconfig.pod b/doc/man-pages/pod5/tapeconfig.pod index 7528ad712..2ece0569b 100644 --- a/doc/man-pages/pod5/tapeconfig.pod +++ b/doc/man-pages/pod5/tapeconfig.pod @@ -46,7 +46,7 @@ The Tape Coordinator uses this capacity value or the one on the Backup 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 chapter on configuring the Backup System. If using a value obtained from the B command, reduce it by 10% to 15% before recording it in the file. @@ -98,7 +98,7 @@ available for actual data. 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 chapter on +for suggested values, see the I chapter on configuring the Backup System. If using a value obtained from the B command, increase it by 10% to 15% before recording it in the file. diff --git a/doc/man-pages/pod5/uss.pod b/doc/man-pages/pod5/uss.pod index 87e7731ff..1e4ee4c82 100644 --- a/doc/man-pages/pod5/uss.pod +++ b/doc/man-pages/pod5/uss.pod @@ -69,7 +69,7 @@ input file C instruction's I field. The C 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 and the B reference page. +I and the B reference page. =over 4 @@ -454,7 +454,7 @@ fashion is useful mainly in very large cells where storing all user home 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 in the I in the I for more information. Any number of C instructions can appear in the template file. If the diff --git a/doc/man-pages/pod8/backup.pod b/doc/man-pages/pod8/backup.pod index 4cb65af1d..3f62b25b7 100644 --- a/doc/man-pages/pod8/backup.pod +++ b/doc/man-pages/pod8/backup.pod @@ -260,7 +260,7 @@ on every Backup Server machine, every Volume Location (VL) Server machine, and every file server machine that houses affected volumes. By convention, a common F file is distributed to all database server and file server machines in the cell. See the chapter on privileged users in the -I for more information on this type of +I for more information on this type of privilege. If the B<-localauth> flag is included, the user must instead be logged on diff --git a/doc/man-pages/pod8/backup_addvolentry.pod b/doc/man-pages/pod8/backup_addvolentry.pod index 7373d6b60..c62ebed75 100644 --- a/doc/man-pages/pod8/backup_addvolentry.pod +++ b/doc/man-pages/pod8/backup_addvolentry.pod @@ -172,7 +172,7 @@ shown here on two lines only for legibility reasons.) % backup addvolentry -name fs2 -server fs2.abc.com \ -partition /vicepb -volumes ".*" -The chapter in the I about configuring the +The chapter in the I about configuring the AFS Backup System presents additional examples as well as advice on grouping volumes. diff --git a/doc/man-pages/pod8/backup_dbverify.pod b/doc/man-pages/pod8/backup_dbverify.pod index 1592a23c1..ce76747b3 100644 --- a/doc/man-pages/pod8/backup_dbverify.pod +++ b/doc/man-pages/pod8/backup_dbverify.pod @@ -76,7 +76,7 @@ The database is undamaged and can be used. 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 chapter about +instructions, see the I chapter about performing backup operations. =back diff --git a/doc/man-pages/pod8/backup_diskrestore.pod b/doc/man-pages/pod8/backup_diskrestore.pod index 27f5336a6..e20f68270 100644 --- a/doc/man-pages/pod8/backup_diskrestore.pod +++ b/doc/man-pages/pod8/backup_diskrestore.pod @@ -66,7 +66,7 @@ dumps to a type of tape the second Tape Coordinator can read, and so on. If dumps are on multiple incompatible tape types, use the B command to restore individual volumes, or the B command after defining groups of volumes that were dumped -to compatible tape types. For further discussion, see the I. By default, the Backup System restores the contents of the specified diff --git a/doc/man-pages/pod8/backup_dump.pod b/doc/man-pages/pod8/backup_dump.pod index b64ebc927..94a615bde 100644 --- a/doc/man-pages/pod8/backup_dump.pod +++ b/doc/man-pages/pod8/backup_dump.pod @@ -297,7 +297,7 @@ arrange to provide them. 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 for information on dealing with interrupted dumps. If dumping to tape rather than a backup data file, it is best to use only diff --git a/doc/man-pages/pod8/backup_restoredb.pod b/doc/man-pages/pod8/backup_restoredb.pod index 6ab75ef59..093f9130e 100644 --- a/doc/man-pages/pod8/backup_restoredb.pod +++ b/doc/man-pages/pod8/backup_restoredb.pod @@ -61,7 +61,7 @@ provide them. 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 chapter about performing +database in the I chapter about performing backup operations. =head1 OPTIONS @@ -115,7 +115,8 @@ L, L, L -I +The I at +L. =head1 COPYRIGHT diff --git a/doc/man-pages/pod8/backup_volrestore.pod b/doc/man-pages/pod8/backup_volrestore.pod index 8aecafac3..19e88b633 100644 --- a/doc/man-pages/pod8/backup_volrestore.pod +++ b/doc/man-pages/pod8/backup_volrestore.pod @@ -139,7 +139,7 @@ on). If restoring multiple volumes, the same ordered list of port offsets must apply to all of them. If not, either issue this command separately for each volume, or use the B command after defining groups of volumes that were dumped to compatible tape types. For further -discussion, see the I. +discussion, see the I. The Tape Coordinator's default response to this command is to access the first tape it needs by invoking the B instruction in the local diff --git a/doc/man-pages/pod8/backup_volsetrestore.pod b/doc/man-pages/pod8/backup_volsetrestore.pod index 0dcc2421f..24e864056 100644 --- a/doc/man-pages/pod8/backup_volsetrestore.pod +++ b/doc/man-pages/pod8/backup_volsetrestore.pod @@ -102,7 +102,7 @@ Coordinator can read, and so on. If dumps are on multiple incompatible tape types, use the B 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. +discussion, see the I. By default, the Backup System overwrites the contents of an existing volume with the restored data. To create a new volume to house the @@ -341,7 +341,7 @@ The date and time when the volume was dumped. 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 section on using the Backup +file. The I 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. diff --git a/doc/man-pages/pod8/bos_addhost.pod b/doc/man-pages/pod8/bos_addhost.pod index 00c540ce9..d2751823f 100644 --- a/doc/man-pages/pod8/bos_addhost.pod +++ b/doc/man-pages/pod8/bos_addhost.pod @@ -28,7 +28,7 @@ After executing this command (and waiting for the Update Server to 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 file. The I explains +F file. The I 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 @@ -112,7 +112,8 @@ L, L, L -I +The I at +L. =head1 COPYRIGHT diff --git a/doc/man-pages/pod8/bos_removehost.pod b/doc/man-pages/pod8/bos_removehost.pod index eb1410d53..a26bd0f41 100644 --- a/doc/man-pages/pod8/bos_removehost.pod +++ b/doc/man-pages/pod8/bos_removehost.pod @@ -29,7 +29,7 @@ After executing this command (and waiting for the Update Server to 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 file. The I explains +F file. The I explains in more detail how to add and remove database server machines. =head1 OPTIONS @@ -103,7 +103,8 @@ L, L, L -I +The I at +L. =head1 COPYRIGHT diff --git a/doc/man-pages/pod8/bos_salvage.pod b/doc/man-pages/pod8/bos_salvage.pod index c9ae4e85f..4b73c5dee 100644 --- a/doc/man-pages/pod8/bos_salvage.pod +++ b/doc/man-pages/pod8/bos_salvage.pod @@ -139,8 +139,8 @@ partition, but do not count against the volume's quota. =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 for more information. +repair corruption only by removing the offending data. Consult the +I for more information. =head1 OPTIONS @@ -349,7 +349,8 @@ L, L, L -I +The I at +L. =head1 COPYRIGHT diff --git a/doc/man-pages/pod8/bos_setcellname.pod b/doc/man-pages/pod8/bos_setcellname.pod index 6d1faefdd..3591dc1e8 100644 --- a/doc/man-pages/pod8/bos_setcellname.pod +++ b/doc/man-pages/pod8/bos_setcellname.pod @@ -42,14 +42,14 @@ machine is thus designated as the cell's first database server machine. =head1 CAUTIONS Issue this command only when the installing the cell's first AFS server -machine. The I explains how to copy over the +machine. The I explains how to copy over the F and F 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 for advice on choosing a cell name. +the I for advice on choosing a cell name. =head1 OPTIONS @@ -121,9 +121,11 @@ L, L, L -I +The I at +L. -I +The I at +L. =head1 COPYRIGHT diff --git a/doc/man-pages/pod8/butc.pod b/doc/man-pages/pod8/butc.pod index 86b04a048..84efbf36c 100644 --- a/doc/man-pages/pod8/butc.pod +++ b/doc/man-pages/pod8/butc.pod @@ -116,7 +116,7 @@ If the Tape Coordinator machine is an AIX machine, use the SMIT utility to 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 chapter about +instructions, see the I chapter about configuring the Backup System. =head1 OPTIONS diff --git a/doc/man-pages/pod8/fms.pod b/doc/man-pages/pod8/fms.pod index 167c90b23..668deb529 100644 --- a/doc/man-pages/pod8/fms.pod +++ b/doc/man-pages/pod8/fms.pod @@ -32,7 +32,7 @@ The intended use of this command is to determine tape capacity and filemark size values that can be specified in a tape device's entry in the F file. For certain types of tape drives, the Tape Coordinator operates more efficiently when the F file -lists accurate values. For further discussion, see the I chapter on configuring the Backup System. Insert a tape in the drive before issuing this command. @@ -43,7 +43,7 @@ Do not use this command on compressing tape devices in compression mode or 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 file -for compressing drives, see the I chapter on +for compressing drives, see the I chapter on configuring the Backup System. Running the command completely overwrites the tape, so use a blank one or diff --git a/doc/man-pages/pod8/fstrace.pod b/doc/man-pages/pod8/fstrace.pod index 55459e2ce..a655fe4fa 100644 --- a/doc/man-pages/pod8/fstrace.pod +++ b/doc/man-pages/pod8/fstrace.pod @@ -18,7 +18,7 @@ overwritten in a circular fashion (new trace messages overwrite the oldest 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. +I. There are several categories of commands in the B command suite: diff --git a/doc/man-pages/pod8/kas_examine.pod b/doc/man-pages/pod8/kas_examine.pod index ea62738c4..abc772857 100644 --- a/doc/man-pages/pod8/kas_examine.pod +++ b/doc/man-pages/pod8/kas_examine.pod @@ -137,7 +137,7 @@ B<-showkey> flag is not included. The checksum is a decimal number derived by encrypting a constant with the key. In the case of the C entry, this number must match the checksum with the corresponding key version number in the output of the B command; if not, follow the -instructions in the I for creating a new +instructions in the I for creating a new server encryption key. =item * diff --git a/doc/man-pages/pod8/kas_setpassword.pod b/doc/man-pages/pod8/kas_setpassword.pod index 62839d112..8052b7b38 100644 --- a/doc/man-pages/pod8/kas_setpassword.pod +++ b/doc/man-pages/pod8/kas_setpassword.pod @@ -49,7 +49,7 @@ echo the password visibly. When changing the B server key, also issue B command to add the key (with the same key version number) to the -F file. See the I for +F file. See the I for instructions. The command interpreter checks the password string subject to the diff --git a/doc/man-pages/pod8/kdb.pod b/doc/man-pages/pod8/kdb.pod index 2ce846ac9..ca039cf26 100644 --- a/doc/man-pages/pod8/kdb.pod +++ b/doc/man-pages/pod8/kdb.pod @@ -26,8 +26,7 @@ information on privileged actions performed by the Authentication Server. It is possible that on some operating systems that AFS otherwise supports, the Authentication Server cannot create the F -and F files, making this command -inoperative. See the I for details. +and F files, making this command inoperative. =head1 OPTIONS diff --git a/doc/man-pages/pod8/uss_add.pod b/doc/man-pages/pod8/uss_add.pod index 0724f9591..b9027d8de 100644 --- a/doc/man-pages/pod8/uss_add.pod +++ b/doc/man-pages/pod8/uss_add.pod @@ -238,7 +238,7 @@ variable. =back -See the chapter on uss in the I for further +See the chapter on uss in the I for further explanation. =item B<-cell> > -- 2.39.5