49d7b042f54444080a7ab343dde54c93160ed886
[openafs.git] / doc / man-pages / pod1 / fs_getfid.pod
1 =head1 NAME
2
3 fs_getfid - Display the fid for a given path in AFS
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<fs getfid> S<<< [B<-path>] I<path> >>> [B<-help>]
11
12 =for html
13 </div>
14
15 =head1 DESCRIPTION
16
17 The fs getfid command displays the FID for a given path in AFS.  The FID
18 is the internal identifier used by AFS encoding the volume name and the
19 file within a volume.
20
21 =head1 CAUTIONS
22
23 This command is not available on Windows prior to version 1.5.60.
24
25 =head1 OPTIONS
26
27 =over 4
28
29 =item B<-path> I<path>
30
31 The path of the file (or directory).
32
33 =item B<-literal>
34
35 Windows only: for a symlink or mount point, evaluates the specified object
36 rather than the object it refers to.
37
38 =item B<-help>
39
40 Prints the online help for this command. All other valid options are
41 ignored.
42
43 =back
44
45 =head1 OUTPUT
46
47 The output contains the name of the file or directory, the FID, and the
48 volume containing the FID.  The Windows version also outputs the object
49 type instead of using "File" to describe all objects.
50
51 =head1 EXAMPLES
52
53 On Unix:
54
55    % fs getfid .
56    File . (536870918.1.1) contained in volume 536870918
57
58    % fs getfid /afs/example.com/foo 
59    File /afs/example.com/foo (536870918.20404.20997) contained in volume 536870918
60
61 On Windows:
62
63    % fs.exe getfid \\afs\example.edu\user\b\o\bob \
64        \\afs\example.org\usr\bob\linktests\broken
65    Directory \\afs\example.edu\user\b\o\bob (537235559.1.1) contained in cell example.edu
66    fs: File '\\afs\example.org\usr\bob\linktests\broken' doesn't exist
67
68    % fs.exe getfid \\afs\example.edu\user\b\o\bob \
69        \\afs\example.org\usr\bob\linktests\broken -literal
70    Mountpoint \\afs\example.edu\user\b\o\bob (536873032.1162.16997) contained in cell example.edu
71    Symlink \\afs\example.org\usr\bob\linktests\broken (536874416.27618.488969) contained in cell example.org
72
73 =head1 PRIVILEGE REQUIRED
74
75 The issuer must be have read access in the directory containing the path
76 to be resolved.
77
78 =head1 COPYRIGHT
79
80 This document was written by Steven Jenkins, and is released under the IBM
81 Public License Version 1.0.  Jeffrey Altman made several suggestions and
82 additions.