From 62a6fd771285457969ca25f1abf0574c76636b6c Mon Sep 17 00:00:00 2001 From: 0x1eef <0x1eef@protonmail.com> Date: Sat, 11 May 2024 17:45:59 -0300 Subject: [PATCH] Fix / improve docs --- README.md | 13 ++++++------- man/man8/portzap.8 | 10 +++++----- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d084520..f6c68d9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ ## 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). The copy of the ports tree is maintained by members of the `_portzap` group, and the copy of the ports tree can be installed to `/usr/ports/` by root. @@ -11,7 +11,7 @@ can be installed to `/usr/ports/` by root. ### CLI: setup-portzap This command should be run after installing portzap for -the first time. +the first time: # Add the portzap user, group and home directory. # This command requires root privileges. @@ -19,8 +19,7 @@ the first time. ### CLI: portzap - - # Clone the hardenedbsd ports tree into /home/_portzap/ports/. + # Clone the HardenedBSD ports tree into /home/_portzap/ports/. # This command is delegated to the '_portzap' user. $ portzap clone @@ -41,7 +40,7 @@ the first time. * __$PORTZAP\_GITURL__
The URL to a git repository.
- Default: https://git.hardenedbsd.org/hardenedbsd/ports.git. + Default: https://git.HardenedBSD.org/HardenedBSD/ports.git. * __$PORTZAP\_BRANCH__
The git branch to clone and pull updates from.
@@ -56,7 +55,7 @@ the first time. **Port** portzap is available -[as a hardenedbsd port](https://git.hardenedbsd.org/hardenedbsd/ports/-/tree/hardenedbsd/main/hardenedbsd/portzap).
+[as a HardenedBSD port](https://git.HardenedBSD.org/HardenedBSD/ports/-/tree/HardenedBSD/main/hardenedbsd/portzap).
`pkg install portzap` should work too but expect slower updates. **Source** @@ -79,7 +78,7 @@ via git: * [GitHub](https://github.com/0x1eef/portzap) * [GitLab](https://gitlab.com/0x1eef/portzap) -* [git.hardenedbsd.org](https://git.hardenedbsd.org/0x1eef/portzap) +* [git.HardenedBSD.org](https://git.HardenedBSD.org/0x1eef/portzap) ## License diff --git a/man/man8/portzap.8 b/man/man8/portzap.8 index 67244e7..3be224c 100644 --- a/man/man8/portzap.8 +++ b/man/man8/portzap.8 @@ -3,7 +3,7 @@ .Os .Sh NAME .Nm portzap -.Nd manages a copy of the hardenedbsd ports tree +.Nd manages a copy of the HardenedBSD ports tree .Sh SYNOPSIS .br portzap clone @@ -15,16 +15,16 @@ portzap install portzap erase .Sh DESCRIPTION .Nm portzap -manages a copy of the hardenedbsd ports tree. +manages a copy of the HardenedBSD ports tree. The copy of the ports tree is maintained by members of the '_portzap' group, and the copy of the ports tree -can be installed to /usr/ports/ by root. +can be installed into /usr/ports/ by root. .Sh EXAMPLES .sp .sp .Nm portzap clone .br -Clone the hardenedbsd ports tree into /home/_portzap/ports/. +Clone the HardenedBSD ports tree into /home/_portzap/ports/. .br This command is delegated to the '_portzap' user. .Pp @@ -53,7 +53,7 @@ This command requires root privileges. .br The URL to a git repository. .br -Default: https://git.hardenedbsd.org/hardenedbsd/ports.git +Default: https://git.HardenedBSD.org/HardenedBSD/ports.git .sp .Nm PORTZAP_BRANCH .br