lib/libc/sys/chdir.2

   1 .\" Copyright (c) 1980, 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 .\"     @(#)chdir.2     8.2 (Berkeley) 12/11/93
  33 .\" $FreeBSD: src/lib/libc/sys/chdir.2,v 1.7.2.5 2001/12/14 18:34:00 ru Exp $
  34 .\" $DragonFly: src/lib/libc/sys/chdir.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  35 .\"
  36 .Dd December 11, 1993
  37 .Dt CHDIR 2
  38 .Os
  39 .Sh NAME
  40 .Nm chdir ,
  41 .Nm fchdir
  42 .Nd change current working directory
  43 .Sh LIBRARY
  44 .Lb libc
  45 .Sh SYNOPSIS
  46 .In unistd.h
  47 .Ft int
  48 .Fn chdir "const char *path"
  49 .Ft int
  50 .Fn fchdir "int fd"
  51 .Sh DESCRIPTION
  52 The
  53 .Fa path
  54 argument points to the pathname of a directory.
  55 The
  56 .Fn chdir
  57 function
  58 causes the named directory
  59 to become the current working directory, that is,
  60 the starting point for path searches of pathnames not beginning with
  61 a slash,
  62 .Ql / .
  63 .Pp
  64 The
  65 .Fn fchdir
  66 function
  67 causes the directory referenced by
  68 .Fa fd
  69 to become the current working directory,
  70 the starting point for path searches of pathnames not beginning with
  71 a slash,
  72 .Ql / .
  73 .Pp
  74 In order for a directory to become the current directory,
  75 a process must have execute (search) access to the directory.
  76 .Sh RETURN VALUES
  77 .Rv -std
  78 .Sh ERRORS
  79 .Fn Chdir
  80 will fail and the current working directory will be unchanged if
  81 one or more of the following are true:
  82 .Bl -tag -width Er
  83 .It Bq Er ENOTDIR
  84 A component of the path prefix is not a directory.
  85 .It Bq Er ENAMETOOLONG
  86 A component of a pathname exceeded 255 characters,
  87 or an entire path name exceeded 1023 characters.
  88 .It Bq Er ENOENT
  89 The named directory does not exist.
  90 .It Bq Er ELOOP
  91 Too many symbolic links were encountered in translating the pathname.
  92 .It Bq Er EACCES
  93 Search permission is denied for any component of
  94 the path name.
  95 .It Bq Er EFAULT
  96 .Fa Path
  97 points outside the process's allocated address space.
  98 .It Bq Er EIO
  99 An I/O error occurred while reading from or writing to the file system.
 100 .El
 101 .Pp
 102 .Fn Fchdir
 103 will fail and the current working directory will be unchanged if
 104 one or more of the following are true:
 105 .Bl -tag -width Er
 106 .It Bq Er EACCES
 107 Search permission is denied for the directory referenced by the
 108 file descriptor.
 109 .It Bq Er ENOTDIR
 110 The file descriptor does not reference a directory.
 111 .It Bq Er EBADF
 112 The argument
 113 .Fa fd
 114 is not a valid file descriptor.
 115 .El
 116 .Sh SEE ALSO
 117 .Xr chroot 2
 118 .Sh STANDARDS
 119 The
 120 .Fn chdir
 121 function call is expected to conform to
 122 .St -p1003.1-90 .
 123 .Sh HISTORY
 124 A
 125 .Fn chdir
 126 function call appeared in
 127 .At v7 .
 128 The
 129 .Fn fchdir
 130 function call
 131 appeared in
 132 .Bx 4.2 .