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