1.\" Copyright (c) 1994, 2020 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. Neither the name of the University nor the names of its contributors 16.\" may be used to endorse or promote products derived from this software 17.\" without specific prior written permission. 18.\" 19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29.\" SUCH DAMAGE. 30.\" 31.\" @(#)realpath.3 8.2 (Berkeley) 2/16/94 32.\" $FreeBSD: head/lib/libc/stdlib/realpath.3 251672 2013-06-13 00:19:30Z emaste $ 33.\" 34.Dd March 18, 2015 35.Dt REALPATH 3 36.Os 37.Sh NAME 38.Nm realpath 39.Nd returns the canonicalized absolute pathname 40.Sh LIBRARY 41.Lb libc 42.Sh SYNOPSIS 43.In stdlib.h 44.Ft "char *" 45.Fn realpath "const char * restrict pathname" "char * restrict resolved_path" 46.Sh DESCRIPTION 47The 48.Fn realpath 49function resolves all symbolic links, extra 50.Dq / 51characters and references to 52.Pa /./ 53and 54.Pa /../ 55in 56.Fa pathname , 57and copies the resulting absolute pathname into 58the memory pointed to by 59.Fa resolved_path . 60The 61.Fa resolved_path 62argument 63.Em must 64point to a buffer capable of storing at least 65.Dv PATH_MAX 66characters, or be 67.Dv NULL . 68.Pp 69The 70.Fn realpath 71function will resolve both absolute and relative paths 72and return the absolute pathname corresponding to 73.Fa pathname . 74All components of 75.Fa pathname 76must exist when 77.Fn realpath 78is called, and all but the last component must name either directories or 79symlinks pointing to the directories. 80.Sh "RETURN VALUES" 81The 82.Fn realpath 83function returns 84.Fa resolved_path 85on success. 86If the function was supplied 87.Dv NULL 88as 89.Fa resolved_path , 90and operation did not cause errors, the returned value is 91a null-terminated string in a buffer allocated by a call to 92.Fn malloc 3 . 93If an error occurs, 94.Fn realpath 95returns 96.Dv NULL , 97and if 98.Fa resolved_path 99is not 100.Dv NULL , 101the array that it points to contains the pathname which caused the problem. 102.Sh ERRORS 103The function 104.Fn realpath 105may fail and set the external variable 106.Va errno 107for any of the errors specified for the library functions 108.Xr lstat 2 , 109.Xr readlink 2 110and 111.Xr getcwd 3 . 112.Sh SEE ALSO 113.Xr __realpath 2 , 114.Xr getcwd 3 115.\" .Sh STANDARDS 116.\" The 117.\" .Fn realpath 118.\" function conforms to 119.\" .St -p1003.1-2008 . 120.Sh HISTORY 121The 122.Fn realpath 123function first appeared in 124.Bx 4.4 . 125.Sh CAVEATS 126This implementation of 127.Fn realpath 128differs slightly from the Solaris implementation. 129The 130.Bx 4.4 131version always returns absolute pathnames, 132whereas the Solaris implementation will, 133under certain circumstances, return a relative 134.Fa resolved_path 135when given a relative 136.Fa pathname . 137