63 lines
1.6 KiB
Groff
63 lines
1.6 KiB
Groff
.\" 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.3 (Berkeley) 8/26/85
|
|
.\"
|
|
.TH CHROOT 2 "August 26, 1985"
|
|
.UC 5
|
|
.SH NAME
|
|
chroot \- change root directory
|
|
.SH SYNOPSIS
|
|
.nf
|
|
.ft B
|
|
#include <unistd.h>
|
|
|
|
int chroot(const char *\fIdirname\fP)
|
|
.ft R
|
|
.fi
|
|
.SH DESCRIPTION
|
|
.I Dirname
|
|
is the address of the pathname of a directory, terminated by a null byte.
|
|
.B 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
|
|
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 \fBerrno\fP is set to indicate an error.
|
|
.SH ERRORS
|
|
.B 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
|
|
[ENAMETOOLONG]
|
|
The path name exceeds PATH_MAX 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.
|
|
(Minix-vmd)
|
|
.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"
|
|
.BR chdir (2).
|