xref: /openbsd-src/usr.sbin/chroot/chroot.8 (revision b2ea75c1b17e1a9a339660e7ed45cd24946b230e)
1.\" $OpenBSD: chroot.8,v 1.6 2001/05/28 15:26:55 aaron Exp $
2.\"
3.\" Copyright (c) 1988, 1991 The Regents of the University of California.
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     from: @(#)chroot.8	5.3 (Berkeley) 3/16/91
35.\"	$Id: chroot.8,v 1.6 2001/05/28 15:26:55 aaron Exp $
36.\"
37.Dd March 16, 1991
38.Dt CHROOT 8
39.Os
40.Sh NAME
41.Nm chroot
42.Nd change root directory
43.Sh SYNOPSIS
44.Nm chroot
45.Ar newroot
46.Op Ar command
47.Sh DESCRIPTION
48The
49.Nm
50command changes its root directory to the supplied directory
51.Ar newroot
52and executes
53.Ar command ,
54if supplied, or an interactive copy of your shell.
55.Pp
56Note,
57.Ar command
58or the shell are run as your real user ID.
59.Sh ENVIRONMENT
60.Bl -tag -width SHELL
61.It Ev SHELL
62If set,
63the string specified by
64.Ev SHELL
65is interpreted as the name of
66the shell to execute.
67If the variable
68.Ev SHELL
69is not set,
70.Pa /bin/sh
71is used.
72.El
73.Sh SEE ALSO
74.Xr chdir 2 ,
75.Xr chroot 2 ,
76.Xr environ 7
77.Sh HISTORY
78The
79.Nm
80command is
81.Ud
82