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

Fix outdated docs (README, man page)

Browse source
This commit is contained in:
0x1eef 2024-05-21 21:32:55 -03:00
parent 08b4fd0c76
commit 8625d945b9
2 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -19,21 +19,21 @@ the first time:
### CLI: portzap ### 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. # This command is delegated to the '_portzap' user
$ portzap clone $ portzap clone
# Pull updates into /home/_portzap/ports/. # Pull updates into /home/_portzap/ports/
# This command is delegated to the '_portzap' user. # This command is delegated to the '_portzap' user
$ portzap pull $ portzap pull
# Install /home/_portzap/ports/ into /usr/ports/. # Install /home/_portzap/ports/ into /usr/ports/
# This command requires root privileges. # This command requires root privileges
# portzap install # portzap install
# Start over: erase /usr/ports/ and /home/_portzap/ports/. # Remove the contents of /usr/ports/ and /home/_portzap/ports/
# This command requires root privileges. # This command requires root privileges
$ portzap erase $ portzap rm
### ENVIRONMENT ### ENVIRONMENT

26
man/man8/portzap.8
View file

@ -12,7 +12,7 @@ portzap pull
.br .br
portzap install portzap install
.br .br
portzap erase portzap rm
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm portzap .Nm portzap
manages a copy of the HardenedBSD ports tree. manages a copy of the HardenedBSD ports tree.
@ -24,47 +24,47 @@ can be installed into /usr/ports/ by root.
.sp .sp
.Nm portzap clone .Nm portzap clone
.br .br
Clone the HardenedBSD ports tree into /home/_portzap/ports/. Clone the HardenedBSD ports tree into /home/_portzap/ports/
.br .br
This command is delegated to the '_portzap' user. This command is delegated to the '_portzap' user
.Pp .Pp
.Nm portzap pull .Nm portzap pull
.br .br
Pull updates into /home/_portzap/ports/. Pull updates into /home/_portzap/ports/
.br .br
This command is delegated to the '_portzap' user. This command is delegated to the '_portzap' user
.Pp .Pp
.Nm portzap install .Nm portzap install
.br .br
Install /home/_portzap/ports/ into /usr/ports/. Install /home/_portzap/ports/ into /usr/ports/
.br .br
This command requires root privileges. This command requires root privileges
.Pp .Pp
.Nm portzap erase .Nm portzap rm
.br .br
Start over: erase /usr/ports/ and /home/_portzap/ports/. Remove the contents of /usr/ports/ and /home/_portzap/ports/
.br .br
This command requires root privileges. This command requires root privileges
.br .br
.Sh ENVIRONMENT .Sh ENVIRONMENT
.sp .sp
.sp .sp
.Nm PORTZAP_GITURL .Nm PORTZAP_GITURL
.br .br
The URL to a git repository. The URL to a git repository
.br .br
Default: https://git.HardenedBSD.org/HardenedBSD/ports.git Default: https://git.HardenedBSD.org/HardenedBSD/ports.git
.sp .sp
.Nm PORTZAP_BRANCH .Nm PORTZAP_BRANCH
.br .br
The git branch to clone and pull updates from. The git branch to clone and pull updates from
.br .br
Default: hardenedbsd/main Default: hardenedbsd/main
.br .br
.sp .sp
.Nm PORTZAP_INSTALLDIR .Nm PORTZAP_INSTALLDIR
.br .br
The directory where the ports collection will be installed. The directory where the ports collection will be installed
.br .br
Default: /usr/ports/ Default: /usr/ports/
.sp .sp