Mirrors/BastilleBSD_bastille
1
0
Fork 1
mirror of https://github.com/BastilleBSD/bastille.git synced 2025-12-11 01:19:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Finish man pages

Browse Source
This commit is contained in:
tschettervictor
2025-12-06 23:19:19 -07:00
parent cb7e9811fc
commit b60af850c9
117 changed files with 3591 additions and 494 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/chapters/subcommands/bootstrap.rst
View File

@@ -1,8 +1,6 @@
bootstrap
=========
Bootstrap a release or template(s).
The bootstrap sub-command is used to download and extract releases and templates
for use with Bastille containers. A valid release is needed before containers
can be created. Templates are optional but are managed in the same manner.
@@ -126,9 +124,11 @@ begin applying your template.
.. code-block:: shell
ishmael ~ # bastille bootstrap help
Usage: bastille bootstrap [option(s)] RELEASE|TEMPLATE [update|arch]
Usage: bastille bootstrap [option(s)] RELEASE [update|ARCH]
TEMPLATE
Options:
-p | --pkgbase Bootstrap using pkgbase (15.0-RELEASE and above).
-p | --pkgbase Bootstrap using pkgbase (FreeBSD 15.0-RELEASE and above).
-u | --update Update the release after bootstrap.
-x | --debug Enable debug mode.

2
docs/chapters/subcommands/clone.rst
View File

@@ -1,8 +1,6 @@
clone
=====
Clone an existing jail.
Limitations
-----------

2
docs/chapters/subcommands/cmd.rst
View File

@@ -1,8 +1,6 @@
cmd
===
Execute command inside targeted jail(s).
.. code-block:: shell
ishmael ~ # bastille cmd folsom ps -auxw

4
docs/chapters/subcommands/config.rst
View File

@@ -1,8 +1,6 @@
config
======
Get, set, add or remove properties from targeted jail(s).
Getting a property that *is* defined in jail.conf:
.. code-block:: shell
@@ -43,4 +41,4 @@ The restart message will appear every time a property is removed.
Options:
-x | --debug Enable debug mode.
-x | --debug Enable debug mode.

4
docs/chapters/subcommands/console.rst
View File

@@ -21,5 +21,5 @@ jail are limited to the jail.
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.

13
docs/chapters/subcommands/convert.rst
View File

@@ -1,10 +1,6 @@
convert
=======
Convert a thin jail to a thick jail.
Convert a thick jail to a custom release.
Converting a thin jail to a thick jail requires only the TARGET arg.
.. code-block:: shell
@@ -28,10 +24,11 @@ flag.
.. code-block:: shell
ishmael ~ # bastille convert help
Usage: bastille convert [option(s)] TARGET [RELEASE]
Usage: bastille convert [option(s)] TARGET
TARGET RELEASE
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-y | --yes Do not prompt. Just convert.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-y | --yes Do not prompt. Assume always yes.
-x | --debug Enable debug mode.

6
docs/chapters/subcommands/cp.rst
View File

@@ -1,8 +1,6 @@
cp
==
Copy files from host to jail(s).
.. code-block:: shell
ishmael ~ # bastille cp ALL /tmp/resolv.conf-cf /etc/resolv.conf
@@ -28,5 +26,5 @@ Unless you see errors reported in the output the ``cp`` was successful.
Options:
-q | --quiet Suppress output.
-x | --debug Enable debug mode.
-q | --quiet Suppress output.
-x | --debug Enable debug mode.

30
docs/chapters/subcommands/create.rst
View File

@@ -57,20 +57,20 @@ options. See the below help output.
Options:
-B | --bridge Enable VNET, and attach to a specified, already existing external bridge.
-C | --clone Create a clone jail.
-D | --dual Create jail with both IPv4 and IPv6 networking ('inherit' and 'ip_hostname' only).
-E | --empty Create an empty container, intended for custom jail builds (thin/thick/linux or unsupported).
-g | --gateway IP Specify a default router/gateway for the jail.
-B | --bridge Enable VNET. INTERFACE must be a bridge.
-C | --clone Create a clone jail (ZFS only).
-D | --dual Use dual (IPv4+6) networking (IP=[inherit|ip_hostname] only).
-E | --empty Create an empty jail.
-g | --gateway IP Specify a default router/gateway.
-L | --linux Create a Linux jail (experimental).
-M | --static-mac Generate a static MAC address for jail (VNET only).
-n | --nameserver IP,IP Specify nameserver(s) for the jail. Comma separated.
--no-validate Do not validate the release when creating the jail.
--no-boot Create jail with boot=off.
-P | --passthrough Enable VNET, and pass the specified interface into the jail.
-p | --priority VALUE Set priority value for jail.
-T | --thick Creates a thick container, they consume more space as they are self contained and independent.
-V | --vnet Enable VNET, and attach to an existing, physical interface.
-v | --vlan VLANID Creates the jail with specified VLAN ID (VNET only).
-M | --static-mac Use a static/persistent MAC address (VNET only).
-n | --nameserver IP Specify nameserver(s) for the jail. Comma-separated.
--no-validate Do not validate the release name.
--no-boot Set boot=off.
-P | --passthrough Enable VNET. INTERFACE is used as-is.
-p | --priority VALUE Set priority value.
-T | --thick Create a thick jail.
-V | --vnet Enable VNET. INTERFACE must be a physical interface.
-v | --vlan VLANID Set VLAN ID (VNET only).
-x | --debug Enable debug mode.
-Z | --zfs-opts zfs,options Comma separated list of ZFS options to create the jail with. This overrides the defaults.
-Z | --zfs-opts zfs,options Custom zfs options. Comma-separated.

15
docs/chapters/subcommands/destroy.rst
View File

@@ -1,8 +1,6 @@
destroy
=======
Destroy jails or releases.
Bastille will normally ask if you are sure you want to delete targeted jail(s).
Use the ``-y|--yes`` option to bypass this prompt.
@@ -21,12 +19,13 @@ option will retain the release cache (*.txz file), if you choose to keep it.
.. code-block:: shell
ishmael ~ # bastille destroy help
Usage: bastille destroy [option(s)] JAIL|RELEASE
Usage: bastille destroy [option(s)] JAIL
RELEASE
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-c | --no-cache Do no destroy cache when destroying a release.
-f | --force Force unmount any mounted datasets when destroying a jail or release (ZFS only).
-y | --yes Do no prompt. Just destroy.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-c | --no-cache Do not destroy cache when destroying a release (legacy releases).
-f | --force Force unmount any mounted datasets when destroying a jail or release (ZFS only).
-y | --yes Do not prompt. Assume always yes.
-x | --debug Enable debug mode.

2
docs/chapters/subcommands/edit.rst
View File

@@ -1,8 +1,6 @@
edit
====
Edit jail config files.
.. code-block:: shell
ishmael ~ # bastille edit azkaban [FILE]

10
docs/chapters/subcommands/etcupdate.rst
View File

@@ -39,10 +39,12 @@ To show only the differences between the releases, use the ``diff`` command.
.. code-block:: shell
ishmael ~ # bastille etcupdate help
Usage: bastille etcupdate [option(s)] [bootstrap|TARGET] [diff|resolve|update RELEASE]
Usage: bastille etcupdate [option(s)] bootstrap RELEASE
TARGET update RELEASE
TARGET diff|resolve
Options:
-d | --dry-run Show output, but do not apply.
-f | --force Force a re-bootstrap of a RELEASE.
-x | --debug Enable debug mode.
-d | --dry-run Show output, but do not apply.
-f | --force Force a re-bootstrap of a RELEASE.
-x | --debug Enable debug mode.

6
docs/chapters/subcommands/export.rst
View File

@@ -22,15 +22,15 @@ Available options are:
.. code-block:: shell
ishmael ~ # bastille export help
Usage: bastille export [option(s)] TARGET PATH
Usage: bastille export [option(s)] TARGET [PATH]
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-l | --live Export a running jail (ZFS only).
--gz Export to '.gz' compressed image (ZFS only).
--gz Export to a '.gz' compressed image (ZFS only).
--xz Export to a '.xz' compressed image (ZFS only).
--zst Export to a .zst compressed image (ZFS only).
--zst Export to a '.zst' compressed image (ZFS only).
--raw Export to an uncompressed RAW image (ZFS only).
--tgz Export to a '.tgz' compressed archive.
--txz Export to a '.txz' compressed archive.

4
docs/chapters/subcommands/htop.rst
View File

@@ -15,5 +15,5 @@ in the jail.
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.

6
docs/chapters/subcommands/import.rst
View File

@@ -1,8 +1,6 @@
import
======
Import a jail backup image or archive.
.. code-block:: shell
ishmael ~ # bastille import /path/to/archive.file
@@ -19,8 +17,8 @@ To import to a specified release, specify it as the last argument.
Options:
-f | --force Force an archive import regardless if the checksum file does not match or missing.
-M | --static-mac Generate static MAC for jail when importing foreign jails like iocage.
-f | --force Force an archive import without validating checksum.
-M | --static-mac Use a static/persistent MAC address (VNET only) when importing foreign jails.
-v | --verbose Enable verbose mode (ZFS only).
-x | --debug Enable debug mode.

8
docs/chapters/subcommands/jcp.rst
View File

@@ -1,8 +1,6 @@
jcp
===
Copy files from jail to jail(s).
.. code-block:: shell
ishmael ~ # bastille jcp bastion /tmp/resolv.conf-cf ALL /etc/resolv.conf
@@ -22,9 +20,9 @@ Unless you see errors reported in the output the ``jcp`` was successful.
.. code-block:: shell
ishmael ~ # bastille jcp help
Usage: bastille jcp [option(s)] SOURCE_JAIL JAIL_PATH DEST_JAIL JAIL_PATH
Usage: bastille jcp [option(s)] SOURCE_JAIL JAIL_PATH DESTINATION_JAIL JAIL_PATH
Options:
-q | --quiet Suppress output.
-x | --debug Enable debug mode.
-q | --quiet Suppress output.
-x | --debug Enable debug mode.

13
docs/chapters/subcommands/limits.rst
View File

@@ -4,8 +4,6 @@ limits
rctl
----
Set resourse limits for targeted jail(s).
To add a limit, use ``bastille limits TARGET add OPTION VALUE``.
To clear the limits from the system, use ``bastille limits TARGET clear``.
@@ -43,13 +41,16 @@ This file can be edited manually using ``bastille edit TARGET cpuset.conf``.
.. code-block:: shell
ishmael ~ # bastille limits help
Usage: bastille limits [option(s)] TARGET [add|remove|clear|reset|(list|show [active])|stats] OPTION [VALUE]
Usage: bastille limits [option(s)] TARGET add OPTION VALUE
TARGET remove OPTION"
TARGET clear|reset|stats"
TARGET list|show [active]"
Example: bastille limits TARGET add memoryuse 1G
Example: bastille limits TARGET add cpu 0,1,2
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-l | --log Enable logging for the specified rule (rctl only).
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-l | --log Enable logging for the specified rule (RCTL only).
-x | --debug Enable debug mode.

15
docs/chapters/subcommands/list.rst
View File

@@ -13,12 +13,13 @@ Use ``-p|--pretty`` to print in columns instead of rows.
.. code-block:: shell
ishmael ~ # bastille list help
Usage: bastille list [option(s)] [RELEASE (-p)] [all] [backup(s)] [export(s)] [import(s)] [ip(s)] [jail(s)] [limit(s)] [log(s)]
[path(s)] [port(s)] [prio|priority] [release(s)] [state(s)] [template(s)] [type]
Usage: bastille list [option(s)] [all|backup|export|import|ip|jail|limit]"
[log|path|port|priority|release|snapshot|state|template|type]"
Options:
-d | --down List stopped jails only.
-j | --json List jails or sub-arg(s) in json format.
-p | --pretty Print JSON in columns. Must be used with -j|--json.
-u | --up List running jails only.
-x | --debug Enable debug mode.
-d | --down List stopped jails only.
-j | --json List jails or sub-arg(s) in json format.
-p | --pretty Print JSON in columns. Must be used with -j|--json.
-u | --up List running jails only.
-x | --debug Enable debug mode.

8
docs/chapters/subcommands/migrate.rst
View File

@@ -14,16 +14,10 @@ port by supplying it as in ``user@host:port``.
ishmael ~ # bastille migrate help
Usage: bastille migrate [option(s)] TARGET USER@HOST[:PORT]
Examples:
bastille migrate attica migrate@192.168.10.100
bastille migrate attica migrate@192.168.1.10:20022
bastille migrate --keyfile id_rsa attica migrate@192.168.1.10
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-b | --backup Retain archives on remote system.
-b | --backup Keep archives on remote system.
-d | --destroy Destroy local jail after migration.
| --doas Use 'doas' instead of 'sudo'.
-k | --keyfile Specify an alternative private keyfile name. Must be in '~/.ssh'

8
docs/chapters/subcommands/mount.rst
View File

@@ -1,8 +1,6 @@
mount
=====
To mount storage within the container use ``bastille mount``.
Syntax follows standard ``/etc/fstab`` format:
.. code-block:: shell
@@ -67,8 +65,8 @@ It is possible to do the same for the jail path, but again, not recommemded.
.. code-block:: shell
ishmael ~ # bastille mount help
Usage: bastille mount [option(s)] TARGET HOST_PATH JAIL_PATH [filesystem_type options dump pass_number]
Usage: bastille mount [option(s)] TARGET HOST_PATH JAIL_PATH [FS_TYPE OPTIONS DUMP PASS_NUMBER]
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.

13
docs/chapters/subcommands/network.rst
View File

@@ -1,8 +1,6 @@
network
=======
Add or remove interfaces to existing jails.
You can only add an interface once to a jail, with two exceptions.
1. For classic jails, you can add an interface as many times as you want, but
@@ -36,15 +34,16 @@ network TARGET remove INTERFACE`` while both jails are stopped.
.. code-block:: shell
ishmael ~ # bastille network help
Usage: bastille network [option(s)] TARGET [remove|add] INTERFACE [IP]
Usage: bastille network [option(s)] TARGET add INTERFACE [IP]
TARGET remove INTERFACE
Options:
-a | --auto Start/stop jail(s) if required.
-B | --bridge Add a bridge VNET interface.
-M | --static-mac Generate a static MAC address for the interface (VNET only).
-B | --bridge Add a bridge interface.
-M | --static-mac Use a static/persistent MAC address (VNET only).
-n | --no-ip Create interface without an IP (VNET only).
-P | --passthrough Add a raw interface.
-V | --vnet Add a VNET interface.
-v | --vlan VLANID Assign VLAN ID to interface (VNET only).
-V | --vnet Add a physical interface.
-v | --vlan VLANID Assign VLANID to interface (VNET only).
-x | --debug Enable debug mode.

10
docs/chapters/subcommands/pkg.rst
View File

@@ -1,8 +1,6 @@
pkg
===
Manage binary packages inside jails.
.. code-block:: shell
ishmael ~ # bastille pkg folsom install vim-console git-lite zsh
@@ -111,7 +109,7 @@ you can fully leverage the pkg manager. This means, ``install``, ``update``,
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-H | --host Use the hosts 'pkg' instead of the jails.
-y | --yes Assume always yes for pkg. Do not prompt.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-H | --host Use host 'pkg' binary instead of jails.
-y | --yes Do not prompt. Assume always yes.
-x | --debug Enable debug mode.

6
docs/chapters/subcommands/rcp.rst
View File

@@ -1,8 +1,6 @@
rcp
===
This command allows copying files from jail to host.
.. code-block:: shell
ishmael ~ # bastille rcp bastion /test/testfile.txt /tmp/testfile.txt
@@ -18,5 +16,5 @@ Unless you see errors reported in the output the ``rcp`` was successful.
Options:
-q | --quiet Suppress output.
-x | --debug Enable debug mode.
-q | --quiet Suppress output.
-x | --debug Enable debug mode.

11
docs/chapters/subcommands/rdr.rst
View File

@@ -75,12 +75,13 @@ Simply use the table name instead of an IP address or subnet.
.. code-block:: shell
# bastille rdr --help
Usage: bastille rdr TARGET [option(s)] [clear|reset|list|(tcp|udp host_port jail_port [log ['(' logopts ')'] ] )]
Usage: bastille rdr [option(s)] TARGET tcp|udp HOST_PORT JAIL_PORT [log LOG_OPTIONS]
TARGET clear|reset|list
Options:
-d | --destination IP Limit rdr to a destination IP. Useful if you have multiple IPs on one interface.
-i | --interface IF,IF Specify interface(s) to apply rule to. Comman separated.
-s | --source IP|table Limit rdr to a source IP or table.
-t | --type ipv4|ipv6 Specify IP type. Must be used if -s or -d are used. Defaults to both.
-d | --destination IP Limit rdr to a destination IP.
-i | --interface IF,IF Specify interface(s) to apply rule to. Comma-separated.
-s | --source IP|TABLE Limit rdr to a source IP or table.
-t | --type ipv4|ipv6 Specify IP type. Must be used if '-s' or '-d' are used. Defaults to both.
-x | --debug Enable debug mode.

6
docs/chapters/subcommands/rename.rst
View File

@@ -1,8 +1,6 @@
rename
======
Rename a jail.
.. code-block:: shell
ishmael ~ # bastille rename azkaban arkham
@@ -14,5 +12,5 @@ Rename a jail.
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.

4
docs/chapters/subcommands/restart.rst
View File

@@ -1,8 +1,6 @@
restart
=======
Restart jail(s).
Bastille will attempt to stop, then start the targetted jail(s). If a jail is
not running, Bastille will still start it. To avoid this, run the restart
command with ``-i|--ignore`` to skip any stopped jail(s).
@@ -25,5 +23,5 @@ command with ``-i|--ignore`` to skip any stopped jail(s).
-b | --boot Respect jail boot setting.
-d | --delay VALUE Time (seconds) to wait after starting each jail.
-i | --ignore Ignore stopped jails (do not start if stopped).
-v | --verbose Print every action on jail restart.
-v | --verbose Enable verbose mode.
-x | --debug Enable debug mode.

6
docs/chapters/subcommands/service.rst
View File

@@ -17,9 +17,9 @@ inside the jail(s).
.. code-block:: shell
ishmael ~ # bastille service help
Usage: bastille service [option(s)] TARGET SERVICE_NAME ARGS
Usage: bastille service [option(s)] TARGET SERVICE ARGS
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.

15
docs/chapters/subcommands/setup.rst
View File

@@ -58,16 +58,9 @@ Running ``bastille setup`` without any options will attempt to auto-configure th
.. code-block:: shell
ishmael ~ # bastille setup -h
Usage: bastille setup [option(s)] [bridge]
[linux]
[loopback]
[netgraph]
[pf|firewall]
[shared]
[storage]
[vnet]
Usage: bastille setup [option(s)] [bridge|linux|loopback|netgraph|firewall|shared|storage|vnet]
Options:
Options:
-y | --yes Assume always yes on prompts.
-x | --debug Enable debug mode.
-y | --yes Do not prompt. Assume always yes.
-x | --debug Enable debug mode.

10
docs/chapters/subcommands/start.rst
View File

@@ -1,8 +1,6 @@
start
=====
Start jail(s).
.. code-block:: shell
ishmael ~ # bastille start folsom
@@ -16,7 +14,7 @@ Start jail(s).
Options:
-b | --boot Respect jail boot setting.
-d | --delay VALUE Time (seconds) to wait after starting each jail.
-v | --verbose Print every action on jail start.
-x | --debug Enable debug mode.
-b | --boot Respect jail boot setting.
-d | --delay VALUE Time (seconds) to wait after starting each jail.
-v | --verbose Enable verbose mode.
-x | --debug Enable debug mode.

6
docs/chapters/subcommands/stop.rst
View File

@@ -1,8 +1,6 @@
stop
====
Stop jail(s).
.. code-block:: shell
ishmael ~ # bastille stop folsom
@@ -16,5 +14,5 @@ Stop jail(s).
Options:
-v | --verbose Print every action on jail stop.
-x | --debug Enable debug mode.
-v | --verbose Enable verbose mode.
-x | --debug Enable debug mode.

4
docs/chapters/subcommands/sysrc.rst
View File

@@ -19,5 +19,5 @@ See ``man sysrc(8)`` for more info.
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.

7
docs/chapters/subcommands/tags.rst
View File

@@ -1,8 +1,6 @@
tags
====
The ``tags`` sub-command adds, removes or lists arbitrary tags on your jail(s).
.. code-block:: shell
ishmael ~ # bastille tags help ## display tags help
@@ -14,8 +12,9 @@ The ``tags`` sub-command adds, removes or lists arbitrary tags on your jail(s).
.. code-block:: shell
ishmael ~ # bastille tags help
Usage: bastille tags [option(s)] TARGET [add|delete|list] [tag1,tag2]
Usage: bastille tags [option(s)] TARGET add|delete TAG1,TAG2
TARGET list [TAG]
Options:
-x | --debug Enable debug mode.
-x | --debug Enable debug mode.

8
docs/chapters/subcommands/template.rst
View File

@@ -1,8 +1,6 @@
template
========
Run preconfigured template files inside targeted jail(s).
.. code-block:: shell
ishmael ~ # bastille template azkaban project/template
@@ -17,9 +15,9 @@ The TEMPLATE arg should be called with the ``project/template`` format.
.. code-block:: shell
ishmael ~ # bastille template help
Usage: bastille template [option(s)] TARGET [--convert] TEMPLATE
Usage: bastille template [option(s)] TARGET|--convert TEMPLATE
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.

7
docs/chapters/subcommands/top.rst
View File

@@ -1,9 +1,6 @@
top
===
This command runs ``top`` in the targeted jail.
.. image:: ../../images/top.png
:align: center
:alt: bastille top container
@@ -15,5 +12,5 @@ This command runs ``top`` in the targeted jail.
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.

6
docs/chapters/subcommands/umount.rst
View File

@@ -1,8 +1,6 @@
umount
======
Unmount storage from jail(s).
.. code-block:: shell
ishmael ~ # bastille umount azkaban /media/foo
@@ -34,5 +32,5 @@ backslash \, and enclose the mount point in quotes "".
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-x | --debug Enable debug mode.

6
docs/chapters/subcommands/update.rst
View File

@@ -48,6 +48,6 @@ will be updated just like the release shown above.
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-f | --force Force update a release.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-f | --force Force update a release (FreeBSD legacy releases).
-x | --debug Enable debug mode.

9
docs/chapters/subcommands/upgrade.rst
View File

@@ -8,10 +8,11 @@ upgraded normally.
.. code-block:: shell
ishmael ~ # bastille upgrade help
Usage: bastille upgrade [option(s)] TARGET NEW_RELEASE|install
Usage: bastille upgrade [option(s)] TARGET NEW_RELEASE
TARGET install
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-f | --force Force upgrade a jail.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-f | --force Force upgrade a release (FreeBSD legacy releases).
-x | --debug Enable debug mode.

2
docs/chapters/subcommands/verify.rst
View File

@@ -40,4 +40,4 @@ release or template .
Options:
-x | --debug Enable debug mode.
-x | --debug Enable debug mode.

10
docs/chapters/subcommands/zfs.rst
View File

@@ -24,14 +24,14 @@ To destroy a snaphot however, you must supply a TAG. To destroy a snapshot, run
.. code-block:: shell
ishmael ~ # bastille zfs help
Usage: bastille zfs [option(s)] TARGET destroy|rollback|snapshot TAG"
Usage: bastille zfs [option(s)] TARGET snapshot|destroy|rollback [TAG]"
df|usage"
get|set key=value"
get|set KEY=VALUE"
jail pool/dataset /jail/path"
unjail pool/dataset"
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.
-v | --verbose Enable verbose mode.
-x | --debug Enable debug mode.
-a | --auto Auto mode. Start/stop jail(s) if required.
-v | --verbose Enable verbose mode.
-x | --debug Enable debug mode.

51
docs/chapters/usage.rst
View File

@@ -13,42 +13,43 @@ Usage
Available Commands:
bootstrap Bootstrap a release or template(s).
clone Clone an existing jail.
cmd Execute command inside targeted jail(s).
config Get, set, add or remove properties from targeted jail(s).
cmd Execute command(s) inside jail(s).
config Get, set, add or remove properties from jail(s).
console Console into a jail.
convert Convert thin jail to thick jail, or convert a jail to a custom release.
cp cp(1) files from host to targeted jail(s).
convert Convert a jail from thin to thick; convert a jail to a custom release.
cp Copy file(s)/directorie(s) from host to jail(s).
create Create a jail.
destroy Destroy a jail or release.
destroy Destroy jail(s) or release(s).
edit Edit jail configuration files (advanced).
etcupdate Update /etc for jail(s).
export Export a jail.
help Help about any command.
help Help for any command.
htop Interactive process viewer (requires htop).
import Import a jail.
jcp cp(1) files from a jail to jail(s).
limits Apply resources limits to targeted jail(s). See rctl(8) and cpuset(1).
jcp Copy file(s)/directorie(s) from jail to jail(s).
limits Apply resources limits to jail(s). See rctl(8) and cpuset(1).
list List jails, releases, templates and more...
migrate Migrate targeted jail(s) to a remote system.
mount Mount a volume inside targeted jail(s).
network Add or remove interfaces from targeted jail(s).
pkg Manipulate binary packages within targeted jail(s). See pkg(8).
rcp cp(1) files from a jail to host.
migrate Migrate jail(s) to a remote system.
mount Mount file(s)/directorie(s) inside jail(s).
network Add or remove interface(s) from jail(s).
pkg Manage packages inside jail(s). See pkg(8).
rcp Copy file(s)/directorie(s) from jail to host.
rdr Redirect host port to jail port.
rename Rename a jail.
restart Restart a jail.
service Manage services within targeted jail(s).
setup Attempt to auto-configure network, firewall and storage and more...
start Start a stopped jail.
stop Stop a running jail.
sysrc Safely edit rc files within targeted jail(s).
tags Add or remove tags to targeted jail(s).
template Apply file templates to targeted jail(s).
top Display and update information about the top(1) cpu processes.
umount Unmount a volume from targeted jail(s).
update Update jail base -pX release.
upgrade Upgrade jail release to X.Y-RELEASE.
service Manage services within jail(s).
setup Auto-configure network, firewall, storage and more...
start Start stopped jail(s).
stop Stop running jail(s).
sysrc Edit rc files inside jail(s).
tags Add or remove tags to jail(s).
template Apply templates to jail(s).
top Process viewer. See top(1).
umount Unmount file(s)/directorie(s) from jail(s).
update Update a jail or release.
upgrade Upgrade a jail to new release.
verify Compare release against a "known good" index.
zfs Manage (get|set) ZFS attributes on targeted jail(s).
zfs Manage ZFS options/attributes for jail(s).
Use "bastille -v|--version" for version information.
Use "bastille command -h|--help" for more information about a command.