doc: fs manpage fixes
[openafs.git] / doc / man-pages / pod1 / fs_whichcell.pod
1 =head1 NAME
2
3 fs_whichcell - Returns the cell to which a file or directory belongs
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs whichcell> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
11
12 B<fs whi > S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
13
14 =for html
15 </div>
16
17 =head1 DESCRIPTION
18
19 The B<fs whichcell> command returns the name of the cell in which the
20 volume that houses each indicated directory or file resides.
21
22 To display the file server machine on which the volume housing a directory
23 or file resides, use the B<fs whichcell> command. To display the cell
24 membership of the local machine, use the B<fs wscell> command.
25
26 =head1 OPTIONS
27
28 =over 4
29
30 =item B<-path> <I<dir/file path>>+
31
32 Names each AFS file or directory for which to return the cell
33 membership. Partial pathnames are interpreted relative to the current
34 working directory, which is also the default value if this argument is
35 omitted.
36
37 =item B<-help>
38
39 Prints the online help for this command. All other valid options are
40 ignored.
41
42 =back
43
44 =head1 OUTPUT
45
46 The output includes a line for each directory or file, naming the cell to
47 which the volume that houses the directory or file resides.
48
49 =head1 EXAMPLES
50
51 The following example shows that the current working directory resides in
52 a volume in the Example Corporation cell:
53
54    % fs whichcell
55    File . lives in cell 'example.com'
56
57 =head1 PRIVILEGE REQUIRED
58
59 None
60
61 =head1 SEE ALSO
62
63 L<fs_wscell(1)>,
64 L<fs_whereis(1)>
65
66 =head1 COPYRIGHT
67
68 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
69
70 This documentation is covered by the IBM Public License Version 1.0.  It was
71 converted from HTML to POD by software written by Chas Williams and Russ
72 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.