lib/libc/gen/getcwd.3

   1 .\" Copyright (c) 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)getcwd.3    8.2 (Berkeley) 12/11/93
  33 .\" $FreeBSD: src/lib/libc/gen/getcwd.3,v 1.7.2.6 2001/12/14 18:33:51 ru Exp $
  34 .\" $DragonFly: src/lib/libc/gen/getcwd.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
  35 .\"
  36 .Dd November 24, 1997
  37 .Dt GETCWD 3
  38 .Os
  39 .Sh NAME
  40 .Nm getcwd ,
  41 .Nm getwd
  42 .Nd get working directory pathname
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In unistd.h
  47 .Ft char *
  48 .Fn getcwd "char *buf" "size_t size"
  49 .Ft char *
  50 .Fn getwd "char *buf"
  51 .Sh DESCRIPTION
  52 The
  53 .Fn getcwd
  54 function copies the absolute pathname of the current working directory
  55 into the memory referenced by
  56 .Fa buf
  57 and returns a pointer to
  58 .Fa buf .
  59 The
  60 .Fa size
  61 argument is the size, in bytes, of the array referenced by
  62 .Fa buf .
  63 .Pp
  64 If
  65 .Fa buf
  66 is
  67 .Dv NULL ,
  68 space is allocated as necessary to store the pathname.
  69 This space may later be
  70 .Xr free 3 Ns 'd .
  71 .Pp
  72 The function
  73 .Fn getwd
  74 is a compatibility routine which calls
  75 .Fn getcwd
  76 with its
  77 .Fa buf
  78 argument and a size of
  79 .Dv MAXPATHLEN
  80 (as defined in the include
  81 file
  82 .Aq Pa sys/param.h ) .
  83 Obviously,
  84 .Fa buf
  85 should be at least
  86 .Dv MAXPATHLEN
  87 bytes in length.
  88 .Pp
  89 These routines have traditionally been used by programs to save the
  90 name of a working directory for the purpose of returning to it.
  91 A much faster and less error-prone method of accomplishing this is to
  92 open the current directory
  93 .Pq Ql .\&
  94 and use the
  95 .Xr fchdir 2
  96 function to return.
  97 .Sh RETURN VALUES
  98 Upon successful completion, a pointer to the pathname is returned.
  99 Otherwise a
 100 .Dv NULL
 101 pointer is returned and the global variable
 102 .Va errno
 103 is set to indicate the error.
 104 In addition,
 105 .Fn getwd
 106 copies the error message associated with
 107 .Va errno
 108 into the memory referenced by
 109 .Fa buf .
 110 .Sh ERRORS
 111 The
 112 .Fn getcwd
 113 function
 114 will fail if:
 115 .Bl -tag -width Er
 116 .It Bq Er EACCES
 117 Read or search permission was denied for a component of the pathname.
 118 .It Bq Er EINVAL
 119 The
 120 .Fa size
 121 argument is zero.
 122 .It Bq Er ENOENT
 123 A component of the pathname no longer exists.
 124 .It Bq Er ENOMEM
 125 Insufficient memory is available.
 126 .It Bq Er ERANGE
 127 The
 128 .Fa size
 129 argument is greater than zero but smaller than the length of the pathname
 130 plus 1.
 131 .El
 132 .Sh SEE ALSO
 133 .Xr chdir 2 ,
 134 .Xr fchdir 2 ,
 135 .Xr malloc 3 ,
 136 .Xr strerror 3
 137 .Sh STANDARDS
 138 The
 139 .Fn getcwd
 140 function
 141 conforms to
 142 .St -p1003.1-90 .
 143 The ability to specify a
 144 .Dv NULL
 145 pointer and have
 146 .Fn getcwd
 147 allocate memory as necessary is an extension.
 148 .Sh HISTORY
 149 The
 150 .Fn getwd
 151 function appeared in
 152 .Bx 4.0 .
 153 .Sh BUGS
 154 The
 155 .Fn getwd
 156 function
 157 does not do sufficient error checking and is not able to return very
 158 long, but valid, paths.
 159 It is provided for compatibility.