chroot(2)chroot(2)NAMEchroot() - change root directory
SYNOPSISDESCRIPTION
causes the named directory to become the root directory, the starting
point for path searches for path names beginning with path points to a
path name naming a directory. The user's working directory is unaf‐
fected by the system call.
The entry in the root directory is interpreted to mean the root direc‐
tory itself. Thus, cannot be used to access files outside the subtree
rooted at the root directory.
Security Restrictions
The effective user ID of the process must be a user with the privilege
to change the root directory. system call should be called within a
single threaded process. A process should invoke system call before
the system call to change the current working directory of the process
to the new root directory.
See privileges(5) for more information about privileged access on sys‐
tems that support fine-grained privileges.
RETURN VALUE
returns the following values:
Successful completion.
Failure.
is set to indicate the error.
ERRORS
fails and the root directory remains unchanged if one or more of the
following is true:
Any component of the path name is not a directory.
The named directory does not exist or a component of the
path does not exist.
The effective user
ID is not a user who has the privilege.
path points outside the allocated address space of the
process. The reliable detection of this error is
implementation dependent.
The length of the specified path name exceeds
bytes, or the length of a component of the path
name exceeds bytes while is in effect.
Too many symbolic links were encountered in translating the path
name.
WARNINGS
Obsolescent Interfaces
is to be obsoleted at a future date.
SEE ALSOchroot(1M), chdir(2), privileges(5).
STANDARDS CONFORMANCE
TO BE OBSOLETED chroot(2)