xref: /freebsd/lib/libsys/chdir.2 (revision 8269e7673cf033aba67dab8264fe719920c70f87)
1*8269e767SBrooks Davis.\" Copyright (c) 1980, 1991, 1993
2*8269e767SBrooks Davis.\"	The Regents of the University of California.  All rights reserved.
3*8269e767SBrooks Davis.\"
4*8269e767SBrooks Davis.\" Redistribution and use in source and binary forms, with or without
5*8269e767SBrooks Davis.\" modification, are permitted provided that the following conditions
6*8269e767SBrooks Davis.\" are met:
7*8269e767SBrooks Davis.\" 1. Redistributions of source code must retain the above copyright
8*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer.
9*8269e767SBrooks Davis.\" 2. Redistributions in binary form must reproduce the above copyright
10*8269e767SBrooks Davis.\"    notice, this list of conditions and the following disclaimer in the
11*8269e767SBrooks Davis.\"    documentation and/or other materials provided with the distribution.
12*8269e767SBrooks Davis.\" 3. Neither the name of the University nor the names of its contributors
13*8269e767SBrooks Davis.\"    may be used to endorse or promote products derived from this software
14*8269e767SBrooks Davis.\"    without specific prior written permission.
15*8269e767SBrooks Davis.\"
16*8269e767SBrooks Davis.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17*8269e767SBrooks Davis.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18*8269e767SBrooks Davis.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19*8269e767SBrooks Davis.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20*8269e767SBrooks Davis.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21*8269e767SBrooks Davis.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22*8269e767SBrooks Davis.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23*8269e767SBrooks Davis.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24*8269e767SBrooks Davis.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25*8269e767SBrooks Davis.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26*8269e767SBrooks Davis.\" SUCH DAMAGE.
27*8269e767SBrooks Davis.\"
28*8269e767SBrooks Davis.Dd March 30, 2020
29*8269e767SBrooks Davis.Dt CHDIR 2
30*8269e767SBrooks Davis.Os
31*8269e767SBrooks Davis.Sh NAME
32*8269e767SBrooks Davis.Nm chdir ,
33*8269e767SBrooks Davis.Nm fchdir
34*8269e767SBrooks Davis.Nd change current working directory
35*8269e767SBrooks Davis.Sh LIBRARY
36*8269e767SBrooks Davis.Lb libc
37*8269e767SBrooks Davis.Sh SYNOPSIS
38*8269e767SBrooks Davis.In unistd.h
39*8269e767SBrooks Davis.Ft int
40*8269e767SBrooks Davis.Fn chdir "const char *path"
41*8269e767SBrooks Davis.Ft int
42*8269e767SBrooks Davis.Fn fchdir "int fd"
43*8269e767SBrooks Davis.Sh DESCRIPTION
44*8269e767SBrooks DavisThe
45*8269e767SBrooks Davis.Fa path
46*8269e767SBrooks Davisargument points to the pathname of a directory.
47*8269e767SBrooks DavisThe
48*8269e767SBrooks Davis.Fn chdir
49*8269e767SBrooks Davissystem call
50*8269e767SBrooks Daviscauses the named directory
51*8269e767SBrooks Davisto become the current working directory, that is,
52*8269e767SBrooks Davisthe starting point for path searches of pathnames not beginning with
53*8269e767SBrooks Davisa slash,
54*8269e767SBrooks Davis.Ql / .
55*8269e767SBrooks Davis.Pp
56*8269e767SBrooks DavisThe
57*8269e767SBrooks Davis.Fn fchdir
58*8269e767SBrooks Davissystem call
59*8269e767SBrooks Daviscauses the directory referenced by
60*8269e767SBrooks Davis.Fa fd
61*8269e767SBrooks Davisto become the current working directory,
62*8269e767SBrooks Davisthe starting point for path searches of pathnames not beginning with
63*8269e767SBrooks Davisa slash,
64*8269e767SBrooks Davis.Ql / .
65*8269e767SBrooks Davis.Pp
66*8269e767SBrooks DavisIn order for a directory to become the current directory,
67*8269e767SBrooks Davisa process must have execute (search) access to the directory.
68*8269e767SBrooks Davis.Sh RETURN VALUES
69*8269e767SBrooks Davis.Rv -std
70*8269e767SBrooks Davis.Sh ERRORS
71*8269e767SBrooks DavisThe
72*8269e767SBrooks Davis.Fn chdir
73*8269e767SBrooks Davissystem call
74*8269e767SBrooks Daviswill fail and the current working directory will be unchanged if
75*8269e767SBrooks Davisone or more of the following are true:
76*8269e767SBrooks Davis.Bl -tag -width Er
77*8269e767SBrooks Davis.It Bq Er ENOTDIR
78*8269e767SBrooks DavisA component of the path prefix is not a directory.
79*8269e767SBrooks Davis.It Bq Er ENAMETOOLONG
80*8269e767SBrooks DavisA component of a pathname exceeded 255 characters,
81*8269e767SBrooks Davisor an entire path name exceeded 1023 characters.
82*8269e767SBrooks Davis.It Bq Er ENOENT
83*8269e767SBrooks DavisThe named directory does not exist.
84*8269e767SBrooks Davis.It Bq Er ELOOP
85*8269e767SBrooks DavisToo many symbolic links were encountered in translating the pathname.
86*8269e767SBrooks Davis.It Bq Er EACCES
87*8269e767SBrooks DavisSearch permission is denied for any component of
88*8269e767SBrooks Davisthe path name.
89*8269e767SBrooks Davis.It Bq Er EFAULT
90*8269e767SBrooks DavisThe
91*8269e767SBrooks Davis.Fa path
92*8269e767SBrooks Davisargument
93*8269e767SBrooks Davispoints outside the process's allocated address space.
94*8269e767SBrooks Davis.It Bq Er EIO
95*8269e767SBrooks DavisAn I/O error occurred while reading from or writing to the file system.
96*8269e767SBrooks Davis.It Bq Er EINTEGRITY
97*8269e767SBrooks DavisCorrupted data was detected while reading from the file system.
98*8269e767SBrooks Davis.El
99*8269e767SBrooks Davis.Pp
100*8269e767SBrooks DavisThe
101*8269e767SBrooks Davis.Fn fchdir
102*8269e767SBrooks Davissystem call
103*8269e767SBrooks Daviswill fail and the current working directory will be unchanged if
104*8269e767SBrooks Davisone or more of the following are true:
105*8269e767SBrooks Davis.Bl -tag -width Er
106*8269e767SBrooks Davis.It Bq Er EACCES
107*8269e767SBrooks DavisSearch permission is denied for the directory referenced by the
108*8269e767SBrooks Davisfile descriptor.
109*8269e767SBrooks Davis.It Bq Er ENOTDIR
110*8269e767SBrooks DavisThe file descriptor does not reference a directory.
111*8269e767SBrooks Davis.It Bq Er EBADF
112*8269e767SBrooks DavisThe argument
113*8269e767SBrooks Davis.Fa fd
114*8269e767SBrooks Davisis not a valid file descriptor.
115*8269e767SBrooks Davis.El
116*8269e767SBrooks Davis.Sh SEE ALSO
117*8269e767SBrooks Davis.Xr chroot 2
118*8269e767SBrooks Davis.Sh STANDARDS
119*8269e767SBrooks DavisThe
120*8269e767SBrooks Davis.Fn chdir
121*8269e767SBrooks Davissystem call is expected to conform to
122*8269e767SBrooks Davis.St -p1003.1-90 .
123*8269e767SBrooks Davis.Sh HISTORY
124*8269e767SBrooks DavisThe
125*8269e767SBrooks Davis.Fn chdir
126*8269e767SBrooks Davissystem call appeared in
127*8269e767SBrooks Davis.At v1 .
128*8269e767SBrooks DavisThe
129*8269e767SBrooks Davis.Fn fchdir
130*8269e767SBrooks Davissystem call appeared in
131*8269e767SBrooks Davis.Bx 4.2 .
132