From 1c48ee6091ac9f4fcfe6ac42596ad2b073789ce1 Mon Sep 17 00:00:00 2001 From: Koichiro Iwao Date: Wed, 27 Aug 2025 21:28:14 +0900 Subject: [PATCH 1/2] Decompress man page Compressed man page is difficult to edit and also not suitable for tracking in version control system. Compress during install instead. --- Makefile | 1 + usr/local/man/man8/bastille.8 | 122 +++++++++++++++++++++++++++++++ usr/local/man/man8/bastille.8.gz | Bin 1223 -> 0 bytes 3 files changed, 123 insertions(+) create mode 100644 usr/local/man/man8/bastille.8 delete mode 100644 usr/local/man/man8/bastille.8.gz diff --git a/Makefile b/Makefile index fad41f24..a9212c95 100644 --- a/Makefile +++ b/Makefile @@ -12,6 +12,7 @@ install: @echo "BASTILLE_VERSION: ${BASTILLE_BRANCH}-${BASTILLE_VERSION}" @sed -i '' "s/BASTILLE_VERSION=.*/BASTILLE_VERSION=${BASTILLE_BRANCH}-${BASTILLE_VERSION}/" usr/local/bin/bastille @cp -Rv usr / + @gzip -n /usr/local/share/man/man8/bastille.8 @echo @echo "This method is for testing & development." @echo "Please report any issues to https://github.com/BastilleBSD/bastille/issues" diff --git a/usr/local/man/man8/bastille.8 b/usr/local/man/man8/bastille.8 new file mode 100644 index 00000000..8189bda9 --- /dev/null +++ b/usr/local/man/man8/bastille.8 @@ -0,0 +1,122 @@ +.Dd 2020/04/12 +.Dt bastille 8 +.Os FreeBSD +.Sh NAME +bastille - Bastille is an open-source system for automating deployment +\ and management of containerized applications on FreeBSD. +.Sh SYNOPSIS +.Nm bastille +.Ar command +.Ar TARGET +.Op arg +.Sh DESCRIPTION +.Nm To start all containers during boot use: +.Pp +sysrc bastille_enable=YES +.Pp +.Nm To start only selected containers use: +.Pp +sysrc bastille_list="foo bar baz" +.Pp +.Nm The following modules are available: +.Pp +.Bl -tag -width -indent +.It bootstrap +Bootstrap a FreeBSD release for container base. +.It clone +Clone an existing container. +.It cmd +Execute arbitrary command on targeted container(s). +.It console +Console into a running container. +.It convert +Convert a thin container into a thick container. +.It cp +cp(1) files from host to targeted container(s). +.It create +Create a new thin container or a thick container if -T|--thick option specified. +.It destroy +Destroy a stopped container or a FreeBSD release. +.It export +Exports a container archive or image. +.It help +Help about any command +.It htop +Interactive process viewer (requires htop). +.It import +Import a container archive or image. +.It list +List containers, releases, templates, logs, limits or backups. +.It limits +Apply resources limits to targeted container(s). See rctl(8). +.It pkg +Manipulate binary packages within targeted container(s). See pkg(8). +.It restart +Restart a running container. +.It rdr +Redirect host port to container port. +.It service +Manage services within targeted container(s). +.It start +Start a stopped container. +.It stop +Stop a running container. +.It sysrc +Safely edit rc files within targeted container(s). +.It tags +Add tags to targeted container(s). +.It template +Apply file templates to targeted container(s). +.It top +Display and update information about the top(1) cpu processes. +.It update +Update container base -pX release. +.It upgrade +Upgrade container release to X.Y-RELEASE. +.It verify +Compare release against a "known good" index. +.It zfs +Manage (get|set) zfs attributes on targeted container(s). +.El +.Pp +.Sh FILES +.Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact +.It Pa /usr/local/bin/bastille +Bastille executable +.El +.Pp +.Sh BUGS +Please report any bugs on Github +.Nm https://github.com/BastilleBSD/bastille/issues +.Pp +.Sh EXAMPLE +bastille bootstrap 12.1-RELEASE +.Pp +bastille create myjail 12.1-RELEASE 10.0.0.1 em0 +.Pp +.Nm To create a container with VNET and DHCP use +.Pp +bastille create -V myjail 12.1-RELEASE 0.0.0.0 em0 +.Sh HISTORY +.Nm Features added in 0.6.20200412: +.Pp +.Bl -tag -width -indent +.It clone +Clone an existing container. +.It import (updated) +Support for iocage and ezjail import +.Pp +.El +.Nm Features added in 0.6.20200202: +.Pp +.Bl -tag -width -indent +.It convert +Convert a thin container into a thick container. +.It export +Exports a container archive or image. +.It import +Import a container archive or image. +.It limits +Apply resources limits to targeted container(s). See rctl(8). +.It rdr +Redirect host port to container port. diff --git a/usr/local/man/man8/bastille.8.gz b/usr/local/man/man8/bastille.8.gz deleted file mode 100644 index 8f40bcbfdeb3ac59c5c6b5216c0668c1200c15f3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1223 zcmV;&1UUO2iwFp*;1Fa017cxwbZKmCWiB`XtyXPM8#xgEzQ1C`Cy*|?393$~O8o#N zZ6i^L*t9CrNyyoqY+Ssy&-MaA{qZ+rXG5SZP~8b-y?E#4nHN9fd|bof@NifR-xQ<6 zEFTA02p^(P$4w_ek;xrMx^l zpOw=x%g@>^#0Cus$#gCT^j)B0zgjJ`n^SejQ73@fR3uy539x4Qm8 z*=Cj9A05C_aweC~w6HQh0I58O(4hzfFfL?UN9oh+hoi&a$$2)_0iCD`-jdaQhyQfaQSw-FlONee6w|o80tB~w zc1n+(^YKR?7`+jNSVgI(S7jQ0%2rZ%hC8#m?yT?a@OE}YjIk#5#6iB7{$)*}Lo>SV~q@KjS&!Lg6sk}4D+j2cC{m+nzC7i z)P^yCg!>_ZypyCox*J&`<0Mf1zb}AGnh{R90rNw9^+Htmk{-Xt8;L6`#S$sqgqtF$ zHYe$25X4SYsk)9YFPyi&{+r6Oi-(?gNtePHOHZ=vIBGgub4jHphHK+g*>rv&awTDA zgUWV&pW~*rl3MmTX+LI07}&3mk6~vUCu$at>yCWSuLSyQemS_9oKB9)Nzx+zlFKzQ zS!}F2fPU)1Sc0AXXzQvov1W4 zXe_>;p7IcTGCuZ-&(vPN_-2r%mMc!>g8954{!?mwMZ=)E;-Xw>(c&HqDvqE^<7OtH z=)5bGse~%%Bo*5+y}dVJoD@919)UUj{GrTdDG3e}mk>QIx+aG6fqJZ4#KE`X=6u5&z8M|9d`EcYlutYl`{{7h2U*$KxWl&xNd<2(hKKhN{zg1` l=Q=-+lpe1@`d`NXZ%@nLA8h~AKzjXX_!qJ!6spS$004TtRlxuN From 4332df9e845da86228bb92e6bdd64105b8e643c3 Mon Sep 17 00:00:00 2001 From: Koichiro Iwao Date: Wed, 27 Aug 2025 21:58:25 +0900 Subject: [PATCH 2/2] Update man page - Add edit subcommand - Remove bastille_list as it is no longer work with bastille 1.0 - Remove trailing whitespaces - Update date --- usr/local/man/man8/bastille.8 | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/usr/local/man/man8/bastille.8 b/usr/local/man/man8/bastille.8 index 8189bda9..9ff3cf51 100644 --- a/usr/local/man/man8/bastille.8 +++ b/usr/local/man/man8/bastille.8 @@ -1,4 +1,4 @@ -.Dd 2020/04/12 +.Dd 2025/08/27 .Dt bastille 8 .Os FreeBSD .Sh NAME @@ -11,13 +11,9 @@ bastille - Bastille is an open-source system for automating deployment .Op arg .Sh DESCRIPTION .Nm To start all containers during boot use: -.Pp +.Pp sysrc bastille_enable=YES .Pp -.Nm To start only selected containers use: -.Pp -sysrc bastille_list="foo bar baz" -.Pp .Nm The following modules are available: .Pp .Bl -tag -width -indent @@ -37,6 +33,8 @@ cp(1) files from host to targeted container(s). Create a new thin container or a thick container if -T|--thick option specified. .It destroy Destroy a stopped container or a FreeBSD release. +.It edit +Edit container configuration files (advanced). .It export Exports a container archive or image. .It help @@ -104,7 +102,7 @@ bastille create -V myjail 12.1-RELEASE 0.0.0.0 em0 .It clone Clone an existing container. .It import (updated) -Support for iocage and ezjail import +Support for iocage and ezjail import .Pp .El .Nm Features added in 0.6.20200202: