From b040474bf5a068dd13de1a1d3b37fc8aee18cc94 Mon Sep 17 00:00:00 2001 From: tschettervictor Date: Sun, 18 May 2025 17:16:17 -0600 Subject: [PATCH] basic spacing fixes for help commands --- docs/chapters/subcommands/bootstrap.rst | 7 +++-- docs/chapters/subcommands/clone.rst | 21 +++++--------- docs/chapters/subcommands/cmd.rst | 9 +++--- docs/chapters/subcommands/config.rst | 8 +++--- docs/chapters/subcommands/console.rst | 15 +++++----- docs/chapters/subcommands/convert.rst | 20 +++++++------ docs/chapters/subcommands/cp.rst | 9 +++--- docs/chapters/subcommands/create.rst | 38 ++++++++++++------------- docs/chapters/subcommands/destroy.rst | 15 +++++----- docs/chapters/subcommands/edit.rst | 11 +++---- docs/chapters/subcommands/etcupdate.rst | 9 +++--- docs/chapters/subcommands/export.rst | 17 +++++------ docs/chapters/subcommands/htop.rst | 7 +++-- docs/chapters/subcommands/import.rst | 13 +++++---- docs/chapters/subcommands/jcp.rst | 9 +++--- docs/chapters/subcommands/limits.rst | 13 +++++---- docs/chapters/subcommands/list.rst | 12 ++++---- docs/chapters/subcommands/migrate.rst | 22 +++++++------- docs/chapters/subcommands/network.rst | 23 ++++++++------- docs/chapters/subcommands/pkg.rst | 13 +++++---- docs/chapters/subcommands/rcp.rst | 7 +++-- docs/chapters/subcommands/rdr.rst | 12 ++++---- docs/chapters/subcommands/rename.rst | 7 +++-- docs/chapters/subcommands/restart.rst | 11 +++---- docs/chapters/subcommands/service.rst | 9 +++--- docs/chapters/subcommands/start.rst | 11 +++---- docs/chapters/subcommands/stop.rst | 7 +++-- docs/chapters/subcommands/sysrc.rst | 9 +++--- docs/chapters/subcommands/tags.rst | 5 ++-- docs/chapters/subcommands/template.rst | 10 ++++--- docs/chapters/subcommands/top.rst | 7 +++-- docs/chapters/subcommands/umount.rst | 7 +++-- docs/chapters/subcommands/update.rst | 9 +++--- docs/chapters/subcommands/upgrade.rst | 11 +++---- docs/chapters/subcommands/verify.rst | 5 ++-- docs/chapters/subcommands/zfs.rst | 9 ++++-- usr/local/share/bastille/bootstrap.sh | 2 +- usr/local/share/bastille/clone.sh | 4 +-- usr/local/share/bastille/config.sh | 2 +- usr/local/share/bastille/console.sh | 2 +- usr/local/share/bastille/convert.sh | 2 +- usr/local/share/bastille/create.sh | 30 +++++++++---------- usr/local/share/bastille/destroy.sh | 2 +- usr/local/share/bastille/edit.sh | 2 +- usr/local/share/bastille/limits.sh | 7 +++-- usr/local/share/bastille/network.sh | 2 +- usr/local/share/bastille/pkg.sh | 2 +- usr/local/share/bastille/service.sh | 2 +- usr/local/share/bastille/sysrc.sh | 2 +- usr/local/share/bastille/template.sh | 2 +- usr/local/share/bastille/upgrade.sh | 2 +- 51 files changed, 260 insertions(+), 232 deletions(-) diff --git a/docs/chapters/subcommands/bootstrap.rst b/docs/chapters/subcommands/bootstrap.rst index 5a6c0fb2..7bfa8cf3 100644 --- a/docs/chapters/subcommands/bootstrap.rst +++ b/docs/chapters/subcommands/bootstrap.rst @@ -122,7 +122,8 @@ begin applying your template. .. code-block:: shell ishmael ~ # bastille bootstrap help - Usage: bastille bootstrap [option(s)] [RELEASE|TEMPLATE] [update|arch] - Options: + Usage: bastille bootstrap [option(s)] RELEASE|TEMPLATE [update|arch] - -x | --debug Enable debug mode. + Options: + + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/clone.rst b/docs/chapters/subcommands/clone.rst index 50defd8d..614bbfce 100644 --- a/docs/chapters/subcommands/clone.rst +++ b/docs/chapters/subcommands/clone.rst @@ -1,22 +1,15 @@ clone ===== -To clone a container and make a duplicate, use the ``bastille clone`` -sub-command. - -.. code-block:: shell - - ishmael ~ # bastille clone azkaban rikers ip - [azkaban]: - -Syntax requires a name for the new container and an IP address assignment. +Clone/duplicate an existing jail to a new jail. .. code-block:: shell ishmael ~ # bastille clone help - Usage: bastille clone [option(s)] TARGET NEW_NAME IP_ADDRESS - Options: + Usage: bastille clone [option(s)] TARGET NEW_NAME IP - -a | --auto Auto mode. Start/stop jail(s) if required. Cannot be used with [-l|--live]. - -l | --live Clone a running jail. ZFS only. Jail must be running. Cannot be used with [-a|--auto]. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. Cannot be used with [-l|--live]. + -l | --live Clone a running jail (ZFS only). Cannot be used with [-a|--auto]. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/cmd.rst b/docs/chapters/subcommands/cmd.rst index f4f6fcd3..81aa2720 100644 --- a/docs/chapters/subcommands/cmd.rst +++ b/docs/chapters/subcommands/cmd.rst @@ -15,8 +15,9 @@ Execute commands inside targeted jail(s). .. code-block:: shell ishmael ~ # bastille cmd help - Usage: bastille cmd [option(s)] TARGET command - Options: + Usage: bastille cmd [option(s)] TARGET COMMAND - -a | --auto Auto mode. Start/stop jail(s) if required. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -x | --debug Enable debug mode. diff --git a/docs/chapters/subcommands/config.rst b/docs/chapters/subcommands/config.rst index bb06f730..32efc356 100644 --- a/docs/chapters/subcommands/config.rst +++ b/docs/chapters/subcommands/config.rst @@ -1,7 +1,7 @@ config ====== -Get,set or remove properties from targeted jail(s). +Get, set or remove properties from targeted jail(s). Getting a property that *is* defined in jail.conf: @@ -38,8 +38,8 @@ The restart message will appear every time a property is removed. .. code-block:: shell ishmael ~ # bastille config help - Usage: bastille config TARGET [get|set|remove] PROPERTY [VALUE] - Options: + Usage: bastille config [option(s)] TARGET [get|(set|add)|remove] PROPERTY [VALUE] - -x | --debug Enable debug mode. + Options: + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/console.rst b/docs/chapters/subcommands/console.rst index 3e5276f9..6c0dd0e9 100644 --- a/docs/chapters/subcommands/console.rst +++ b/docs/chapters/subcommands/console.rst @@ -1,7 +1,7 @@ console ======= -This sub-command launches a login shell into the container. Default is password- +Launch a login shell into the jail. Default is password- less root login. .. code-block:: shell @@ -10,15 +10,16 @@ less root login. [folsom]: root@folsom:~ # -At this point you are logged in to the container and have full shell access. The +At this point you are logged in to the jail and have full shell access. The system is yours to use and/or abuse as you like. Any changes made inside the -container are limited to the container. +jail are limited to the jail. .. code-block:: shell ishmael ~ # bastille console help - Usage: bastille console [option(s)] TARGET [user] - Options: + Usage: bastille console [option(s)] TARGET [USER] - -a | --auto Auto mode. Start/stop jail(s) if required. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/convert.rst b/docs/chapters/subcommands/convert.rst index c20c4bae..2fc49ecf 100644 --- a/docs/chapters/subcommands/convert.rst +++ b/docs/chapters/subcommands/convert.rst @@ -1,17 +1,18 @@ convert ======= -Convert allows converting a thin jail to a thick jail. -It also allows converting a thick jail to a customized release. +Convert a thin jail to a thick jail. -Converting a thin jail to a thick jail requires only the target 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 ishmael ~ # bastille convert azkaban -Converting a thick jail to a custom release requires a target jail as -well as custom release name. +Converting a thick jail to a custom release requires the TARGET and +RELEASE as args. .. code-block:: shell @@ -26,8 +27,9 @@ This release can then be used to create a thick jail using the ``--no-validate`` .. code-block:: shell ishmael ~ # bastille convert help - Usage: bastille convert [option(s)] TARGET - Options: + Usage: bastille convert [option(s)] TARGET [RELEASE] + + 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. \ No newline at end of file diff --git a/docs/chapters/subcommands/cp.rst b/docs/chapters/subcommands/cp.rst index afd7d1cd..c69bbfd7 100644 --- a/docs/chapters/subcommands/cp.rst +++ b/docs/chapters/subcommands/cp.rst @@ -1,7 +1,7 @@ cp == -This command allows copying files from host to jail(s). +Copy files from host to jail(s). .. code-block:: shell @@ -25,7 +25,8 @@ Unless you see errors reported in the output the ``cp`` was successful. ishmael ~ # bastille cp help Usage: bastille cp [option(s)] TARGET HOST_PATH JAIL_PATH - Options: - -q | --quiet Suppress output. - -x | --debug Enable debug mode. + Options: + + -q | --quiet Suppress output. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/create.rst b/docs/chapters/subcommands/create.rst index 0366f27a..c888ab84 100644 --- a/docs/chapters/subcommands/create.rst +++ b/docs/chapters/subcommands/create.rst @@ -1,9 +1,8 @@ create ====== -Bastille create uses any available bootstrapped release to create a lightweight -container system. To create a container simply provide a name, bootstrapped -release and a private (rfc1918) IP address. +Create a jail uning any available bootstrapped release. To create a jail, +simply provide a name, bootstrapped release, and IP address. The format is ``bastille create NAME RELEASE IP [INTERFACE]`` @@ -54,20 +53,21 @@ options. See the below help output. .. code-block:: shell ishmael ~ # bastille create help - Usage: bastille create [option(s)] NAME RELEASE IP_ADDRESS [interface]" - Options: + Usage: bastille create [option(s)] NAME RELEASE IP [INTERFACE]" + + Options: - -B | --bridge Enables VNET, VNET containers are attached to a specified, already existing external bridge. - -C | --clone Creates a clone container, they are duplicates of the base release, consume low space and preserves changing data. - -D | --dual Creates the jails with both IPv4 and IPv6 networking ('inherit' and 'ip_hostname' only). - -E | --empty Creates an empty container, intended for custom jail builds (thin/thick/linux or unsupported). - -L | --linux This option is intended for testing with Linux jails, this is considered experimental. - -M | --static-mac Generate a static MAC address for jail (VNET only). - --no-validate Do not validate the release when creating the jail. - --no-boot Create jail with boot=off. - -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 Enables VNET, VNET containers are attached to a virtual bridge interface for connectivity. - -v | --vlan VLANID Creates the jail with specified 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. + -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). + -L | --linux Create a Linux jail (experimental). + -M | --static-mac Generate a static MAC address for jail (VNET only). + --no-validate Do not validate the release when creating the jail. + --no-boot Create jail with boot=off. + -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). + -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. \ No newline at end of file diff --git a/docs/chapters/subcommands/destroy.rst b/docs/chapters/subcommands/destroy.rst index dd8b3321..435b228b 100644 --- a/docs/chapters/subcommands/destroy.rst +++ b/docs/chapters/subcommands/destroy.rst @@ -21,11 +21,12 @@ 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] - Options: + Usage: bastille destroy [option(s)] JAIL|RELEASE - -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. + 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. diff --git a/docs/chapters/subcommands/edit.rst b/docs/chapters/subcommands/edit.rst index c059f1c8..de23948c 100644 --- a/docs/chapters/subcommands/edit.rst +++ b/docs/chapters/subcommands/edit.rst @@ -1,11 +1,11 @@ edit ==== -To edit a jails configuration, use ``bastille edit TARGET``. +Edit jail config files. .. code-block:: shell - ishmael ~ # bastille edit azkaban [filename] + ishmael ~ # bastille edit azkaban [FILE] Syntax requires a target an optional filename. By default the file edited will be ``jail.conf``. Other common filenames are ``fstab`` or ``rctl.conf``. @@ -13,7 +13,8 @@ be ``jail.conf``. Other common filenames are ``fstab`` or ``rctl.conf``. .. code-block:: shell ishmael ~ # bastille edit help - Usage: bastille edit [option(s)] TARGET [filename] - Options: + Usage: bastille edit [option(s)] TARGET [FILE] - -x | --debug Enable debug mode. + Options: + + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/etcupdate.rst b/docs/chapters/subcommands/etcupdate.rst index 03a71414..dbaa7c76 100644 --- a/docs/chapters/subcommands/etcupdate.rst +++ b/docs/chapters/subcommands/etcupdate.rst @@ -40,8 +40,9 @@ To show only the differences between the releases, use the ``diff`` command. ishmael ~ # bastille etcupdate help Usage: bastille etcupdate [option(s)] [bootstrap|TARGET] [diff|resolve|update RELEASE] - Options: - -d | --dry-run Show output, but do not apply. - -f | --force Force a re-bootstrap of a RELEASE. - -x | --debug Enable debug mode. + Options: + + -d | --dry-run Show output, but do not apply. + -f | --force Force a re-bootstrap of a RELEASE. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/export.rst b/docs/chapters/subcommands/export.rst index 506638a4..72e628f1 100644 --- a/docs/chapters/subcommands/export.rst +++ b/docs/chapters/subcommands/export.rst @@ -23,14 +23,15 @@ Available options are: ishmael ~ # bastille export help Usage: bastille export [option(s)] TARGET PATH - Options: - --gz Export a ZFS jail using GZIP(.gz) compressed image. - -r | --raw Export a ZFS jail to an uncompressed RAW image. - -s | --safe Safely stop and start a ZFS jail before the exporting process. - --tgz Export a jail using simple .tgz compressed archive instead. - --txz Export a jail using simple .txz compressed archive instead. - -v | --verbose Be more verbose during the ZFS send operation. - --xz Export a ZFS jail using XZ(.xz) compressed image. + Options: + + --gz Export a ZFS jail using GZIP(.gz) compressed image. + -r | --raw Export a ZFS jail to an uncompressed RAW image. + -s | --safe Safely stop and start a ZFS jail before the exporting process. + --tgz Export a jail using simple .tgz compressed archive instead. + --txz Export a jail using simple .txz compressed archive instead. + -v | --verbose Be more verbose during the ZFS send operation. + --xz Export a ZFS jail using XZ(.xz) compressed image. Note: If no export option specified, the container should be redirected to standard output. diff --git a/docs/chapters/subcommands/htop.rst b/docs/chapters/subcommands/htop.rst index afd1d7f7..9f1c8185 100644 --- a/docs/chapters/subcommands/htop.rst +++ b/docs/chapters/subcommands/htop.rst @@ -12,7 +12,8 @@ in the jail. ishmael ~ # bastille htop help Usage: bastille htop [options(s)] TARGET - Options: - -a | --auto Auto mode. Start/stop jail(s) if required. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/import.rst b/docs/chapters/subcommands/import.rst index c6c48e21..0fed6b2f 100644 --- a/docs/chapters/subcommands/import.rst +++ b/docs/chapters/subcommands/import.rst @@ -1,7 +1,7 @@ import ====== -Import a container backup image or archive. +Import a jail backup image or archive. .. code-block:: shell @@ -16,11 +16,12 @@ To import to a specified release, specify it as the last argument. ishmael ~ # bastille import help Usage: bastille import [option(s)] FILE [RELEASE] - 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. - -v | --verbose Be more verbose during the ZFS receive operation. - -x | --debug Enable debug mode. + 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. + -v | --verbose Be more verbose during the ZFS receive operation. + -x | --debug Enable debug mode. Tip: If no option specified, container should be imported from standard input. \ No newline at end of file diff --git a/docs/chapters/subcommands/jcp.rst b/docs/chapters/subcommands/jcp.rst index 37486a71..40a279c9 100644 --- a/docs/chapters/subcommands/jcp.rst +++ b/docs/chapters/subcommands/jcp.rst @@ -1,7 +1,7 @@ jcp === -This command allows copying files from jail to jail(s). +Copy files from jail to jail(s). .. code-block:: shell @@ -23,7 +23,8 @@ Unless you see errors reported in the output the ``jcp`` was successful. ishmael ~ # bastille jcp help Usage: bastille jcp [option(s)] SOURCE_JAIL JAIL_PATH DEST_JAIL JAIL_PATH - Options: - -q | --quiet Suppress output. - -x | --debug Enable debug mode. + Options: + + -q | --quiet Suppress output. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/limits.rst b/docs/chapters/subcommands/limits.rst index 518a797a..d24c60e6 100644 --- a/docs/chapters/subcommands/limits.rst +++ b/docs/chapters/subcommands/limits.rst @@ -42,11 +42,12 @@ 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 OPTION VALUE|remove OPTION|clear|reset|[list|show] (active)|stats] - Example: bastille limits TARGET add memoryuse 1G - Example: bastille limits TARGET add cpu 0,1,2 + Usage: bastille limits [option(s)] TARGET [add|remove|clear|reset|(list|show [active])|stats] OPTION [VALUE] + + Example: bastille limits TARGET add memoryuse 1G + Example: bastille limits TARGET add cpu 0,1,2 - Options: + 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. \ No newline at end of file diff --git a/docs/chapters/subcommands/list.rst b/docs/chapters/subcommands/list.rst index 38fd6aa1..4757a577 100644 --- a/docs/chapters/subcommands/list.rst +++ b/docs/chapters/subcommands/list.rst @@ -14,10 +14,10 @@ to print in columns instead of rows. 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] [state(s)] [template(s)] - Options: + Options: - -d | --down List stopped jails only. - -j | --json List jails or sub-arg(s) in json format. - -p | --pretty Print JSON in columns. - -u | --up List running jails only. - -x | --debug Enable debug mode. \ No newline at end of file + -d | --down List stopped jails only. + -j | --json List jails or sub-arg(s) in json format. + -p | --pretty Print JSON in columns. + -u | --up List running jails only. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/migrate.rst b/docs/chapters/subcommands/migrate.rst index daf26d8c..1666383d 100644 --- a/docs/chapters/subcommands/migrate.rst +++ b/docs/chapters/subcommands/migrate.rst @@ -14,17 +14,17 @@ port by supplying it as in ``user@host:port``. ishmael ~ # bastille migrate help Usage: bastille migrate [option(s)] TARGET USER@HOST[:PORT] - Examples: + Examples: - bastille migrate attica migrate@192.168.10.100 - bastille migrate attica migrate@192.168.1.10:20022 + bastille migrate attica migrate@192.168.10.100 + bastille migrate attica migrate@192.168.1.10:20022 - Options: + Options: - -a | --auto Auto mode. Start/stop jail(s) if required. - -d | --destroy Destroy local jail after migration. - -b | --backup Retain archives on remote system. - | --doas Use 'doas' instead of 'sudo'. - -l | --live Migrate a running jail (ZFS only). - -p | --password Use password based authentication. - -x | --debug Enable debug mode. + -a | --auto Auto mode. Start/stop jail(s) if required. + -d | --destroy Destroy local jail after migration. + -b | --backup Retain archives on remote system. + | --doas Use 'doas' instead of 'sudo'. + -l | --live Migrate a running jail (ZFS only). + -p | --password Use password based authentication. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/network.rst b/docs/chapters/subcommands/network.rst index 33af0767..077d632b 100644 --- a/docs/chapters/subcommands/network.rst +++ b/docs/chapters/subcommands/network.rst @@ -33,15 +33,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_ADDRESS] - Options: + Usage: bastille network [option(s)] TARGET [remove|add] INTERFACE [IP] - -a | --auto Start/stop the jail(s) if required. - -B | --bridge Add a bridged VNET interface to an existing jail. - -C | --classic Add an interface to a classic (non-VNET) jail. - -M | --static-mac Generate a static MAC address for the interface. - -n | --no-ip Create interface without an IP (VNET only). - -P | --passthrough Pass the entire interface through to the jail. - -V | --vnet Add a VNET interface to an existing jail. - -v | --vlan VLANID Add interface with specified VLAN ID (VNET only). - -x | --debug Enable debug mode. + Options: + + -a | --auto Start/stop the jail(s) if required. + -B | --bridge Add a bridged VNET interface to an existing jail. + -C | --classic Add an interface to a classic (non-VNET) jail. + -M | --static-mac Generate a static MAC address for the interface. + -n | --no-ip Create interface without an IP (VNET only). + -P | --passthrough Pass the entire interface through to the jail. + -V | --vnet Add a VNET interface to an existing jail. + -v | --vlan VLANID Add interface with specified VLAN ID (VNET only). + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/pkg.rst b/docs/chapters/subcommands/pkg.rst index 5b00ca88..bc13dfae 100644 --- a/docs/chapters/subcommands/pkg.rst +++ b/docs/chapters/subcommands/pkg.rst @@ -107,10 +107,11 @@ you can fully leverage the pkg manager. This means, ``install``, ``update``, .. code-block:: shell ishmael ~ # bastille pkg help - Usage: bastille pkg [option(s)] TARGET COMMAND ARGS - Options: + Usage: bastille pkg [option(s)] TARGET ARGS - -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. + 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. \ No newline at end of file diff --git a/docs/chapters/subcommands/rcp.rst b/docs/chapters/subcommands/rcp.rst index ffd8d934..90bec0d5 100644 --- a/docs/chapters/subcommands/rcp.rst +++ b/docs/chapters/subcommands/rcp.rst @@ -15,7 +15,8 @@ Unless you see errors reported in the output the ``rcp`` was successful. ishmael ~ # bastille rcp help Usage: bastille rcp [option(s)] TARGET JAIL_PATH HOST_PATH - Options: - -q | --quiet Suppress output. - -x | --debug Enable debug mode. + Options: + + -q | --quiet Suppress output. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/rdr.rst b/docs/chapters/subcommands/rdr.rst index ef152aa0..ecf37c63 100644 --- a/docs/chapters/subcommands/rdr.rst +++ b/docs/chapters/subcommands/rdr.rst @@ -73,10 +73,10 @@ only redirect using the default one. # bastille rdr --help Usage: bastille rdr TARGET [option(s)] [clear|reset|list|(tcp|udp host_port jail_port [log ['(' logopts ')'] ] )] - Options: + Options: - -i | --interface [interface] Set the interface to create the rdr rule on. Useful if you have multiple interfaces. - -s | --source [source ip] Limit rdr to a source IP. Useful to only allow access from a certian IP or subnet. - -d | --destination [destination ip] Limit rdr to a destination IP. Useful if you have multiple IPs on one interface. - -t | --type [ipv4|ipv6] Specify IP type. Must be used if -s or -d are used. Defaults to both. - -x | --debug Enable debug mode. + -i | --interface [interface] Set the interface to create the rdr rule on. Useful if you have multiple interfaces. + -s | --source [source ip] Limit rdr to a source IP. Useful to only allow access from a certian IP or subnet. + -d | --destination [destination ip] Limit rdr to a destination IP. Useful if you have multiple IPs on one interface. + -t | --type [ipv4|ipv6] Specify IP type. Must be used if -s or -d are used. Defaults to both. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/rename.rst b/docs/chapters/subcommands/rename.rst index d823c5b8..3827c47e 100644 --- a/docs/chapters/subcommands/rename.rst +++ b/docs/chapters/subcommands/rename.rst @@ -11,7 +11,8 @@ Rename a jail. ishmael ~ # bastille rename help Usage: bastille rename [option(s)] TARGET NEW_NAME - Options: - -a | --auto Auto mode. Start/stop jail(s) if required. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/restart.rst b/docs/chapters/subcommands/restart.rst index 189f7320..86e3749b 100644 --- a/docs/chapters/subcommands/restart.rst +++ b/docs/chapters/subcommands/restart.rst @@ -18,9 +18,10 @@ are stopped will not be started. ishmael ~ # bastille restart help Usage: bastille start [option(s)] TARGET - 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 restart. - -x | --debug Enable debug mode. + 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 restart. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/service.rst b/docs/chapters/subcommands/service.rst index 76513676..ef89d6ce 100644 --- a/docs/chapters/subcommands/service.rst +++ b/docs/chapters/subcommands/service.rst @@ -17,8 +17,9 @@ inside the jail(s). .. code-block:: shell ishmael ~ # bastille service help - Usage: bastille service [option(s)] TARGET SERVICE_NAME ACTION - Options: + Usage: bastille service [option(s)] TARGET SERVICE_NAME ARGS - -a | --auto Auto mode. Start/stop jail(s) if required. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/start.rst b/docs/chapters/subcommands/start.rst index fa673cd1..0d4d3c97 100644 --- a/docs/chapters/subcommands/start.rst +++ b/docs/chapters/subcommands/start.rst @@ -13,9 +13,10 @@ Start jail(s). ishmael ~ # bastille start help Usage: bastille start [option(s)] TARGET - 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. + 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. \ No newline at end of file diff --git a/docs/chapters/subcommands/stop.rst b/docs/chapters/subcommands/stop.rst index 9e56aa0d..299bb15e 100644 --- a/docs/chapters/subcommands/stop.rst +++ b/docs/chapters/subcommands/stop.rst @@ -13,7 +13,8 @@ Stop jail(s). ishmael ~ # bastille stop help Usage: bastille stop [option(s)] TARGET - Options: - -v | --verbose Print every action on jail stop. - -x | --debug Enable debug mode. + Options: + + -v | --verbose Print every action on jail stop. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/sysrc.rst b/docs/chapters/subcommands/sysrc.rst index 04a875f3..333ddd4f 100644 --- a/docs/chapters/subcommands/sysrc.rst +++ b/docs/chapters/subcommands/sysrc.rst @@ -15,8 +15,9 @@ See ``man sysrc(8)`` for more info. .. code-block:: shell ishmael ~ # bastille sysrc help - Usage: bastille sysrc [option(s)] TARGET args - Options: + Usage: bastille sysrc [option(s)] TARGET ARGS - -a | --auto Auto mode. Start/stop jail(s) if required. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/tags.rst b/docs/chapters/subcommands/tags.rst index c08e56b4..6c816fdf 100644 --- a/docs/chapters/subcommands/tags.rst +++ b/docs/chapters/subcommands/tags.rst @@ -15,6 +15,7 @@ The ``tags`` sub-command adds, removes or lists arbitrary tags on your jail(s). ishmael ~ # bastille tags help Usage: bastille tags [option(s)] TARGET [add|delete|list] [tag1,tag2] - Options: - -x | --debug Enable debug mode. + Options: + + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/template.rst b/docs/chapters/subcommands/template.rst index c79bcc87..a5ed1cc5 100644 --- a/docs/chapters/subcommands/template.rst +++ b/docs/chapters/subcommands/template.rst @@ -12,12 +12,14 @@ placed in the template directory, which defaults to ``/usr/local/bastille/templates``. The Bastillefile should contain the template hooks. See the chapter called Template for a list of supported hooks. +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|project/template] + Usage: bastille template [option(s)] TARGET [--convert] TEMPLATE - Options: + 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. \ No newline at end of file diff --git a/docs/chapters/subcommands/top.rst b/docs/chapters/subcommands/top.rst index 97d35b38..831feaee 100644 --- a/docs/chapters/subcommands/top.rst +++ b/docs/chapters/subcommands/top.rst @@ -12,7 +12,8 @@ This command runs ``top`` in the targeted jail. ishmael ~ # bastille top help Usage: bastille top [options(s)] TARGET - Options: - -a | --auto Auto mode. Start/stop jail(s) if required. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/umount.rst b/docs/chapters/subcommands/umount.rst index c65c4a00..3b25a246 100644 --- a/docs/chapters/subcommands/umount.rst +++ b/docs/chapters/subcommands/umount.rst @@ -31,7 +31,8 @@ backslash \, and enclose the mount point in quotes "". ishmael ~ # bastille umount help Usage: bastille umount [option(s)] TARGET JAIL_PATH - Options: - -a | --auto Auto mode. Start/stop jail(s) if required. - -x | --debug Enable debug mode. \ No newline at end of file + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/update.rst b/docs/chapters/subcommands/update.rst index 4f418c87..3edb7759 100644 --- a/docs/chapters/subcommands/update.rst +++ b/docs/chapters/subcommands/update.rst @@ -45,8 +45,9 @@ will be updated just like the release shown above. ishmael ~ # bastille update help Usage: bastille update [option(s)] TARGET - Options: - -a | --auto Auto mode. Start/stop jail(s) if required. - -f | --force Force update a release. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -f | --force Force update a release. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/upgrade.rst b/docs/chapters/subcommands/upgrade.rst index afeedf13..077a772c 100644 --- a/docs/chapters/subcommands/upgrade.rst +++ b/docs/chapters/subcommands/upgrade.rst @@ -8,9 +8,10 @@ upgraded normally. .. code-block:: shell ishmael ~ # bastille upgrade help - Usage: bastille upgrade [option(s)] TARGET [NEWRELEASE|install] - Options: + Usage: bastille upgrade [option(s)] TARGET NEW_RELEASE|install - -a | --auto Auto mode. Start/stop jail(s) if required. - -f | --force Force upgrade a jail. - -x | --debug Enable debug mode. + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -f | --force Force upgrade a jail. + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/verify.rst b/docs/chapters/subcommands/verify.rst index f3d92bdf..de5cb3d4 100644 --- a/docs/chapters/subcommands/verify.rst +++ b/docs/chapters/subcommands/verify.rst @@ -37,6 +37,7 @@ release or template . ishmael ~ # bastille verify help Usage: bastille verify [option(s)] RELEASE|TEMPLATE - Options: - -x | --debug Enable debug mode. + Options: + + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/docs/chapters/subcommands/zfs.rst b/docs/chapters/subcommands/zfs.rst index 063a4513..40cbd21a 100644 --- a/docs/chapters/subcommands/zfs.rst +++ b/docs/chapters/subcommands/zfs.rst @@ -7,7 +7,10 @@ targeted jail(s). .. code-block:: shell ishmael ~ # bastille zfs help - Usage: bastille zfs TARGET [set|get|snap|destroy_snap|df|usage] [key=value|date] - Options: + Usage: bastille zfs [option(s)] TARGET [destroy_snap|(df|usage)|get|set|(snap|snapshot)] [key=value|date] + [jail pool/dataset /jail/path] + [unjail pool/dataset] - -x | --debug Enable debug mode. + Options: + + -x | --debug Enable debug mode. \ No newline at end of file diff --git a/usr/local/share/bastille/bootstrap.sh b/usr/local/share/bastille/bootstrap.sh index 9cf93984..547c4d98 100644 --- a/usr/local/share/bastille/bootstrap.sh +++ b/usr/local/share/bastille/bootstrap.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille bootstrap [option(s)] [RELEASE|TEMPLATE] [update|arch]" + error_notify "Usage: bastille bootstrap [option(s)] RELEASE|TEMPLATE [update|arch]" cat << EOF Options: diff --git a/usr/local/share/bastille/clone.sh b/usr/local/share/bastille/clone.sh index 1204580f..93fa4193 100644 --- a/usr/local/share/bastille/clone.sh +++ b/usr/local/share/bastille/clone.sh @@ -33,13 +33,13 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille clone [option(s)] TARGET NEWNAME IPADDRESS" + error_notify "Usage: bastille clone [option(s)] TARGET NEW_NAME IP" cat << EOF Options: -a | --auto Auto mode. Start/stop jail(s) if required. Cannot be used with [-l|--live]. - -l | --live Clone a running jail. ZFS only. Jail must be running. Cannot be used with [-a|--auto]. + -l | --live Clone a running jail (ZFS only). Cannot be used with [-a|--auto]. -x | --debug Enable debug mode. EOF diff --git a/usr/local/share/bastille/config.sh b/usr/local/share/bastille/config.sh index 6f88e9de..ccffb3c5 100644 --- a/usr/local/share/bastille/config.sh +++ b/usr/local/share/bastille/config.sh @@ -34,7 +34,7 @@ usage() { - error_notify "Usage: bastille config [option(s)] TARGET [get|(set|add)|remove] PROPERTY VALUE" + error_notify "Usage: bastille config [option(s)] TARGET [get|(set|add)|remove] PROPERTY [VALUE]" cat << EOF Options: diff --git a/usr/local/share/bastille/console.sh b/usr/local/share/bastille/console.sh index 1457eb79..7d4111d3 100644 --- a/usr/local/share/bastille/console.sh +++ b/usr/local/share/bastille/console.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille console [option(s)] TARGET [user]" + error_notify "Usage: bastille console [option(s)] TARGET [USER]" cat << EOF Options: diff --git a/usr/local/share/bastille/convert.sh b/usr/local/share/bastille/convert.sh index f1ccd819..67a406ad 100644 --- a/usr/local/share/bastille/convert.sh +++ b/usr/local/share/bastille/convert.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille convert [option(s)] [TARGET|TARGET RELEASE]" + error_notify "Usage: bastille convert [option(s)] TARGET [RELEASE]" cat << EOF Options: diff --git a/usr/local/share/bastille/create.sh b/usr/local/share/bastille/create.sh index ec71ab96..95f6b6af 100644 --- a/usr/local/share/bastille/create.sh +++ b/usr/local/share/bastille/create.sh @@ -35,25 +35,25 @@ usage() { # Build an independent usage for the create command # If no option specified, will create a thin container by default - error_notify "Usage: bastille create [option(s)] NAME RELEASE IP_ADDRESS [INTERFACE]" + error_notify "Usage: bastille create [option(s)] NAME RELEASE IP [INTERFACE]" cat << EOF Options: - -B | --bridge Enables VNET, VNET containers are attached to a specified, already existing external bridge. - -C | --clone Creates a clone container, they are duplicates of the base release, consume low space and preserves changing data. - -D | --dual Creates the jails with both IPv4 and IPv6 networking ('inherit' and 'ip_hostname' only). - -E | --empty Creates an empty container, intended for custom jail builds (thin/thick/linux or unsupported). - -L | --linux This option is intended for testing with Linux jails, this is considered experimental. - -M | --static-mac Generate a static MAC address for jail (VNET only). - --no-boot Create jail with boot=off. - --no-validate Do not validate the release when creating 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 Enables VNET, VNET containers are attached to a virtual bridge interface for connectivity. - -v | --vlan VLANID Creates the jail with specified VLAN ID (VNET only). - -x | --debug Enable debug mode. - -Z | --zfs-opts "-o option" Custom set of ZFS options to create the jail with. This overrides the defaults. + -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). + -L | --linux Create a Linux jail (experimental). + -M | --static-mac Generate a static MAC address for jail (VNET only). + --no-validate Do not validate the release when creating the jail. + --no-boot Create jail with boot=off. + -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). + -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. EOF exit 1 diff --git a/usr/local/share/bastille/destroy.sh b/usr/local/share/bastille/destroy.sh index 836e7e48..a085c316 100644 --- a/usr/local/share/bastille/destroy.sh +++ b/usr/local/share/bastille/destroy.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille destroy [option(s)] [JAIL|RELEASE]" + error_notify "Usage: bastille destroy [option(s)] JAIL|RELEASE" cat << EOF Options: diff --git a/usr/local/share/bastille/edit.sh b/usr/local/share/bastille/edit.sh index 60a6ef4f..0f657e1f 100644 --- a/usr/local/share/bastille/edit.sh +++ b/usr/local/share/bastille/edit.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille edit [option(s)] TARGET [filename]" + error_notify "Usage: bastille edit [option(s)] TARGET [FILE]" cat << EOF Options: diff --git a/usr/local/share/bastille/limits.sh b/usr/local/share/bastille/limits.sh index 4e038bc2..77255a05 100644 --- a/usr/local/share/bastille/limits.sh +++ b/usr/local/share/bastille/limits.sh @@ -34,11 +34,12 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille limits [option(s)] TARGET [add OPTION VALUE|remove OPTION|clear|reset|[list|show] (active)|stats]" - echo -e "Example: bastille limits TARGET add memoryuse 1G" - echo -e "Example: bastille limits TARGET add cpu 0,1,2" + error_notify "Usage: bastille limits [option(s)] TARGET [add|remove|clear|reset|(list|show [active])|stats] OPTION [VALUE]" cat << EOF + 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. diff --git a/usr/local/share/bastille/network.sh b/usr/local/share/bastille/network.sh index 4040cf41..04007f75 100644 --- a/usr/local/share/bastille/network.sh +++ b/usr/local/share/bastille/network.sh @@ -34,7 +34,7 @@ . /usr/local/etc/bastille/bastille.conf usage() { - error_notify "Usage: bastille network [option(s)] TARGET [remove|add] INTERFACE [IP_ADDRESS]" + error_notify "Usage: bastille network [option(s)] TARGET [remove|add] INTERFACE [IP]" cat << EOF Options: diff --git a/usr/local/share/bastille/pkg.sh b/usr/local/share/bastille/pkg.sh index 2e674f44..302c56ce 100644 --- a/usr/local/share/bastille/pkg.sh +++ b/usr/local/share/bastille/pkg.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille pkg [option(s)] TARGET COMMAND args" + error_notify "Usage: bastille pkg [option(s)] TARGET ARGS" cat << EOF Options: diff --git a/usr/local/share/bastille/service.sh b/usr/local/share/bastille/service.sh index 8bca9ec0..c6322e95 100644 --- a/usr/local/share/bastille/service.sh +++ b/usr/local/share/bastille/service.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille service [option(s)] TARGET SERVICE_NAME ACTION" + error_notify "Usage: bastille service [option(s)] TARGET SERVICE_NAME ARGS" cat << EOF Options: diff --git a/usr/local/share/bastille/sysrc.sh b/usr/local/share/bastille/sysrc.sh index ac679e7b..bccd72c5 100644 --- a/usr/local/share/bastille/sysrc.sh +++ b/usr/local/share/bastille/sysrc.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille sysrc [option(s)] TARGET args" + error_notify "Usage: bastille sysrc [option(s)] TARGET ARGS" cat << EOF Options: diff --git a/usr/local/share/bastille/template.sh b/usr/local/share/bastille/template.sh index de6c0491..2475ad2a 100644 --- a/usr/local/share/bastille/template.sh +++ b/usr/local/share/bastille/template.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille template [option(s)] TARGET [--convert|project/template]" + error_notify "Usage: bastille template [option(s)] TARGET [--convert] TEMPLATE" cat << EOF Options: diff --git a/usr/local/share/bastille/upgrade.sh b/usr/local/share/bastille/upgrade.sh index 915f804d..fbb9fe56 100644 --- a/usr/local/share/bastille/upgrade.sh +++ b/usr/local/share/bastille/upgrade.sh @@ -33,7 +33,7 @@ . /usr/local/share/bastille/common.sh usage() { - error_notify "Usage: bastille upgrade [option(s)] TARGET [NEWRELEASE|install]" + error_notify "Usage: bastille upgrade [option(s)] TARGET NEW_RELEASE|install" cat << EOF Options: