lib/libc/stdlib/realpath.3

   1 .\" Copyright (c) 1994
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Jan-Simon Pendry.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\" 3. All advertising materials mentioning features or use of this software
  16 .\"    must display the following acknowledgement:
  17 .\"     This product includes software developed by the University of
  18 .\"     California, Berkeley and its contributors.
  19 .\" 4. Neither the name of the University nor the names of its contributors
  20 .\"    may be used to endorse or promote products derived from this software
  21 .\"    without specific prior written permission.
  22 .\"
  23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  33 .\" SUCH DAMAGE.
  34 .\"
  35 .\"     @(#)realpath.3  8.2 (Berkeley) 2/16/94
  36 .\" $FreeBSD: src/lib/libc/stdlib/realpath.3,v 1.7.2.3 2001/12/14 18:33:58 ru Exp $
  37 .\" $DragonFly: src/lib/libc/stdlib/realpath.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  38 .\"
  39 .Dd February 16, 1994
  40 .Dt REALPATH 3
  41 .Os
  42 .Sh NAME
  43 .Nm realpath
  44 .Nd returns the canonicalized absolute pathname
  45 .Sh LIBRARY
  46 .Lb libc
  47 .Sh SYNOPSIS
  48 .In sys/param.h
  49 .In stdlib.h
  50 .Ft "char *"
  51 .Fn realpath "const char *pathname" "char resolved_path[MAXPATHLEN]"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn realpath
  55 function resolves all symbolic links, extra
  56 .Dq /
  57 characters and references to
  58 .Pa /./
  59 and
  60 .Pa /../
  61 in
  62 .Fa pathname ,
  63 and copies the resulting absolute pathname into
  64 the memory referenced by
  65 .Fa resolved_path .
  66 The
  67 .Fa resolved_path
  68 argument
  69 .Em must
  70 refer to a buffer capable of storing at least
  71 .Dv MAXPATHLEN
  72 characters.
  73 .Pp
  74 The
  75 .Fn realpath
  76 function will resolve both absolute and relative paths
  77 and return the absolute pathname corresponding to
  78 .Fa pathname .
  79 All but the last component of
  80 .Fa pathname
  81 must exist when
  82 .Fn realpath
  83 is called.
  84 .Sh "RETURN VALUES"
  85 The
  86 .Fn realpath
  87 function returns
  88 .Fa resolved_path
  89 on success.
  90 If an error occurs,
  91 .Fn realpath
  92 returns
  93 .Dv NULL ,
  94 and
  95 .Fa resolved_path
  96 contains the pathname which caused the problem.
  97 .Sh ERRORS
  98 The function
  99 .Fn realpath
 100 may fail and set the external variable
 101 .Va errno
 102 for any of the errors specified for the library functions
 103 .Xr chdir 2 ,
 104 .Xr close 2 ,
 105 .Xr fchdir 2 ,
 106 .Xr lstat 2 ,
 107 .Xr open 2 ,
 108 .Xr readlink 2
 109 and
 110 .Xr getcwd 3 .
 111 .Sh CAVEATS
 112 This implementation of
 113 .Fn realpath
 114 differs slightly from the Solaris implementation.
 115 The
 116 .Bx 4.4
 117 version always returns absolute pathnames,
 118 whereas the Solaris implementation will,
 119 under certain circumstances, return a relative
 120 .Fa resolved_path
 121 when given a relative
 122 .Fa pathname .
 123 .Sh "SEE ALSO"
 124 .Xr getcwd 3
 125 .Sh HISTORY
 126 The
 127 .Fn realpath
 128 function call first appeared in
 129 .Bx 4.4 .