.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FS_NEWALIAS 1"
.TH FS_NEWALIAS 1 2024-03-20 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
fs_newalias \- Creates a new alias for a cell
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBfs newalias\fR [\fB\-alias\fR]\ <\fIalias\ name\fR>
    [\fB\-name\fR]\ <\fIcell\ name\fR> [\fB\-help\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBfs newalias\fR command is used when the AFS Cache Manager is in
Dynamic Root (\fB\-dynroot\fR) mode. It creates a symbolic link in \fI/afs\fR
from an alias to the full name of the cell. It also creates a symbolic
link from the alias prepended with \f(CW\*(C`.\*(C'\fR to the full name of the cell
prepended with \f(CW\*(C`.\*(C'\fR, the convention for access to the read/write version
of the \f(CW\*(C`root.cell\*(C'\fR volume of that cell.
.PP
This command is used to supplement aliases created via the \fICellAlias\fR
configuration file when \fBafsd\fR starts.
.PP
Traditionally, these aliases would be created by the local AFS
administrator by creating symbolic links in the \f(CW\*(C`root.afs\*(C'\fR 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 \f(CW\*(C`root.afs\*(C'\fR
volume. This alias capability is a replacement that allows such short
names to be created under client control.
.SH CAUTIONS
.IX Header "CAUTIONS"
Aliases created with \fBfs newalias\fR 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
\&\fICellAlias\fR file.
.PP
There is no way to remove an alias once created without restarting the
AFS Cache Manager.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-alias\fR <\fIalias name\fR>" 4
.IX Item "-alias <alias name>"
This is the short name to which the user wants to map the real cell name.
.IP "\fB\-name\fR <\fIcell name\fR>" 4
.IX Item "-name <cell name>"
This is the real cell name.
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH OUTPUT
.IX Header "OUTPUT"
This command has no output.
.SH EXAMPLES
.IX Header "EXAMPLES"
There are two ways to call \fBfs newalias\fR:
.PP
.Vb 2
\&   % fs newalias openafs openafs.org
\&   % fs newalias \-alias openafs \-name openafs.org
.Ve
.PP
Both of the above examples create an alias \f(CW\*(C`openafs\*(C'\fR for the cell
\&\f(CW\*(C`openafs.org\*(C'\fR. Two links will be created in \fI/afs\fR:
.PP
.Vb 2
\&   /afs/openafs   \->  /afs/openafs.org
\&   /afs/.openafs  \->  /afs/.openafs.org
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must be logged in as the local superuser root.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBafsd\fR\|(8),
\&\fBCellAlias\fR\|(5),
\&\fBfs_listaliases\fR\|(1)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
.PP
This documentation is covered by the BSD License as written in the
doc/LICENSE file. This man page was written by Jason Edgecombe for
OpenAFS.