1 .\" Copyright 2015 Garrett D'Amore <garrett@damore.org>
   2 .\" Copyright (c) 1992, X/Open Company Limited All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .Dd Mar 30, 2015
  11 .Dt GETWD 3C
  12 .Os
  13 .Sh NAME
  14 .Nm getwd
  15 .Nd get current working directory pathname
  17 .In unistd.h
  18 .Ft "char *"
  19 .Fn getwd "char *path_name"
  21 The
  22 .Fn getwd
  23 function determines an absolute pathname of the current
  24 working directory of the calling process, and copies that pathname into the
  25 array pointed to by the
  26 .Fa path_name
  27 argument.
  28 .Lp
  29 If the length of the pathname of the current working directory is greater than
  30 .Pq Dv PATH_MAX + 1
  31 including the null byte,
  32 .Fn getwd
  33 fails and returns a null pointer.
  35 Upon successful completion, a pointer to the string containing the absolute
  36 pathname of the current working directory is returned.  Otherwise,
  37 .Fn getwd
  38 returns a null pointer and the contents of the array pointed to by
  39 .Fa path_name
  40 are undefined.
  41 .Sh ERRORS
  42 No errors are defined.
  43 .Sh USAGE
  44 The
  45 .Fn getwd
  46 function is supplied for backwards compatibility.  The
  47 .Xr getcwd 3C
  48 should be used instead.
  50 .Sy Obsolete Standard .
  51 .Sh SEE ALSO
  52 .Xr getcwd 3C ,
  53 .Xr standards 5
  55 The
  56 .Fn getwd
  57 function is available in the following compilation environments. See
  58 .Xr standards 5 .
  59 .Lp
  60 .Bl -bullet -compact
  61 .It
  62 .St -xpg4.2
  63 .It
  64 .St -susv2
  65 .It
  66 .St -susv3
  67 .El
  68 .Lp
  69 It was marked obsolete in
  70 .St -susv3
  71 and removed from
  72 .St -p1003.1-2008 .