DEVEL15-man-page-fs-newalias-20070805
authorJason Edgecombe <jason@rampaginggeek.com>
Mon, 6 Aug 2007 00:38:42 +0000 (00:38 +0000)
committerRuss Allbery <rra@stanford.edu>
Mon, 6 Aug 2007 00:38:42 +0000 (00:38 +0000)
Add a new fs newalias man page.  Add -help to the synopsis and options of
the other new man pages.  Add additional missing links in the fs man page.
Fix some wording in the CellAlias man page.

(cherry picked from commit e7742db31f68acf2d227c13840e0a0ed9291d247)

doc/man-pages/README
doc/man-pages/pod1/fs.pod
doc/man-pages/pod1/fs_getcrypt.pod
doc/man-pages/pod1/fs_listaliases.pod
doc/man-pages/pod1/fs_newalias.pod [new file with mode: 0644]
doc/man-pages/pod1/fs_setcrypt.pod
doc/man-pages/pod5/CellAlias.pod

index 6046f23..e190d8f 100644 (file)
@@ -197,7 +197,6 @@ Known Problems
        copyauth
        flushall (Windows only)
        fs getcalleraccess
-       fs newalias
        fs rxstatpeer
        fs rxstatproc
        fs setcbaddr
index 286a795..e240ace 100644 (file)
@@ -58,6 +58,7 @@ 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)>,
+L<B<fs newalias>|fs_newalias(1)>,
 and L<B<fs setcachesize>|fs_setcachesize(1)>.
 
 =item *
@@ -189,14 +190,17 @@ L<fs_flushvolume(1)>,
 L<fs_getcacheparms(1)>,
 L<fs_getcellstatus(1)>,
 L<fs_getclientaddrs(1)>,
+L<fs_getcrypt(1)>,
 L<fs_getserverprefs(1)>,
 L<fs_help(1)>,
 L<fs_listacl(1)>,
+L<fs_listaliases(1)>,
 L<fs_listcells(1)>,
 L<fs_listquota(1)>,
 L<fs_lsmount(1)>,
 L<fs_messages(1)>,
 L<fs_mkmount(1)>,
+L<fs_newalias(1)>,
 L<fs_newcell(1)>,
 L<fs_quota(1)>,
 L<fs_rmmount(1)>,
@@ -204,6 +208,7 @@ L<fs_setacl(1)>,
 L<fs_setcachesize(1)>,
 L<fs_setcell(1)>,
 L<fs_setclientaddrs(1)>,
+L<fs_setcrypt(1)>,
 L<fs_setquota(1)>,
 L<fs_setserverprefs(1)>,
 L<fs_setvol(1)>,
index 5d7d3f8..1b33bc2 100644 (file)
@@ -7,7 +7,7 @@ fs getcrypt - Displays the state of encryption for AFS file transfers
 =for html
 <div class="synopsis">
 
-B<fs getcrypt>
+B<fs getcrypt> [B<-help>]
 
 =for html
 </div>
@@ -33,7 +33,14 @@ encryption is turned on.
 
 =head1 OPTIONS
 
-This commands takes no options.
+=over 4
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
 
 =head1 OUTPUT
 
index aa015df..bb1ec45 100644 (file)
@@ -7,7 +7,7 @@ fs listaliases - Displays the current list of aliases for AFS cells
 =for html
 <div class="synopsis">
 
-B<fs listaliases>
+B<fs listaliases> [B<-help>]
 
 =for html
 </div>
@@ -21,7 +21,14 @@ option to B<afsd>).
 
 =head1 OPTIONS
 
-This command takes no options.
+=over 4
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
 
 =head1 OUTPUT
 
diff --git a/doc/man-pages/pod1/fs_newalias.pod b/doc/man-pages/pod1/fs_newalias.pod
new file mode 100644 (file)
index 0000000..2c56c83
--- /dev/null
@@ -0,0 +1,96 @@
+=head1 NAME
+
+fs newalias - Creates a new alias for a cell
+
+=head1 SYNOPSIS
+
+=for html
+<div class="synopsis">
+
+B<fs newalias> S<<< [B<-alias>] <I<alias name>> >>>
+    S<<< [B<-name>] <I<cell name>> >>> [B<-help>]
+
+=for html
+</div>
+
+=head1 DESCRIPTION
+
+The B<fs newalias> command is used when the AFS Cache Manager is in
+Dynamic Root (B<-dynroot>) mode. It creates a symbolic link in F</afs>
+from an alias to the full name of the cell. It also creates a symbolic
+link from the alias prepended with C<.> to the full name of the cell
+prepended with C<.>, the convention for access to the read/write version
+of the C<root.cell> volume of that cell.
+
+This command is used to supplement aliases created via the F<CellAlias>
+configuration file when B<afsd> starts.
+
+Traditionally, these aliases would be created by the local AFS
+administrator by creating symbolic links in the C<root.afs> volume. Such
+symlinks do not appear when Dynamic Root is enabled because, with Dynamic
+Root, the Cache Manager does not mount or look at the C<root.afs>
+volume. This alias capability is a replacement that allows such short
+names to be created under client control.
+
+=head1 CAUTIONS
+
+Aliases created with B<fs newcell> are only temporary and will be lost
+when the AFS Cache Manager is restarted or the client machine is
+rebooted. In order to make the alias permanent, it must be put into the
+F<CellAlias> file.
+
+There is no way to remove an alias once created without restarting the
+AFS Cache Manager.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-alias> <I<alias name>>
+
+This is the short name to which the user wants to map the real cell name.
+
+=item B<-name> <I<cell name>>
+
+This is the real cell name.
+
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
+=back
+
+=head1 OUTPUT
+
+This command has no output.
+
+=head1 EXAMPLES
+
+There are two ways to call B<fs newalias>:
+
+   % fs newalias openafs openafs.org
+   % fs newalias -alias openafs -name openafs.org
+
+Both of the above examples create an alias C<openafs> for the cell
+C<openafs.org>. Two links wil be created in F</afs>:
+
+   /afs/openafs   ->  /afs/openafs.org
+   /afs/.openafs  ->  /afs/.openafs.org
+
+=head1 PRIVILEGE REQUIRED
+
+The issuer must be logged in as the local superuser root.
+
+=head1 SEE ALSO
+
+L<afsd(8)>,
+L<CellAlias(5)>,
+L<fs_listaliases(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.
index 059ed27..76676f1 100644 (file)
@@ -7,7 +7,7 @@ fs setcrypt - Enables of disables the encryption of AFS file transfers
 =for html
 <div class="synopsis">
 
-B<fs setcrypt> S<<< [B<-crypt>] <I<on/off>> >>>
+B<fs setcrypt> S<<< [B<-crypt>] <I<on/off>> >>> [B<-help>]
 
 =for html
 </div>
@@ -54,6 +54,11 @@ omitted.
 C<0> and C<1> or C<true> and C<false> are not supported as replacements
 for C<on> and C<off>.
 
+=item B<-help>
+
+Prints the online help for this command. All other valid options are
+ignored.
+
 =back
 
 =head1 OUTPUT
index 2a9e126..5fb3eb0 100644 (file)
@@ -14,12 +14,12 @@ frequently used cell names. Traditionally, such short names would be
 created by the local AFS administrator by creating symbolic links in the
 C<root.afs> volume. Such symlinks do not appear when Dynamic Root is
 enabled because, with Dynamic Root, the Cache Manager does not mount or
-look at the C<root.afs> volume. F<CellAlias> is a replacement which allows
+look at the C<root.afs> volume. F<CellAlias> is a replacement that allows
 such short names to be created under the client control.
 
 If you configure a short name mapping such as C<ir> for
 C<ir.stanford.edu>, the mapping of C<.ir> to C<.ir.stanford.edu> for the
-read-write version of the C<root.cell> volume for that cell will be
+read/write version of the C<root.cell> volume for that cell will be
 created automatically. There is no need to list that alias separately (and
 it is listed separately, B<afsd> will report an error on startup).