man-page-fs-listaliases-20070805
authorJason Edgecombe <jason@rampaginggeek.com>
Sun, 5 Aug 2007 22:16:47 +0000 (22:16 +0000)
committerRuss Allbery <rra@stanford.edu>
Sun, 5 Aug 2007 22:16:47 +0000 (22:16 +0000)
Add manual page for fs listaliases.  Also add the links in the fs(1) man
page and update README more for the current to-do list.

doc/man-pages/README
doc/man-pages/pod1/fs.pod
doc/man-pages/pod1/fs_listaliases.pod [new file with mode: 0644]

index ff43340..7fef037 100644 (file)
@@ -195,8 +195,8 @@ Known Problems
 
        bos_util
        copyauth
+       flushall (Windows only)
        fs getcalleraccess
-       fs listaliases
        fs newalias
        fs rxstatpeer
        fs rxstatproc
@@ -218,10 +218,6 @@ Known Problems
        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
index 6c88f5e..286a795 100644 (file)
@@ -19,10 +19,12 @@ Commands to set and report how the Cache Manager interacts with server
 machines:
 L<B<fs checkservers>|fs_checkservers(1)>,
 L<B<fs getcellstatus>|fs_getcellstatus(1)>,
+L<B<fs getcrypt>|fs_getcrypt(1)>,
 L<B<fs getserverprefs>|fs_getserverprefs(1)>,
 L<B<fs listcells>|fs_listcells(1)>,
 L<B<fs newcell>|fs_newcell(1)>,
 L<B<fs setcell>|fs_setcell(1)>,
+L<B<fs setcrypt>|fs_setcrypt(1)>,
 L<B<fs setserverprefs>|fs_setserverprefs(1)>,
 L<B<fs sysname>|fs_sysname(1)>,
 and L<B<fs wscell>|fs_wscell(1)>.
@@ -55,6 +57,7 @@ L<B<fs checkvolumes>|fs_checkvolumes(1)>,
 L<B<fs flush>|fs_flush(1)>,
 L<B<fs flushvolume>|fs_flushvolume(1)>,
 L<B<fs getcacheparms>|fs_getcacheparms(1)>,
+L<B<fs listaliases>|fs_listaliases(1)>,
 and L<B<fs setcachesize>|fs_setcachesize(1)>.
 
 =item *
diff --git a/doc/man-pages/pod1/fs_listaliases.pod b/doc/man-pages/pod1/fs_listaliases.pod
new file mode 100644 (file)
index 0000000..aa015df
--- /dev/null
@@ -0,0 +1,56 @@
+=head1 NAME
+
+fs listaliases - Displays the current list of aliases for AFS cells
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs listaliases>
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fs listaliases> command shows the list of cell aliases currently in
+effect, both from F<CellAlias> and created using B<fs newalias>.  Cell
+aliases can only be used when the using a Dynamic Root (the B<-dynroot>
+option to B<afsd>).
+
+=head1 OPTIONS
+
+This command takes no options.
+
+=head1 OUTPUT
+
+If an alias C<openafs> exists for the cell C<openafs.org>, the output
+include the following line:
+
+   Alias openafs for cell openafs.org
+
+=head1 EXAMPLES
+
+There is only one way to invoke B<fs listaliases>:
+
+   % fs listaliases
+
+=back
+
+=head1 PRIVILEGE REQUIRED
+
+No special priviledges are required for this command.
+
+=head1 SEE ALSO
+
+L<afsd(8)>,
+L<CellAlias(5)>,
+L<fs_newalias(1)>
+
+=head1 COPYRIGHT
+
+Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
+
+This documentation is covered by the IBM Public License Version 1.0. This
+man page was written by Jason Edgecombe for OpenAFS.