* <I<>> for user-provided arguments (note the surrounding <>).
* I<> for terms being defined or titles of works.
* C<> for command examples, ACL characters, and example arguments.
+ * S<<<>>> for text with non-breaking spaces (usually in synopsis).
Also see the afs(1) man page for general rules about how OpenAFS man
pages are formatted and for standard terminology to use when talking
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:
-
- compile_et.afs
- copyauth
- fs cscpolicy
- fs memdump
- fs monitor
- fs rxstatpeer
- fs rxstatproc
- fs setcbaddr
- klog.krb
- krb.conf
- pagsh.krb
- restorevol
- rmtsysd
- tokens.krb
- vldb_convert
- vos setfields
- vsys
-
- * Add -noresolve to the documentation of all the vos commands.
-
- * 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.
-
* Some of the documentation in fs getserverprefs needs minor updates to
reflect what happens in the dynroot case.
* 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.
-
- * 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
- and the same transform needs to be applied to the other pages. See
- the fs intro page for the details.
-
* The references to the other OpenAFS manuals, such as the Quick Start
guide and the Admin Guide, should be links, probably to the documents
on openafs.org.
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
the commands are installed into. (In some cases, it may be better to
change the directory than the section of the man page.)
+ * Consider using M4 or similar to operate on POD text before output.
+ This would allow common options like vos -c,-noa,-l,-v,-e,-nor
+ to be documented once and automatically included in all vos_ reference
+ pages, much like the vos.c source includes those arguments as COMMONPARMS.
+
+ * Check that suite intro pages mention all subcommands
+
+ Changes needed to have vos suite commands completely up to date,
+ including the 1.5 branch:
+
+ * Document vos listaddrs -uuid / -host, and verify docs and example for
+ -printuuid
+
+ * Document vos offline -busy / -sleep
+
+ * Do vos online/offline support -bless/-unbless? By looking at the
+ source they dont, and according to Git log that goes back to 2000
+ they never did.
+ According to Derrick, there was a patch to support them that vanished.
+ Either the patch should be found, or bless/unbless removed from
+ vos online/offline.
+
+ * Document vos create -minquota which is available since 1.5.61
+
+ * Document vos restore -creation/-lastupdate and -nodelete
+
+ * Document vos delentry -noexecute. Should this option also be renamed
+ to -dryrun like others?
+
+ Man section 8 suite commands:
+
+ * Mention bos (un)blockscanner in bos.pod text, not just in See Also
+ at the end
+
+ * Update fstrace source to include option descriptions (for content,
+ use existing manpage information "condensed" to half line of text)
+
+ * Update backup source to include option descriptions (for content,
+ use existing manpage information "condensed" to half line of text)
+
+ * Document backup deletedump -port/-groupid/-dbonly/-force/-noexecute
+
+ * Replace backup diskrestore/dump -n option with -noexecute or -dryrun?
+
+ * Document backup help -admin
+
+ * Document backup volrestore -usedump. Also, s/-n/.../ as above?
+
+ * Replace backup volsetrestore -n option with -noexecute or -dryrun?
+
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