From e7742db31f68acf2d227c13840e0a0ed9291d247 Mon Sep 17 00:00:00 2001 From: Jason Edgecombe Date: Sun, 5 Aug 2007 22:38:10 +0000 Subject: [PATCH] man-page-fs-newalias-20070805 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. --- doc/man-pages/README | 1 - doc/man-pages/pod1/fs.pod | 5 ++ doc/man-pages/pod1/fs_getcrypt.pod | 11 ++- doc/man-pages/pod1/fs_listaliases.pod | 11 ++- doc/man-pages/pod1/fs_newalias.pod | 96 +++++++++++++++++++++++++++ doc/man-pages/pod1/fs_setcrypt.pod | 7 +- doc/man-pages/pod5/CellAlias.pod | 4 +- 7 files changed, 127 insertions(+), 8 deletions(-) create mode 100644 doc/man-pages/pod1/fs_newalias.pod diff --git a/doc/man-pages/README b/doc/man-pages/README index 7fef037cb..e4ce8102f 100644 --- a/doc/man-pages/README +++ b/doc/man-pages/README @@ -197,7 +197,6 @@ Known Problems copyauth flushall (Windows only) fs getcalleraccess - fs newalias fs rxstatpeer fs rxstatproc fs setcbaddr diff --git a/doc/man-pages/pod1/fs.pod b/doc/man-pages/pod1/fs.pod index 286a79519..e240acee3 100644 --- a/doc/man-pages/pod1/fs.pod +++ b/doc/man-pages/pod1/fs.pod @@ -58,6 +58,7 @@ L|fs_flush(1)>, L|fs_flushvolume(1)>, L|fs_getcacheparms(1)>, L|fs_listaliases(1)>, +L|fs_newalias(1)>, and L|fs_setcachesize(1)>. =item * @@ -189,14 +190,17 @@ L, L, L, L, +L, L, L, L, +L, L, L, L, L, L, +L, L, L, L, @@ -204,6 +208,7 @@ L, L, L, L, +L, L, L, L, diff --git a/doc/man-pages/pod1/fs_getcrypt.pod b/doc/man-pages/pod1/fs_getcrypt.pod index 5d7d3f8e2..1b33bc2d7 100644 --- a/doc/man-pages/pod1/fs_getcrypt.pod +++ b/doc/man-pages/pod1/fs_getcrypt.pod @@ -7,7 +7,7 @@ fs getcrypt - Displays the state of encryption for AFS file transfers =for html
-B +B [B<-help>] =for html
@@ -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 diff --git a/doc/man-pages/pod1/fs_listaliases.pod b/doc/man-pages/pod1/fs_listaliases.pod index aa015df2c..bb1ec4519 100644 --- a/doc/man-pages/pod1/fs_listaliases.pod +++ b/doc/man-pages/pod1/fs_listaliases.pod @@ -7,7 +7,7 @@ fs listaliases - Displays the current list of aliases for AFS cells =for html
-B +B [B<-help>] =for html
@@ -21,7 +21,14 @@ option to B). =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 index 000000000..2c56c83ce --- /dev/null +++ b/doc/man-pages/pod1/fs_newalias.pod @@ -0,0 +1,96 @@ +=head1 NAME + +fs newalias - Creates a new alias for a cell + +=head1 SYNOPSIS + +=for html +
+ +B S<<< [B<-alias>] > >>> + S<<< [B<-name>] > >>> [B<-help>] + +=for html +
+ +=head1 DESCRIPTION + +The B command is used when the AFS Cache Manager is in +Dynamic Root (B<-dynroot>) mode. It creates a symbolic link in F +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 volume of that cell. + +This command is used to supplement aliases created via the F +configuration file when B starts. + +Traditionally, these aliases would be created by the local AFS +administrator by creating symbolic links in the C 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 +volume. This alias capability is a replacement that allows such short +names to be created under client control. + +=head1 CAUTIONS + +Aliases created with B 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 file. + +There is no way to remove an alias once created without restarting the +AFS Cache Manager. + +=head1 OPTIONS + +=over 4 + +=item B<-alias> > + +This is the short name to which the user wants to map the real cell name. + +=item B<-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 openafs openafs.org + % fs newalias -alias openafs -name openafs.org + +Both of the above examples create an alias C for the cell +C. Two links wil be created in F: + + /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, +L, +L + +=head1 COPYRIGHT + +Copyright 2007 Jason Edgecombe + +This documentation is covered by the IBM Public License Version 1.0. This +man page was written by Jason Edgecombe for OpenAFS. diff --git a/doc/man-pages/pod1/fs_setcrypt.pod b/doc/man-pages/pod1/fs_setcrypt.pod index 059ed2732..76676f167 100644 --- a/doc/man-pages/pod1/fs_setcrypt.pod +++ b/doc/man-pages/pod1/fs_setcrypt.pod @@ -7,7 +7,7 @@ fs setcrypt - Enables of disables the encryption of AFS file transfers =for html
-B S<<< [B<-crypt>] > >>> +B S<<< [B<-crypt>] > >>> [B<-help>] =for html
@@ -54,6 +54,11 @@ omitted. C<0> and C<1> or C and C are not supported as replacements for C and C. +=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/pod5/CellAlias.pod b/doc/man-pages/pod5/CellAlias.pod index 2a9e126a6..5fb3eb051 100644 --- a/doc/man-pages/pod5/CellAlias.pod +++ b/doc/man-pages/pod5/CellAlias.pod @@ -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 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 volume. F is a replacement which allows +look at the C volume. F 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 for C, the mapping of C<.ir> to C<.ir.stanford.edu> for the -read-write version of the C volume for that cell will be +read/write version of the C volume for that cell will be created automatically. There is no need to list that alias separately (and it is listed separately, B will report an error on startup). -- 2.39.5