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. (And check other people's documentation and find any
+ problems that have crept in.)
+
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.
* Provide a way to substitute the correct paths into the HTML output
from Autoconf results.
+ * Currently, the man pages are built by regen.sh, which is somewhat
+ annoying since it takes a long time. Figure out how better to do this
+ during the release process so that end users don't have to have
+ pod2man.
+
+ * Review the sections used for all man pages against what directories
+ the commands are installed into. (In some cases, it may be better to
+ change the directory than the section of the man page.)
+
If you notice other problems, please send them to the openafs-doc list
even if you don't have time to fix them. Someone else might, and we
want to track all of the issues.
git://git.openafs.org / openafs.git / blobdiff