|File: [cvs.NetBSD.org] / src / lib / libc / gen / realpath.3 (download)
Revision 1.16, Tue Mar 5 03:11:27 2013 UTC (13 months, 2 weeks ago) by enami
CVS Tags: agc-symver-base, agc-symver
Changes since 1.15: +3 -3
- Refer the argument with correct name.
- Mark up the function as a function like rest of this paragraph does.
.\" $NetBSD: realpath.3,v 1.16 2013/03/05 03:11:27 enami 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 June 21, 2012
.Dt REALPATH 3
.Nd returns the canonicalized absolute pathname
.Ft "char *"
.Fn realpath "const char * restrict pathname" "char * restrict resolvedname"
function resolves all symbolic links, extra
characters and references to
.Fa pathname ,
and copies the resulting absolute pathname into
the memory referenced by
.Fa resolvedname .
refer to a buffer capable of storing at least
characters, or be
.Dv NULL .
function will resolve both absolute and relative paths
and return the absolute pathname corresponding to
.Fa pathname .
.Sh RETURN VALUES
.Dv NULL ,
it will be allocated and the returned pointer can be deallocated using
.Xr free 3 .
If an error occurs,
.Dv NULL ,
was not allocated by
.Fn realpath ,
it will contain the pathname which caused the problem.
may fail and set the external variable
for any of the errors specified for the library functions
.Xr chdir 2 ,
.Xr close 2 ,
.Xr fchdir 2 ,
.Xr lstat 2 ,
.Xr malloc 3 ,
.Xr open 2 ,
.Xr readlink 2
.Xr getcwd 3 .
.Sh SEE ALSO
.Xr getcwd 3
first appeared in
and is part of
.St -p1003.1-2001 .
function call first appeared in
.Bx 4.4 .
the function was updated to accept a
pointer for the
This implementation of
differs slightly from the Solaris implementation.
version always returns absolute pathnames,
whereas the Solaris implementation will,
under certain circumstances, return a relative
when given a relative
.Fa pathname .