From 2c7d0cb3d466ddc9ac04711999fd246c10c400fa Mon Sep 17 00:00:00 2001 From: tschettervictor <85497460+tschettervictor@users.noreply.github.com> Date: Thu, 10 Apr 2025 13:35:54 -0600 Subject: [PATCH] docs: clearer boot and priority --- docs/chapters/boot-and-priority.rst | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/docs/chapters/boot-and-priority.rst b/docs/chapters/boot-and-priority.rst index 811f7d60..322b164d 100644 --- a/docs/chapters/boot-and-priority.rst +++ b/docs/chapters/boot-and-priority.rst @@ -4,27 +4,35 @@ Boot and Priority Boot ---- -The boot setting control whether a jail will be started on system startup if you have enabled bastille -with ``sysrc bastille_enable=YES``. You can also use ``bastille start -b TARGET`` to respect this boot setting. -If it is off, the jail(s) will not be started if ``-b`` is used with ``start/stop/restart`` or on system -startup. Jails will still shut down on system shutdown, regardless of this setting. +The boot setting controls whether a jail will be started on system startup. If you have enabled bastille +with ``sysrc bastille_enable=YES``, all jails with ``boot=on`` will start on system startup. Any jail(s) +with ``boot=off`` will not be started on system startup. + +You can also use ``bastille start --boot TARGET`` to make Bastille respect the boot setting. If ``-b|--boot`` is not +used, the targeted jail(s) will start, regardless of the boot setting. + +Jails will still shut down on system shutdown, regardless of this setting. + +The ``-b|--boot`` can also be used with the ``stop`` command. Any jails with ``boot=off`` will +not be touched if ``stop`` is called with ``-b|--boot``. Same goes for the ``restart`` command. When jails are created with Bastille, the boot setting is set to ``on`` by default. This can be overridden using the ``--no-boot`` flag. See ``bastille create --no-boot TARGET...``. -This value can also be changed using ``bastille config TARGET boot [on|off]``. +This value can be changed using ``bastille config TARGET boot [on|off]``. This value will be shown using ``bastille list all``. Priority -------- -The priority value determines in what order commands are executed. This also controls in what order jails are started -and stopped. +The priority value determines in what order commands are executed if multiple jails are targetted. This also controls +in what order jails are started and stopped on system startup and shutdown. This requires Bastille to be enabled +with ``sysrc bastille_enable=YES``. When jails are created with Bastille, this value defaults to ``99``, but can be overridden with ``-p|--priority VALUE`` on -creation. See ``bastille create -p 90 TARGET...``. +creation. See ``bastille create --priority 90 TARGET...``. -This value can also be changed using ``bastille config TARGET priority VALUE``. +This value can be changed using ``bastille config TARGET priority VALUE``. This value will be shown using ``bastille list all``.