xref: /dragonfly/lib/libc/sys/chdir.2 (revision a4da4a90)
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. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)chdir.2	8.2 (Berkeley) 12/11/93
29.\" $FreeBSD: src/lib/libc/sys/chdir.2,v 1.7.2.5 2001/12/14 18:34:00 ru Exp $
30.\" $DragonFly: src/lib/libc/sys/chdir.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
31.\"
32.Dd December 11, 1993
33.Dt CHDIR 2
34.Os
35.Sh NAME
36.Nm chdir ,
37.Nm fchdir
38.Nd change current working directory
39.Sh LIBRARY
40.Lb libc
41.Sh SYNOPSIS
42.In unistd.h
43.Ft int
44.Fn chdir "const char *path"
45.Ft int
46.Fn fchdir "int fd"
47.Sh DESCRIPTION
48The
49.Fa path
50argument points to the pathname of a directory.
51The
52.Fn chdir
53function
54causes the named directory
55to become the current working directory, that is,
56the starting point for path searches of pathnames not beginning with
57a slash,
58.Ql / .
59.Pp
60The
61.Fn fchdir
62function
63causes the directory referenced by
64.Fa fd
65to become the current working directory,
66the starting point for path searches of pathnames not beginning with
67a slash,
68.Ql / .
69.Pp
70In order for a directory to become the current directory,
71a process must have execute (search) access to the directory.
72.Sh RETURN VALUES
73.Rv -std
74.Sh ERRORS
75.Fn Chdir
76will fail and the current working directory will be unchanged if
77one or more of the following are true:
78.Bl -tag -width Er
79.It Bq Er ENOTDIR
80A component of the path prefix is not a directory.
81.It Bq Er ENAMETOOLONG
82A component of a pathname exceeded 255 characters,
83or an entire path name exceeded 1023 characters.
84.It Bq Er ENOENT
85The named directory does not exist.
86.It Bq Er ELOOP
87Too many symbolic links were encountered in translating the pathname.
88.It Bq Er EACCES
89Search permission is denied for any component of
90the path name.
91.It Bq Er EFAULT
92.Fa Path
93points outside the process's allocated address space.
94.It Bq Er EIO
95An I/O error occurred while reading from or writing to the file system.
96.El
97.Pp
98.Fn Fchdir
99will fail and the current working directory will be unchanged if
100one or more of the following are true:
101.Bl -tag -width Er
102.It Bq Er EACCES
103Search permission is denied for the directory referenced by the
104file descriptor.
105.It Bq Er ENOTDIR
106The file descriptor does not reference a directory.
107.It Bq Er EBADF
108The argument
109.Fa fd
110is not a valid file descriptor.
111.El
112.Sh SEE ALSO
113.Xr chroot 2
114.Sh STANDARDS
115The
116.Fn chdir
117function call is expected to conform to
118.St -p1003.1-90 .
119.Sh HISTORY
120A
121.Fn chdir
122function call appeared in
123.At v7 .
124The
125.Fn fchdir
126function call
127appeared in
128.Bx 4.2 .
129