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.3 2003/08/24 16:04:16 drhodus Exp $
  35 .\"
  36 .Dd January 24, 2003
  37 .Dt CHROOT 8
  38 .Os
  39 .Sh NAME
  40 .Nm chroot
  41 .Nd change root directory
  42 .Sh SYNOPSIS
  43 .Nm
  44 .Op Fl u Ar user
  45 .Op Fl g Ar group
  46 .Op Fl G Ar group,group,...
  47 .Ar newroot
  48 .Op Ar command
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility changes its current and root directories to the supplied directory
  53 .Ar newroot
  54 and then exec's
  55 .Ar command ,
  56 if supplied,
  57 or an interactive copy of the user's login shell.
  58 .Pp
  59 If the
  60 .Fl u ,
  61 .Fl g
  62 or
  63 .Fl G
  64 options are given,
  65 the user,
  66 group and group list of the process are set to
  67 these values after the
  68 .Xr chroot 8
  69 has taken place.
  70 .Sh ENVIRONMENT
  71 The following environment variable is referenced by
  72 .Nm :
  73 .Bl -tag -width ".Ev SHELL"
  74 .It Ev SHELL
  75 If set,
  76 the string specified by
  77 .Ev SHELL
  78 is interpreted as the name of
  79 the shell to exec.
  80 If the variable
  81 .Ev SHELL
  82 is not set,
  83 .Pa /bin/sh
  84 is used.
  85 .El
  86 .Sh SEE ALSO
  87 .Xr chdir 2 ,
  88 .Xr chroot 2 ,
  89 .Xr setgid 2 ,
  90 .Xr setgroups 2 ,
  91 .Xr setuid 2 ,
  92 .Xr getgrnam 3 ,
  93 .Xr environ 7 ,
  94 .Xr jail 8
  95 .Sh HISTORY
  96 The
  97 .Nm
  98 utility first appeared in
  99 .Bx 4.4 .