Skip to content

Commit be09bae

Browse files
a-stjohnBrandon Schneider
authored and
Brandon Schneider
committed
Made changes to iocage docs. Came from ticket48768. (iocage#663)
* Made changes to iocage docs. Came from ticket48768. * Updated with regard to feedback. * Updated with regard to feedback.
1 parent ea461c8 commit be09bae

17 files changed

+35
-11
lines changed

doc/Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
# You can set these variables from the command line.
55
SPHINXOPTS =
6-
SPHINXBUILD = sphinx-build
6+
SPHINXBUILD = sphinx-build-3.6
77
PAPER =
88
BUILDDIR = build
99

-7.3 KB
Binary file not shown.

doc/build/doctrees/basic-use.doctree

-9.54 KB
Binary file not shown.
-2.12 KB
Binary file not shown.

doc/build/doctrees/debian.doctree

-1.5 KB
Binary file not shown.

doc/build/doctrees/environment.pickle

-5.89 KB
Binary file not shown.

doc/build/doctrees/faq.doctree

-2.79 KB
Binary file not shown.

doc/build/doctrees/index.doctree

-1.26 KB
Binary file not shown.

doc/build/doctrees/jailtypes.doctree

-2.17 KB
Binary file not shown.
-2.44 KB
Binary file not shown.

doc/build/doctrees/networking.doctree

-5.42 KB
Binary file not shown.

doc/build/doctrees/templates.doctree

-1.87 KB
Binary file not shown.

doc/build/html/advanced-use.html

+5
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@
127127
<p>Make sure <strong class="command">iocage_enable=&quot;YES&quot;</strong> is set in <code class="file docutils literal"><span class="pre">/etc/rc.conf</span></code>.</p>
128128
<p>To enable a jail to auto-boot during a system boot, simply run:</p>
129129
<p><code class="samp docutils literal"><span class="pre">#</span> <span class="pre">iocage</span> <span class="pre">set</span> <span class="pre">boot=on</span> <span class="pre">UUID|NAME</span></code></p>
130+
<div class="admonition note">
131+
<p class="first admonition-title">Note</p>
132+
<p class="last">Setting <strong class="command">boot=on</strong> during jail creation starts the
133+
jail after the jail is created.</p>
134+
</div>
130135
<div class="section" id="boot-priority">
131136
<span id="index-7"></span><span id="id7"></span><h3>Boot Priority<a class="headerlink" href="#boot-priority" title="Permalink to this headline"></a></h3>
132137
<p>Boot order can be specified by setting the priority value:</p>

doc/build/html/searchindex.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

doc/source/advanced-use.rst

+3
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,9 @@ To enable a jail to auto-boot during a system boot, simply run:
120120

121121
:samp:`# iocage set boot=on UUID|NAME`
122122

123+
.. note:: Setting :command:`boot=on` during jail creation starts the
124+
jail after the jail is created.
125+
123126
.. index:: Boot Priority
124127
.. _Boot Priority:
125128

iocage.8

+25-9
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
.Op Fl U | -jail_user Ar NAME
7575
.Op Fl u | -host_user Ar NAME
7676
.Ar UUID | NAME
77-
.Cm COMMAND Op Ar ARGS
77+
.Cm -- COMMAND Op Ar ARGS
7878
.\" == EXPORT ==
7979
.Nm
8080
.Cm export
@@ -498,15 +498,17 @@ UUID/NAME wrapper for
498498
After invoking
499499
.Cm exec ,
500500
specify the jail, any commands to run inside that jail, and any
501-
arguments for those commands.
501+
arguments for those commands.
502502
.Xr jexec
503-
also runs commands similar to
503+
also runs commands similar to
504504
.Nm .
505505
When using
506506
.Xr jexec
507507
use the JID instead of the jail name.
508-
For more info see the manual page for
508+
For more info see the manual page for
509509
.Xr jexec .
510+
Use -- in front of the specified command to prevent iocage from parsing
511+
them.
510512
.Pp
511513
Options:
512514
.Bl -tag -width "[-u | --host_user NAME]"
@@ -984,8 +986,6 @@ Stop the jail identified by the shortened UUID.
984986
Runs
985987
.Cm freebsd-update
986988
to update the specified jail to the latest patch level.
987-
A backup snapshot is automatically created to provide a rollback
988-
option.
989989
.Pp
990990
Example:
991991
.Pp
@@ -996,6 +996,7 @@ Example:
996996
Runs
997997
.Cm freebsd-update
998998
to upgrade a jail RELEASE to the specified RELEASE.
999+
A backup snapshot is automatically created to provide a rollback option.
9991000
.Pp
10001001
Options:
10011002
.Bl -tag -width "[-r | --release RELEASE]"
@@ -1605,6 +1606,18 @@ Default: 0
16051606
.Pp
16061607
Source:
16071608
.Xr jail 8
1609+
.It Pf allow_tun= Op 0 | 1
1610+
Unhides tun devices for the jail with an individual devfsruleset.
1611+
Allows the creation of tuns in the jail.
1612+
.Pp
1613+
Default: 0
1614+
.It Pf allow_mlock= Op 0 | 1
1615+
Enables running services that require mlock() in a jail.
1616+
.Pp
1617+
Default: 0
1618+
.Pp
1619+
Source:
1620+
.Xr mlock 2
16081621
.It host_hostuuid=UUID
16091622
.Pp
16101623
Default: UUID
@@ -1804,6 +1817,11 @@ Default: none
18041817
.Pp
18051818
Source:
18061819
.Xr jail(8)
1820+
.It Pf vnet_default_interface= Op none | Ar INTERFACE
1821+
Default network interface used for the VNET bridge interface in the jail.
1822+
Only takes effect when VNET is set.
1823+
.Pp
1824+
Default: none
18071825
.El
18081826
.Sh EXAMPLES
18091827
Set up
@@ -1856,9 +1874,7 @@ Also see
18561874
for how traffic is handled.
18571875
Basically, bridges behave like a network switch.
18581876
.Pp
1859-
The PF firewall is not supported inside VNET jails as of July 2014.
1860-
PF can be enabled for the host.
1861-
IPFW is fully supported inside a VNET jail.
1877+
IPFW and PF are fully supported inside a VNET jail.
18621878
.Pp
18631879
The actual jail name in the
18641880
.Xr jls 8

iocage.8.gz

145 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)