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