0x1eef/portzap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Update docs (README.md)
Some checks are pending
portzap / shellcheck (push) Waiting to run
Details

Browse source
This commit is contained in:
0x1eef 2024-08-07 02:20:07 -03:00
parent c4ee461925
commit 7ffb0d7880
1 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
README.md
View file

@ -8,7 +8,7 @@ can be installed into `/usr/ports/` by root.
## Examples ## Examples
#### CLI: setup-portzap ### CLI: setup-portzap
`setup-portzap` should be run after installing portzap for `setup-portzap` should be run after installing portzap for
the first time. <br> There is no harm in running `setup-portzap` the first time. <br> There is no harm in running `setup-portzap`
@ -18,37 +18,37 @@ multiple times:
# This command requires root privileges # This command requires root privileges
root@localhost# setup-portzap root@localhost# setup-portzap
#### CLI: portzap ### CLI: group
# Clone the HardenedBSD ports tree into /home/_portzap/ports/ The following commands are delegated to the `_portzap` user and
# This command is delegated to the '_portzap' user and restricted to members of the `_portzap` group. The restrictions
# limited to members of the '_portzap' group are enforced by portzap and to a lesser extent by
user@localhost$ portzap clone [doas(1)](https://man.openbsd.org/doas):
# Pull updates into /home/_portzap/ports/ **portzap clone** <br>
# This command is delegated to the '_portzap' user and Clone the HardenedBSD ports tree into `/home/_portzap/ports/` <br>
# limited to members of the '_portzap' group
user@localhost$ portzap pull
# Checkout a branch other than the default: hardenedbsd/main **portzap pull** <br>
# This command is delegated to the '_portzap' user and Pull updates into `/home/_portzap/ports/` <br>
# limited to members of the '_portzap' group
user@localhost$ portzap checkout freebsd/main
# Run /bin/sh within /home/_portzap/ports/ **portzap checkout** <br>
# This command is delegated to the '_portzap' user and Checkout a branch other than the default: `hardenedbsd/main` <br>
# limited to members of the '_portzap' group
user@localhost$ portzap sh
# Remove the contents of /usr/ports/ and /home/_portzap/ports/ **portzap sh** <br>
# This command requires root privileges Run `/bin/sh` within `/home/_portzap/ports/` <br>
root@localhost# portzap rm
# Install /home/_portzap/ports/ into /usr/ports/ ### CLI: superuser
# This command requires root privileges
root@localhost# portzap install
#### Environment The following commands are restricted to root. <br>
The restrictions are enforced by portzap:
**portzap rm** <br>
Remove the contents of `/usr/ports/` and `/home/_portzap/ports/` <br>
**portzap install** <br>
Install `/home/_portzap/ports/` into `/usr/ports/` <br>
## Environment
* __$PORTZAP\_CLONEURL__ <br> * __$PORTZAP\_CLONEURL__ <br>
The URL of a git repository <br> The URL of a git repository <br>