46b6395329b7ec392f84ca98761e829f9a832730
[openafs.git] / doc / man-pages / pod1 / fs_listaliases.pod
1 =head1 NAME
2
3 fs_listaliases - Displays the current list of aliases for AFS cells
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs listaliases> [B<-help>]
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 The B<fs listaliases> command shows the list of cell aliases currently in
18 effect, both from F<CellAlias> and created using B<fs newalias>.  Cell
19 aliases can only be used when the using a Dynamic Root (the B<-dynroot>
20 option to B<afsd>).
21
22 =head1 OPTIONS
23
24 =over 4
25
26 =item B<-help>
27
28 Prints the online help for this command. All other valid options are
29 ignored.
30
31 =back
32
33 =head1 OUTPUT
34
35 If an alias C<openafs> exists for the cell C<openafs.org>, the output
36 include the following line:
37
38    Alias openafs for cell openafs.org
39
40 =head1 EXAMPLES
41
42 There is only one way to invoke B<fs listaliases>:
43
44    % fs listaliases
45
46 =head1 PRIVILEGE REQUIRED
47
48 No special priviledges are required for this command.
49
50 =head1 SEE ALSO
51
52 L<afsd(8)>,
53 L<CellAlias(5)>,
54 L<fs_newalias(1)>
55
56 =head1 COPYRIGHT
57
58 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
59
60 This documentation is covered by the IBM Public License Version 1.0. This
61 man page was written by Jason Edgecombe for OpenAFS.