Mirrors/hackacad
2
0
Fork 0
mirror of https://github.com/hackacad/bastille.git synced 2025-12-17 07:42:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

basic spacing fixes for help commands

Browse Source
This commit is contained in:
tschettervictor
2025-05-18 17:16:17 -06:00
parent 8f33850310
commit b040474bf5
51 changed files with 260 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -122,7 +122,8 @@ 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|TEMPLATE [update|arch]
Options:
-x | --debug Enable debug mode.

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

@@ -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
Usage: bastille clone [option(s)] TARGET NEW_NAME IP
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.

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

@@ -15,7 +15,8 @@ Execute commands inside targeted jail(s).
.. code-block:: shell
ishmael ~ # bastille cmd help
Usage: bastille cmd [option(s)] TARGET command
Usage: bastille cmd [option(s)] TARGET COMMAND
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.

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

@@ -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]
Usage: bastille config [option(s)] TARGET [get|(set|add)|remove] PROPERTY [VALUE]
Options:
-x | --debug Enable debug mode.

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

@@ -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,14 +10,15 @@ 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]
Usage: bastille console [option(s)] TARGET [USER]
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.

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

@@ -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,7 +27,8 @@ 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
Usage: bastille convert [option(s)] TARGET [RELEASE]
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.

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

@@ -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,6 +25,7 @@ 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.

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

@@ -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]"
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.
-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 Enables VNET, VNET containers are attached to a virtual bridge interface for connectivity.
-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.

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

@@ -21,7 +21,8 @@ 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.

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

@@ -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]
Usage: bastille edit [option(s)] TARGET [FILE]
Options:
-x | --debug Enable debug mode.

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

@@ -40,6 +40,7 @@ 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.

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

@@ -23,6 +23,7 @@ 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.

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

@@ -12,6 +12,7 @@ in the jail.
ishmael ~ # bastille htop help
Usage: bastille htop [options(s)] TARGET
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.

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

@@ -1,7 +1,7 @@
import
======
Import a container backup image or archive.
Import a jail backup image or archive.
.. code-block:: shell
@@ -16,6 +16,7 @@ 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.

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

@@ -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,6 +23,7 @@ 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.

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

@@ -42,7 +42,8 @@ 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]
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

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

@@ -33,7 +33,8 @@ 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]
Usage: bastille network [option(s)] TARGET [remove|add] INTERFACE [IP]
Options:
-a | --auto Start/stop the jail(s) if required.

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

@@ -107,7 +107,8 @@ 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
Usage: bastille pkg [option(s)] TARGET ARGS
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.

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

@@ -15,6 +15,7 @@ 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.

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

@@ -11,6 +11,7 @@ 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.

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

@@ -18,6 +18,7 @@ are stopped will not be started.
ishmael ~ # bastille restart help
Usage: bastille start [option(s)] TARGET
Options:
-b | --boot Respect jail boot setting.

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

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

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

@@ -13,6 +13,7 @@ Start jail(s).
ishmael ~ # bastille start help
Usage: bastille start [option(s)] TARGET
Options:
-b | --boot Respect jail boot setting.

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

@@ -13,6 +13,7 @@ Stop jail(s).
ishmael ~ # bastille stop help
Usage: bastille stop [option(s)] TARGET
Options:
-v | --verbose Print every action on jail stop.

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

@@ -15,7 +15,8 @@ See ``man sysrc(8)`` for more info.
.. code-block:: shell
ishmael ~ # bastille sysrc help
Usage: bastille sysrc [option(s)] TARGET args
Usage: bastille sysrc [option(s)] TARGET ARGS
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.

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

@@ -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.

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

@@ -12,10 +12,12 @@ 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:

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

@@ -12,6 +12,7 @@ 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.

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

@@ -31,6 +31,7 @@ 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.

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

@@ -45,6 +45,7 @@ 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.

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

@@ -8,7 +8,8 @@ upgraded normally.
.. code-block:: shell
ishmael ~ # bastille upgrade help
Usage: bastille upgrade [option(s)] TARGET [NEWRELEASE|install]
Usage: bastille upgrade [option(s)] TARGET NEW_RELEASE|install
Options:
-a | --auto Auto mode. Start/stop jail(s) if required.

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

@@ -37,6 +37,7 @@ release or template .
ishmael ~ # bastille verify help
Usage: bastille verify [option(s)] RELEASE|TEMPLATE
Options:
-x | --debug Enable debug mode.

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

@@ -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]
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]
Options:
-x | --debug Enable debug mode.

2
usr/local/share/bastille/bootstrap.sh
View File

@@ -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:

4
usr/local/share/bastille/clone.sh
View File

@@ -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

2
usr/local/share/bastille/config.sh
View File

@@ -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:

2
usr/local/share/bastille/console.sh
View File

@@ -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:

2
usr/local/share/bastille/convert.sh
View File

@@ -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:

18
usr/local/share/bastille/create.sh
View File

@@ -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.
-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-boot Create jail with boot=off.
--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 | --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 "-o option" Custom set of ZFS options to create the jail with. This overrides the defaults.
-Z | --zfs-opts [zfs,options] Comma separated list of ZFS options to create the jail with. This overrides the defaults.
EOF
exit 1

2
usr/local/share/bastille/destroy.sh
View File

@@ -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:

2
usr/local/share/bastille/edit.sh
View File

@@ -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:

7
usr/local/share/bastille/limits.sh
View File

@@ -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.

2
usr/local/share/bastille/network.sh
View File

@@ -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:

2
usr/local/share/bastille/pkg.sh
View File

@@ -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:

2
usr/local/share/bastille/service.sh
View File

@@ -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:

2
usr/local/share/bastille/sysrc.sh
View File

@@ -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:

2
usr/local/share/bastille/template.sh
View File

@@ -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:

2
usr/local/share/bastille/upgrade.sh
View File

@@ -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: