\" $NetBSD: chroot.8,v 1.14 2011/08/15 14:43:17 wiz Exp $
\"
\" Copyright (c) 1988, 1991, 1993
\" The Regents of the University of California. All rights reserved.
\"
\" Redistribution and use in source and binary forms, with or without
\" modification, are permitted provided that the following conditions
\" are met:
\" 1. Redistributions of source code must retain the above copyright
\" notice, this list of conditions and the following disclaimer.
\" 2. Redistributions in binary form must reproduce the above copyright
\" notice, this list of conditions and the following disclaimer in the
\" documentation and/or other materials provided with the distribution.
\" 3. Neither the name of the University nor the names of its contributors
\" may be used to endorse or promote products derived from this software
\" without specific prior written permission.
\"
\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
\" SUCH DAMAGE.
\"
\" from: @(#)chroot.8 8.1 (Berkeley) 6/9/93
\"
Dd August 13, 2011
Dt CHROOT 8
Os
Sh NAME
Nm chroot
Nd change root directory
Sh SYNOPSIS
Nm
Op Fl G Ar group,group,...
Op Fl g Ar group
Op Fl u Ar user
Ar newroot
Op Ar command
Sh DESCRIPTION
The
Nm
command changes its root directory to the supplied directory
Ar newroot
and exec's
Ar command ,
or, if not supplied, an interactive copy of your shell.
Pp
If the
Fl u ,
Fl g ,
or
Fl G
options are given, the user, group, and group list of the process are
set to these values after the chroot has taken place; see
Xr setgid 2 ,
Xr setgroups 2 ,
Xr setuid 2 ,
Xr getgrnam 3 ,
and
Xr getpwnam 3 .
Pp
Note:
Ar command
or the shell are run as your real-user-id.
Sh ENVIRONMENT
The following environment variable is referenced by
Nm :
Bl -tag -width SHELL
It Ev SHELL
If set,
the string specified by
Ev SHELL
is interpreted as the name of
the shell to exec.
If the variable
Ev SHELL
is not set,
Pa /bin/sh
is used.
El
Sh SEE ALSO
Xr ldd 1 ,
Xr chdir 2 ,
Xr chroot 2 ,
Xr environ 7
Sh HISTORY
The
Nm
utility first appeared in
Bx 4.4 .
Sh SECURITY CONSIDERATIONS
Nm
should never be installed setuid root, as it would then be possible
to exploit the program to gain root privileges.
