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