.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "FS_GETFID 1"
.TH FS_GETFID 1 2024-03-20 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
fs_getfid \- Display the fid for a given path in AFS
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBfs getfid\fR [\fB\-path\fR]\ \fIpath\fR [\fB\-literal\fR] [\fB\-help\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The fs getfid command displays the FID for a given path in AFS.  The FID
is the internal identifier used by AFS encoding the volume name and the
file within a volume.
.SH CAUTIONS
.IX Header "CAUTIONS"
This command is not available on Windows prior to version 1.5.60.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-path\fR \fIpath\fR" 4
.IX Item "-path path"
The path of the file (or directory).
.IP \fB\-literal\fR 4
.IX Item "-literal"
For a symlink or mount point, evaluates the specified object rather than
the object it refers to.
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH OUTPUT
.IX Header "OUTPUT"
The output contains the name of the file or directory, the FID, and the
volume containing the FID.  The Windows version also outputs the object
type instead of using "File" to describe all objects.
.SH EXAMPLES
.IX Header "EXAMPLES"
On Unix:
.PP
.Vb 2
\&   % fs getfid .
\&   File . (536870918.1.1) contained in volume 536870918
\&
\&   % fs getfid /afs/example.com/foo 
\&   File /afs/example.com/foo (536870918.20404.20997) contained in volume 536870918
.Ve
.PP
On Windows:
.PP
.Vb 4
\&   % fs.exe getfid \e\eafs\eexample.edu\euser\eb\eo\ebob \e
\&       \e\eafs\eexample.org\eusr\ebob\elinktests\ebroken
\&   Directory \e\eafs\eexample.edu\euser\eb\eo\ebob (537235559.1.1) contained in cell example.edu
\&   fs: File \*(Aq\e\eafs\eexample.org\eusr\ebob\elinktests\ebroken\*(Aq doesn\*(Aqt exist
\&
\&   % fs.exe getfid \e\eafs\eexample.edu\euser\eb\eo\ebob \e
\&       \e\eafs\eexample.org\eusr\ebob\elinktests\ebroken \-literal
\&   Mountpoint \e\eafs\eexample.edu\euser\eb\eo\ebob (536873032.1162.16997) contained in cell example.edu
\&   Symlink \e\eafs\eexample.org\eusr\ebob\elinktests\ebroken (536874416.27618.488969) contained in cell example.org
.Ve
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
The issuer must be have read access in the directory containing the path
to be resolved.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
This document was written by Steven Jenkins, and is released under the IBM
Public License Version 1.0.  Jeffrey Altman made several suggestions and
additions.