summaryrefslogtreecommitdiff
path: root/man1/ezjail-admin.1
diff options
context:
space:
mode:
authorerdgeist <erdgeist@erdgeist.org>2006-01-30 19:02:44 +0000
committererdgeist <erdgeist@erdgeist.org>2006-01-30 19:02:44 +0000
commit8fda6980120c2815a13e439436b166e0b504447e (patch)
treed93c3068873f501a67901e94efdd51d653ada0bb /man1/ezjail-admin.1
parent9308bc4f473b51793035479c58c6e024f2a7b5ed (diff)
Documentation tidy up
Diffstat (limited to 'man1/ezjail-admin.1')
-rwxr-xr-xman1/ezjail-admin.152
1 files changed, 28 insertions, 24 deletions
diff --git a/man1/ezjail-admin.1 b/man1/ezjail-admin.1
index b4ff3ea..85a8ed8 100755
--- a/man1/ezjail-admin.1
+++ b/man1/ezjail-admin.1
@@ -29,12 +29,13 @@ using either the name specified with the -r option or a name derived from
29the given hostname. 29the given hostname.
30 30
31If the jailroot does not start with a /, it is 31If the jailroot does not start with a /, it is
32interpreted relative to ezjails root dir. If the given jailroot lies 32interpreted relative to ezjails root dir (default: /usr/jails). If the
33outside ezjails root dir, a soft link is created inside ezjails root dir 33given jailroot lies outside ezjails root dir, a soft link is created
34pointing to the newly created jails location. 34inside ezjails root dir pointing to the newly created jails location.
35 35
36The first step is skipped, if the -x (jail exists) option is given, useful 36If the -x (jail exists) option is given,
37in situations where you just want to alter some of a jail properties and 37.B the first step is skipped (an existing jail is used)
38useful in situations where you just want to alter some of a jail properties and
38called ezjail-admin delete without the -w option before. However, sanity 39called ezjail-admin delete without the -w option before. However, sanity
39checks are being performed. 40checks are being performed.
40 41
@@ -48,10 +49,12 @@ is generated, allowing the basejail to be auto-mounted when the jail starts
48up. 49up.
49 50
50The newly created Jail can perform some initializiation actions, if the 51The newly created Jail can perform some initializiation actions, if the
51-f <flavour> option is given, where flavour is a path to a flavour configuration 52-f
52file or a short name expanding to 53.I flavour
53.I EZJAIL_PREFIX/etc/ezjail.flavour.<flavour> . 54option is given, where
54 55.I flavour
56is a directory directory tree under ezjails root dir (default:
57.I /usr/jails/flavours).
55See section 58See section
56.B FLAVOURS 59.B FLAVOURS
57below for more details. 60below for more details.
@@ -75,16 +78,20 @@ root entry is removed as well as the soft link in ezjails root dir.
75lists all jails inside ezjails scope, together with some information on 78lists all jails inside ezjails scope, together with some information on
76them. 79them.
77.SH ezjail-admin update 80.SH ezjail-admin update
78installs a FreeBSD system from the source tree whose location is either 81is used to create or update ezjails basejail. Depending on the parameters
79provided in the 82given it will install a FreeBSD system from a source tree whose location
83is either provided in the
80.B ezjail.conf 84.B ezjail.conf
81config file or via the -s option. It will check out or update a fresh ports 85config file or via the -s option.
82tree to the base jail, if the -p or -P option is given. In fact, if the -P 86
83option is given, 87If the -p or -P options are given, the base jail is given a copy of FreeBSDs
84.B only the ports tree will be updated. 88ports tree, which is in turn linked into all newly created ezjails.
89
90If the -P option is given,
91.B only the ports tree will be checked out/updated,
92this can be done, while jails are running.
85 93
86Install destination is a temporary directory inside ezjails jail root. If 94If the -i (install only) option is given,
87the -i (install only) option is given,
88.B ezjail-admin update 95.B ezjail-admin update
89only performes a 96only performes a
90.I make installworld, 97.I make installworld,
@@ -92,14 +99,11 @@ otherwise
92.I make world 99.I make world
93is invoked. 100is invoked.
94 101
95It then fills the basejail from that temporary directory (leaving intact
96all installed libraries, if the base jail already exists). All
97copied directories are then removed and replaced by soft links into the
98base jail tree that later will be mounted into the jail.
99
100Finally it removes the old template jail and renames the
101temporary directory as the new template jail.
102.SH NOTES 102.SH NOTES
103.B ezjail-admin update
104uses a temporary directory to install its world to, thus leaving intact
105all installed libraries, if a base jail already exists.
106
103When using the 107When using the
104.B ezjail-admin update 108.B ezjail-admin update
105option, be careful to use the same FreeBSD source tree used to build the 109option, be careful to use the same FreeBSD source tree used to build the