BSD 4_3_Net_2 release

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

diff --git a/usr/src/lib/libc/sys/chroot.2 b/usr/src/lib/libc/sys/chroot.2
index d22a27d..529f00b 100644 (file)
--- a/usr/src/lib/libc/sys/chroot.2
+++ b/usr/src/lib/libc/sys/chroot.2
@@ -1,68 +1,97 @@
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1991 Regents of the University of California.
+.\" All rights reserved.

 .\"
 .\"

-.\"    @(#)chroot.2    6.4 (Berkeley) 1/25/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 CHROOT 2 "January 25, 1989"
-.UC 5
-.SH NAME
-chroot \- change root directory
-.SH SYNOPSIS
-.nf
-.ft B
-chroot(dirname)
-char *dirname;
-.ft R
-.fi
-.SH DESCRIPTION
-.I Dirname
-is the address of the pathname of a directory, terminated by a null byte.
-.I Chroot
-causes this directory
+.\" 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.
+.\"
+.\"     @(#)chroot.2   6.5 (Berkeley) 3/10/91
+.\"
+.Dd March 10, 1991
+.Dt CHROOT 2
+.Os BSD 4.2
+.Sh NAME
+.Nm chroot
+.Nd change root directory
+.Sh SYNOPSIS
+.Fd #include <unistd.h>
+.Ft int
+.Fn chroot "const char *dirname"
+.Sh DESCRIPTION
+.Fa Dirname
+is the address of the pathname of a directory, terminated by an ASCII NUL.
+.Fn Chroot
+causes
+.Fa dirname

 to become the root directory,
 to become the root directory,

-the starting point for path names beginning with ``/''.
-.PP
+that is, the starting point for path searches of pathnames
+beginning with
+.Ql / .
+.Pp

 In order for a directory to become the root directory
 In order for a directory to become the root directory

-a process must have execute (search) access to the directory.
-.PP
+a process must have execute (search) access for that directory.
+.Pp

 It should be noted that
 It should be noted that

-.I chroot
+.Fn chroot

 has no effect on the process's current directory.
 has no effect on the process's current directory.

-.PP
+.Pp

 This call is restricted to the super-user.
 This call is restricted to the super-user.

-.SH "RETURN VALUE
+.Sh RETURN VALUES

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

-a value of \-1 is returned and \fIerrno\fP is set to indicate an error.
-.SH ERRORS
-.I Chroot
-will fail and the root directory will be unchanged if
-one or more of the following are true:
-.TP 15
-[ENOTDIR]
+a value of -1 is returned and
+.Va errno
+is set to indicate an error.
+.Sh ERRORS
+.Fn Chroot
+will fail and the root directory will be unchanged if:
+.Bl -tag -width [ENOTDIR]
+.It Bq Er ENOTDIR

 A component of the path name is not a directory.
 A component of the path name 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
-[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
-[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
-[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.

-.SH "SEE ALSO"
-chdir(2)
+.El
+.Sh SEE ALSO
+.Xr chdir 2
+.Sh HISTORY
+The
+.Nm
+function call appeared in
+.Bx 4.2 .