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<SECTION>.
+ should be given as L<SECTION>. 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
the bug number so that I'm aware of it, as I don't always notice new
bugs.
+ You can test your new POD documentation by running the check-pod script
+ in this directory with "prove check-pod". (And check other people's
+ documentation and find any problems that have crept in.) You will need
+ to have Test::Pod installed.
+
Known Problems
The current man pages have the following known deficiencies. Please
* The following installed commands have no man pages:
- bos_util
copyauth
- fs getcalleraccess
- fs getcrypt
- fs listaliases
- fs newalias
fs rxstatpeer
fs rxstatproc
fs setcbaddr
- fs setcrypt
- kseal
- pts interactive
- pts quit
- pts sleep
- pts source
read_tape
restorevol
rmtsysd
vldb_convert
- vos changeloc
vos clone
vos convertROtoRW
vos copy
vos shadow
- vos size
vsys
- * The following configuration files have no man pages:
-
- CellAlias
-
* klog.krb, pagsh.krb, and tokens.krb need to be listed as alternative
names in the NAME line of the non-.krb man pages, links should be
installed on man page installation, and the behavior of pagsh.krb
* fs sysname documentation needs to include the possibility of setting
multiple sysnames and the resulting behavior.
- * The afsd man page is horribly out of date. It doesn't explain
- dynroot, many options are missing, and some of the options described
- are no longer valid. It also still assumes that -settime is the
- default and says that the system must be rebooted after shutdown,
- which isn't the case at least on Linux.
-
* bos listkeys and the KeyFile man page assume that you're using the
kaserver.
+ * bos addkey should be marked deprecated in favor of using asetkey with
+ a keytab.
+
* I'm fairly sure that the fileserver man page no longer documents all
of the fileserver options.
- * The package man page should probably mention the (pointless) package
- apropos and package help commands, or they could be removed. There
- used to be separate man pages for them, but that seemed rather
- pointless.
-
* There are lingering references to AFS Development or AFS Product
Support in descriptions of options that one should generally not
use. Also, all of the manual references refer to the "IBM" manual.
* The CellServDB documentation hasn't been updated for -dynroot.
- * The aklog man page isn't in POD. (Neither is the mpp man page, but
- I don't think we care about it and it's not currently installed.)
-
* In the suite introduction pages (pts, vos, etc.), each of the
subcommands in the initial list should be a link to the relevant
page in the HTML output. This has been done for the fs intro page
git://git.openafs.org / openafs.git / blobdiff