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

Update docs

Browse source
This commit is contained in:
0x1eef 2024-04-01 23:49:45 -03:00
parent 9811cf229c
commit a48ef35b04
2 changed files with 19 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -1,34 +1,33 @@
## About
portzap is a utility that manages a local copy of the
[hardenedbsd ports tree](https://git.hardenedbsd.org/hardenedbsd/ports),
[hardenedbsd ports tree](https://git.hardenedbsd.org/hardenedbsd/ports).
## Examples
**CLI**
# Clones the ports tree into "/home/_portzap/ports/"
# Clone the hardenedbsd ports tree into /home/_portzap/ports/.
$ portzap clone
# Pulls updates into "/home/_portzap/ports/"
# Pull updates into /home/_portzap/ports/.
$ portzap pull
# Installs "/home/_portzap/ports/" into "/usr/ports/"
# Install /home/_portzap/ports/ into /usr/ports/.
# portzap install
**Environment**
# Add the portzap user, group and home directory.
# portzap adduser
# The URL of a git repository
# Defaults to https://git.hardenedbsd.org/hardenedbsd/ports.git
export PORTZAP_PORTS_URL=https://github.com/HardenedBSD/ports
**ENVIRONMENT VARIABLES**
# The directory where the ports collection will be installed
# Defaults to "/usr/ports/"
export PORTZAP_PORTS_DIR=/path/to/ports
* __$PORTZAP\_GITURL__ <br>
The URL to a git repository. <br>
Default: https://git.hardenedbsd.org/hardenedbsd/ports.git.
* __$PORTZAP_PORTS_DIR__ <br>
* __$PORTZAP\_INSTALLDIR__ <br>
The directory where the ports collection will be installed. <br>
Defaults to /usr/ports.
Default: /usr/ports/.
## Install
@ -37,10 +36,7 @@ $ git clone https://github.com/0x1eef/portzap.git
$ cd portzap
# cp -R bin /usr/local/
# cp -R libexec /usr/local/
# pw useradd -n _portzap \
-c "portzap utility user" \
-m \
-s /sbin/nologin
# portzap adduser
# pw groupmod -n _portzap -m <user>
```

6
man/man8/portzap.8
View file

@ -11,6 +11,8 @@ portzap clone
portzap pull
.br
portzap install
.br
portzap adduser
.Sh DESCRIPTION
.Nm portzap
manages a copy of the hardenedbsd ports tree.
@ -27,6 +29,10 @@ Pull updates into /home/_portzap/ports/.
.Nm portzap install
.br
Install /home/_portzap/ports/ into /usr/ports/.
.Pp
.Nm portzap adduser
.br
Add the portzap user, group and home directory.
.Sh ENVIRONMENT VARIABLES
.Pp
.Bl -tag -width $PORTZAP_GITURL