[OpenAFS-Doc] pod1/fs_newalias man page

[Jason Edgecombe]

This is a multi-part message in MIME format.
--------------080800060001040501020102
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit

Here is pod1/fs_newalias.pod.

Sincerely,
Jason

--------------080800060001040501020102
Content-Type: text/plain; x-mac-type="0"; x-mac-creator="0";
 name="fs_newalias.pod"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="fs_newalias.pod"

=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>> [B<-name>] <I<cell name>> >>>

=for html
</div>

=head1 DESCRIPTION

The B<fs newalias> command is used when the AFS client is Dynamic Root
(-dynroot) mode. It creates symbolic links in the dynamic root that
link the a short name for a cell to the full name for the cell.

This allows for short names for frequently used cell
names. Traditionally, the AFS administrator would create symbolic
links to short names of the home cell. These short names do not appear
with dynamic root mode because the C<root.afs> cell isn't mounted.
 B<fs newalias> allows these short names to be created on the client
instead of the C<root.afs> volume.

There is no need to create an alias for the read-write (dotted) name. It is mapped
automatically when the read-only alias is created.

=head1 CAUTIONS

Aliases created with B<fs newcell> are only temporary and will be lost
when the AFS client is restarted or the client machine is rebooted. In
order to make the alias permanent, it must be put into the
F<CellAlias> file.

=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.

=back

=head1 OUTPUT

This command has no output.

=head1 EXAMPLES

There are two ways to call B<fs newalias>:

fs newalias openafs openafs.org

and

fs newalias -alias openafs -name openafs.org

Both of the above examples create an alias "openafs" for the cell
"openafs.org". Two links wil be created in /afs. /afs/openafs will
link to /afs/openafs.org and /afs/.openafs will link to
/afs/.openafs.org.

=head1 PRIVILEGE REQUIRED

The user must have local super user root to run this command.

=head1 SEE ALSO

F<CellAlias>

=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.

--------------080800060001040501020102--