Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
CHROOT(2)                 NetBSD Programmer's Manual                 CHROOT(2)

NAME
     chroot - change root directory

SYNOPSIS
     #include <unistd.h>

     int
     chroot(const char *dirname)

DESCRIPTION
     Dirname is the address of the pathname of a directory, terminated by an
     ASCII NUL.  Chroot() causes dirname to become the root directory, that
     is, the starting point for path searches of pathnames beginning with `/'.

     In order for a directory to become the root directory a process must have
     execute (search) access for that directory.

     It should be noted that chroot() has no effect on the process's current
     directory.

     This call is restricted to the super-user.

RETURN VALUES
     Upon successful completion, a value of 0 is returned.  Otherwise, a value
     of -1 is returned and errno is set to indicate an error.

ERRORS
     Chroot() will fail and the root directory will be unchanged if:

     [ENOTDIR]     A component of the path name is not a directory.

     [ENAMETOOLONG]
                   A component of a pathname exceeded {NAME_MAX} characters,
                   or an entire path name exceeded {PATH_MAX} characters.

     [ENOENT]      The named directory does not exist.

     [EACCES]      Search permission is denied for any component of the path
                   name.

     [ELOOP]       Too many symbolic links were encountered in translating the
                   pathname.

     [EFAULT]      Path points outside the process's allocated address space.

     [EIO]         An I/O error occurred while reading from or writing to the
                   file system.

SEE ALSO
     chdir(2)

HISTORY
     The chroot() function call appeared in 4.2BSD.

4.2 Berkeley Distribution       October 2, 1994                              1

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | SEE ALSO | HISTORY

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=chroot&sektion=2&manpath=NetBSD+1.0>

home | help