BSD 4_4 release

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

diff --git a/usr/src/lib/libc/sys/readlink.2 b/usr/src/lib/libc/sys/readlink.2
index 6b95e1b..4827110 100644 (file)
--- a/usr/src/lib/libc/sys/readlink.2
+++ b/usr/src/lib/libc/sys/readlink.2
@@ -1,67 +1,96 @@
-.\" Copyright (c) 1983 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1983, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\" %sccs.include.redist.man%
+.\" 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.

 .\"
 .\"

-.\"    @(#)readlink.2  6.7 (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 READLINK 2 ""
-.UC 5
-.SH NAME
-readlink \- read value of a symbolic link
-.SH SYNOPSIS
-.nf
-.ft B
-cc = readlink(path, buf, bufsiz)
-int cc;
-char *path, *buf;
-int bufsiz;
-.fi
-.ft R
-.SH DESCRIPTION
-.I Readlink
+.\"     @(#)readlink.2 8.1 (Berkeley) 6/4/93
+.\"
+.Dd June 4, 1993
+.Dt READLINK 2
+.Os BSD 4.2
+.Sh NAME
+.Nm readlink
+.Nd read value of a symbolic link
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft int
+.Fn readlink "const char *path" "char *buf" "int bufsiz"
+.Sh DESCRIPTION
+.Fn Readlink

 places the contents of the symbolic link
 places the contents of the symbolic link

-.I name
+.Fa path

 in the buffer
 in the buffer

-.I buf,
+.Fa buf ,

 which has size
 which has size

-.IR bufsiz . 
-The contents of the link are not null terminated when returned.
-.SH "RETURN VALUE
+.Fa bufsiz .
+.Nm Readlink
+does not append a
+.Dv NUL
+character to
+.Fa buf .
+.Sh RETURN VALUES

 The call returns the count of characters placed in the buffer
 The call returns the count of characters placed in the buffer

-if it succeeds, or a \-1 if an error occurs, placing the error
-code in the global variable \fIerrno\fP.
-.SH "ERRORS
-.I Readlink
+if it succeeds, or a -1 if an error occurs, placing the error
+code in the global variable
+.Va errno .
+.Sh ERRORS
+.Fn Readlink

 will fail if:
 will fail if:

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

 A component of the path prefix is not a directory.
 A component of the path prefix is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

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

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 The named file does not exist.
 The named file does not exist.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

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

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 Too many symbolic links were encountered in translating the pathname.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The named file is not a symbolic link.
 The named file is not a symbolic link.

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while reading from the file system.
 An I/O error occurred while reading from the file system.

-.TP 15
-[EFAULT]
-.I Buf
+.It Bq Er EFAULT
+.Fa Buf

 extends outside the process's allocated address space.
 extends outside the process's allocated address space.

-.SH SEE ALSO
-stat(2), lstat(2), symlink(2)
+.El
+.Sh SEE ALSO
+.Xr stat 2 ,
+.Xr lstat 2 ,
+.Xr symlink 2
+.Xr symlink 7 ,
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .