freebsd-skq/lib/libc/sys/getfh.2

.\" Copyright (c) 1989, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)getfh.2	8.1 (Berkeley) 6/9/93
.\" $FreeBSD$
.\"
.Dd April 14, 2011
.Dt GETFH 2
.Os
.Sh NAME
.Nm getfh ,
.Nm lgetfh
.Nd get file handle
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/param.h
.In sys/mount.h
.Ft int
.Fn getfh "const char *path" "fhandle_t *fhp"
.Ft int
.Fn lgetfh "const char *path" "fhandle_t *fhp"
.Sh DESCRIPTION
The
.Fn getfh
system call
returns a file handle for the specified file or directory
in the file handle pointed to by
.Fa fhp .
The
.Fn lgetfh
system call is like
.Fn getfh
except in the case where the named file is a symbolic link,
in which case
.Fn lgetfh
returns information about the link,
while
.Fn getfh
returns information about the file the link references.
These system calls are restricted to the superuser.
.Sh RETURN VALUES
.Rv -std
.Sh ERRORS
The
.Fn getfh
and
.Fn lgetfh
system calls
fail if one or more of the following are true:
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix of
.Fa path
is not a directory.
.It Bq Er ENAMETOOLONG
The length of a component of
.Fa path
exceeds 255 characters,
or the length of
.Fa path
exceeds 1023 characters.
.It Bq Er ENOENT
The file referred to by
.Fa path
does not exist.
.It Bq Er EACCES
Search permission is denied for a component of the path prefix of
.Fa path .
.It Bq Er ELOOP
Too many symbolic links were encountered in translating
.Fa path .
.It Bq Er EFAULT
The
.Fa fhp
argument
points to an invalid address.
.It Bq Er EIO
An
.Tn I/O
error occurred while reading from or writing to the file system.
.El
.Sh SEE ALSO
.Xr fhopen 2 ,
.Xr open 2 ,
.Xr stat 2
.Sh HISTORY
The
.Fn getfh
system call first appeared in
.Bx 4.4 .
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\" Copyright (c) 1989, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)getfh.2 8.1 (Berkeley) 6/9/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.\"`
getfh(2): Add xrefs for fhopen(2), open(2), stat(2). MFC after: 1 week 2011-04-14 22:06:11 +00:00			`.Dd April 14, 2011`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Dt GETFH 2`
			`.Os`
			`.Sh NAME`
Document lgetfh(2). 2004-04-05 10:17:56 +00:00			`.Nm getfh ,`
			`.Nm lgetfh`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Nd get file handle`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In sys/param.h`
			`.In sys/mount.h`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Ft int`
Fixed missing const(s) or #include(s) in synopsis. 1997-04-11 18:47:10 +00:00			`.Fn getfh "const char path" "fhandle_t fhp"`
Document lgetfh(2). 2004-04-05 10:17:56 +00:00			`.Ft int`
			`.Fn lgetfh "const char path" "fhandle_t fhp"`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh DESCRIPTION`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`The`
			`.Fn getfh`
			`system call`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`returns a file handle for the specified file or directory`
			`in the file handle pointed to by`
			`.Fa fhp .`
Document lgetfh(2). 2004-04-05 10:17:56 +00:00			`The`
			`.Fn lgetfh`
			`system call is like`
			`.Fn getfh`
			`except in the case where the named file is a symbolic link,`
			`in which case`
			`.Fn lgetfh`
			`returns information about the link,`
			`while`
			`.Fn getfh`
			`returns information about the file the link references.`
			`These system calls are restricted to the superuser.`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh RETURN VALUES`
Document lgetfh(2). 2004-04-05 10:17:56 +00:00			`.Rv -std`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh ERRORS`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`The`
			`.Fn getfh`
Document lgetfh(2). 2004-04-05 10:17:56 +00:00			`and`
Fix typos, spelling, formatting and mdoc mistakes found by Nobuyuki while translating these manual pages. Minor corrections by me. Submitted by: Nobuyuki Koganemaru <n-kogane@syd.odn.ne.jp> 2010-08-16 15:18:30 +00:00			`.Fn lgetfh`
Document lgetfh(2). 2004-04-05 10:17:56 +00:00			`system calls`
			`fail if one or more of the following are true:`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Bl -tag -width Er`
mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:02:00 +00:00			`.It Bq Er ENOTDIR`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`A component of the path prefix of`
			`.Fa path`
			`is not a directory.`
mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:02:00 +00:00			`.It Bq Er ENAMETOOLONG`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`The length of a component of`
			`.Fa path`
			`exceeds 255 characters,`
			`or the length of`
			`.Fa path`
			`exceeds 1023 characters.`
mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:02:00 +00:00			`.It Bq Er ENOENT`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`The file referred to by`
			`.Fa path`
			`does not exist.`
mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:02:00 +00:00			`.It Bq Er EACCES`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`Search permission is denied for a component of the path prefix of`
			`.Fa path .`
mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:02:00 +00:00			`.It Bq Er ELOOP`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`Too many symbolic links were encountered in translating`
			`.Fa path .`
mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:02:00 +00:00			`.It Bq Er EFAULT`
mdoc(7) police: "The .Fa argument.". 2002-12-19 09:40:28 +00:00			`The`
			`.Fa fhp`
			`argument`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`points to an invalid address.`
mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:02:00 +00:00			`.It Bq Er EIO`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`An`
			`.Tn I/O`
			`error occurred while reading from or writing to the file system.`
			`.El`
getfh(2): Add xrefs for fhopen(2), open(2), stat(2). MFC after: 1 week 2011-04-14 22:06:11 +00:00			`.Sh SEE ALSO`
			`.Xr fhopen 2 ,`
			`.Xr open 2 ,`
			`.Xr stat 2`
BSD 4.4 Lite Lib Sources 1994-05-27 05:00:24 +00:00			`.Sh HISTORY`
			`The`
Correctly use .Fn instead of .Nm to reference function names in a bunch of man pages. Use the correct .Bx (BSD UNIX) or .At (AT&T UNIX) macros instead of explicitly specifying the version in the text in a bunch of man pages. 1996-08-22 23:31:07 +00:00			`.Fn getfh`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call first appeared in`
Correctly use .Fn instead of .Nm to reference function names in a bunch of man pages. Use the correct .Bx (BSD UNIX) or .At (AT&T UNIX) macros instead of explicitly specifying the version in the text in a bunch of man pages. 1996-08-22 23:31:07 +00:00			`.Bx 4.4 .`