freebsd-skq/usr.sbin/chroot/chroot.8

.\" 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.
.\" 4. 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.
.\"
.\"     @(#)chroot.8	8.1 (Berkeley) 6/9/93
.\" $FreeBSD$
.\"
.Dd June 7, 2003
.Dt CHROOT 8
.Os
.Sh NAME
.Nm chroot
.Nd change root directory
.Sh SYNOPSIS
.Nm
.Op Fl u Ar user
.Op Fl g Ar group
.Op Fl G Ar group,group,...
.Ar newroot
.Op Ar command
.Sh DESCRIPTION
The
.Nm
utility changes its current and root directories to the supplied directory
.Ar newroot
and then exec's
.Ar command ,
if supplied,
or an interactive copy of the user's login 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
.Nm
has taken place.
.Sh ENVIRONMENT
The following environment variable is referenced by
.Nm :
.Bl -tag -width ".Ev 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 chdir 2 ,
.Xr chroot 2 ,
.Xr setgid 2 ,
.Xr setgroups 2 ,
.Xr setuid 2 ,
.Xr getgrnam 3 ,
.Xr environ 7 ,
.Xr jail 8
.Sh HISTORY
The
.Nm
utility first appeared in
.Bx 4.4 .
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\" 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.`
			`.\" 4. 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.`
			`.\"`
			`.\" @(#)chroot.8 8.1 (Berkeley) 6/9/93`
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.\"`
Allow the optional setting of a user, primary group, or grouplist when chrooting. Obtained from: NetBSD MFC after: 4 weeks 2003-06-07 10:56:12 +00:00			`.Dd June 7, 2003`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Dt CHROOT 8`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:12:08 +00:00			`.Os`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh NAME`
			`.Nm chroot`
			`.Nd change root directory`
			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Allow the optional setting of a user, primary group, or grouplist when chrooting. Obtained from: NetBSD MFC after: 4 weeks 2003-06-07 10:56:12 +00:00			`.Op Fl u Ar user`
			`.Op Fl g Ar group`
			`.Op Fl G Ar group,group,...`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Ar newroot`
			`.Op Ar command`
			`.Sh DESCRIPTION`
			`The`
Remove unused #include. Statisize usage(). 1997-09-15 06:32:01 +00:00			`.Nm`
The .Nm utility 2002-07-14 14:47:15 +00:00			`utility changes its current and root directories to the supplied directory`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Ar newroot`
Pedantry to satisfy the bin/34159 author. 2002-03-15 12:24:44 +00:00			`and then exec's`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Ar command ,`
Allow the optional setting of a user, primary group, or grouplist when chrooting. Obtained from: NetBSD MFC after: 4 weeks 2003-06-07 10:56:12 +00:00			`if supplied,`
			`or an interactive copy of the user's login 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`
Minor mdoc fixes. 2012-10-07 19:53:04 +00:00			`.Nm`
Allow the optional setting of a user, primary group, or grouplist when chrooting. Obtained from: NetBSD MFC after: 4 weeks 2003-06-07 10:56:12 +00:00			`has taken place.`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh ENVIRONMENT`
			`The following environment variable is referenced by`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm :`
Pedantry to satisfy the bin/34159 author. 2002-03-15 12:24:44 +00:00			`.Bl -tag -width ".Ev SHELL"`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.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 chdir 2 ,`
			`.Xr chroot 2 ,`
Allow the optional setting of a user, primary group, or grouplist when chrooting. Obtained from: NetBSD MFC after: 4 weeks 2003-06-07 10:56:12 +00:00			`.Xr setgid 2 ,`
			`.Xr setgroups 2 ,`
			`.Xr setuid 2 ,`
			`.Xr getgrnam 3 ,`
Add xref to jail(8) PR: docs/33178 Submitted by: Tom Rhodes <darklogik@pittgoth.com> 2001-12-28 09:24:19 +00:00			`.Xr environ 7 ,`
			`.Xr jail 8`
BSD 4.4 Lite usr.sbin Sources 1994-05-26 05:23:31 +00:00			`.Sh HISTORY`
			`The`
Remove unused #include. Statisize usage(). 1997-09-15 06:32:01 +00:00			`.Nm`
Use the .Bx macro where appropriate. 1996-08-23 20:36:11 +00:00			`utility first appeared in`
			`.Bx 4.4 .`