From: Russ Allbery Date: Thu, 5 Jan 2006 18:33:51 +0000 (+0000) Subject: STABLE14-man1-editing-pass-20051209 X-Git-Tag: openafs-stable-1_4_1-rc4~26 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=60f983e7ed4e2c5ea5d292a025b746159c3ab68b;p=packages%2Fo%2Fopenafs.git 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) --- 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