BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / sys / getfh.2

diff --git a/usr/src/lib/libc/sys/getfh.2 b/usr/src/lib/libc/sys/getfh.2
index d27914a..afaf380 100644 (file)
--- a/usr/src/lib/libc/sys/getfh.2
+++ b/usr/src/lib/libc/sys/getfh.2
@@ -1,84 +1,96 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.

 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"

-.\" Redistribution and use in source and binary forms are permitted
-.\" provided that the above copyright notice and this paragraph are
-.\" duplicated in all such forms and that any documentation,
-.\" advertising materials, and other materials related to such
-.\" distribution and use acknowledge that the software was developed
-.\" by the University of California, Berkeley.  The name of the
-.\" University may not be used to endorse or promote products derived
-.\" from this software without specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
-.\" IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
-.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" 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.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 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.

 .\"
 .\"

-.\"    @(#)getfh.2     6.1 (Berkeley) %G%
+.\" 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.

 .\"
 .\"

-.TH GETFH 2 ""
-.UC 7
-.SH NAME
-getfh \- get file handle
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/types.h>
-#include <sys/mount.h>
-.LP
-.ft B
-getfh(path, fhp)
-char *path;
-struct fhandle_t *fhp;
-.fi
-.ft R
-.SH DESCRIPTION
-.I Getfh
+.\"    @(#)getfh.2     6.4 (Berkeley) 7/23/91
+.\"
+.Dd July 23, 1991
+.Dt GETFH 2
+.Os
+.Sh NAME
+.Nm getfh
+.Nd get file handle
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/mount.h>
+.Ft int
+.Fn getfh "char *path" "struct fhandle_t *fhp"
+.Sh DESCRIPTION
+.Fn Getfh

 returns a file handle for the specified file or directory
 in the file handle pointed to by
 returns a file handle for the specified file or directory
 in the file handle pointed to by

-.I fhp .
+.Fa fhp .

 This system call is restricted to the superuser.
 This system call is restricted to the superuser.

-.SH RETURN VALUE
+.Sh RETURN VALUES

 Upon successful completion, a value of 0 is returned.
 Upon successful completion, a value of 0 is returned.

-Otherwise, \-1 is returned and the global variable
-.I errno
+Otherwise, -1 is returned and the global variable
+.Va errno

 is set to indicate the error.
 is set to indicate the error.

-.SH ERRORS
-.I Getfh
+.Sh ERRORS
+.Fn Getfh

 fails if one or more of the following are true:
 fails if one or more of the following are true:

-.TP 15
-ENOTDIR
+.Bl -tag -width Er
+.It Bq ENOTDIR

 A component of the path prefix of
 A component of the path prefix of

-.I path
+.Fa path

 is not a directory.
 is not a directory.

-.TP 15
-EINVAL
-.I path
+.It Bq EINVAL
+.Fa path

 contains a character with the high-order bit set.
 contains a character with the high-order bit set.

-.TP 15
-ENAMETOOLONG
+.It Bq ENAMETOOLONG

 The length of a component of
 The length of a component of

-.I path
+.Fa path

 exceeds 255 characters,
 or the length of
 exceeds 255 characters,
 or the length of

-.I path
+.Fa path

 exceeds 1023 characters.
 exceeds 1023 characters.

-.TP 15
-ENOENT
+.It Bq ENOENT

 The file referred to by
 The file referred to by

-.I path
+.Fa path

 does not exist.
 does not exist.

-.TP 15
-EACCES
+.It Bq EACCES

 Search permission is denied for a component of the path prefix of
 Search permission is denied for a component of the path prefix of

-.IR path .
-.TP 15
-ELOOP
+.Fa path .
+.It Bq ELOOP

 Too many symbolic links were encountered in translating
 Too many symbolic links were encountered in translating

-.IR path .
-.TP 15
-EFAULT
-.I Fhp
+.Fa path .
+.It Bq EFAULT
+.Fa Fhp

 points to an invalid address.
 points to an invalid address.

-.TP 15
-EIO
-An I/O error occurred while reading from or writing to the file system.
+.It Bq EIO
+An
+.Tn I/O
+error occurred while reading from or writing to the file system.
+.El
+.Sh HISTORY
+The
+.Nm getfh
+function call is
+.Ud .