From c4ee461925b859e831ee0acf9ce58ac5b48b1462 Mon Sep 17 00:00:00 2001 From: 0x1eef <0x1eef@protonmail.com> Date: Wed, 7 Aug 2024 02:15:47 -0300 Subject: [PATCH] Add clarity to the documentation --- README.md | 12 ++++++++---- man/man8/portzap.8 | 12 ++++++++---- 2 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d16d4aa..4c5398d 100644 --- a/README.md +++ b/README.md @@ -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/ diff --git a/man/man8/portzap.8 b/man/man8/portzap.8 index 5a03278..8aa0a03 100644 --- a/man/man8/portzap.8 +++ b/man/man8/portzap.8 @@ -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