diff options
Diffstat (limited to 'doc')
| -rwxr-xr-x | doc/injail_man.html | 46 | ||||
| -rwxr-xr-x | doc/jailer_man.html | 109 |
2 files changed, 155 insertions, 0 deletions
diff --git a/doc/injail_man.html b/doc/injail_man.html new file mode 100755 index 0000000..6854e73 --- /dev/null +++ b/doc/injail_man.html @@ -0,0 +1,46 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>injail</B> utility returns a result which indicates the jailed status of + the current process environment. + + +</PRE> +<H2>DIAGNOSTICS</H2><PRE> + The <B>injail</B> utility exits with one of the following values: + 0 the process is running in a jail. + 1 the process is not running in a jail. + 2 an error prevented determining if the process is running in a + jail. + + +</PRE> +<H2>BUGS</H2><PRE> + <B>injail</B> uses <B>kvm_getprocs(3)</B> to determine process status. Anything which + could cause a failure in either <B>kvm_open(3)</B> or <B>kvm_getprocs(3)</B> can cause + this to fail as well. There aught to be a cleaner way. + + +</PRE> +<H2>AUTHOR</H2><PRE> + James E. Quick <jq@quick.com> + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B>jailer(8)</B>, <B>jail(8)</B>, <B>kvm(3)</B> + +FreeBSD 4.6 May 28, 2002 FreeBSD 4.6 +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> diff --git a/doc/jailer_man.html b/doc/jailer_man.html new file mode 100755 index 0000000..229d297 --- /dev/null +++ b/doc/jailer_man.html @@ -0,0 +1,109 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>jailer</B> <B>[</B> <I>console-file</I> <B>]</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + <B>jailer</B> manages the startup and shutdown of a jail from + within the jail. It also manages the jails console by + linking /dev/console inside the jail to a log file. + + To use, replace the '/bin/sh /etc/rc' portion of your jail + startup command with jailer. For example instead of: + + <B>jail</B> <B>/jails/myjail</B> <B>host</B> <B>10.0.1.1</B> <B>/bin/sh</B> <B>/etc/rc</B> + + use: + + <B>jail</B> <B>/jails/myjail</B> <B>host</B> <B>10.0.1.1</B> <B>/usr/local/sbin/jailer</B> + + + <B>jailer</B> will start the jail by running <I>/etc/rc</I> and then + remain running as a daemon inside the jail waiting for + signals to perform shutdown or restarts. + + A shutdown is performed by first running <I>/etc/rc.shutdown</I>, + and then killing all the processes still running. A + restart is a combination of the above. + + + The following signals have special meaning to the jailer: + + HUP Causes <B>jailer</B> to restart the jail. If the jail is + not running at the time it is simply started. + + QUIT Initiates a jail shutdown. <B>jailer</B> remains running + after processing the request. + + TERM Same as <I>QUIT</I> but also quits jailer. No more pro- + cesses will be left running inside the jail. + + + +</PRE> +<H2>JAIL CONSOLE MANAGEMENT</H2><PRE> + A normal jail has no console perse, and <B>dmesg(8)</B> reads + straight from the host kernel message buffer. <B>jailer</B> + changes this to provide a virtual console for the jail. + + On jailer startup the file <I>/var/log/console</I> is created or + truncated. <I>/dev/console</I> is then hard linked to the con- + sole file. + + Along with the jailer distribution you'll find a new + <B>dmesg(8)</B> which just reads from <I>/dev/console.</I> Replace + <B>/sbin/</B><B>dmesg(8)</B> with this new executable and you're set. + + + +</PRE> +<H2>OPTIONS</H2><PRE> + console-file + Overrides the default location of the console log + file, usually <I>/var/log/console</I> + + + +</PRE> +<H2>FILES</H2><PRE> + <I>/var/log/console</I> + Virtual console file. + + + +</PRE> +<H2>BUGS</H2><PRE> + Virtual jail consoles don't work with FreeBSD 5.0 yet. + This is due to <B>devfs(8)</B> + + <B>shutdown(8)</B> doesn't work with the <I>halt</I> and <I>reboot</I> scripts. + + + +</PRE> +<H2>AUTHOR</H2><PRE> + Nate Nielsen <nielsen@memberwebs.com> + + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B>jail(8)</B>, <B>halt(8)</B>, <B>reboot(8)</B>, <B>dmesg(8)</B> + + + +Version 1.2 May 2002 <B>JAILER(8)</B> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |