minix/lib/libc/gen/realpath.3
Lionel Sambuc 84d9c625bf Synchronize on NetBSD-CVS (2013/12/1 12:00:00 UTC)
- Fix for possible unset uid/gid in toproto
 - Fix for default mtree style
 - Update libelf
 - Importing libexecinfo
 - Resynchronize GCC, mpc, gmp, mpfr
 - build.sh: Replace params with show-params.
     This has been done as the make target has been renamed in the same
     way, while a new target named params has been added. This new
     target generates a file containing all the parameters, instead of
     printing it on the console.
 - Update test48 with new etc/services (Fix by Ben Gras <ben@minix3.org)
     get getservbyport() out of the inner loop

Change-Id: Ie6ad5226fa2621ff9f0dee8782ea48f9443d2091
2014-07-28 17:05:06 +02:00

163 lines
4.2 KiB
Groff

.\" $NetBSD: realpath.3,v 1.18 2013/05/24 09:35:11 wiz Exp $
.\"
.\" Copyright (c) 1994
.\" The Regents of the University of California. All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Jan-Simon Pendry.
.\"
.\" 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. 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.
.\"
.\" from: @(#)realpath.3 8.2 (Berkeley) 2/16/94
.\"
.Dd May 24, 2013
.Dt REALPATH 3
.Os
.Sh NAME
.Nm realpath
.Nd returns the canonicalized absolute pathname
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In sys/param.h
.In stdlib.h
.Ft "char *"
.Fn realpath "const char * restrict pathname" "char * restrict resolvedname"
.Sh DESCRIPTION
The
.Fn realpath
function resolves all symbolic links, extra
.Dq /
characters and references to
.Pa /./
and
.Pa /../
in
.Fa pathname ,
and copies the resulting absolute pathname into
the memory referenced by
.Fa resolvedname .
The
.Fa resolvedname
argument
.Em must
refer to a buffer capable of storing at least
.Dv MAXPATHLEN
characters, or be
.Dv NULL .
.Pp
The
.Fn realpath
function will resolve both absolute and relative paths
and return the absolute pathname corresponding to
.Fa pathname .
.Sh RETURN VALUES
If
.Fa resolvedname
is
.Dv NULL ,
it will be allocated and the returned pointer can be deallocated using
.Xr free 3 .
The
.Fn realpath
function returns
.Fa resolvedname
on success.
If an error occurs,
.Fn realpath
returns
.Dv NULL ,
and
.Fa resolvedname
was not allocated by
.Fn realpath ,
it will contain the pathname which caused the problem.
.Sh ERRORS
The function
.Fn realpath
may fail and set the external variable
.Va errno
for any of the errors specified for the library functions
.\" First sorted by section, then by name.
.Xr lstat 2 ,
.Xr readlink 2 ,
.Xr getcwd 3
and
.Xr malloc 3 .
.Pp
In addition, the following errors may be reported:
.Bl -tag -width Er
.It Bq Er EINVAL
The value of the
.Fa pathname
argument is
.Dv NULL .
.It Bq Er ELOOP
Too many symbolic links were encountered in translating the
.Fa pathname .
.It Bq Er ENAMETOOLONG
The resulting absolute pathname exceeds
.Dv MAXPATHLEN
characters.
.It Bq Er ENOENT
The value of the
.Fa pathname
argument is an empty string;
or a symbolic link to an empty string is encountered.
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.El
.Sh SEE ALSO
.Xr getcwd 3
.Sh STANDARDS
.Fn realpath
first appeared in
.St -xpg4.2
and is part of
.St -p1003.1-2001 .
.Sh HISTORY
The
.Fn realpath
function call first appeared in
.Bx 4.4 .
In
.Nx 7.0
the function was updated to accept a
.Dv NULL
pointer for the
.Fa resolvedname
argument.
.Sh BUGS
This implementation of
.Fn realpath
differs slightly from the Solaris implementation.
The
.Bx 4.4
version always returns absolute pathnames,
whereas the Solaris implementation will,
under certain circumstances, return a relative
.Fa resolvedname
when given a relative
.Fa pathname .