summaryrefslogtreecommitdiff
path: root/man1/ezjail-admin.1
diff options
context:
space:
mode:
authorerdgeist <erdgeist@erdgeist.org>2006-05-16 10:53:16 +0000
committererdgeist <erdgeist@erdgeist.org>2006-05-16 10:53:16 +0000
commit5109389f1a0a8f94cea9c76123754a8082377518 (patch)
treedb9dad9b08ca9f8fa4adddd0231f7fdd98e9c5b2 /man1/ezjail-admin.1
parent71bed9ab657d880db9a5d93474049e4b09aa1aa5 (diff)
Documentation for the install and the list subcommand
Diffstat (limited to 'man1/ezjail-admin.1')
-rwxr-xr-xman1/ezjail-admin.169
1 files changed, 59 insertions, 10 deletions
diff --git a/man1/ezjail-admin.1 b/man1/ezjail-admin.1
index 1f95a9a..a00494c 100755
--- a/man1/ezjail-admin.1
+++ b/man1/ezjail-admin.1
@@ -4,7 +4,7 @@ ezjail-admin \- Administrate ezjail
4.SH SYNOPSIS 4.SH SYNOPSIS
5.T 5.T
6.B ezjail-admin create 6.B ezjail-admin create
7[-f flavour] [-r jailroot] [-s imagesize] [-cix] 7[-f flavour] [-r jailroot] [-s imagesize] [-cibx] [-C attachargs]
8.I hostname jailip 8.I hostname jailip
9 9
10.T 10.T
@@ -16,6 +16,9 @@ ezjail-admin \- Administrate ezjail
16.B ezjail-admin list 16.B ezjail-admin list
17 17
18.T 18.T
19.B ezjail-admin install [-mps] [-h host] [-r release]
20
21.T
19.B ezjail-admin update 22.B ezjail-admin update
20[-s sourcetree] [-i] [-pP] 23[-s sourcetree] [-i] [-pP]
21.SH DESCRIPTION 24.SH DESCRIPTION
@@ -37,12 +40,9 @@ is created inside this root dir pointing to the newly created jails
37location. 40location.
38 41
39The -i and the -c option both require a size passed via the -s option 42The -i and the -c option both require a size passed via the -s option
40and create a file based jail image, gbde encrypted for the -c case. The 43and create a file based jail image, gbde or geli encrypted for the -c
41image file is named as the jail root suffixed with 44case. The image file is named as the jail root suffixed with
42.I .img 45.I .img
43, a lock file required for gbde devices is named as the jail root
44suffixed with
45.I .lock
46. 46.
47 47
48The -x (jail exists) option indicates, that an ezjail already exists 48The -x (jail exists) option indicates, that an ezjail already exists
@@ -80,8 +80,57 @@ up on next reboot.
80If the -w (wipe) option is given, the directory pointed to by the jail 80If the -w (wipe) option is given, the directory pointed to by the jail
81root entry is removed as well as the soft link in ezjails root dir. 81root entry is removed as well as the soft link in ezjails root dir.
82.SH ezjail-admin list 82.SH ezjail-admin list
83lists all jails inside ezjails scope, together with some information on 83lists all jails inside ezjails scope. They are sorted by the order they
84them. 84start up, as defined by rcorder. The list format is straight forward.
85
86A status flag consisting of 2 or 3 letters, the first meaning
87.B (D)irectory
88based,
89.B (I)mage
90based,
91.B (B)de
92crypto image based,
93.B (E)li
94crypto image based. The second one meaning
95.B (R)unning
96,
97.B (A)ttached
98but not running,
99.B (S)topped
100. An optional
101.B (N)orun
102stands for disabled jails (see
103.I ezjail-admin config
104).
105
106Rest of the row is follow by jails jid (if available), its IP, hostname
107and root directory.
108.SH ezjail-admin install
109fetches everything needed to setup a base jail from an FTP server and
110installs it.
111
112Default location for ezjails base jail is
113.I /usr/jails
114, so be sure you have enough space there (a FreeBSD base without man
115pages, sources and ports is around 120MB).
116
117The -m and -s option will fetch and install man pages (ca. 10MB) and
118sources packages (ca. 450MB) respectively. The -p option invokes the
119portsnap utility to fetch and extract a FreeBSD ports tree (ca. 475MB).
120
121Default OS version is, whatever uname -r returns. If this does not match
122"*-RELEASE", you will be prompted for a better guess. (Normally
123ftp-servers do not provide release candidates or CURRENT builds). You can
124use the -r option to specify a releas from command line.
125
126Default host to fetch packages from is ftp.freebsd.org, you may want to
127change this via the -h option. If the specified location begins with
128file://, your local copy of the release is used. That way you can do some
129modifications to install.sh scripts before executing them.
130
131You can later update your world from CVS by
132.U ezjail-admin update
133or rerun this subcommand with another OS version.
85.SH ezjail-admin update 134.SH ezjail-admin update
86creates or update ezjails basejail. Depending on the parameters 135creates or update ezjails basejail. Depending on the parameters
87given it will install a FreeBSD system from a source tree whose location 136given it will install a FreeBSD system from a source tree whose location
@@ -91,10 +140,10 @@ config file or via the -s option.
91 140
92If the -p or -P options are given, the base jail also is given a copy of 141If the -p or -P options are given, the base jail also is given a copy of
93FreeBSDs ports tree, which is in turn linked into all newly created 142FreeBSDs ports tree, which is in turn linked into all newly created
94ezjails. 143ezjails. The portsnap utility is invoked to do the actual work.
95 144
96If the -P option is given, 145If the -P option is given,
97.B only the ports tree will be checked out/updated, 146.B only the ports tree will be updated,
98this can be done, while jails are running. 147this can be done, while jails are running.
99 148
100If the -i (install only) option is given, 149If the -i (install only) option is given,