Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

chroot(2) [linux man page]

CHROOT(2)						     Linux Programmer's Manual							 CHROOT(2)

NAME
chroot - change root directory SYNOPSIS
#include <unistd.h> int chroot(const char *path); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): chroot(): Since glibc 2.2.2: _BSD_SOURCE || (_XOPEN_SOURCE >= 500 || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED) && !(_POSIX_C_SOURCE >= 200112L || _XOPEN_SOURCE >= 600) Before glibc 2.2.2: none DESCRIPTION
chroot() changes the root directory of the calling process to that specified in path. This directory will be used for pathnames beginning with /. The root directory is inherited by all children of the calling process. Only a privileged process (Linux: one with the CAP_SYS_CHROOT capability) may call chroot(). This call changes an ingredient in the pathname resolution process and does nothing else. This call does not change the current working directory, so that after the call '.' can be outside the tree rooted at '/'. In particular, the superuser can escape from a "chroot jail" by doing: mkdir foo; chroot foo; cd .. This call does not close open file descriptors, and such file descriptors may allow access to files outside the chroot tree. RETURN VALUE
On success, zero is returned. On error, -1 is returned, and errno is set appropriately. ERRORS
Depending on the file system, other errors can be returned. The more general errors are listed below: EACCES Search permission is denied on a component of the path prefix. (See also path_resolution(7).) EFAULT path points outside your accessible address space. EIO An I/O error occurred. ELOOP Too many symbolic links were encountered in resolving path. ENAMETOOLONG path is too long. ENOENT The file does not exist. ENOMEM Insufficient kernel memory was available. ENOTDIR A component of path is not a directory. EPERM The caller has insufficient privilege. CONFORMING TO
SVr4, 4.4BSD, SUSv2 (marked LEGACY). This function is not part of POSIX.1-2001. NOTES
A child process created via fork(2) inherits its parent's root directory. The root directory is left unchanged by execve(2). FreeBSD has a stronger jail() system call. SEE ALSO
chdir(2), path_resolution(7) COLOPHON
This page is part of release 3.27 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. Linux 2010-09-20 CHROOT(2)

Check Out this Related Man Page

CHDIR(2)						     Linux Programmer's Manual							  CHDIR(2)

NAME
chdir, fchdir - change working directory SYNOPSIS
#include <unistd.h> int chdir(const char *path); int fchdir(int fd); Feature Test Macro Requirements for glibc (see feature_test_macros(7)): fchdir(): Since glibc 2.12: _BSD_SOURCE || _XOPEN_SOURCE >= 500 || _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED || _POSIX_C_SOURCE >= 200809L Before glibc 2.12: _BSD_SOURCE || _XOPEN_SOURCE >= 500 _XOPEN_SOURCE && _XOPEN_SOURCE_EXTENDED DESCRIPTION
chdir() changes the current working directory of the calling process to the directory specified in path. fchdir() is identical to chdir(); the only difference is that the directory is given as an open file descriptor. RETURN VALUE
On success, zero is returned. On error, -1 is returned, and errno is set appropriately. ERRORS
Depending on the file system, other errors can be returned. The more general errors for chdir() are listed below: EACCES Search permission is denied for one of the components of path. (See also path_resolution(7).) EFAULT path points outside your accessible address space. EIO An I/O error occurred. ELOOP Too many symbolic links were encountered in resolving path. ENAMETOOLONG path is too long. ENOENT The file does not exist. ENOMEM Insufficient kernel memory was available. ENOTDIR A component of path is not a directory. The general errors for fchdir() are listed below: EACCES Search permission was denied on the directory open on fd. EBADF fd is not a valid file descriptor. CONFORMING TO
SVr4, 4.4BSD, POSIX.1-2001. NOTES
The current working directory is the starting point for interpreting relative pathnames (those not starting with '/'). A child process created via fork(2) inherits its parent's current working directory. The current working directory is left unchanged by execve(2). The prototype for fchdir() is only available if _BSD_SOURCE is defined, or _XOPEN_SOURCE is defined with the value 500. SEE ALSO
chroot(2), getcwd(3), path_resolution(7) COLOPHON
This page is part of release 3.27 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/. Linux 2010-09-20 CHDIR(2)
Man Page