Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod5 / CellAlias.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3CellAlias - Maps cell names to aliases in /afs
4
5=head1 DESCRIPTION
6
7The F<CellAlias> file is used by the Unix cache manager when it is using
8Dynamic Root (B<-dynroot>) mode. It creates symbolic links in the dynamic
9root (/afs) that link an alias for a cell (usually a short name) to the
10full name for the cell.
11
12The most common use of this configuration file is to allow short names for
13frequently used cell names. Traditionally, such short names would be
14created by the local AFS administrator by creating symbolic links in the
15C<root.afs> volume. Such symlinks do not appear when Dynamic Root is
16enabled because, with Dynamic Root, the Cache Manager does not mount or
17look at the C<root.afs> volume. F<CellAlias> is a replacement that allows
18such short names to be created under the client control.
19
20If you configure a short name mapping such as C<ir> for
21C<ir.example.org>, the mapping of C<.ir> to C<.ir.example.org> for the
22read/write version of the C<root.cell> volume for that cell will be
23created automatically. There is no need to list that alias
24separately. B<afsd> will report an error on startup if the dotted entry is
25listed separately.
26
27The contents of the F<CellAlias> file should consist of one line of two
28whitespace-separated columns per alias. The first column is the real name
29of the cell, and the second column is the alias that should be created.
30
31=head1 EXAMPLES
32
33The following F<CellAlias> file:
34
35 prod.example.com prod
36 test.example.org testcell
37
38results in the following symbolic links:
39
40 /afs/.prod -> /afs/.prod.example.com
41 /afs/prod -> /afs/prod.example.com
42 /afs/.testcell -> /afs/.testcell.example.org
43 /afs/testcell -> /afs/testcell.example.org
44
45=head1 SEE ALSO
46
47L<fs_newalias(1)>,
48L<fs_listaliases(1)>,
49L<afsd(8)>
50
51=head1 COPYRIGHT
52
53Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
54
55This documentation is covered by the BSD License as written in the
56doc/LICENSE file. This man page was written by Jason Edgecombe for
57OpenAFS.