add -s option which inserts/matches truncated member names

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

.\" Copyright (c) 1983 Regents of the University of California.
.\" All rights reserved.  The Berkeley software License Agreement
.\" specifies the terms and conditions for redistribution.
.\"
.\"	@(#)chroot.2	6.4 (Berkeley) %G%
.\"
.TH CHROOT 2 ""
.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
to become the root directory,
the starting point for path names beginning with ``/''.
.PP
In order for a directory to become the root directory
a process must have execute (search) access to the directory.
.PP
It should be noted that
.I chroot
has no effect on the process's current directory.
.PP
This call is restricted to the super-user.
.SH "RETURN VALUE
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 component of the path name is not a directory.
.TP 15
[EINVAL]
The pathname contains a character with the high-order bit set.
.TP 15
[ENAMETOOLONG]
A component of a pathname exceeded 255 characters,
or an entire path name exceeded 1023 characters.
.TP 15
[ENOENT]
The named directory does not exist.
.TP 15
[EACCES]
Search permission is denied for any component of the path name.
.TP 15
[ELOOP]
Too many symbolic links were encountered in translating the pathname.
.TP 15
[EFAULT]
.I Path
points outside the process's allocated address space.
.TP 15
[EIO]
An I/O error occurred while reading from or writing to the file system.
.SH "SEE ALSO"
chdir(2)