From 60f983e7ed4e2c5ea5d292a025b746159c3ab68b Mon Sep 17 00:00:00 2001 From: Russ Allbery Date: Thu, 5 Jan 2006 18:33:51 +0000 Subject: [PATCH] STABLE14-man1-editing-pass-20051209 This file got the wrong name when it was originally committed. Fix. RCS file: /cvs/openafs/doc/man-pages/pod5/Attic/afsmonitor.5,v Working file: doc/man-pages/pod5/afsmonitor.5 head: 1.2 branch: locks: strict access list: keyword substitution: kv total revisions: 2; selected revisions: 0 description: (cherry picked from commit 03b9fcc8834bfaaac069b27c0cd919934b68e833) --- doc/man-pages/generate-pod | 7 +- doc/man-pages/pod1/afs.pod | 700 +++++++----------- doc/man-pages/pod1/afsmonitor.pod | 479 ++++++------ doc/man-pages/pod1/dlog.pod | 210 +++--- doc/man-pages/pod1/dpass.pod | 64 +- doc/man-pages/pod1/fs.pod | 160 ++-- doc/man-pages/pod1/fs_apropos.pod | 37 +- doc/man-pages/pod1/fs_checkservers.pod | 200 +++-- doc/man-pages/pod1/fs_checkvolumes.pod | 28 +- doc/man-pages/pod1/fs_cleanacl.pod | 64 +- doc/man-pages/pod1/fs_copyacl.pod | 132 ++-- doc/man-pages/pod1/fs_diskfree.pod | 99 ++- doc/man-pages/pod1/fs_examine.pod | 92 ++- doc/man-pages/pod1/fs_exportafs.pod | 185 +++-- doc/man-pages/pod1/fs_flush.pod | 48 +- doc/man-pages/pod1/fs_flushmount.pod | 54 +- doc/man-pages/pod1/fs_flushvolume.pod | 51 +- doc/man-pages/pod1/fs_getcacheparms.pod | 30 +- doc/man-pages/pod1/fs_getcellstatus.pod | 42 +- doc/man-pages/pod1/fs_getclientaddrs.pod | 81 +- doc/man-pages/pod1/fs_getserverprefs.pod | 148 ++-- doc/man-pages/pod1/fs_help.pod | 57 +- doc/man-pages/pod1/fs_listacl.pod | 194 +++-- doc/man-pages/pod1/fs_listcells.pod | 51 +- doc/man-pages/pod1/fs_listquota.pod | 83 +-- doc/man-pages/pod1/fs_lsmount.pod | 80 +- doc/man-pages/pod1/fs_messages.pod | 37 +- doc/man-pages/pod1/fs_mkmount.pod | 276 +++---- doc/man-pages/pod1/fs_newcell.pod | 106 ++- doc/man-pages/pod1/fs_quota.pod | 43 +- doc/man-pages/pod1/fs_rmmount.pod | 41 +- doc/man-pages/pod1/fs_setacl.pod | 241 +++--- doc/man-pages/pod1/fs_setcachesize.pod | 82 +- doc/man-pages/pod1/fs_setcell.pod | 89 ++- doc/man-pages/pod1/fs_setclientaddrs.pod | 90 ++- doc/man-pages/pod1/fs_setquota.pod | 61 +- doc/man-pages/pod1/fs_setserverprefs.pod | 346 ++++----- doc/man-pages/pod1/fs_setvol.pod | 93 ++- doc/man-pages/pod1/fs_storebehind.pod | 227 +++--- doc/man-pages/pod1/fs_sysname.pod | 70 +- doc/man-pages/pod1/fs_whereis.pod | 45 +- doc/man-pages/pod1/fs_whichcell.pod | 27 +- doc/man-pages/pod1/fs_wscell.pod | 24 +- doc/man-pages/pod1/klog.pod | 338 ++++----- doc/man-pages/pod1/knfs.pod | 189 +++-- doc/man-pages/pod1/kpasswd.pod | 168 ++--- doc/man-pages/pod1/pagsh.pod | 100 ++- doc/man-pages/pod1/pts.pod | 141 ++-- doc/man-pages/pod1/pts_adduser.pod | 91 ++- doc/man-pages/pod1/pts_apropos.pod | 35 +- doc/man-pages/pod1/pts_chown.pod | 82 +- doc/man-pages/pod1/pts_creategroup.pod | 202 +++-- doc/man-pages/pod1/pts_createuser.pod | 186 ++--- doc/man-pages/pod1/pts_delete.pod | 68 +- doc/man-pages/pod1/pts_examine.pod | 223 +++--- doc/man-pages/pod1/pts_help.pod | 58 +- doc/man-pages/pod1/pts_listentries.pod | 81 +- doc/man-pages/pod1/pts_listmax.pod | 58 +- doc/man-pages/pod1/pts_listowned.pod | 108 ++- doc/man-pages/pod1/pts_membership.pod | 124 ++-- doc/man-pages/pod1/pts_removeuser.pod | 82 +- doc/man-pages/pod1/pts_rename.pod | 82 +- doc/man-pages/pod1/pts_setfields.pod | 233 +++--- doc/man-pages/pod1/pts_setmax.pod | 74 +- doc/man-pages/pod1/rxdebug.pod | 227 +++--- doc/man-pages/pod1/scout.pod | 386 +++++----- doc/man-pages/pod1/sys.pod | 54 ++ doc/man-pages/pod1/tokens.pod | 56 +- doc/man-pages/pod1/translate_et.pod | 15 +- doc/man-pages/pod1/udebug.pod | 377 +++++----- doc/man-pages/pod1/unlog.pod | 47 +- doc/man-pages/pod1/up.pod | 98 ++- doc/man-pages/pod1/vos.pod | 281 ++++--- doc/man-pages/pod1/vos_addsite.pod | 120 ++- doc/man-pages/pod1/vos_apropos.pod | 35 +- doc/man-pages/pod1/vos_backup.pod | 80 +- doc/man-pages/pod1/vos_backupsys.pod | 314 ++++---- doc/man-pages/pod1/vos_changeaddr.pod | 144 ++-- doc/man-pages/pod1/vos_create.pod | 175 ++--- doc/man-pages/pod1/vos_delentry.pod | 190 +++-- doc/man-pages/pod1/vos_dump.pod | 235 +++--- doc/man-pages/pod1/vos_examine.pod | 300 +++----- doc/man-pages/pod1/vos_help.pod | 58 +- doc/man-pages/pod1/vos_listaddrs.pod | 67 +- doc/man-pages/pod1/vos_listpart.pod | 70 +- doc/man-pages/pod1/vos_listvldb.pod | 215 +++--- doc/man-pages/pod1/vos_listvol.pod | 298 +++----- doc/man-pages/pod1/vos_lock.pod | 85 +-- doc/man-pages/pod1/vos_move.pod | 191 +++-- doc/man-pages/pod1/vos_partinfo.pod | 99 ++- doc/man-pages/pod1/vos_release.pod | 202 +++-- doc/man-pages/pod1/vos_remove.pod | 200 +++-- doc/man-pages/pod1/vos_remsite.pod | 113 ++- doc/man-pages/pod1/vos_rename.pod | 88 +-- doc/man-pages/pod1/vos_restore.pod | 247 +++--- doc/man-pages/pod1/vos_status.pod | 132 ++-- doc/man-pages/pod1/vos_syncserv.pod | 108 ++- doc/man-pages/pod1/vos_syncvldb.pod | 138 ++-- doc/man-pages/pod1/vos_unlock.pod | 77 +- doc/man-pages/pod1/vos_unlockvldb.pod | 116 ++- doc/man-pages/pod1/vos_zap.pod | 159 ++-- doc/man-pages/pod5/AuthLog.dir.pod | 2 +- doc/man-pages/pod5/CacheItems.pod | 2 +- doc/man-pages/pod5/VolumeItems.pod | 2 +- doc/man-pages/pod5/afs_volume_header.pod | 27 + doc/man-pages/pod5/afsmonitor.pod | 127 ++++ doc/man-pages/pod5/sysid.pod | 2 +- doc/man-pages/pod8/afsd.pod | 2 +- doc/man-pages/pod8/backup_addvolentry.pod | 2 +- doc/man-pages/pod8/backup_dbverify.pod | 2 +- doc/man-pages/pod8/backup_deletedump.pod | 2 +- doc/man-pages/pod8/backup_delvolentry.pod | 2 +- doc/man-pages/pod8/backup_delvolset.pod | 2 +- doc/man-pages/pod8/backup_diskrestore.pod | 2 +- doc/man-pages/pod8/backup_dump.pod | 2 +- doc/man-pages/pod8/backup_kill.pod | 2 +- doc/man-pages/pod8/backup_quit.pod | 2 +- doc/man-pages/pod8/backup_restoredb.pod | 2 +- doc/man-pages/pod8/backup_scantape.pod | 2 +- doc/man-pages/pod8/bos_addhost.pod | 2 +- doc/man-pages/pod8/bos_getlog.pod | 2 +- doc/man-pages/pod8/bos_listkeys.pod | 2 +- doc/man-pages/pod8/bos_removehost.pod | 2 +- doc/man-pages/pod8/bos_removekey.pod | 2 +- doc/man-pages/pod8/bos_salvage.pod | 2 +- doc/man-pages/pod8/bos_setauth.pod | 2 +- doc/man-pages/pod8/bos_setcellname.pod | 2 +- doc/man-pages/pod8/bos_setrestart.pod | 2 +- doc/man-pages/pod8/buserver.pod | 2 +- doc/man-pages/pod8/butc.pod | 2 +- doc/man-pages/pod8/fileserver.pod | 2 +- doc/man-pages/pod8/fms.pod | 2 +- doc/man-pages/pod8/fstrace_dump.pod | 2 +- doc/man-pages/pod8/kadb_check.pod | 2 +- doc/man-pages/pod8/kas_examine.pod | 2 +- doc/man-pages/pod8/kas_setfields.pod | 2 +- doc/man-pages/pod8/kas_statistics.pod | 2 +- doc/man-pages/pod8/kas_stringtokey.pod | 2 +- doc/man-pages/pod8/kdb.pod | 2 +- doc/man-pages/{pod1 => pod8}/package.pod | 2 +- .../{pod1 => pod8}/package_apropos.pod | 0 doc/man-pages/{pod1 => pod8}/package_help.pod | 0 doc/man-pages/{pod1 => pod8}/package_test.pod | 0 doc/man-pages/pod8/prdb_check.pod | 2 +- doc/man-pages/pod8/upclient.pod | 2 +- doc/man-pages/pod8/upserver.pod | 2 +- doc/man-pages/pod8/vldb_check.pod | 2 +- doc/man-pages/pod8/xfs_size_check.pod | 2 +- 148 files changed, 6506 insertions(+), 7526 deletions(-) create mode 100644 doc/man-pages/pod1/sys.pod create mode 100644 doc/man-pages/pod5/afs_volume_header.pod create mode 100644 doc/man-pages/pod5/afsmonitor.pod rename doc/man-pages/{pod1 => pod8}/package.pod (99%) rename doc/man-pages/{pod1 => pod8}/package_apropos.pod (100%) rename doc/man-pages/{pod1 => pod8}/package_help.pod (100%) rename doc/man-pages/{pod1 => pod8}/package_test.pod (100%) diff --git a/doc/man-pages/generate-pod b/doc/man-pages/generate-pod index 15456a1c1..0a4f01529 100755 --- a/doc/man-pages/generate-pod +++ b/doc/man-pages/generate-pod @@ -63,9 +63,7 @@ sub element { $command =~ s/^L$//; } elsif ($lasttag eq "strong") { - if ($buffer eq 'Cautions') { - $buffer = 'CAVEATS'; - } elsif ($buffer eq 'Related Information') { + if ($buffer eq 'Related Information') { $buffer = 'SEE ALSO'; } else { $buffer = uc $buffer; @@ -170,8 +168,7 @@ $p->parse_file($file) || die "Can't open file: $!\n"; # Fix up a few last things. $result =~ s/L<(\S+) (\S+\(1\))>/L<${1}_${2}>/g; -$result =~ s/^(L<\S+>)\n\n(?=L<)/$1,\n/mg; -$result =~ s/^(\S+[^\n]+)\n +/$1\n/mg; +$result =~ s/^(L<[^>]+>)\n\n(?=L<)/$1,\n/mg; $result =~ s/^(\s+.*)B<([^>]+)>/$1$2/mg; # Append a stock copyright statement. diff --git a/doc/man-pages/pod1/afs.pod b/doc/man-pages/pod1/afs.pod index 8ff165757..6f7420dd1 100644 --- a/doc/man-pages/pod1/afs.pod +++ b/doc/man-pages/pod1/afs.pod @@ -1,6 +1,6 @@ =head1 NAME -afs_intro - Introduction to AFS commands +afs - Introduction to AFS commands =head1 DESCRIPTION @@ -12,89 +12,86 @@ following categories, called I. =item backup -Interface for configuring and operating the AFS Backup System +Interface for configuring and operating the AFS Backup System. =item bos Interface to the Basic Overseer (BOS) Server for administering server -processes and configuration files +processes and configuration files. =item fs Interface for administering access control lists (ACLs), the Cache -Manager, and other miscellaneous file system functions +Manager, and other miscellaneous file system functions. =item fstrace -Interface for tracing Cache Manager operations when debugging problems +Interface for tracing Cache Manager operations when debugging problems. =item kas Interface to the Authentication Server for administering security and -authentication information +authentication information. =item pts Interface to the Protection Server for administering AFS ID and group -membership information +membership information. =item uss -Interface for automated administration of user accounts +Interface for automated administration of user accounts. =item vos Interface to the Volume Server and Volume Location (VL) Server for -administering volumes +administering volumes. =back In addition, there are several commands that do not belong to suites. -=head2 +=head2 AFS Command Syntax -AFS commands that belong to suites have the following -structure: +AFS commands that belong to suites have the following structure: - B B<-switch> >[+] [-flag] +I I B<-switch> >[+] [B<-flag>] -=head3 +=head3 Command Names -Together, the B and operation_code -make up the I. +Together, the I and I make up the I. -The command_suite specifies the group of related commands to -which the command belongs, and indicates which command interpreter and server -process perform the command. AFS has several command suites, including -B, B, B, B, -B, B, B and B. -Some of these suites have an interactive mode in which the issuer omits the -B portion of the command name. +The I specifies the group of related commands to which the +command belongs, and indicates which command interpreter and server +process perform the command. AFS has several command suites, including +B, B, B, B, B, B and B. Some of +these suites have an interactive mode in which the issuer omits the +I portion of the command name. -The operation_code tells the command interpreter and server -process which action to perform. Most command suites include several -operation codes. The I -describes each operation code in detail, and the I describes how to use them in the context of performing -administrative tasks. +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 +in the context of performing administrative tasks. Several AFS commands do not belong to a suite and so their names do not -have a B portion. Their structure is otherwise -similar to the commands in the suites. +have a I portion. Their structure is otherwise similar to +the commands in the suites. -=head3 +=head3 Options -The term I