1 .\" Copyright (c) 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" @(#)getcwd.3 8.2 (Berkeley) 12/11/93
33 .\" $FreeBSD: src/lib/libc/gen/getcwd.3,v 1.15 2001/10/01 16:08:51 ru Exp $
41 .Nd get working directory pathname
47 .Fn getcwd "char *buf" "size_t size"
53 function copies the absolute pathname of the current working directory
54 into the memory referenced by
56 and returns a pointer to
60 argument is the size, in bytes, of the array referenced by
67 space is allocated as necessary to store the pathname.
68 This space may later be
73 is a compatibility routine which calls
77 argument and a size of
79 (as defined in the include
81 .Aq Pa sys/param.h ) .
88 These routines have traditionally been used by programs to save the
89 name of a working directory for the purpose of returning to it.
90 A much faster and less error-prone method of accomplishing this is to
91 open the current directory
97 Upon successful completion, a pointer to the pathname is returned.
100 pointer is returned and the global variable
102 is set to indicate the error.
105 copies the error message associated with
107 into the memory referenced by
116 Read or search permission was denied for a component of the pathname.
122 A component of the pathname no longer exists.
124 Insufficient memory is available.
128 argument is greater than zero but smaller than the length of the pathname
142 The ability to specify a
146 allocate memory as necessary is an extension.
156 does not do sufficient error checking and is not able to return very
157 long, but valid, paths.
158 It is provided for compatibility.