xref: /386bsd/usr/src/usr.sbin/chroot/chroot.8 (revision a2142627)
1.\" Copyright (c) 1988, 1991 The Regents of the University of California.
2.\" 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	5.3 (Berkeley) 3/16/91
33.\"
34.Dd March 16, 1991
35.Dt CHROOT 8
36.Os BSD 4.3
37.Sh NAME
38.Nm chroot
39.Nd change root directory
40.Sh SYNOPSIS
41.Nm chroot
42.Ar newroot
43.Op Ar command
44.Sh DESCRIPTION
45The
46.Nm chroot
47command changes its root directory to the supplied directory
48.Ar newroot
49and exec's
50.Ar command ,
51if supplied, or an interactive copy of your shell.
52.Pp
53Note,
54.Ar command
55or the shell are run as your real-user-id.
56.Sh ENVIRONMENT
57The following environment variable is referenced by
58.Nm chroot :
59.Bl -tag -width SHELL
60.It Ev SHELL
61If set,
62the string specified by
63.Ev SHELL
64is interpreted as the name of
65the shell to exec.
66If the variable
67.Ev SHELL
68is not set,
69.Pa /bin/sh
70is used.
71.El
72.Sh SEE ALSO
73.Xr chdir 2 ,
74.Xr chroot 2 ,
75.Xr environ 7
76.Sh HISTORY
77The
78.Nm
79command
80.Ud
81