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