own copyright and a statement that the man page is released under the
IBM Public License Version 1.0, or under some other license that is
sufficiently compatible that we can use your work. If you use another
- license and that license isn't "public domain," you have to give the
- full license text in the man page; please don't use a license so long
- that this is annoying.
+ license and that license isn't "public domain" or one of the ones
+ already listed in our LICENSE file, you have to give the full license
+ text in the man page; please don't use a license so long that this is
+ annoying.
The SYNOPSIS section should start with the full command name and the
full names of all options, and then have a second section showing the
surrounding the variable. For consistency in formatting, references to
those variables should be formatted the same in following text.
+Man Page Sections
+
+ The section of a man page is determined by which directory it's in.
+ pod1 will be section 1 man pages, pod5 will be section 5, and pod8 will
+ be section 8.
+
+ The breakdown between section 1 and section 8 is fuzzy and it's hard to
+ get right. The current layout balances the following goals:
+
+ * In general, section 1 is used for commands that can be executed by any
+ user and section 8 is used for commands that can only be meaningfully
+ issued as root. If a command can be run with AFS privileged
+ credentials but still as a regular user on the local system, the
+ preference is for it to be in section 1, although some pages of that
+ type are in section 8.
+
+ * All the commands for a given suite should be kept together. So, for
+ example, there are fs commands that can only be issued as root, but
+ since most of the suite is available to any user, all of the fs
+ commands are in section 1.
+
+ * The sections of the man pages should roughly correspond to the
+ installation paths of the binaries. Binaries installed in bin should
+ have man pages in section 1 and binaries installed in sbin should have
+ man pages in section 8.
+
+ Section 5 should be used for all documentation of configuration files
+ and file formats.
+
How You Can Help
The OpenAFS man page project is just starting, and a lot of work remains
don't just report the deficiency again, but any contributions towards
fixing it are greatly appreciated.
- * The following installed commands have no man pages:
-
- copyauth
- fs rxstatproc
- fs setcbaddr
- restorevol
- rmtsysd
- vldb_convert
- vos clone
- vos setfields
- vos shadow
- vsys
-
- * 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
- should be documented in the pagsh man page.
+ * Add -noresolve to the documentation of all the vos commands.
* Some of the documentation in fs getserverprefs needs minor updates to
reflect what happens in the dynroot case.
* 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
* The salvager actually creates a bunch of SalvageLog files and then
combines them, but the SalvageLog man page doesn't reflect this.
- * 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.)
kaserver (and possibly without fakeka), and deprecation warnings
on the .krb varient commands.
+ * Linked cells are currently documented in fs newcell as being only
+ for DCE, which is not correct. That documentation, aklog, and the
+ CellServDB documentation needs to be updated.
+
* We need a way to add links to other man pages (kinit most notably)
without creating dangling links in the HTML output. This probably
means that the HTML conversion script needs to generate at startup