From eb1bce22898633a28bfc8adda67064a4c02b63d1 Mon Sep 17 00:00:00 2001 From: tschettervictor Date: Mon, 5 May 2025 18:41:34 -0600 Subject: [PATCH] docs: README update --- README.md | 19 ++++++------ docs/chapters/usage.rst | 67 +++++++++++++++++++++-------------------- 2 files changed, 45 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 7a23c58d..3ca56610 100644 --- a/README.md +++ b/README.md @@ -59,28 +59,29 @@ Available Commands: clone Clone an existing jail. cmd Execute arbitrary command on targeted jail(s). config Get, set or remove a config value for the targeted jail(s). - console Console into a running jail. + 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 or jail to host or targeted jail(s). + cp cp(1) files from host to targeted jail(s). create Create a jail. destroy Destroy a jail or release. edit Edit jail configuration files (advanced). - export Exports a jail. + export Export a jail. help Help about 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). - list List jails, releases, templates etc... + limits Apply resources limits to targeted 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. - rdr Redirect host port to container port. + rdr Redirect host port to jail port. rename Rename a jail. restart Restart a running jail. service Manage services within targeted jail(s). - setup Attempt to auto-configure network, firewall and storage on new installs. + 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). @@ -95,8 +96,8 @@ Available Commands: Use "bastille -v|--version" for version information. Use "bastille command -h|--help" for more information about a command. -Use "bastille [-c|--config config.conf] command" to specify a non-default config file. -Use "bastille [-p|--parallel VALUE] command" to run bastille in parallel mode. +Use "bastille -c|--config config.conf command" to specify a non-default config file. +Use "bastille -p|--parallel VALUE command" to run bastille in parallel mode. ``` diff --git a/docs/chapters/usage.rst b/docs/chapters/usage.rst index 2086d6db..b6623a8f 100644 --- a/docs/chapters/usage.rst +++ b/docs/chapters/usage.rst @@ -8,46 +8,49 @@ Usage containerized applications on FreeBSD. Usage: - bastille command TARGET [args] + bastille command [options(s)] TARGET [option(s)] [args] Available Commands: - bootstrap Bootstrap a FreeBSD release for container base. - clone Clone an existing container. - cmd Execute arbitrary command on targeted container(s). - config Get or set a config value for the targeted container(s). - console Console into a running container. - convert Convert a Thin container into a Thick container. - cp cp(1) files from host or container to host or targeted container(s). - create Create a new thin container or a thick container if -T|--thick option specified. - destroy Destroy a stopped container or a FreeBSD release. - edit Edit container configuration files (advanced). - export Exports a specified container. + bootstrap Bootstrap a release for jail base. + clone Clone an existing jail. + cmd Execute arbitrary command on targeted jail(s). + config Get, set or remove a config value for the targeted 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). + create Create a jail. + destroy Destroy a jail or release. + edit Edit jail configuration files (advanced). + export Export a jail. help Help about any command. htop Interactive process viewer (requires htop). - import Import a specified container. - jcp cp(1) files from a jail to targeted jail(s). - limits Apply resources limits to targeted container(s). See rctl(8). - list List containers (running). - mount Mount a volume inside the targeted container(s). - pkg Manipulate binary packages within targeted container(s). See pkg(8). + 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). + 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. - rdr Redirect host port to container port. - rename Rename a container. - restart Restart a running container. - service Manage services within targeted container(s). - setup Attempt to auto-configure network, firewall and storage on new installs. - start Start a stopped container. - stop Stop a running container. - sysrc Safely edit rc files within targeted container(s). - tags Add or remove tags to targeted container(s). - template Apply file templates to targeted container(s). + rdr Redirect host port to jail port. + rename Rename a jail. + restart Restart a running 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 within the targeted container(s). - update Update container base -pX release. - upgrade Upgrade container release to X.Y-RELEASE. + umount Unmount a volume from targeted jail(s). + update Update jail base -pX release. + upgrade Upgrade jail release to X.Y-RELEASE. verify Compare release against a "known good" index. zfs Manage (get|set) ZFS attributes on targeted container(s). Use "bastille -v|--version" for version information. Use "bastille command -h|--help" for more information about a command. - Use "bastille [-c|--config FILE] command" to specify a non-default config file. + Use "bastille -c|--config config.conf command" to specify a non-default config file. + Use "bastille -p|--parallel VALUE command" to run bastille in parallel mode. \ No newline at end of file