usr.sbin/chroot/chroot.8

   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: src/usr.sbin/chroot/chroot.8,v 1.5.2.5 2003/03/12 22:08:13 trhodes Exp $
  34 .\" $DragonFly: src/usr.sbin/chroot/chroot.8,v 1.2 2003/06/17 04:29:52 dillon Exp $
  35 .\"
  36 .Dd January 24, 2002
  37 .Dt CHROOT 8
  38 .Os
  39 .Sh NAME
  40 .Nm chroot
  41 .Nd change root directory
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Ar newroot
  45 .Op Ar command
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility changes its current and root directories to the supplied directory
  50 .Ar newroot
  51 and then exec's
  52 .Ar command ,
  53 if supplied, or an interactive copy of the user's login shell.
  54 .Sh ENVIRONMENT
  55 The following environment variable is referenced by
  56 .Nm :
  57 .Bl -tag -width ".Ev SHELL"
  58 .It Ev SHELL
  59 If set,
  60 the string specified by
  61 .Ev SHELL
  62 is interpreted as the name of
  63 the shell to exec.
  64 If the variable
  65 .Ev SHELL
  66 is not set,
  67 .Pa /bin/sh
  68 is used.
  69 .El
  70 .Sh SEE ALSO
  71 .Xr chdir 2 ,
  72 .Xr chroot 2 ,
  73 .Xr environ 7 ,
  74 .Xr jail 8
  75 .Sh HISTORY
  76 The
  77 .Nm
  78 utility first appeared in
  79 .Bx 4.4 .