From: Chas Williams (CONTRACTOR) Date: Fri, 10 Jun 2011 01:14:05 +0000 (-0400) Subject: doc: fix some broken link specifications X-Git-Tag: upstream/1.6.18^2~14 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=18e761bdea76db32130e20598b8e3b310cf390c4;p=packages%2Fo%2Fopenafs.git doc: fix some broken link specifications "local" links to section heads inside the same pod page should be written L instead of L. the other broken links are assorted typos and capitalization changes. Reviewed-on: http://gerrit.openafs.org/4831 Tested-by: BuildBot Reviewed-by: Derrick Brashear Reviewed-by: Ken Dreyer Reviewed-by: Jeffrey Altman (cherry picked from commit 6770c6c411f2766471b4dc07bd7c66794f95ba63) Change-Id: Id53b3ad6c2f8e0ec00fabf733b2b2052495b3f27 Reviewed-on: https://gerrit.openafs.org/11675 Reviewed-by: Chas Williams <3chas3@gmail.com> Reviewed-by: Michael Meffie Tested-by: BuildBot Reviewed-by: Stephan Wiesand --- diff --git a/doc/man-pages/pod1/fs.pod b/doc/man-pages/pod1/fs.pod index 636479661..2ffe3ba88 100644 --- a/doc/man-pages/pod1/fs.pod +++ b/doc/man-pages/pod1/fs.pod @@ -232,7 +232,7 @@ L, L, L, L, -L, +L, L, L, L, diff --git a/doc/man-pages/pod1/fs_mkmount.pod b/doc/man-pages/pod1/fs_mkmount.pod index 71eb5cbc1..7f4a6a7c1 100644 --- a/doc/man-pages/pod1/fs_mkmount.pod +++ b/doc/man-pages/pod1/fs_mkmount.pod @@ -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). For further discussion of the concept of read/write and -read-only paths through the filespace, see L. +read-only paths through the filespace, see L. =item B<-vol> > diff --git a/doc/man-pages/pod1/fs_setacl.pod b/doc/man-pages/pod1/fs_setacl.pod index 9eac2acad..cc9792dfb 100644 --- a/doc/man-pages/pod1/fs_setacl.pod +++ b/doc/man-pages/pod1/fs_setacl.pod @@ -171,7 +171,7 @@ within an individual pairing of user or group and permissions. Granting the C (lookup) and C (insert) permissions without granting the C (write) and/or C (read) permissions is a special case, and grants rights approrpriate for "dropbox" directories. See the -L section for details. +L 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. diff --git a/doc/man-pages/pod1/fs_storebehind.pod b/doc/man-pages/pod1/fs_storebehind.pod index 70e804166..a2eddf9fd 100644 --- a/doc/man-pages/pod1/fs_storebehind.pod +++ b/doc/man-pages/pod1/fs_storebehind.pod @@ -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. +complications discussed in the L. 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. +specified in L. =head1 CAUTIONS diff --git a/doc/man-pages/pod1/klog.krb5.pod b/doc/man-pages/pod1/klog.krb5.pod index 96c88eb21..82f85dbc8 100644 --- a/doc/man-pages/pod1/klog.krb5.pod +++ b/doc/man-pages/pod1/klog.krb5.pod @@ -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. +ticket's lifetime is calculated as described in L. % klog.krb5 Password for user@EXAMPLE.ORG: diff --git a/doc/man-pages/pod1/klog.pod b/doc/man-pages/pod1/klog.pod index 6b6472462..02e2b7c56 100644 --- a/doc/man-pages/pod1/klog.pod +++ b/doc/man-pages/pod1/klog.pod @@ -281,7 +281,7 @@ encountered. Requests a specific lifetime for the token. Provide a number of hours and optionally minutes and seconds in the format I[B<:>I[B<:>I]]. The value is used in calculating the token lifetime as described in -L. +L. =item B<-setpag> @@ -321,7 +321,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 (if no +ticket's lifetime is calculated as described in L (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). @@ -337,7 +337,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, the token's lifetime is 110:44:28, which is the next +L, the token's lifetime is 110:44:28, which is the next largest possible value. % klog -lifetime 104:30 diff --git a/doc/man-pages/pod1/pagsh.pod b/doc/man-pages/pod1/pagsh.pod index 6ab0da2ff..4f72d3c74 100644 --- a/doc/man-pages/pod1/pagsh.pod +++ b/doc/man-pages/pod1/pagsh.pod @@ -70,7 +70,7 @@ to obtain a PAG before issuing the B command (or include the B<-setpag> argument to the B 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. +described in L. 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 specifies the appropriate settings. +interpretation. L specifies the appropriate settings. =head1 OPTIONS diff --git a/doc/man-pages/pod1/rxdebug.pod b/doc/man-pages/pod1/rxdebug.pod index df992dcc2..13c4346db 100644 --- a/doc/man-pages/pod1/rxdebug.pod +++ b/doc/man-pages/pod1/rxdebug.pod @@ -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. The output is intended +additional information as described in L. The output is intended for debugging purposes and is meaningful to someone familiar with the implementation of Rx. diff --git a/doc/man-pages/pod1/scout.pod b/doc/man-pages/pod1/scout.pod index 6e27f6cbb..6e9296e84 100644 --- a/doc/man-pages/pod1/scout.pod +++ b/doc/man-pages/pod1/scout.pod @@ -28,7 +28,7 @@ B [B] S<<< B<-s> >+ >>> The scout command displays statistics gathered from the File Server process running on each machine specified with the B<-server> -argument. L explains the meaning of the statistics and describes +argument. L 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. diff --git a/doc/man-pages/pod1/vos_zap.pod.in b/doc/man-pages/pod1/vos_zap.pod.in index b3f351716..5291c316f 100644 --- a/doc/man-pages/pod1/vos_zap.pod.in +++ b/doc/man-pages/pod1/vos_zap.pod.in @@ -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. +L. To remove the specified read/write volume's backup version at the same time, include the B<-backup> flag. diff --git a/doc/man-pages/pod5/butc.pod b/doc/man-pages/pod5/butc.pod index c3f513da6..c1f769675 100644 --- a/doc/man-pages/pod5/butc.pod +++ b/doc/man-pages/pod5/butc.pod @@ -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. The script or program inherits the Tape +example appears in L. 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. The script or program +although an example appears in L. 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 file. To review the meaning of each -instruction, see L. +instruction, see L. 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 file. To review the meaning of each -instruction, see L. +instruction, see L. MOUNT /usr/afs/backup/file FILE YES diff --git a/doc/man-pages/pod8/afsd.pod b/doc/man-pages/pod8/afsd.pod index 4add789c6..062e38b0a 100644 --- a/doc/man-pages/pod8/afsd.pod +++ b/doc/man-pages/pod8/afsd.pod @@ -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 for details. For a memory cache, if total cache size +two; see L for details. For a memory cache, if total cache size divided by chunk size leaves a remainder, the B program rounds down the number of dcache entries, resulting in a slightly smaller cache. @@ -585,7 +585,7 @@ the Finder program doesn't hang when browsing AFS directories. Specifies the number of F> files to create in the cache directory for a disk cache, overriding the default that is calculated as described -in L. Each F> file accommodates a chunk of data, and +in L. Each F> 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. diff --git a/doc/man-pages/pod8/backup_addvolentry.pod b/doc/man-pages/pod8/backup_addvolentry.pod index fba324b85..deb7f5951 100644 --- a/doc/man-pages/pod8/backup_addvolentry.pod +++ b/doc/man-pages/pod8/backup_addvolentry.pod @@ -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 lists the acceptable metacharacters. +volume name. L lists the acceptable metacharacters. =head1 CAUTIONS diff --git a/doc/man-pages/pod8/backup_kill.pod b/doc/man-pages/pod8/backup_kill.pod index d3f4e957f..dc3dc9cee 100644 --- a/doc/man-pages/pod8/backup_kill.pod +++ b/doc/man-pages/pod8/backup_kill.pod @@ -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. +L. =back diff --git a/doc/man-pages/pod8/backup_labeltape.pod b/doc/man-pages/pod8/backup_labeltape.pod index 57e3ed459..2bbca6754 100644 --- a/doc/man-pages/pod8/backup_labeltape.pod +++ b/doc/man-pages/pod8/backup_labeltape.pod @@ -62,7 +62,7 @@ output from B commands. The permanent name appears in the C field of the output from the B 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. Include the +argument in the required format described in L. 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<< >>, but the Backup System automatically assigns the appropriate name when the tape is diff --git a/doc/man-pages/pod8/backup_volsetrestore.pod b/doc/man-pages/pod8/backup_volsetrestore.pod index 24e864056..77711376d 100644 --- a/doc/man-pages/pod8/backup_volsetrestore.pod +++ b/doc/man-pages/pod8/backup_volsetrestore.pod @@ -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 for a detailed description of the output, and suggestions on how +L 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 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 details the format of +included, without actually restoring them. L 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 command. diff --git a/doc/man-pages/pod8/bos_create.pod b/doc/man-pages/pod8/bos_create.pod index bf4dcac1d..88c2d54fb 100644 --- a/doc/man-pages/pod8/bos_create.pod +++ b/doc/man-pages/pod8/bos_create.pod @@ -38,7 +38,7 @@ a demand-attach File Server, and a server process entry of type B 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 below for an example of switching from a traditional File +L 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. +administrator use. See L. =item B<-cell> > diff --git a/doc/man-pages/pod8/bos_salvage.pod b/doc/man-pages/pod8/bos_salvage.pod index 4b73c5dee..a598188f3 100644 --- a/doc/man-pages/pod8/bos_salvage.pod +++ b/doc/man-pages/pod8/bos_salvage.pod @@ -343,7 +343,7 @@ L, L, L, L, -L, +L, L, L, L, diff --git a/doc/man-pages/pod8/kadb_check.pod b/doc/man-pages/pod8/kadb_check.pod index f0af11917..95a85f845 100644 --- a/doc/man-pages/pod8/kadb_check.pod +++ b/doc/man-pages/pod8/kadb_check.pod @@ -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. The +additional information as described for each option in L. The output is intended for debugging purposes and is meaningful to someone familiar with the internal structure of the Authentication Database. diff --git a/doc/man-pages/pod8/kpwvalid.pod b/doc/man-pages/pod8/kpwvalid.pod index 7ee468e60..0cd059bcf 100644 --- a/doc/man-pages/pod8/kpwvalid.pod +++ b/doc/man-pages/pod8/kpwvalid.pod @@ -26,7 +26,7 @@ B binary. The AFS distribution includes an example B program that checks that the password is at least eight characters long; the code for it -appears in L below. +appears in L 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 diff --git a/doc/man-pages/pod8/prdb_check.pod b/doc/man-pages/pod8/prdb_check.pod index dff97f525..771684577 100644 --- a/doc/man-pages/pod8/prdb_check.pod +++ b/doc/man-pages/pod8/prdb_check.pod @@ -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. The +additional information as described for each option in L. The output is intended for debugging purposes and is meaningful to someone familiar with the internal structure of the Protection Database. diff --git a/doc/man-pages/pod8/salvageserver.pod b/doc/man-pages/pod8/salvageserver.pod index e39b626d4..d14da6f36 100644 --- a/doc/man-pages/pod8/salvageserver.pod +++ b/doc/man-pages/pod8/salvageserver.pod @@ -310,7 +310,7 @@ the local superuser C. L, L, -L, +L, L, L, L, diff --git a/doc/man-pages/pod8/vldb_check.pod b/doc/man-pages/pod8/vldb_check.pod index 320442847..e5d76a91c 100644 --- a/doc/man-pages/pod8/vldb_check.pod +++ b/doc/man-pages/pod8/vldb_check.pod @@ -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. The +additional information as described for each option in L. The output is intended for debugging purposes and is meaningful to someone familiar with the internal structure of the VLDB. diff --git a/doc/man-pages/pod8/volinfo.pod b/doc/man-pages/pod8/volinfo.pod index e2bcc1fd1..b7f2848ff 100644 --- a/doc/man-pages/pod8/volinfo.pod +++ b/doc/man-pages/pod8/volinfo.pod @@ -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. The output is intended for +information as described in L. The output is intended for debugging purposes and is meaningful to someone familiar with the internal structure of volume headers.