xnu-1228.7.58.tar.gz

[apple/xnu.git] / bsd / man / man2 / readlink.2

diff --git a/bsd/man/man2/readlink.2 b/bsd/man/man2/readlink.2
index 0a604f256939460bd6ace5ca501213e66873b224..acd80233f662bcad319ecaf161041cc648aeb755 100644 (file)
--- a/bsd/man/man2/readlink.2
+++ b/bsd/man/man2/readlink.2
@@ -41,8 +41,12 @@
 .Nd read value of a symbolic link
 .Sh SYNOPSIS
 .Fd #include <unistd.h>
-.Ft int
-.Fn readlink "const char *path" "char *buf" "int bufsiz"
+.Ft  ssize_t
+.Fo readlink
+.Fa "const char *restrict path"
+.Fa "char *restrict buf"
+.Fa "size_t bufsize"
+.Fc
 .Sh DESCRIPTION
 .Fn Readlink
 places the contents of the symbolic link
@@ -50,7 +54,7 @@ places the contents of the symbolic link
 in the buffer
 .Fa buf ,
 which has size
-.Fa bufsiz .
+.Fa bufsize .
 .Nm Readlink
 does not append a
 .Dv NUL
@@ -65,33 +69,58 @@ code in the global variable
 .Fn Readlink
 will fail if:
 .Bl -tag -width Er
-.It Bq Er ENOTDIR
-A component of the path prefix is not a directory.
+.\" ===========
+.It Bq Er EACCES
+Search permission is denied for a component of the path prefix.
+.\" ===========
+.It Bq Er EFAULT
+.Fa Buf
+extends outside the process's allocated address space.
+.\" ===========
+.It Bq Er EINVAL
+The named file is not a symbolic link.
+.\" ===========
+.It Bq Er EIO
+An I/O error occurred while reading from the file system.
+.\" ===========
+.It Bq Er ELOOP
+Too many symbolic links are encountered in translating the pathname.
+This is taken to be indicative of a looping symbolic link.
+.\" ===========
 .It Bq Er ENAMETOOLONG
 A component of a pathname exceeded 
 .Dv {NAME_MAX}
-characters, or an entire path name exceeded 
+characters, or an entire path name
+(possibly expanded by a symbolic link) exceeded 
 .Dv {PATH_MAX}
 characters.
+.\" ===========
 .It Bq Er ENOENT
 The named file does not exist.
-.It Bq Er EACCES
-Search permission is denied for a component of the path prefix.
-.It Bq Er ELOOP
-Too many symbolic links were encountered in translating the pathname.
-.It Bq Er EINVAL
-The named file is not a symbolic link.
-.It Bq Er EIO
-An I/O error occurred while reading from the file system.
-.It Bq Er EFAULT
-.Fa Buf
-extends outside the process's allocated address space.
+.\" ===========
+.It Bq Er ENOTDIR
+A component of the path prefix is not a directory.
 .El
+.Sh LEGACY SYNOPSIS
+.Fd #include <unistd.h>
+.Pp
+.Ft int
+.br
+.Fo readlink
+.Fa "const char *path"
+.Fa "char *buf"
+.Fa "int bufsize"
+.Fc ;
+.Pp
+The function type and the type of
+.Fa bufsize
+have changed.
 .Sh SEE ALSO
-.Xr stat 2 ,
 .Xr lstat 2 ,
-.Xr symlink 2
-.Xr symlink 7 ,
+.Xr stat 2 ,
+.Xr symlink 2 ,
+.Xr compat 5 ,
+.Xr symlink 7
 .Sh HISTORY
 The
 .Fn readlink