man-page-vos-shadow-20080331

[openafs.git] / doc / man-pages / README

diff --git a/doc/man-pages/README b/doc/man-pages/README
index 9d39703..33f08ab 100644 (file)
--- a/doc/man-pages/README
+++ b/doc/man-pages/README
@@ -78,7 +78,10 @@ Formatting Standards
   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,
@@ -186,8 +189,9 @@ How You Can Help
   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
 
@@ -197,27 +201,18 @@ Known Problems
 
    * The following installed commands have no man pages:
 
-       bos_util
        copyauth
-       flushall (Windows only)
-       fs getcalleraccess
+       fs cscpolicy
+       fs memdump
+       fs monitor
        fs rxstatpeer
        fs rxstatproc
        fs setcbaddr
-       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 setfields
        vsys
 
    * klog.krb, pagsh.krb, and tokens.krb need to be listed as alternative
@@ -228,12 +223,12 @@ Known Problems
    * Some of the documentation in fs getserverprefs needs minor updates to
      reflect what happens in the dynroot case.
 
-   * fs sysname documentation needs to include the possibility of setting
-     multiple sysnames and the resulting behavior.
-
    * 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.