From: Russ Allbery Date: Sun, 5 Aug 2007 22:08:22 +0000 (+0000) Subject: man-page-style-20070805 X-Git-Tag: BP-openafs-windows-kdfs-ifs~574 X-Git-Url: http://git.openafs.org/?p=openafs.git;a=commitdiff_plain;h=e735ef962de3623f8fa11cca92d13151d62b5aaa man-page-style-20070805 Some style fixes and some additional style documentation in README. --- diff --git a/doc/man-pages/README b/doc/man-pages/README index 957691f..ff43340 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -123,7 +123,11 @@ Formatting Standards References to functions should be noted like function() with the trailing parens. The POD converters know how to format these sorts of references appropriately. References to other sections in the same page - should be given as L
. + should be given as L
. Man pages for all other AFS commands or + file formats referenced in the page should be listed in the SYNOPSIS. + List each reference on its own line for easier addition of other + references later, but don't put blank lines between them. Don't forget + the commas at the end of each line but the last. Command and output examples should be indented three spaces. Commands entered by the user should be given on a line beginning with %. If the diff --git a/doc/man-pages/pod1/fs_getcrypt.pod b/doc/man-pages/pod1/fs_getcrypt.pod index 1258880..5d7d3f8 100644 --- a/doc/man-pages/pod1/fs_getcrypt.pod +++ b/doc/man-pages/pod1/fs_getcrypt.pod @@ -39,17 +39,17 @@ This commands takes no options. If encryption is enabled, the output is: - Security level is currently crypt (data security). + Security level is currently crypt (data security). If encryption if disabled, the output is: - Security level is currently clear. + Security level is currently clear. =head1 EXAMPLES There is only one way to invoke B: - % fs getcrypt + % fs getcrypt =back diff --git a/doc/man-pages/pod1/fs_setcrypt.pod b/doc/man-pages/pod1/fs_setcrypt.pod index 386bdd7..059ed27 100644 --- a/doc/man-pages/pod1/fs_setcrypt.pod +++ b/doc/man-pages/pod1/fs_setcrypt.pod @@ -64,13 +64,13 @@ This command produces no output other than error messages. There are only four ways to invoke B. Either of: - % fs setcrypt -crypt on - % fs setcrypt on + % fs setcrypt -crypt on + % fs setcrypt on will enable encryption for authenticated connections and: - % fs setcrypt -crypt off - % fs setcrypt off + % fs setcrypt -crypt off + % fs setcrypt off will disable encryption. diff --git a/doc/man-pages/pod5/CellAlias.pod b/doc/man-pages/pod5/CellAlias.pod index 350eea6..2a9e126 100644 --- a/doc/man-pages/pod5/CellAlias.pod +++ b/doc/man-pages/pod5/CellAlias.pod @@ -31,15 +31,15 @@ of the cell, and the second column is the alias that should be created. The following F file: - openafs.org openafs - uncc.edu uncc + openafs.org openafs + uncc.edu uncc results in the following symbolic links: - /afs/.openafs -> /afs/.openafs.org - /afs/openafs -> /afs/openafs.org - /afs/.uncc -> /afs/.uncc.edu - /afs/uncc -> /afs/uncc.edu + /afs/.openafs -> /afs/.openafs.org + /afs/openafs -> /afs/openafs.org + /afs/.uncc -> /afs/.uncc.edu + /afs/uncc -> /afs/uncc.edu =head1 SEE ALSO diff --git a/doc/man-pages/pod8/afsd.pod b/doc/man-pages/pod8/afsd.pod index 5e49164..4c92513 100644 --- a/doc/man-pages/pod8/afsd.pod +++ b/doc/man-pages/pod8/afsd.pod @@ -678,17 +678,17 @@ The B command is normally included in the machine's AFS initialization file, rather than typed at the command shell prompt. For most disk caches, the appropriate form is - /usr/vice/etc/afsd + % /usr/vice/etc/afsd The following command is appropriate when enabling a machine to act as an NFS/AFS Translator machine serving more than five users. - /usr/vice/etc/afsd -daemons 4 -rmtsys + % /usr/vice/etc/afsd -daemons 4 -rmtsys The following command initializes a memory cache and sets chunk size to 16 KB (2^14). - /usr/vice/etc/afsd -memcache -chunksize 14 + % /usr/vice/etc/afsd -memcache -chunksize 14 =head1 PRIVILEGE REQUIRED