diff options
author | erdgeist <erdgeist@erdgeist.org> | 2005-09-05 02:49:33 +0000 |
---|---|---|
committer | erdgeist <erdgeist@erdgeist.org> | 2005-09-05 02:49:33 +0000 |
commit | 87e7aeab5b36101b18ef3aa485cc3f79fcf9b3d4 (patch) | |
tree | dcc70c87fe799c6a5f87ba4c2e65801610f1c246 /man1/ezjail-admin.1 | |
parent | 1066932e423aec6a44b05fb143cbf949e5220e74 (diff) |
documentation
Diffstat (limited to 'man1/ezjail-admin.1')
-rwxr-xr-x | man1/ezjail-admin.1 | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/man1/ezjail-admin.1 b/man1/ezjail-admin.1 new file mode 100755 index 0000000..9030d53 --- /dev/null +++ b/man1/ezjail-admin.1 | |||
@@ -0,0 +1,81 @@ | |||
1 | .TH ezjail\-admin 1 | ||
2 | .SH NAME | ||
3 | ezjail-admin \- Administrate ezjail | ||
4 | .SH SYNOPSIS | ||
5 | .T | ||
6 | .B ezjail-admin create | ||
7 | [-r jailroot] [-x] | ||
8 | .I hostname jailip | ||
9 | |||
10 | .T | ||
11 | .B ezjail-admin delete | ||
12 | [-w] | ||
13 | .I hostname | ||
14 | |||
15 | .T | ||
16 | .B ezjail-admin list | ||
17 | |||
18 | .T | ||
19 | .B ezjail-admin update | ||
20 | [-s sourcetree] | ||
21 | .SH DESCRIPTION | ||
22 | The | ||
23 | .B ezjail-admin | ||
24 | tool is used to manage jails inside the ezjail scope. It is not used | ||
25 | to start or stop ezjails jails. Refer to ezjail(5) for more details. | ||
26 | .SH ezjail-admin create | ||
27 | makes a copy of the ezjail template jail to the standard jail directory, | ||
28 | using either the name specified with the -r option or a name derived from | ||
29 | the given hostname. | ||
30 | |||
31 | If the jailroot does not start with a /, it is | ||
32 | interpreted relative to ezjails root dir. If the given jailroot lies | ||
33 | outside ezjails root dir, a soft link is created inside ezjails root dir | ||
34 | pointing to the newly created jails location. | ||
35 | |||
36 | The first step is skipped, if the -x (jail exists) option is given, useful | ||
37 | 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 | checks are being performed. | ||
40 | |||
41 | It then creates an entry in its /etc/ezjail directory allowing the | ||
42 | jail to be brought up after next reboot. | ||
43 | |||
44 | If the ezjail_mount_enable option is set, a /etc/fstab.hostname is | ||
45 | generated, allowing the basejail to be auto-mounted when the jail starts | ||
46 | up. | ||
47 | |||
48 | Options for newly created jails are read from ezjail.conf, refer to | ||
49 | ezjail.conf(5) for more information. | ||
50 | .SH ezjail-admin delete | ||
51 | removes a jail from ezjails /etc/ezjail resource directory thus preventing | ||
52 | it from being brought up on next reboot. | ||
53 | |||
54 | It then removes the /etc/fstab.hostname entry, if it exists. | ||
55 | |||
56 | If the -w (wipe) option is given, the directory pointed to by the jail | ||
57 | root entry is removed as well as the soft link, if necessary. | ||
58 | .SH ezjail-admin list | ||
59 | lists all jails inside ezjails scope, together with some information on | ||
60 | them. | ||
61 | .SH ezjail-admin update | ||
62 | tries to build and install a FreeBSD system from the source tree either | ||
63 | specified in the ezjail.conf config file or via the -s option. Build | ||
64 | destination is a temporary directory inside ezjails jail root. | ||
65 | |||
66 | It then fills the basejail from that temporary directory (leaving all | ||
67 | older version installed libraries intact, if it already existed). All | ||
68 | copied directories are removed and replaced by soft links to what later is | ||
69 | mounted into the jail. | ||
70 | |||
71 | Finally it removes the old template jail and renames the | ||
72 | temporary directory as the new template jail. | ||
73 | .SH FILES | ||
74 | .T4 | ||
75 | /usr/local/etc/ezjail.conf | ||
76 | .br | ||
77 | /usr/local/etc/rc.d/ezjail | ||
78 | .SH "SEE ALSO" | ||
79 | ezjail(5), ezjail.conf(5), jail(8), devfs(5), fdescfs(5), procfs(5) | ||
80 | .SH AUTHOR | ||
81 | Dirk Engling <erdgeist@erdgeist.org> | ||