[unix-history] / usr / src / lib / libc / sys / chdir.2

.\" Copyright (c) 1980, 1991 Regents of the University of California.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)chdir.2	6.7 (Berkeley) 3/10/91
.\"
.Dd March 10, 1991
.Dt CHDIR 2
.Os BSD 4
.Sh NAME
.Nm chdir ,
.Nm fchdir
.Nd change current working directory
.Sh SYNOPSIS
.Fd #include <unistd.h>
.Ft int
.Fn chdir "const char *path"
.Ft int
.Fn fchdir "int fd"
.Sh DESCRIPTION
The
.Fa path
arument points to the pathname of a directory.
The
.Fn chdir
function
causes the named directory
to become the current working directory, that is,
the starting point for path searches of pathnames not beginning with
a slash,
.Ql / .
.Pp
The
.Fn fchdir
function
causes the directory referenced by
.Fa fd
to become the current working directory,
the starting point for path searches of pathnames not beginning with
a slash,
.Ql / .
.Pp
In order for a directory to become the current directory,
a process must have execute (search) access to the directory.
.Sh RETURN VALUES
Upon successful completion, a value of 0 is returned.
Otherwise, a value of -1 is returned and
.Va errno
is set to indicate
the error.
.Sh ERRORS
.Fn Chdir
will fail and the current working directory will be unchanged if
one or more of the following are true:
.Bl -tag -width Er
.It Bq Er ENOTDIR
A component of the path prefix is not a directory.
.It Bq Er EINVAL
The pathname contains a character with the high-order bit set.
.It Bq Er ENAMETOOLONG
A component of a pathname exceeded 255 characters,
or an entire path name exceeded 1023 characters.
.It Bq Er ENOENT
The named directory does not exist.
.It Bq Er ELOOP
Too many symbolic links were encountered in translating the pathname.
.It Bq Er EACCES
Search permission is denied for any component of
the path name.
.It Bq Er EFAULT
.Fa Path
points outside the process's allocated address space.
.It Bq Er EIO
An I/O error occurred while reading from or writing to the file system.
.El
.Pp
.Fn Fchdir
will fail and the current working directory will be unchanged if
one or more of the following are true:
.Bl -tag -width Er
.It Bq Er EACCES
Search permission is denied for the directory referenced by the
file descriptor.
.It Bq Er ENOTDIR
The file descriptor does not reference a directory.
.It Bq Er EBADF
The argument
.Fa fd
is not a valid file descriptor.
.El
.Sh SEE ALSO
.Xr chroot 2
.Sh STANDARDS
.Fn Chdir
is expected to conform to IEEE Std 1003.1-1988
.Pq Dq Tn POSIX .
.Sh HISTORY
The
.Fn fchdir
function call
appeared in
.Bx 4.2 .
Commit	Line	Data
55c2faba WJ	1	.\" Copyright (c) 1980, 1991 Regents of the University of California.
	2	.\" 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 6.7 (Berkeley) 3/10/91
	33	.\"
	34	.Dd March 10, 1991
	35	.Dt CHDIR 2
	36	.Os BSD 4
	37	.Sh NAME
	38	.Nm chdir ,
	39	.Nm fchdir
	40	.Nd change current working directory
	41	.Sh SYNOPSIS
	42	.Fd #include <unistd.h>
	43	.Ft int
	44	.Fn chdir "const char *path"
	45	.Ft int
	46	.Fn fchdir "int fd"
	47	.Sh DESCRIPTION
	48	The
	49	.Fa path
	50	arument points to the pathname of a directory.
	51	The
	52	.Fn chdir
	53	function
	54	causes the named directory
	55	to become the current working directory, that is,
	56	the starting point for path searches of pathnames not beginning with
	57	a slash,
	58	.Ql / .
	59	.Pp
	60	The
	61	.Fn fchdir
	62	function
	63	causes the directory referenced by
	64	.Fa fd
65	to become the current working directory,
66	the starting point for path searches of pathnames not beginning with
67	a slash,
68	.Ql / .
69	.Pp
70	In order for a directory to become the current directory,
71	a process must have execute (search) access to the directory.
72	.Sh RETURN VALUES
73	Upon successful completion, a value of 0 is returned.
74	Otherwise, a value of -1 is returned and
75	.Va errno
76	is set to indicate
77	the error.
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 EINVAL
86	The pathname contains a character with the high-order bit set.
87	.It Bq Er ENAMETOOLONG
88	A component of a pathname exceeded 255 characters,
89	or an entire path name exceeded 1023 characters.
90	.It Bq Er ENOENT
91	The named directory does not exist.
92	.It Bq Er ELOOP
93	Too many symbolic links were encountered in translating the pathname.
94	.It Bq Er EACCES
95	Search permission is denied for any component of
96	the path name.
97	.It Bq Er EFAULT
98	.Fa Path
99	points outside the process's allocated address space.
100	.It Bq Er EIO
101	An I/O error occurred while reading from or writing to the file system.
102	.El
103	.Pp
104	.Fn Fchdir
105	will fail and the current working directory will be unchanged if
106	one or more of the following are true:
107	.Bl -tag -width Er
108	.It Bq Er EACCES
109	Search permission is denied for the directory referenced by the
110	file descriptor.
111	.It Bq Er ENOTDIR
112	The file descriptor does not reference a directory.
113	.It Bq Er EBADF
114	The argument
115	.Fa fd
116	is not a valid file descriptor.
117	.El
118	.Sh SEE ALSO
119	.Xr chroot 2
120	.Sh STANDARDS
121	.Fn Chdir
122	is expected to conform to IEEE Std 1003.1-1988
123	.Pq Dq Tn POSIX .
124	.Sh HISTORY
125	The
126	.Fn fchdir
127	function call
128	appeared in
129	.Bx 4.2 .