xref: /dragonfly/usr.sbin/chroot/chroot.8 (revision 279dd846)
1.\" Copyright (c) 1988, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)chroot.8	8.1 (Berkeley) 6/9/93
29.\" $FreeBSD: src/usr.sbin/chroot/chroot.8,v 1.5.2.5 2003/03/12 22:08:13 trhodes Exp $
30.\" $DragonFly: src/usr.sbin/chroot/chroot.8,v 1.3 2003/08/24 16:04:16 drhodus Exp $
31.\"
32.Dd January 24, 2003
33.Dt CHROOT 8
34.Os
35.Sh NAME
36.Nm chroot
37.Nd change root directory
38.Sh SYNOPSIS
39.Nm
40.Op Fl u Ar user
41.Op Fl g Ar group
42.Op Fl G Ar group,group,...
43.Ar newroot
44.Op Ar command
45.Sh DESCRIPTION
46The
47.Nm
48utility changes its current and root directories to the supplied directory
49.Ar newroot
50and then exec's
51.Ar command ,
52if supplied,
53or an interactive copy of the user's login shell.
54.Pp
55If the
56.Fl u ,
57.Fl g
58or
59.Fl G
60options are given,
61the user,
62group and group list of the process are set to
63these values after the
64.Xr chroot 8
65has taken place.
66.Sh ENVIRONMENT
67The following environment variable is referenced by
68.Nm :
69.Bl -tag -width ".Ev SHELL"
70.It Ev SHELL
71If set,
72the string specified by
73.Ev SHELL
74is interpreted as the name of
75the shell to exec.
76If the variable
77.Ev SHELL
78is not set,
79.Pa /bin/sh
80is used.
81.El
82.Sh SEE ALSO
83.Xr chdir 2 ,
84.Xr chroot 2 ,
85.Xr setgid 2 ,
86.Xr setgroups 2 ,
87.Xr setuid 2 ,
88.Xr getgrnam 3 ,
89.Xr environ 7 ,
90.Xr jail 8
91.Sh HISTORY
92The
93.Nm
94utility first appeared in
95.Bx 4.4 .
96