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