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

docs: README update

Browse Source
This commit is contained in:
tschettervictor
2025-05-05 18:41:34 -06:00
parent bd24727a2c
commit eb1bce2289
2 changed files with 45 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -59,28 +59,29 @@ Available Commands:
clone Clone an existing jail. clone Clone an existing jail.
cmd Execute arbitrary command on targeted jail(s). cmd Execute arbitrary command on targeted jail(s).
config Get, set or remove a config value for the 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. 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. create Create a jail.
destroy Destroy a jail or release. destroy Destroy a jail or release.
edit Edit jail configuration files (advanced). edit Edit jail configuration files (advanced).
export Exports a jail. export Export a jail.
help Help about any command. help Help about any command.
htop Interactive process viewer (requires htop). htop Interactive process viewer (requires htop).
import Import a jail. import Import a jail.
jcp cp(1) files from a jail to jail(s). jcp cp(1) files from a jail to jail(s).
limits Apply resources limits to targeted jail(s). See rctl(8). limits Apply resources limits to targeted jail(s). See rctl(8) and cpuset(1).
list List jails, releases, templates etc... list List jails, releases, templates and more...
migrate Migrate targeted jail(s) to a remote system.
mount Mount a volume inside targeted jail(s). mount Mount a volume inside targeted jail(s).
network Add or remove interfaces from targeted jail(s). network Add or remove interfaces from targeted jail(s).
pkg Manipulate binary packages within targeted jail(s). See pkg(8). pkg Manipulate binary packages within targeted jail(s). See pkg(8).
rcp cp(1) files from a jail to host. 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. rename Rename a jail.
restart Restart a running jail. restart Restart a running jail.
service Manage services within targeted jail(s). 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. start Start a stopped jail.
stop Stop a running jail. stop Stop a running jail.
sysrc Safely edit rc files within targeted jail(s). sysrc Safely edit rc files within targeted jail(s).
@@ -95,8 +96,8 @@ Available Commands:
Use "bastille -v|--version" for version information. Use "bastille -v|--version" for version information.
Use "bastille command -h|--help" for more information about a command. 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 -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 -p|--parallel VALUE command" to run bastille in parallel mode.
``` ```

67
docs/chapters/usage.rst
View File

@@ -8,46 +8,49 @@ Usage
containerized applications on FreeBSD. containerized applications on FreeBSD.
Usage: Usage:
bastille command TARGET [args] bastille command [options(s)] TARGET [option(s)] [args]
Available Commands: Available Commands:
bootstrap Bootstrap a FreeBSD release for container base. bootstrap Bootstrap a release for jail base.
clone Clone an existing container. clone Clone an existing jail.
cmd Execute arbitrary command on targeted container(s). cmd Execute arbitrary command on targeted jail(s).
config Get or set a config value for the targeted container(s). config Get, set or remove a config value for the targeted jail(s).
console Console into a running container. console Console into a jail.
convert Convert a Thin container into a Thick container. convert Convert thin jail to thick jail, or convert a jail to a custom release.
cp cp(1) files from host or container to host or targeted container(s). cp cp(1) files from host to targeted jail(s).
create Create a new thin container or a thick container if -T|--thick option specified. create Create a jail.
destroy Destroy a stopped container or a FreeBSD release. destroy Destroy a jail or release.
edit Edit container configuration files (advanced). edit Edit jail configuration files (advanced).
export Exports a specified container. export Export a jail.
help Help about any command. help Help about any command.
htop Interactive process viewer (requires htop). htop Interactive process viewer (requires htop).
import Import a specified container. import Import a jail.
jcp cp(1) files from a jail to targeted jail(s). jcp cp(1) files from a jail to jail(s).
limits Apply resources limits to targeted container(s). See rctl(8). limits Apply resources limits to targeted jail(s). See rctl(8) and cpuset(1).
list List containers (running). list List jails, releases, templates and more...
mount Mount a volume inside the targeted container(s). migrate Migrate targeted jail(s) to a remote system.
pkg Manipulate binary packages within targeted container(s). See pkg(8). 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. 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 container. rename Rename a jail.
restart Restart a running container. restart Restart a running jail.
service Manage services within targeted container(s). 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 container. start Start a stopped jail.
stop Stop a running container. stop Stop a running jail.
sysrc Safely edit rc files within targeted container(s). sysrc Safely edit rc files within targeted jail(s).
tags Add or remove tags to targeted container(s). tags Add or remove tags to targeted jail(s).
template Apply file templates to targeted container(s). template Apply file templates to targeted jail(s).
top Display and update information about the top(1) cpu processes. top Display and update information about the top(1) cpu processes.
umount Unmount a volume from within the targeted container(s). umount Unmount a volume from targeted jail(s).
update Update container base -pX release. update Update jail base -pX release.
upgrade Upgrade container release to X.Y-RELEASE. upgrade Upgrade jail release to X.Y-RELEASE.
verify Compare release against a "known good" index. verify Compare release against a "known good" index.
zfs Manage (get|set) ZFS attributes on targeted container(s). zfs Manage (get|set) ZFS attributes on targeted container(s).
Use "bastille -v|--version" for version information. Use "bastille -v|--version" for version information.
Use "bastille command -h|--help" for more information about a command. 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.