Add clarity to the documentation
Some checks are pending
portzap / shellcheck (push) Waiting to run

This commit is contained in:
0x1eef 2024-08-07 02:15:47 -03:00
parent cba5973df8
commit c4ee461925
2 changed files with 16 additions and 8 deletions

View file

@ -21,19 +21,23 @@ multiple times:
#### CLI: portzap
# Clone the HardenedBSD ports tree into /home/_portzap/ports/
# This command is delegated to the '_portzap' user
# This command is delegated to the '_portzap' user and
# limited to members of the '_portzap' group
user@localhost$ portzap clone
# Pull updates into /home/_portzap/ports/
# This command is delegated to the '_portzap' user
# This command is delegated to the '_portzap' user and
# limited to members of the '_portzap' group
user@localhost$ portzap pull
# Checkout a branch other than the default: hardenedbsd/main
# This command is delegated to the '_portzap' user
# This command is delegated to the '_portzap' user and
# limited to members of the '_portzap' group
user@localhost$ portzap checkout freebsd/main
# Run /bin/sh within /home/_portzap/ports/
# This command is delegated to the '_portzap' user
# This command is delegated to the '_portzap' user and
# limited to members of the '_portzap' group
user@localhost$ portzap sh
# Remove the contents of /usr/ports/ and /home/_portzap/ports/

View file

@ -23,26 +23,30 @@ can be installed into /usr/ports/ by root.
.br
Clone the HardenedBSD ports tree into /home/_portzap/ports/
.br
This command is delegated to the '_portzap' user
This command is delegated to the '_portzap' user and
limited to members of the '_portzap' group
.Pp
.Nm portzap pull
.br
Pull updates into /home/_portzap/ports/
.br
This command is delegated to the '_portzap' user
This command is delegated to the '_portzap' user and
limited to members of the '_portzap' group
.br
.Pp
.Nm portzap checkout
.br
Checkout a branch other than the default: hardenedbsd/main
.br
This command is delegated to the '_portzap' user
This command is delegated to the '_portzap' user and
limited to members of the '_portzap' group
.Pp
.Nm portzap sh
.br
Run /bin/sh within /home/_portzap/ports/
.br
This command is delegated to the '_portzap' user
This command is delegated to the '_portzap' user and
limited to members of the '_portzap' group
.Pp
.Nm portzap rm
.br