sourcezap/man/man8/sourcezap.8

.Dd May 2023
.Dt SOURCEZAP 8
.Os
.Sh NAME
.Nm sourcezap
.Nd manages a copy of the HardenedBSD source tree
.Sh SYNOPSIS
.br
.Nm sourcezap setup
.Nm sourcezap teardown
.Nm sourcezap clone
.Nm sourcezap pull
.Nm sourcezap checkout
.Nm sourcezap install
.Nm sourcezap rm
.Sh DESCRIPTION
.Nm sourcezap
manages a copy of the HardenedBSD source tree.
The copy of the source tree is maintained by members of
the '_sourcezap' group, and a copy of the source tree
can be installed into /usr/src/ by root.
.Sh SETUP
.sp
.sp
.Nm sourcezap setup
.br
Setup sourcezap for the first time
.br
This command requires root privileges
.Pp
.Nm sourcezap teardown
.br
Reverse the changes made by 'sourcezap setup'
.br
This command requires root privileges
.Pp
.Sh GENERAL
.sp
.sp
.Nm sourcezap clone
.br
Clone the HardenedBSD source tree into /home/_sourcezap/src/
.br
This command is delegated to the '_sourcezap' user
.Pp
.Nm sourcezap pull
.br
Pull updates into /home/_sourcezap/src/
.br
This command is delegated to the '_sourcezap' user
.Pp
.Nm sourcezap checkout
.br
Checkout a branch other than the default: hardened/14-stable/master
.br
This command is delegated to the '_sourcezap' user
.Pp
.Nm sourcezap sh
.br
Run /bin/sh within /home/_sourcezap/src/
.br
This command is delegated to the '_sourcezap' user and
limited to members of the '_sourcezap' group
.Pp
.Nm sourcezap rm
.br
Remove the contents of /usr/src/ and /home/_sourcezap/src/
.br
This command requires root privileges
.Pp
.Nm sourcezap install
.br
Install /home/_sourcezap/src/ into /usr/src/
.br
This command requires root privileges
.br
.Sh ENVIRONMENT
.sp
.sp
.Nm SOURCEZAP_CLONEURL
.br
The URL of a git repository
.br
Default: https://git.HardenedBSD.org/HardenedBSD/HardenedBSD.git/
.sp
.Nm SOURCEZAP_INSTALLDIR
.br
The directory where the source tree will be installed
.br
Default: /usr/src/
.sp
.Sh AUTHORS
The
.Nm sourcezap
utility and this manual page were written by
0x1eef <0x1eef@protonmail.com>.
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.Dd May 2023`
Rename project (srczap -> sourcezap) 2024-05-12 01:19:45 +02:00			`.Dt SOURCEZAP 8`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.Os`
			`.Sh NAME`
Rename project (srczap -> sourcezap) 2024-05-12 01:19:45 +02:00			`.Nm sourcezap`
Docs: fix 2024-05-11 21:33:43 +02:00			`.Nd manages a copy of the HardenedBSD source tree`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.Sh SYNOPSIS`
			`.br`
Add 'sourcezap [setup\|teardown]' (#5) Co-authored-by: 0x1eef <0x1eef@protonmail.com> Reviewed-on: http://git.bastion.home.network/0x1eef/sourcezap/pulls/5 2024-08-17 00:45:22 +02:00			`.Nm sourcezap setup`
			`.Nm sourcezap teardown`
Update docs 2024-06-01 08:58:10 +02:00			`.Nm sourcezap clone`
			`.Nm sourcezap pull`
			`.Nm sourcezap checkout`
			`.Nm sourcezap install`
			`.Nm sourcezap rm`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.Sh DESCRIPTION`
Rename project (srczap -> sourcezap) 2024-05-12 01:19:45 +02:00			`.Nm sourcezap`
Docs: fix 2024-05-11 21:33:43 +02:00			`manages a copy of the HardenedBSD source tree.`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`The copy of the source tree is maintained by members of`
Rename project (srczap -> sourcezap) 2024-05-12 01:19:45 +02:00			`the '_sourcezap' group, and a copy of the source tree`
Swap shebang with set -e 2024-05-11 21:43:59 +02:00			`can be installed into /usr/src/ by root.`
Add 'sourcezap [setup\|teardown]' (#5) Co-authored-by: 0x1eef <0x1eef@protonmail.com> Reviewed-on: http://git.bastion.home.network/0x1eef/sourcezap/pulls/5 2024-08-17 00:45:22 +02:00			`.Sh SETUP`
			`.sp`
			`.sp`
			`.Nm sourcezap setup`
			`.br`
			`Setup sourcezap for the first time`
			`.br`
			`This command requires root privileges`
			`.Pp`
			`.Nm sourcezap teardown`
			`.br`
Update sourcezap.8 2024-08-17 21:34:28 +02:00			`Reverse the changes made by 'sourcezap setup'`
Add 'sourcezap [setup\|teardown]' (#5) Co-authored-by: 0x1eef <0x1eef@protonmail.com> Reviewed-on: http://git.bastion.home.network/0x1eef/sourcezap/pulls/5 2024-08-17 00:45:22 +02:00			`.br`
			`This command requires root privileges`
			`.Pp`
s\|COMMANDS\|GENERAL\|g 2024-08-17 01:16:21 +02:00			`.Sh GENERAL`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.sp`
			`.sp`
Rename project (srczap -> sourcezap) 2024-05-12 01:19:45 +02:00			`.Nm sourcezap clone`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Match README.md (sourcezap.8) 2024-05-12 05:06:01 +02:00			`Clone the HardenedBSD source tree into /home/_sourcezap/src/`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Match README.md (sourcezap.8) 2024-05-12 05:06:01 +02:00			`This command is delegated to the '_sourcezap' user`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.Pp`
Rename project (srczap -> sourcezap) 2024-05-12 01:19:45 +02:00			`.Nm sourcezap pull`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Match README.md (sourcezap.8) 2024-05-12 05:06:01 +02:00			`Pull updates into /home/_sourcezap/src/`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Match README.md (sourcezap.8) 2024-05-12 05:06:01 +02:00			`This command is delegated to the '_sourcezap' user`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.Pp`
Replace set-branch with checkout 2024-05-12 04:32:08 +02:00			`.Nm sourcezap checkout`
Add 'sourcezap set-branch' The $SOURCEZAP_BRANCH environment variable has been removed. When you want to change branch 'sourcezap set-branch <branch name>' can be used instead. 2024-05-12 03:53:37 +02:00			`.br`
Match README.md (sourcezap.8) 2024-05-12 05:06:01 +02:00			`Checkout a branch other than the default: hardened/14-stable/master`
Add 'sourcezap set-branch' The $SOURCEZAP_BRANCH environment variable has been removed. When you want to change branch 'sourcezap set-branch <branch name>' can be used instead. 2024-05-12 03:53:37 +02:00			`.br`
Match README.md (sourcezap.8) 2024-05-12 05:06:01 +02:00			`This command is delegated to the '_sourcezap' user`
Add 'sourcezap set-branch' The $SOURCEZAP_BRANCH environment variable has been removed. When you want to change branch 'sourcezap set-branch <branch name>' can be used instead. 2024-05-12 03:53:37 +02:00			`.Pp`
Add 'sourcezap sh' 2024-08-07 08:45:25 +02:00			`.Nm sourcezap sh`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Add 'sourcezap sh' 2024-08-07 08:45:25 +02:00			`Run /bin/sh within /home/_sourcezap/src/`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Add 'sourcezap sh' 2024-08-07 08:45:25 +02:00			`This command is delegated to the '_sourcezap' user and`
			`limited to members of the '_sourcezap' group`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.Pp`
sourcezap erase -> sourcezap rm 2024-05-12 04:55:58 +02:00			`.Nm sourcezap rm`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Match README.md (sourcezap.8) 2024-05-12 05:06:01 +02:00			`Remove the contents of /usr/src/ and /home/_sourcezap/src/`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Match README.md (sourcezap.8) 2024-05-12 05:06:01 +02:00			`This command requires root privileges`
Add 'sourcezap sh' 2024-08-07 08:45:25 +02:00			`.Pp`
			`.Nm sourcezap install`
			`.br`
			`Install /home/_sourcezap/src/ into /usr/src/`
			`.br`
			`This command requires root privileges`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
			`.Sh ENVIRONMENT`
			`.sp`
			`.sp`
${SOURCEZAP_GITURL} -> ${SOURCEZAP_CLONEURL} 2024-05-12 04:23:57 +02:00			`.Nm SOURCEZAP_CLONEURL`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Match README.md (sourcezap.8) 2024-05-12 05:06:01 +02:00			`The URL of a git repository`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Fix outdated link 2024-05-12 00:41:53 +02:00			`Default: https://git.HardenedBSD.org/HardenedBSD/HardenedBSD.git/`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.sp`
Rename project (srczap -> sourcezap) 2024-05-12 01:19:45 +02:00			`.Nm SOURCEZAP_INSTALLDIR`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
Fix typo in man page 2024-06-23 01:21:54 +02:00			`The directory where the source tree will be installed`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`.br`
			`Default: /usr/src/`
			`.sp`
			`.Sh AUTHORS`
			`The`
Rename project (srczap -> sourcezap) 2024-05-12 01:19:45 +02:00			`.Nm sourcezap`
First commit A modified copy of portzap repurposed for management of the hardenedbsd source tree. 2024-05-11 21:03:00 +02:00			`utility and this manual page were written by`
			`0x1eef <0x1eef@protonmail.com>.`