sourcezap/man/man8/sourcezap.8
2024-06-01 03:58:10 -03:00

72 lines
1.5 KiB
Groff

.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 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 EXAMPLES
.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 install
.br
Install /home/_sourcezap/src/ into /usr/src/
.br
This command requires root privileges
.Pp
.Nm sourcezap rm
.br
Remove the contents of /usr/src/ and /home/_sourcezap/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 ports collection 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>.