doc: fix some broken link specifications
authorChas Williams (CONTRACTOR) <chas@cmf.nrl.navy.mil>
Fri, 10 Jun 2011 01:14:05 +0000 (21:14 -0400)
committerJeffrey Altman <jaltman@openafs.org>
Wed, 22 Jun 2011 18:01:09 +0000 (11:01 -0700)
"local" links to section heads inside the same pod page should be written
L</OPTIONS> instead of L<OPTIONS>.  the other broken links are assorted
typos and capitalization changes.

Change-Id: I18b57a81d984501309e96dcd4c04582e744a6db2
Reviewed-on: http://gerrit.openafs.org/4831
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Derrick Brashear <shadow@dementia.org>
Reviewed-by: Ken Dreyer <kdreyer@usgs.gov>
Reviewed-by: Jeffrey Altman <jaltman@openafs.org>

25 files changed:
doc/man-pages/pod1/fs.pod
doc/man-pages/pod1/fs_mkmount.pod
doc/man-pages/pod1/fs_setacl.pod
doc/man-pages/pod1/fs_storebehind.pod
doc/man-pages/pod1/klog.krb5.pod
doc/man-pages/pod1/klog.pod
doc/man-pages/pod1/pagsh.pod
doc/man-pages/pod1/pts_setfields.pod.in
doc/man-pages/pod1/rxdebug.pod
doc/man-pages/pod1/scout.pod
doc/man-pages/pod1/vos_zap.pod.in
doc/man-pages/pod5/butc.pod
doc/man-pages/pod8/afsd.pod
doc/man-pages/pod8/backup_addvolentry.pod
doc/man-pages/pod8/backup_kill.pod
doc/man-pages/pod8/backup_labeltape.pod
doc/man-pages/pod8/backup_volsetrestore.pod
doc/man-pages/pod8/bos_create.pod
doc/man-pages/pod8/bos_salvage.pod
doc/man-pages/pod8/kadb_check.pod
doc/man-pages/pod8/kpwvalid.pod
doc/man-pages/pod8/prdb_check.pod
doc/man-pages/pod8/salvageserver.pod
doc/man-pages/pod8/vldb_check.pod
doc/man-pages/pod8/volinfo.pod

index 0a4dd14..654faf3 100644 (file)
@@ -227,7 +227,7 @@ L<fs_rxstatpeer(1)>,
 L<fs_rxstatproc(1)>,
 L<fs_setacl(1)>,
 L<fs_setcachesize(1)>,
-L<fs_setcbattr(1)>,
+L<fs_setcbaddr(1)>,
 L<fs_setcell(1)>,
 L<fs_setclientaddrs(1)>,
 L<fs_setcrypt(1)>,
index 71eb5cb..7f4a6a7 100644 (file)
@@ -161,7 +161,7 @@ results from attempting to create a new mount point in a read-only
 volume. By convention, the read/write path is indicated by placing a
 period before the cell name at the pathname's second level (for example,
 F</afs/.abc.com>). For further discussion of the concept of read/write and
-read-only paths through the filespace, see L<DESCRIPTION>.
+read-only paths through the filespace, see L</DESCRIPTION>.
 
 =item B<-vol> <I<volume name>>
 
index fea5a5a..6c23977 100644 (file)
@@ -173,7 +173,7 @@ within an individual pairing of user or group and permissions.
 Granting the C<l> (lookup) and C<i> (insert) permissions without
 granting the C<w> (write) and/or C<r> (read) permissions is a special
 case, and grants rights approrpriate for "dropbox" directories. See the
-L<DROPBOXES> section for details.
+L</DROPBOXES> section for details.
 
 If setting ACLs on a pathname in DFS filespace, see the DFS documentation
 for the proper format and acceptable values for DFS ACL entries.
index 70e8041..a2eddf9 100644 (file)
@@ -30,7 +30,7 @@ Server. This command specifies the number of kilobytes of a file that can
 still remain to be written to the File Server when the Cache Manager
 returns control to the application. It is useful if users working on the
 machine commonly work with very large files, but also introduces the
-complications discussed in the L<CAUTIONS>.
+complications discussed in the L</CAUTIONS>.
 
 Set either or both of the following in a single command:
 
@@ -81,7 +81,7 @@ asynchrony once another value has been set for the file.
 
 To display the settings that currently apply to individual files or to all
 files, provide the command's arguments in certain combinations as
-specified in L<OUTPUT>.
+specified in L</OUTPUT>.
 
 =head1 CAUTIONS
 
index 96c88eb..82f85db 100644 (file)
@@ -247,7 +247,7 @@ The path to the cache will vary, of course.
 
 Most often, this command is issued without arguments. The appropriate
 password is for the person currently logged into the local system.  The
-ticket's lifetime is calculated as described in L<DESCRIPTION>.
+ticket's lifetime is calculated as described in L</DESCRIPTION>.
 
    % klog.krb5
    Password for user@EXAMPLE.ORG:
index 3dbdc72..175c8da 100644 (file)
@@ -285,7 +285,7 @@ encountered.
 Requests a specific lifetime for the token. Provide a number of hours and
 optionally minutes and seconds in the format I<hh>[B<:>I<mm>[B<:>I<ss>]].
 The value is used in calculating the token lifetime as described in
-L<DESCRIPTION>.
+L</DESCRIPTION>.
 
 =item B<-setpag>
 
@@ -325,7 +325,7 @@ Kerberos-style ticket file was created:
 
 Most often, this command is issued without arguments. The appropriate
 password is for the person currently logged into the local system. The
-ticket's lifetime is calculated as described in L<DESCRIPTION> (if no
+ticket's lifetime is calculated as described in L</DESCRIPTION> (if no
 defaults have been changed, it is 25 hours for a user whose Authentication
 Database entry was created in AFS 3.1 or later).
 
@@ -341,7 +341,7 @@ Corporation's test cell:
 In the following, the issuer requests a ticket lifetime of 104 hours 30
 minutes (4 days 8 hours 30 minutes). Presuming that this lifetime is
 allowed by the maximum ticket lifetimes and other factors described in
-L<DESCRIPTION>, the token's lifetime is 110:44:28, which is the next
+L</DESCRIPTION>, the token's lifetime is 110:44:28, which is the next
 largest possible value.
 
    % klog -lifetime 104:30
index 6ab0da2..4f72d3c 100644 (file)
@@ -70,7 +70,7 @@ to obtain a PAG before issuing the B<klog> command (or include the
 B<-setpag> argument to the B<klog> command). If a PAG is not acquired, the
 Cache Manager stores the token in a credential structure identified by
 local UID rather than PAG. This creates the potential security exposure
-described in L<DESCRIPTION>.
+described in L</DESCRIPTION>.
 
 If users of NFS client machines for which AFS is supported are to issue
 this command as part of authenticating with AFS, do not use the B<fs
index 398c40b..b6c9d19 100644 (file)
@@ -37,7 +37,7 @@ recommended. The concept is meaningless for machines and groups, because
 it is impossible to authenticate as a group or machine.
 
 Similarly, some privacy flag settings do not have a sensible
-interpretation. L<OPTIONS> specifies the appropriate settings.
+interpretation. L</OPTIONS> specifies the appropriate settings.
 
 =head1 OPTIONS
 
index df992dc..13c4346 100644 (file)
@@ -179,7 +179,7 @@ written to the standard output stream begins with basic statistics about
 packet usage and availability, how many calls are waiting for a thread,
 how many threads are free, and so on (this is the only information
 provided by the B<-noconns> flag). Adding other options produces
-additional information as described in L<OPTIONS>. The output is intended
+additional information as described in L</OPTIONS>. The output is intended
 for debugging purposes and is meaningful to someone familiar with the
 implementation of Rx.
 
index e4370e1..baf7522 100644 (file)
@@ -28,7 +28,7 @@ B<scout> [B<i>] S<<< B<-s> <I<servers to monitor>>+ >>>
 
 The scout command displays statistics gathered from the File Server
 process running on each machine specified with the B<-server>
-argument. L<OUTPUT> explains the meaning of the statistics and describes
+argument. L</OUTPUT> explains the meaning of the statistics and describes
 how they appear in the command shell, which is preferably a window managed
 by a window manager program.
 
index b3f3517..5291c31 100644 (file)
@@ -36,7 +36,7 @@ The B<-force> flag removes a volume even if it cannot be "attached"
 (brought online), which can happen either because the volume is extremely
 damaged or because the Salvager functioned abnormally. Without this flag,
 this command cannot remove volumes that are not attachable. See also
-L<CAUTIONS>.
+L</CAUTIONS>.
 
 To remove the specified read/write volume's backup version at the same
 time, include the B<-backup> flag.
index c3f513d..c1f7696 100644 (file)
@@ -304,7 +304,7 @@ shell script or program that directs an automated tape device, such as a
 jukebox or stacker, to mount a tape (insert it into the tape reader).  The
 operator must write the routine to invoke the mount command specified by
 the device's manufacturer; AFS does not include any scripts, although an
-example appears in L<EXAMPLES>.  The script or program inherits the Tape
+example appears in L</EXAMPLES>.  The script or program inherits the Tape
 Coordinator's AFS authentication status.
 
 When the Tape Coordinator needs to mount a tape, it checks the
@@ -463,7 +463,7 @@ shell script or program that directs an automated tape device, such as a
 jukebox or stacker, to unmount a tape (remove it from the tape reader).
 The operator must write the routine to invoke the unmount command
 specified by the device's manufacturer; AFS does not include any scripts,
-although an example appears in L<EXAMPLES>.  The script or program
+although an example appears in L</EXAMPLES>.  The script or program
 inherits the Tape Coordinator's AFS authentication status.
 
 After closing a tape device, the Tape Coordinator checks the configuration
@@ -512,7 +512,7 @@ has port offset 0.
 
 The administrator includes the following five lines in the
 F</usr/afs/backup/CFG_stacker0.1> file. To review the meaning of each
-instruction, see L<DESCRIPTION>.
+instruction, see L</DESCRIPTION>.
 
    MOUNT /usr/afs/backup/stacker0.1
    UNMOUNT /usr/afs/backup/stacker0.1
@@ -590,7 +590,7 @@ file. It has port offset 20.
 
 The administrator includes the following lines in the
 F</usr/afs/backup/CFG_HSM_device> file. To review the meaning of each
-instruction, see L<DESCRIPTION>.
+instruction, see L</DESCRIPTION>.
 
    MOUNT /usr/afs/backup/file
    FILE YES
index 9d76326..ef5c930 100644 (file)
@@ -184,7 +184,7 @@ for a memory cache is 8 KB.
 
 To override the default chunk size for either type of cache, use the
 B<-chunksize> argument to provide an integer to be used as an exponent of
-two; see L<OPTIONS> for details. For a memory cache, if total cache size
+two; see L</OPTIONS> for details. For a memory cache, if total cache size
 divided by chunk size leaves a remainder, the B<afsd> program rounds down
 the number of dcache entries, resulting in a slightly smaller cache.
 
@@ -584,7 +584,7 @@ the Finder program doesn't hang when browsing AFS directories.
 
 Specifies the number of F<VI<n>> files to create in the cache directory
 for a disk cache, overriding the default that is calculated as described
-in L<DESCRIPTION>. Each F<VI<n>> file accommodates a chunk of data, and
+in L</DESCRIPTION>. Each F<VI<n>> file accommodates a chunk of data, and
 can grow to a maximum size of 64 KB by default. Do not combine this
 argument with the B<-memcache> argument.
 
index c62ebed..ebb4d5f 100644 (file)
@@ -46,7 +46,7 @@ machine name or partition name in the Volume Location Database (VLDB).
 
 For the B<-volumes> argument, specify a combination of alphanumeric
 characters and one or more metacharacters to wildcard part or all of the
-volume name. L<OPTIONS> lists the acceptable metacharacters.
+volume name. L</OPTIONS> lists the acceptable metacharacters.
 
 =head1 CAUTIONS
 
index d3f4e95..dc3dc9c 100644 (file)
@@ -85,7 +85,7 @@ multiple tapes. If the termination signal comes before the Backup System
 has accessed all of the necessary tapes, each volume is only partially
 written and is never brought online. It is best to restart the restore
 operation from scratch to avoid possible inconsistencies. See also
-L<CAUTIONS>.
+L</CAUTIONS>.
 
 =back
 
index 57e3ed4..2bbca67 100644 (file)
@@ -62,7 +62,7 @@ output from B<backup> commands. The permanent name appears in the C<tape
 name> field of the output from the B<backup readlabel> command.
 
 To write an AFS tape name on the label, provide a value for the B<-name>
-argument in the required format described in L<OPTIONS>.  Include the
+argument in the required format described in L</OPTIONS>.  Include the
 B<-name> argument or the B<-pname> argument, but not both. If this
 argument is omitted, the AFS tape name is set to C<< <NULL> >>, but the
 Backup System automatically assigns the appropriate name when the tape is
index 24e8640..7771137 100644 (file)
@@ -114,7 +114,7 @@ specified extension also already exists, the command overwrites it.
 
 The B<-n> flag produces a list of the volumes to be restored if the B<-n>
 flag were not included, without actually restoring any volumes. See
-L<OUTPUT> for a detailed description of the output, and suggestions on how
+L</OUTPUT> for a detailed description of the output, and suggestions on how
 to combine it most effectively with the B<-file> and B<-name> arguments.
 
 The execution time for a B<backup volsetrestore> command depends on the
@@ -227,7 +227,7 @@ explicitly in the appropriate order.
 =item B<-n>
 
 Displays a list of the volumes to be restored if the flag were not
-included, without actually restoring them. L<OUTPUT> details the format of
+included, without actually restoring them. L</OUTPUT> details the format of
 the output. When combined with the B<-name> argument, its output is easily
 edited for use as input to the B<-file> argument on a subsequent B<backup
 volsetrestore> command.
index bf4dcac..88c2d54 100644 (file)
@@ -38,7 +38,7 @@ a demand-attach File Server, and a server process entry of type B<dafs>
 for a demand-attach File Server will not work with a traditional File
 Server. When switching from one File Server implementation to another,
 remove the existing server process entry and create a new one. See
-L<EXAMPLES> below for an example of switching from a traditional File
+L</EXAMPLES> below for an example of switching from a traditional File
 Server to a demand-attach File Server.
 
 =head1 OPTIONS
@@ -230,7 +230,7 @@ format as when specifying the time alone.
 Specifies the complete pathname on the local disk of a program that the
 BOS Server invokes when the process terminates. The AFS distribution does
 not include any notifier programs, but this argument is available for
-administrator use. See L<NOTES>.
+administrator use. See L</NOTES>.
 
 =item B<-cell> <I<cell name>>
 
index 4b73c5d..a598188 100644 (file)
@@ -343,7 +343,7 @@ L<SalvageLog(5)>,
 L<UserList(5)>,
 L<bos(8)>,
 L<salvager(8)>,
-L<salvagserver(8)>,
+L<salvageserver(8)>,
 L<vos_backup(1)>,
 L<vos_release(1)>,
 L<vos_remove(1)>,
index f0af119..95a85f8 100644 (file)
@@ -85,7 +85,7 @@ ignored.
 If there are errors in the database, the output always reports them on the
 standard error stream. If any options other than B<-database> or B<-help>
 are provided, the output written to the standard output stream includes
-additional information as described for each option in L<OPTIONS>.  The
+additional information as described for each option in L</OPTIONS>.  The
 output is intended for debugging purposes and is meaningful to someone
 familiar with the internal structure of the Authentication Database.
 
index 7ee468e..0cd059b 100644 (file)
@@ -26,7 +26,7 @@ B<kpwvalid> binary.
 
 The AFS distribution includes an example B<kpwvalid> program that checks
 that the password is at least eight characters long; the code for it
-appears in L<EXAMPLES> below.
+appears in L</EXAMPLES> below.
 
 The script or program must accept a sequence of password strings, one per
 line, on the standard input stream. The first is the current password and
index dff97f5..7716845 100644 (file)
@@ -71,7 +71,7 @@ ignored.
 If there are errors in the database, the output always reports them on the
 standard error stream. If any options other than B<-database> or B<-help>
 are provided, the output written to the standard output stream includes
-additional information as described for each option in L<OPTIONS>.  The
+additional information as described for each option in L</OPTIONS>.  The
 output is intended for debugging purposes and is meaningful to someone
 familiar with the internal structure of the Protection Database.
 
index b48a491..a93a33e 100644 (file)
@@ -313,7 +313,7 @@ the local superuser C<root>.
 
 L<BosConfig(5)>,
 L<SalvageLog(5)>,
-L<Salvager(8)>,
+L<salvager(8)>,
 L<bos_create(8)>,
 L<bos_getlog(8)>,
 L<bos_salvage(8)>,
index 3204428..e5d76a9 100644 (file)
@@ -82,7 +82,7 @@ ignored.
 If there are errors in the database, the output always reports them on the
 standard error stream. If any options other than B<-database> or B<-help>
 are provided, the output written to the standard output stream includes
-additional information as described for each option in L<OPTIONS>.  The
+additional information as described for each option in L</OPTIONS>.  The
 output is intended for debugging purposes and is meaningful to someone
 familiar with the internal structure of the VLDB.
 
index 2d57564..d4c0e38 100644 (file)
@@ -118,7 +118,7 @@ ignored.
 
 By default, the command produces several line of statistics for each
 volume. Adding other options produces or substitutes additional
-information as described in L<OPTIONS>.  The output is intended for
+information as described in L</OPTIONS>.  The output is intended for
 debugging purposes and is meaningful to someone familiar with the internal
 structure of volume headers.