From c87237df2bbdc3e067d2a7bc68d2ec4a48043896 Mon Sep 17 00:00:00 2001
From: 0x1eef <0x1eef@protonmail.com>
Date: Mon, 1 Apr 2024 23:49:45 -0300
Subject: [PATCH] Update docs

---
 README.md          | 30 +++++++++++++-----------------
 man/man8/portzap.8 |  6 ++++++
 2 files changed, 19 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 863142d..ad13a6d 100644
--- a/README.md
+++ b/README.md
@@ -7,28 +7,27 @@ portzap is a utility that manages a local copy of the
 
 **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.  Default:
+  https://git.hardenedbsd.org/hardenedbsd/ports.git
 
-* __$PORTZAP_PORTS_DIR__ <br>
-  The directory where the ports collection will be installed. <br>
-  Defaults to /usr/ports.
+* __$PORTZAP\_INSTALLDIR__ <br>
+  The directory where the ports collection will be
+  installed. 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
+# pw adduser
 # pw groupmod -n _portzap -m <user>
 ```
 
diff --git a/man/man8/portzap.8 b/man/man8/portzap.8
index 976cdab..10a0d8b 100644
--- a/man/man8/portzap.8
+++ b/man/man8/portzap.8
@@ -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