BSD 4_3_Net_2 release

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

diff --git a/usr/src/lib/libc/sys/chdir.2 b/usr/src/lib/libc/sys/chdir.2
index 24cf96a..244ab59 100644 (file)
--- a/usr/src/lib/libc/sys/chdir.2
+++ b/usr/src/lib/libc/sys/chdir.2
@@ -1,88 +1,129 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1980, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)chdir.2     6.5 (Berkeley) 6/6/89
+.\" 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.

 .\"
 .\"

-.TH CHDIR 2 "June 6, 1989"
-.UC 4
-.SH NAME
-chdir, fchdir \- change current working directory
-.SH SYNOPSIS
-.nf
-.ft B
-chdir(path)
-char *path;
-.ft R
-.fi
-.LP
-.nf
-.ft B
-fchdir(fd)
-int fd;
-.fi
-.ft R
-.SH DESCRIPTION
-.I Path
-is the pathname of a directory.
-.I Chdir
-causes this directory
-to become the current working directory,
-the starting point for path names not beginning with ``/''.
-.PP
-.I Fchdir
+.\" 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
 causes the directory referenced by

-.I fd
+.Fa fd

 to become the current working directory,
 to become the current working directory,

-the starting point for path names not beginning with ``/''.
-.PP
+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.
 In order for a directory to become the current directory,
 a process must have execute (search) access to the directory.

-.SH "RETURN VALUE
+.Sh RETURN VALUES

 Upon successful completion, a value of 0 is returned.
 Upon successful completion, a value of 0 is returned.

-Otherwise, a value of \-1 is returned and \fIerrno\fP is set to indicate
+Otherwise, a value of -1 is returned and
+.Va errno
+is set to indicate

 the error.
 the error.

-.SH ERRORS
-.I Chdir
+.Sh ERRORS
+.Fn Chdir

 will fail and the current working directory will be unchanged if
 one or more of the following are true:
 will fail and the current working directory will be unchanged if
 one or more of the following are true:

-.TP 15
-[ENOTDIR]
+.Bl -tag -width Er
+.It Bq Er ENOTDIR

 A component of the path prefix is not a directory.
 A component of the path prefix is not a directory.

-.TP 15
-[EINVAL]
+.It Bq Er EINVAL

 The pathname contains a character with the high-order bit set.
 The pathname contains a character with the high-order bit set.

-.TP 15
-[ENAMETOOLONG]
+.It Bq Er ENAMETOOLONG

 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.
 A component of a pathname exceeded 255 characters,
 or an entire path name exceeded 1023 characters.

-.TP 15
-[ENOENT]
+.It Bq Er ENOENT

 The named directory does not exist.
 The named directory does not exist.

-.TP 15
-[ELOOP]
+.It Bq Er ELOOP

 Too many symbolic links were encountered in translating the pathname.
 Too many symbolic links were encountered in translating the pathname.

-.TP 15
-[EACCES]
+.It Bq Er EACCES

 Search permission is denied for any component of
 the path name.
 Search permission is denied for any component of
 the path name.

-.TP 15
-[EFAULT]
-.I Path
+.It Bq Er EFAULT
+.Fa Path

 points outside the process's allocated address space.
 points outside the process's allocated address space.

-.TP 15
-[EIO]
+.It Bq Er EIO

 An I/O error occurred while reading from or writing to the file system.
 An I/O error occurred while reading from or writing to the file system.

-.LP
-.I Fchdir
+.El
+.Pp
+.Fn Fchdir

 will fail and the current working directory will be unchanged if
 one or more of the following are true:
 will fail and the current working directory will be unchanged if
 one or more of the following are true:

-.TP 15
-[ENOTDIR]
+.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.
 The file descriptor does not reference a directory.

-.TP 15
-EBADF
-.I fd
-is not a valid open file descriptor.
-.SH "SEE ALSO"
-chroot(2)
+.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 .