documentation

2 files changed, 177 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 @@
+.TH ezjail\-admin 1
+.SH NAME
+ezjail-admin \- Administrate ezjail
+.SH SYNOPSIS
+.T
+.B ezjail-admin create
+[-r jailroot] [-x]
+.I hostname jailip
+
+.T
+.B ezjail-admin delete
+[-w]
+.I hostname
+
+.T
+.B ezjail-admin list
+
+.T
+.B ezjail-admin update
+[-s sourcetree]
+.SH DESCRIPTION
+The
+.B ezjail-admin
+tool is used to manage jails inside the ezjail scope. It is not used 
+to start or stop ezjails jails. Refer to ezjail(5) for more details. 
+.SH ezjail-admin create
+makes a copy of the ezjail template jail to the standard jail directory,
+using either the name specified with the -r option or a name derived from 
+the given hostname.
+
+If the jailroot does not start with a /, it is 
+interpreted relative to ezjails root dir. If the given jailroot lies 
+outside ezjails root dir, a soft link is created inside ezjails root dir 
+pointing to the newly created jails location.
+
+The first step is skipped, if the -x (jail exists) option is given, useful 
+in situations where you just want to alter some of a jail properties and 
+called ezjail-admin delete without the -w option before. However, sanity 
+checks are being performed.
+
+It then creates an entry in its /etc/ezjail directory allowing the 
+jail to be brought up after next reboot.
+
+If the ezjail_mount_enable option is set, a /etc/fstab.hostname is 
+generated, allowing the basejail to be auto-mounted when the jail starts 
+up.
+
+Options for newly created jails are read from ezjail.conf, refer to 
+ezjail.conf(5) for more information.
+.SH ezjail-admin delete
+removes a jail from ezjails /etc/ezjail resource directory thus preventing 
+it from being brought up on next reboot.
+
+It then removes the /etc/fstab.hostname entry, if it exists.
+
+If the -w (wipe) option is given, the directory pointed to by the jail 
+root entry is removed as well as the soft link, if necessary.
+.SH ezjail-admin list
+lists all jails inside ezjails scope, together with some information on 
+them.
+.SH ezjail-admin update
+tries to build and install a FreeBSD system from the source tree either 
+specified in the ezjail.conf config file or via the -s option. Build 
+destination is a temporary directory inside ezjails jail root.
+
+It then fills the basejail from that temporary directory (leaving all 
+older version installed libraries intact, if it already existed). All 
+copied directories are removed and replaced by soft links to what later is 
+mounted into the jail.
+
+Finally it removes the old template jail and renames the 
+temporary directory as the new template jail.
+.SH FILES
+.T4
+/usr/local/etc/ezjail.conf
+.br
+/usr/local/etc/rc.d/ezjail
+.SH "SEE ALSO"
+ezjail(5), ezjail.conf(5), jail(8), devfs(5), fdescfs(5), procfs(5)
+.SH AUTHOR
+Dirk Engling <erdgeist@erdgeist.org>
diff --git a/man5/ezjail.conf.5 b/man5/ezjail.conf.5
new file mode 100755
index 0000000..8f6cf39
--- /dev/null
+++ b/man5/ezjail.conf.5
@@ -0,0 +1,96 @@
+.TH ezjail.conf 5
+.SH NAME
+ezjail.conf \- configuration file for ezjail script
+.SH DESCRIPTION
+The file
+.B ezjail.conf
+contains setting that control the operation of the ezjail rc script. It is 
+also read by the
+.B ezjail-admin
+utility to figure out where it should perform its actions.
+.SH PATH OPTIONS
+.TP
+.B ezjail_jaildir (str)
+Location of jail root directories
+.br
+.I default: /usr/jails
+.TP
+.B ezjail_jailtemplate (str)
+Location of template jail used to create a new jail
+.br
+.I default: /usr/jails/newjail
+.TP
+.B ezjail_jailbase (str)
+Location of base jail, the one that is mounted to all jails
+.br
+.I default: /usr/jails/basejail
+.TP
+.B ezjail_sourcetree (str)
+Location of your copy of FreeBSD's source tree (refer to the
+.B ezjail-admin(1)
+utility for more information)
+.br
+.I default: /usr/src
+.SH JAIL CREATION OPTIONS
+Default options for newly created jails. Used by the
+.B ezjail-admin(1)
+utility. Be careful about disabling ezjail_mount_enable. (Refer to
+.B ezjail-admin(1)
+for more information).
+.TP
+.B ezjail_mount_enable (bool)
+Controls, wheter /etc/fstab.JAILNAME should be executed at jail startup 
+time.
+.br
+.I default: "YES"
+.TP
+.B ezjail_devfs_enable (bool)
+Controls, wheter newly created jails will be given a working
+.I /dev
+directory. (Refer to
+.B devfs(5)
+and
+.B jail(8)
+for more information).
+.br
+.I default: "YES"
+.TP
+.B ezjail_devfs_ruleset (str)
+Specifies, which devfs ruleset should apply for newly created jails. 
+(Refer to
+.B devfs(5)
+and
+.N jail(8)
+for more information).
+.br
+.I default: "devfsrules_jail"
+.TP
+.B ezjail_procfs_enable (bool)
+Controls, wheter newly created jails will be given a working
+.I /proc
+directory. (Refer to
+.B procfs(5)
+and
+.B jail(8)
+for more information).
+.br
+.I default: "YES"
+.TP
+.B ezjail_fdescfs_enable (bool)
+Controls, wheter newly created jails will be given a working
+.I /dev/fd/
+directory. (Refer to
+.B fdescfs(5)
+and
+.B jail(8)
+for more information).
+.br
+.I default: "YES"
+.SH FILES
+.TP
+/usr/local/etc/ezjail.conf
+/usr/local/etc/rc.d/ezjail
+.SH "SEE ALSO"
+ezjail-admin(1), ezjail(5), jail(8), devfs(5), fdescfs(5), procfs(5)
+.SH AUTHOR
+Dirk Engling <erdgeist@erdgeist.org>