portzap/README.md

34 lines
1.3 KiB
Markdown
Raw Normal View History

2023-01-14 18:30:29 +01:00
## About
portzap is a simple bourne shell script that takes care of keeping up to
date with the [HardenedBSD](https://hardenedbsd.org) ports collection.
The
[HardenedBSD ports collection](https://git.hardenedbsd.org/hardenedbsd/ports.git)
is maintained as a git repository, and portzap allows the repository to be cloned
(and updated) using a regular user account. The unpacking of the repository to
`/usr/ports` is also supported but must be performed by root.
## Usage
2023-01-16 01:26:59 +01:00
* **portzap init** <br>
This command should be run as root. <br>
The command creates the `_portzap` user / group, and the directory `/home/_portzap`.
2023-01-16 02:36:35 +01:00
2023-01-14 18:45:46 +01:00
* **portzap clone** <br>
2023-01-16 01:26:59 +01:00
This command should be run by a user account that is a member of the `_portzap` group. <br>
2023-01-16 02:35:12 +01:00
The command clones HardenedBSD's ports collection to `/home/_portzap/ports`.
2023-01-14 18:30:29 +01:00
2023-01-14 18:45:46 +01:00
* **portzap pull** <br>
2023-01-16 01:26:59 +01:00
This command should be run by a user account that is a member of the `_portzap` group. <br>
2023-01-14 18:30:29 +01:00
The command updates an existing repository previously cloned with `portzap clone`.
2023-01-14 18:45:46 +01:00
* **portzap unpack** <br>
2023-01-14 23:52:50 +01:00
This command should be run as root. <br>
2023-01-16 01:26:59 +01:00
The command copies `/home/_portzap/ports` to `/usr/ports`.
2023-01-14 18:30:29 +01:00
2023-01-14 18:45:46 +01:00
## Sources
* [Source code (GitHub)](https://github.com/0x1eef/portzap)
* [Source code (GitLab)](https://gitlab.com/0x1eef/portzap)