documents common options, and discusses the general use of the suite.
Then, each operation code in the suite should have a separate man page,
named after the command with the space between the command suite and the
- operation code replaced with an underscore.
+ operation code replaced with an underscore. The NAME section of the
+ operation man page must also use an underscore (fs_listacl, not fs
+ listacl) for compatibility with some man programs. The SYNOPSIS section
+ should, of course, use a space, since that's what the user must type.
All man pages must follow the standard layout for man page sections and
formatting. The best general reference is the pod2man man page,
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.)
+ 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 following installed commands have no man pages:
- bos_util
copyauth
- flushall (Windows only)
- fs getcalleraccess
fs rxstatpeer
fs rxstatproc
fs setcbaddr
- kseal
- read_tape
restorevol
rmtsysd
vldb_convert
- vos changeloc
vos clone
- vos convertROtoRW
- vos copy
+ vos setfields
vos shadow
vsys
* 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.