From 712cdc830d1456cec055ffd9a96540c047c96225 Mon Sep 17 00:00:00 2001 From: erdgeist Date: Thu, 20 Jan 2011 21:03:50 +0000 Subject: New man pages, also put in new sections --- man5/ezjail.5 | 40 -------- man5/ezjail.conf.5 | 288 ++++++++++++++++++++++++++++++++--------------------- 2 files changed, 176 insertions(+), 152 deletions(-) delete mode 100755 man5/ezjail.5 (limited to 'man5') diff --git a/man5/ezjail.5 b/man5/ezjail.5 deleted file mode 100755 index 62cbb42..0000000 --- a/man5/ezjail.5 +++ /dev/null @@ -1,40 +0,0 @@ -.TH ezjail 5 -.SH NAME -ezjail \- A simple jail setup framework -.SH SYNOPSIS -EZJAIL_PREFIX/etc/rc.d/ezjail.sh -.SH DESCRIPTION -The ezjail framework provides a simple way to create many virtual FreeBSD -servers by using FreeBSD's jail system. It requires little administration -effort and aims for minimum system resource usage. - -If you are not familiar with the FreeBSD jail concept, please refer to -jail(8) before continuing. -.SH OVERVIEW -One \fIbase jail\fR is filled with most userland binaries and libraries and -then mounted read only into a number of stripped down jails via -.B mount_nullfs(8)\fR - thus saving lots of inodes and memory resources. -.SH INVOCATION -The ezjail script \fBEZJAIL_PREFIX/etc/rc.d/ezjail.sh\fR takes parameters \fIstart, -startcrypto, restart\fR and \fIstop\fR. It may be passed an additional list of -jails. If no jail name is specified (usually when the script is called by -rc.local at boot and shutdown time), all jails in ezjail's scope, except crypto -image jails (or jails marked as blocking), are started/stopped. To start -all crytpo image jails (or those depending on them), use the \fIstartcrypto\fR parameter. - -The script examines its config, attaches and mounts images, and sets -variables for each jail in the jail_list before passing its command on -to the \fB/etc/rc.d/jail\fR script. -.SH NOTES -.B ezjail.sh\fR enforces the execution of \fB/etc/rc.d/jail\fR, by -prepending \fI"one"\fR to the start, restart, and stop commands so it is -.B NOT NECESSARY\fR to set \fIjail_enable\fR in the \fB/etc/rc.conf\fR -config file. -.SH FILES -EZJAIL_PREFIX/etc/ezjail.conf -.br -EZJAIL_PREFIX/etc/rc.d/ezjail.sh -.SH "SEE ALSO" -ezjail-admin(1), ezjail.conf(5), jail(8), mount_nullfs(8) -.SH AUTHOR -Dirk Engling diff --git a/man5/ezjail.conf.5 b/man5/ezjail.conf.5 index 81ac1ba..27e6e2a 100755 --- a/man5/ezjail.conf.5 +++ b/man5/ezjail.conf.5 @@ -1,143 +1,207 @@ -.TH ezjail.conf 5 -.SH NAME -ezjail.conf \- configuration file for ezjail script -.SH DESCRIPTION +.Dd January 15, 2011 +.Dt EZJAIL.CONF 5 USD +.Os FreeBSD +.Sh NAME +.Pa ezjail.conf +.Nd configuration file for ezjail script +.Sh DESCRIPTION The file -.B ezjail.conf +.Pa ezjail.conf contains settings 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) +.Cm ezjail-admin +utility to figure out where it should perform its actions. Its path is +set at installation time to +.Pa EZJAIL_PREFIX/etc/ezjail.conf , +with an example file installed at +.Pa EZJAIL_PREFIX/etc/ezjail.conf.sample . +.Pp +This file is really a shell script that is sourced by the +.Cm ezjail-admin +command at run-time. +.Dq (str) +denotes a string; it should be enclosed in quotes if it contains space. +.Dq (bool) +notes a boolean, whose possible values are +.Dq YES +and +.Dq NO . +.Sh PATH OPTIONS +.Bl -tag -width option +.It ezjail_jaildir (str) +Location of jail root directories. +.br +Default: +.Em /usr/jails . +.It ezjail_jailtemplate (str) Location of template jail used to create a new jail .br -.I default: /usr/jails/newjail -.TP -.B ezjail_jailbase (str) +Default: +.Em ${ezjail_jaildir}/newjail . +.It 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) +Default: +.Em ${ezjail_jaildir}/basejail . +.It 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 -.TP -.B ezjail_portscvsroot (str) -Cvs root to use when checking out or updating the ports tree in base jail -.br -.I default: :pserver:anoncvs@anoncvs.at.FreeBSD.org:/home/ncvs -.TP -.B ezjail_ftphost (str) -This is where the install subcommand defaults to fetch its packages from -.br -.I default: ftp.freebsd.org -.TP -.B ezjail_archivedir (str) -This is the default archive location for the \fIezjail-admin archive\fR command. -.br -.I default: `pwd -P` -.SH JAIL ADMIN OPTIONS -.TP -.B ezjail_default_execute (str) -This is the default command executed in a jail by ezjail-admin console. -.br -.I default: YES -.SH JAIL CREATION OPTIONS +.Xr ezjail-admin 1 +utility for more information). +.br +Default: +.Em /usr/src . +.It ezjail_flavours_dir (str) +Location of the flavours, where each directory is a different flavour. +.br +Default: +.Em ${ezjail_jaildir}/flavours . +.It ezjail_portscvsroot (str) +CVS root to use when checking out or updating the ports tree in base jail. +.br +Default: +.Em :pserver:anoncvs@anoncvs.FreeBSD.org:/home/ncvs . +.It ezjail_ftphost (str) +This is where the install subcommand defaults to fetch its packages from. +.br +Default: +.Em ftp.freebsd.org . +.It ezjail_archivedir (str) +This is the default archive location for the +.Cm ezjail-admin archive +command. +.br +Default: +.Em ${ezjail_jaildir}/ezjail_archives . +.El +.Sh JAIL ADMIN OPTIONS +.Bl -tag -width option +.It ezjail_default_execute (str) +This is the default command executed in a jail by +.Cm ezjail-admin console . +.br +Default: +.Em /usr/bin/login -f root . +.It ezjail_exec_start (str) +The command to execute in a jail when starting it. +.br +Default: +.Em /bin/sh /etc/rc . +.El +.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 whether /etc/fstab.hostname should be executed at jail startup -time. -.br -.I default: "YES" -.TP -.B ezjail_devfs_enable (bool) +.Xr ezjail-admin 1 +utility. Be careful about disabling +.Em ezjail_mount_enable . +.Bl -tag -width option +.It ezjail_mount_enable (bool) +Controls whether +.Pa /etc/fstab. Ar hostname +should be executed at jail startup time. +.br +Default: +.Em YES . +.It ezjail_devfs_enable (bool) Controls whether newly created jails are given a working -.I /dev +.Pa /dev directory. (Refer to -.B devfs(5) +.Xr devfs 5 and -.B jail(8) +.Xr 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. +Default: +.Em YES . +.It ezjail_devfs_ruleset (str) +Specifies which devfs ruleset should apply for newly created jails. (Refer to -.B devfs(5) +.Xr devfs 5 and -.N jail(8) +.Xr jail 8 for more information). .br -.I default: "devfsrules_jail" -.TP -.B ezjail_procfs_enable (bool) +Default: +.Em devfsrules_jail . +.It ezjail_procfs_enable (bool) Controls whether newly created jails are given a working -.I /proc +.Pa /proc directory. (Refer to -.B procfs(5) +.Xr procfs 5 and -.B jail(8) +.Xr jail (8) for more information). .br -.I default: "YES" -.TP -.B ezjail_fdescfs_enable (bool) +Default: +.Em YES . +.It ezjail_fdescfs_enable (bool) Controls whether newly created jails are given a working -.I /dev/fd/ +.Pa /dev/fd/ directory. (Refer to -.B fdescfs(5) +.Xr fdescfs (5) and -.B jail(8) +.Xr jail (8) for more information). .br -.I default: "YES" -.TP -.B ezjail_uglyperlhack (bool) -Set to YES, if ezjail should provide a soft link from /usr/bin/perl to /usr/local/bin/perl in base jail. -.br -.I default: YES -.TP -.B ezjail_default_flavour (str) -Controls which flavours should be used for newly created jails if none are given on the command line. -.br -.I default: none -.SH ZFS OPTIONS -.TP -.B ezjail_use_zfs (bool) -Set to YES, if ezjail should manage basejail and newjail in a seperate ZFS-datasets. -.br -.I default: NO -.TP -.B ezjail_jailzfs (str) -The name of the parent ZFS-dataset which ezjail will use to create jails on. It will be mounted at the ezjail_jaildir. Setting this will automaticly enable ezjail managing jails in seperate ZFS-datasets. -.br -.I default: none -.TP -.B ezjail_zfs_properties (str) -Default properties ZFS will use for creating datasets. See zfs(1m) for details. ADVANCED, be very careful! -.br -.I default: none -.SH FILES +Default: +.Em YES . +.It ezjail_uglyperlhack (bool) +Set to YES, if ezjail should provide a soft link from +.Pa /usr/bin/perl +to +.Pa /usr/local/bin/perl +in base jail. +.br +Default: +.Em YES . +.It ezjail_default_flavour (str) +Controls which flavours should be used for newly created jails if none +are given on the command line. +.br +Default: +.Em none . +.It ezjail_imagetype (one of simple, bde, eli, zfs) +Type of jail to create when creating a jail with the +.Fl i +flag without specifying the type explicitely. +.br +Default: +.Em simple +.El +.Sh ZFS OPTIONS +.Bl -tag -width option +.It ezjail_use_zfs (bool) +Set to YES, if ezjail should manage basejail and newjail in a seperate +ZFS-datasets. +.br +Default: +.Em NO . +.It ezjail_jailzfs (str) +The name of the parent ZFS-dataset which ezjail will use to create +jails on. It will be mounted in +.Em ezjail_jaildir . +Setting this will automaticly enable ezjail managing jails in seperate +ZFS-datasets. +.br +Default: +.Em none . +.It ezjail_zfs_properties (str) +Default properties ZFS will use for creating datasets. See +.Xr zfs 1m +for details. ADVANCED, be very careful! +.br +Default: +.Em none . +.El +.Sh FILES EZJAIL_PREFIX/etc/ezjail.conf .br EZJAIL_PREFIX/etc/rc.d/ezjail.sh -.SH "SEE ALSO" -ezjail-admin(1), ezjail(5), jail(8), devfs(5), fdescfs(5), procfs(5) -.SH AUTHOR -Dirk Engling +.Sh SEE ALSO +.Xr ezjail-admin 1 , +.Xr ezjail 5 , +.Xr jail 8 , +.Xr devfs 5 , +.Xr fdescfs 5 , +.Xr procfs 5 . +.Sh AUTHOR +Dirk Engling +.Aq erdgeist@erdgeist.org . -- cgit v1.2.3