xref: /freebsd/usr.sbin/jexec/jexec.8 (revision 3078531de10dcae44b253a35125c949ff4235284)
1.\"
2.\" Copyright (c) 2003 Mike Barcroft <mike@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd April 24, 2016
29.Dt JEXEC 8
30.Os
31.Sh NAME
32.Nm jexec
33.Nd "execute a command inside an existing jail"
34.Sh SYNOPSIS
35.Nm
36.Op Fl l
37.Op Fl u Ar username | Fl U Ar username
38.Ar jail Op Ar command ...
39.Sh DESCRIPTION
40The
41.Nm
42utility executes
43.Ar command
44inside the
45.Ar jail
46identified by its jid or name.
47If
48.Ar command
49is not specified then the user's shell is used.
50.Pp
51The following options are available:
52.Bl -tag -width indent
53.It Fl l
54Execute in a clean environment.
55The environment is discarded except for
56.Ev HOME , SHELL , TERM , USER ,
57and anything from the login class capability database for the user.
58.Ev PATH
59is set to "/bin:/usr/bin".
60.It Fl u Ar username
61The user name from host environment as whom the
62.Ar command
63should run.
64This is the default.
65.It Fl U Ar username
66The user name from jailed environment as whom the
67.Ar command
68should run.
69.El
70.Sh SEE ALSO
71.Xr jail_attach 2 ,
72.Xr jail 8 ,
73.Xr jls 8
74.Sh HISTORY
75The
76.Nm
77utility was added in
78.Fx 5.1 .
79.Sh BUGS
80If the jail is not identified by
81.Ar jid
82there is a possible race in between the lookup of the jail
83and executing the command inside the jail.
84Giving a
85.Ar jid
86has a similar race as another process can stop the jail and
87start another one after the user looked up the
88.Ar jid .
89