Merge 1.8.0~pre4 packaging into master
[pkg-k5-afs_openafs.git] / doc / man-pages / pod1 / fs_whereis.pod
blobaa4527431a5fc9bb5e5a27da94b8bde9cbec2f13
1 =head1 NAME
3 fs_whereis - Reports each file server housing a file or directory
5 =head1 SYNOPSIS
7 =for html
8 <div class="synopsis">
10 B<fs whereis> S<<< [B<-path> <I<dir/file path>>+] >>> [B<-help>]
12 B<fs whe> S<<< [B<-p> <I<dir/file path>>+] >>> [B<-h>]
14 =for html
15 </div>
17 =head1 DESCRIPTION
19 The B<fs whereis> command returns the name of each file server machine
20 that houses the volume containing each directory or file named by the
21 B<-path> argument.
23 =head1 OPTIONS
25 =over 4
27 =item B<-path> <I<dir/file path>>+
29 Names each AFS file or directory for which to return the host file server
30 machine. Partial pathnames are interpreted relative to the current working
31 directory, which is also the default value if this argument is omitted.
33 =item B<-help>
35 Prints the online help for this command. All other valid options are
36 ignored.
38 =back
40 =head1 OUTPUT
42 The output includes a line for each specified directory or file. It names
43 the file server machine on which the volume that houses the specified
44 directory or file resides. A list of multiple machines indicates that the
45 directory or file is in a replicated volume.
47 Machine names usually have a suffix indicating their cell membership. If
48 the cell is not clear, use the B<fs whichcell> command to display the cell
49 in which the directory or file resides. To display the cell membership of
50 the local machine, use the B<fs wscell> command.
52 =head1 EXAMPLES
54 The following example indicates that volume housing the directory
55 F</afs/example.com> resides is replicated on both C<fs1.example.com> and
56 C<fs3.example.com>:
58    % fs whereis -path /afs/example.com
59    File /afs/example.com is on hosts fs1.example.com fs3.example.com
61 =head1 PRIVILEGE REQUIRED
63 None
65 =head1 SEE ALSO
67 L<fs_whichcell(1)>,
68 L<fs_wscell(1)>
70 =head1 COPYRIGHT
72 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
74 This documentation is covered by the IBM Public License Version 1.0.  It was
75 converted from HTML to POD by software written by Chas Williams and Russ
76 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.