share/man/man3c/realpath.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  45 .\" Copyright (c) 2003, Sun Microsystems, Inc.  All Rights Reserved.
  46 .\" Copyright (c) 2014, Joyent, Inc.
  47 .\"
  48 .TH REALPATH 3C "Dec 20, 2014"
  49 .SH NAME
  50 realpath, canonicalize_file_name \- resolve pathname
  51 .SH SYNOPSIS
  52 .LP
  53 .nf
  54 #include <stdlib.h>
  55
  56 \fBchar *\fR\fBrealpath\fR(\fBconst char *restrict\fR \fIfile_name\fR,
  57      \fBchar *restrict\fR \fIresolved_name\fR);
  58
  59 \fBchar *\fR\fBcanonicalize_file_name\fR(\fBconst char *\fR\fIpath\fR);
  60 .fi
  61
  62 .SH DESCRIPTION
  63 .LP
  64 The \fBrealpath()\fR function derives, from the pathname pointed to by
  65 \fIfile_name\fR, an absolute pathname that names the same file, whose
  66 resolution does not involve "\fB\&.\fR", "\fB\&..\fR", or symbolic links. The
  67 generated pathname is stored as a null-terminated string, up to a maximum of
  68 {\fBPATH_MAX\fR} bytes (defined in \fBlimits.h\fR(3HEAD)), in the buffer
  69 pointed to by \fIresolved_name\fR.
  70 .sp
  71 .LP
  72 The \fBcanonicalize_file_name()\fR function is equivalent to calling
  73 \fBrealpath\fR(\fIpath\fR, \fINULL\fR). This function is only provided for
  74 compatibility.
  75 .SH RETURN VALUES
  76 .LP
  77 On successful completion, \fBrealpath()\fR returns a pointer to the resolved
  78 name.  Otherwise, \fBrealpath()\fR returns a null pointer and sets \fBerrno\fR
  79 to indicate the error, and the contents of the buffer pointed to by
  80 \fIresolved_name\fR are left in an indeterminate state.
  81 .SH ERRORS
  82 .LP
  83 The \fBrealpath()\fR function will fail if:
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBEACCES\fR\fR
  88 .ad
  89 .RS 16n
  90 Read or search permission was denied for a component of \fIfile_name\fR.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fBEINVAL\fR\fR
  97 .ad
  98 .RS 16n
  99 Either the \fIfile_name\fR or \fIresolved_name\fR argument is a null pointer.
 100 .RE
 101
 102 .sp
 103 .ne 2
 104 .na
 105 \fB\fBEIO\fR\fR
 106 .ad
 107 .RS 16n
 108 An error occurred while reading from the file system.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBELOOP\fR\fR
 115 .ad
 116 .RS 16n
 117 Too many symbolic links were encountered in resolving \fIfile_name\fR.
 118 .RE
 119
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBELOOP\fR\fR
 124 .ad
 125 .RS 16n
 126 A loop exists in symbolic links encountered during resolution of the
 127 \fIfile_name\fR argument.
 128 .RE
 129
 130 .sp
 131 .ne 2
 132 .na
 133 \fB\fBENAMETOOLONG\fR\fR
 134 .ad
 135 .RS 16n
 136 The \fIfile_name\fR argument is longer than {\fBPATH_MAX\fR} or a pathname
 137 component is longer than {\fBNAME_MAX\fR}.
 138 .RE
 139
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fBENOENT\fR\fR
 144 .ad
 145 .RS 16n
 146 A component of \fIfile_name\fR does not name an existing file or
 147 \fIfile_name\fR points to an empty string.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBENOTDIR\fR\fR
 154 .ad
 155 .RS 16n
 156 A component of the path prefix is not a directory.
 157 .RE
 158
 159 .sp
 160 .LP
 161 The \fBrealpath()\fR function may fail if:
 162 .sp
 163 .ne 2
 164 .na
 165 \fB\fBENAMETOOLONG\fR\fR
 166 .ad
 167 .RS 16n
 168 Pathname resolution of a symbolic link produced an intermediate result whose
 169 length exceeds {\fBPATH_MAX\fR}.
 170 .RE
 171
 172 .sp
 173 .ne 2
 174 .na
 175 \fB\fBENOMEM\fR\fR
 176 .ad
 177 .RS 16n
 178 Insufficient storage space is available.
 179 .RE
 180
 181 .SH USAGE
 182 .LP
 183 The \fBrealpath()\fR function operates on null-terminated strings.
 184 .sp
 185 .LP
 186 Execute permission is required for all the directories in the given and the
 187 resolved path.
 188 .sp
 189 .LP
 190 The \fBrealpath()\fR function might fail to return to the current directory if
 191 an error occurs.
 192 .SH ATTRIBUTES
 193 .LP
 194 See \fBattributes\fR(5) for descriptions of the following attributes:
 195 .sp
 196
 197 .sp
 198 .TS
 199 box;
 200 c | c
 201 l | l .
 202 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 203 _
 204 Interface Stability     Standard
 205 _
 206 MT-Level        MT-Safe
 207 .TE
 208
 209 .SH SEE ALSO
 210 .LP
 211 \fBgetcwd\fR(3C), \fBlimits.h\fR(3HEAD), \fBsysconf\fR(3C),
 212 \fBattributes\fR(5), \fBstandards\fR(5)