portzap/man/man8/portzap.8

.Dd May 2023
.Dt PORTZAP 8
.Os
.Sh NAME
.Nm portzap
.Nd manages a copy of the HardenedBSD ports tree
.Sh SYNOPSIS
.Nm portzap setup
.Nm portzap teardown
.Nm portzap clone
.Nm portzap pull
.Nm portzap checkout
.Nm portzap install
.Nm portzap rm
.Sh DESCRIPTION
.Nm portzap
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 into /usr/ports/ by root.
.Sh SETUP
.sp
.sp
.Nm portzap setup
.br
Setup portzap for the first time
.br
This command requires root privileges
.Pp
.Nm portzap teardown
.br
Reverse the changes made by 'portzap setup'
.br
This command requires root privileges
.Pp
.Sh GENERAL
.sp
.sp
.Nm portzap clone
.br
Clone the HardenedBSD ports tree into /home/_portzap/ports/
.br
This command is delegated to the '_portzap' user and
limited to members of the '_portzap' group
.Pp
.Nm portzap pull
.br
Pull updates into /home/_portzap/ports/
.br
This command is delegated to the '_portzap' user and
limited to members of the '_portzap' group
.br
.Pp
.Nm portzap checkout
.br
Checkout a branch other than the default: hardenedbsd/main
.br
This command is delegated to the '_portzap' user and
limited to members of the '_portzap' group
.Pp
.Nm portzap sh
.br
Run /bin/sh within /home/_portzap/ports/
.br
This command is delegated to the '_portzap' user and
limited to members of the '_portzap' group
.Pp
.Nm portzap rm
.br
Remove the contents of /usr/ports/ and /home/_portzap/ports/
.br
This command requires root privileges
.Pp
.Nm portzap install
.br
Install /home/_portzap/ports/ into /usr/ports/
.br
This command requires root privileges
.br
.Sh ENVIRONMENT
.sp
.sp
.Nm PORTZAP_CLONEURL
.br
The URL of a git repository
.br
Default: https://git.HardenedBSD.org/HardenedBSD/ports.git
.sp
.Nm PORTZAP_INSTALLDIR
.br
The directory where the ports collection will be installed
.br
Default: /usr/ports/
.sp
.Sh AUTHORS
The
.Nm portzap
utility and this manual page were written by
0x1eef <0x1eef@protonmail.com>.
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.Dd May 2023`
portzap.1 -> portzap.8 2023-06-10 02:23:38 +02:00			`.Dt PORTZAP 8`
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.Os`
			`.Sh NAME`
			`.Nm portzap`
Fix / improve docs 2024-05-11 22:45:59 +02:00			`.Nd manages a copy of the HardenedBSD ports tree`
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.Sh SYNOPSIS`
Add 'portzap [setup\|teardown]' And improve setup/setup-doas. 2024-08-17 22:15:30 +02:00			`.Nm portzap setup`
			`.Nm portzap teardown`
Update docs 2024-06-01 10:27:11 +02:00			`.Nm portzap clone`
			`.Nm portzap pull`
			`.Nm portzap checkout`
			`.Nm portzap install`
			`.Nm portzap rm`
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.Sh DESCRIPTION`
			`.Nm portzap`
Fix / improve docs 2024-05-11 22:45:59 +02:00			`manages a copy of the HardenedBSD ports tree.`
Update docs 2024-04-18 22:06:58 +02:00			`The copy of the ports tree is maintained by members of`
			`the '_portzap' group, and the copy of the ports tree`
Fix / improve docs 2024-05-11 22:45:59 +02:00			`can be installed into /usr/ports/ by root.`
Add 'portzap [setup\|teardown]' And improve setup/setup-doas. 2024-08-17 22:15:30 +02:00			`.Sh SETUP`
			`.sp`
			`.sp`
			`.Nm portzap setup`
			`.br`
			`Setup portzap for the first time`
			`.br`
			`This command requires root privileges`
			`.Pp`
			`.Nm portzap teardown`
			`.br`
			`Reverse the changes made by 'portzap setup'`
			`.br`
			`This command requires root privileges`
			`.Pp`
			`.Sh GENERAL`
Delegate 'portzap clone\|pull' to the _portzap user (via doas) 2024-04-08 01:27:18 +02:00			`.sp`
			`.sp`
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.Nm portzap clone`
			`.br`
Fix outdated docs (README, man page) 2024-05-22 02:32:55 +02:00			`Clone the HardenedBSD ports tree into /home/_portzap/ports/`
Delegate 'portzap clone\|pull' to the _portzap user (via doas) 2024-04-08 01:27:18 +02:00			`.br`
Add clarity to the documentation 2024-08-07 07:15:47 +02:00			`This command is delegated to the '_portzap' user and`
			`limited to members of the '_portzap' group`
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.Pp`
			`.Nm portzap pull`
			`.br`
Fix outdated docs (README, man page) 2024-05-22 02:32:55 +02:00			`Pull updates into /home/_portzap/ports/`
Delegate 'portzap clone\|pull' to the _portzap user (via doas) 2024-04-08 01:27:18 +02:00			`.br`
Add clarity to the documentation 2024-08-07 07:15:47 +02:00			`This command is delegated to the '_portzap' user and`
			`limited to members of the '_portzap' group`
Add 'portzap checkout' A copy of the same sourcezap command ('sourcezap checkout') 2024-05-22 03:24:36 +02:00			`.br`
			`.Pp`
			`.Nm portzap checkout`
			`.br`
			`Checkout a branch other than the default: hardenedbsd/main`
			`.br`
Add clarity to the documentation 2024-08-07 07:15:47 +02:00			`This command is delegated to the '_portzap' user and`
			`limited to members of the '_portzap' group`
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.Pp`
Add 'portzap sh' 2024-08-07 07:08:54 +02:00			`.Nm portzap sh`
Update docs 2024-04-18 01:30:14 +02:00			`.br`
Add 'portzap sh' 2024-08-07 07:08:54 +02:00			`Run /bin/sh within /home/_portzap/ports/`
Update docs 2024-04-18 01:30:14 +02:00			`.br`
Add clarity to the documentation 2024-08-07 07:15:47 +02:00			`This command is delegated to the '_portzap' user and`
			`limited to members of the '_portzap' group`
Update docs 2024-04-18 01:30:14 +02:00			`.Pp`
Fix outdated docs (README, man page) 2024-05-22 02:32:55 +02:00			`.Nm portzap rm`
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.br`
Fix outdated docs (README, man page) 2024-05-22 02:32:55 +02:00			`Remove the contents of /usr/ports/ and /home/_portzap/ports/`
Delegate 'portzap clone\|pull' to the _portzap user (via doas) 2024-04-08 01:27:18 +02:00			`.br`
Fix outdated docs (README, man page) 2024-05-22 02:32:55 +02:00			`This command requires root privileges`
Add 'portzap sh' 2024-08-07 07:08:54 +02:00			`.Pp`
			`.Nm portzap install`
			`.br`
			`Install /home/_portzap/ports/ into /usr/ports/`
			`.br`
			`This command requires root privileges`
Alter default umask / mode '/home/_portzap/ports/' and '/usr/ports/' have reduced permissions for members of the '_portzap' group, who now possess read-only permissions for both directories. The 'portzap erase' command must be run by root, since members of the '_portzap' group can't delete contents of either of those directories anymore. 2024-04-20 07:23:20 +02:00			`.br`
Fix docs 2024-04-08 21:15:15 +02:00			`.Sh ENVIRONMENT`
Delegate 'portzap clone\|pull' to the _portzap user (via doas) 2024-04-08 01:27:18 +02:00			`.sp`
			`.sp`
s\|PORTZAP_GITURL\|PORTZAP_CLONEURL\|g 2024-05-23 22:00:03 +02:00			`.Nm PORTZAP_CLONEURL`
Delegate 'portzap clone\|pull' to the _portzap user (via doas) 2024-04-08 01:27:18 +02:00			`.br`
s\|PORTZAP_GITURL\|PORTZAP_CLONEURL\|g 2024-05-23 22:00:03 +02:00			`The URL of a git repository`
Delegate 'portzap clone\|pull' to the _portzap user (via doas) 2024-04-08 01:27:18 +02:00			`.br`
Fix / improve docs 2024-05-11 22:45:59 +02:00			`Default: https://git.HardenedBSD.org/HardenedBSD/ports.git`
Delegate 'portzap clone\|pull' to the _portzap user (via doas) 2024-04-08 01:27:18 +02:00			`.sp`
			`.Nm PORTZAP_INSTALLDIR`
			`.br`
Fix outdated docs (README, man page) 2024-05-22 02:32:55 +02:00			`The directory where the ports collection will be installed`
Delegate 'portzap clone\|pull' to the _portzap user (via doas) 2024-04-08 01:27:18 +02:00			`.br`
			`Default: /usr/ports/`
Add $PORTZAP_BRANCH 2024-04-17 21:37:16 +02:00			`.sp`
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.Sh AUTHORS`
v0.5.5 2023-05-22 07:28:50 +02:00			`The`
Add $PORTZAP_PORTS_URL This change introduces an environment variable that can point to an alternative git repository (eg GitHub) if the default is offline. 2023-06-10 01:47:34 +02:00			`.Nm portzap`
v0.5.5 2023-05-22 07:28:50 +02:00			`utility and this manual page were written by`
Add $PORTZAP_PORTS_DIR 2023-06-10 03:04:38 +02:00			`0x1eef <0x1eef@protonmail.com>.`