summaryrefslogtreecommitdiff
path: root/srcx/jstart.8
blob: 25896810433c6e1a52c563f64e1eed53bc8d9ec1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
.\" 
.\" Copyright (c) 2004, Stefan Walter
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without 
.\" modification, are permitted provided that the following conditions 
.\" are met:
.\" 
.\"     * Redistributions of source code must retain the above 
.\"       copyright notice, this list of conditions and the 
.\"       following disclaimer.
.\"     * Redistributions in binary form must reproduce the 
.\"       above copyright notice, this list of conditions and 
.\"       the following disclaimer in the documentation and/or 
.\"       other materials provided with the distribution.
.\"     * The names of contributors to this software may not be 
.\"       used to endorse or promote products derived from this 
.\"       software without specific prior written permission.
.\" 
.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
.\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
.\" COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 
.\" OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 
.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 
.\" THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 
.\" DAMAGE.
.\" 
.\"
.\" CONTRIBUTORS
.\"  Stef Walter <stef@memberwebs.com>
.\"
.\" Process this file with 
.\" groff -mdoc -Tascii jstart.8
.\"
.Dd April, 2004
.Dt jstart 8
.Os jstart 
.Sh NAME
.Nm jstart
.Nd start a jail
.Sh SYNOPSIS
.Nm
.Op Fl i
.Ar path
.Ar hostname
.Ar ip-number
.Op Ar command ...
.Sh DESCRIPTION
The 
.Nm 
utility starts a jail. It is a more secure replacement for the
.Xr jail 8
command. See the 
.Xr jail 8 
man page for details on how to setup a jail, and jail concepts. 
.Pp
See the 
.Em NOTES
section for how how exactly 
.Nm 
differs from the
.Xr jail 8
command.
.Sh OPTIONS
.Bl -tag -width ".Fl u Ar ip-number"
.It Fl i
Print the jail identifier of the newly created jail.
.It Ar path
Directory which is to be the root of the jail.
.It Ar hostname
Hostname of the prison.
.It Ar ip-number
IP number assigned to the prison.
.It Ar command
Optional command to be executed inside the jail. When not specified
this defaults to
.Pa "/bin/sh /etc/rc"
.El
.Sh NOTES
.Nm 
always runs as root, and runs 
.Em command
as root.
.Pp
.Nm 
logs the startup to the jail's console if one exists. 
.Pp
The command called must be owned by root in order to be executed.
.Pp
The environment is purged properly before running the scripts in the 
jail in order to prevent unwanted information from leaking into the
jail.
.Pp
.Nm 
works well for jails that are of the 'virtual system image' type,
which act like a full FreeBSD system. If any of the above functionality
is not desired in your case, use 
.Xr jail 8 
command.
.Sh FILES
.Pa /etc/rc
.Pa /dev/console
.Sh SEE ALSO
.Xr jail 2 ,
.Xr jail 8 ,
.Xr jails 8 ,
.Xr jls 8 ,
.Xr jexec 8 , 
.Xr jkill 8 
.Sh AUTHOR
.An Stef Walter Aq stef@memberwebs.com