Fix / improve docs
This commit is contained in:
parent
ee84071329
commit
62a6fd7712
2 changed files with 11 additions and 12 deletions
13
README.md
13
README.md
|
@ -1,7 +1,7 @@
|
||||||
## About
|
## About
|
||||||
|
|
||||||
portzap is a utility that manages a local copy of the
|
portzap is a utility that manages a local copy of the
|
||||||
[hardenedbsd ports tree](https://git.hardenedbsd.org/hardenedbsd/ports).
|
[HardenedBSD ports tree](https://git.HardenedBSD.org/HardenedBSD/ports).
|
||||||
The copy of the ports tree is maintained by members of
|
The copy of the ports tree is maintained by members of
|
||||||
the `_portzap` group, and the copy of the ports tree
|
the `_portzap` group, and the copy of the ports tree
|
||||||
can be installed to `/usr/ports/` by root.
|
can be installed to `/usr/ports/` by root.
|
||||||
|
@ -11,7 +11,7 @@ can be installed to `/usr/ports/` by root.
|
||||||
### CLI: setup-portzap
|
### CLI: setup-portzap
|
||||||
|
|
||||||
This command should be run after installing portzap for
|
This command should be run after installing portzap for
|
||||||
the first time.
|
the first time:
|
||||||
|
|
||||||
# Add the portzap user, group and home directory.
|
# Add the portzap user, group and home directory.
|
||||||
# This command requires root privileges.
|
# This command requires root privileges.
|
||||||
|
@ -19,8 +19,7 @@ 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
|
||||||
|
|
||||||
|
@ -41,7 +40,7 @@ the first time.
|
||||||
|
|
||||||
* __$PORTZAP\_GITURL__ <br>
|
* __$PORTZAP\_GITURL__ <br>
|
||||||
The URL to a git repository. <br>
|
The URL to a git repository. <br>
|
||||||
Default: https://git.hardenedbsd.org/hardenedbsd/ports.git.
|
Default: https://git.HardenedBSD.org/HardenedBSD/ports.git.
|
||||||
|
|
||||||
* __$PORTZAP\_BRANCH__ <br>
|
* __$PORTZAP\_BRANCH__ <br>
|
||||||
The git branch to clone and pull updates from. <br>
|
The git branch to clone and pull updates from. <br>
|
||||||
|
@ -56,7 +55,7 @@ the first time.
|
||||||
**Port**
|
**Port**
|
||||||
|
|
||||||
portzap is available
|
portzap is available
|
||||||
[as a hardenedbsd port](https://git.hardenedbsd.org/hardenedbsd/ports/-/tree/hardenedbsd/main/hardenedbsd/portzap). <br>
|
[as a HardenedBSD port](https://git.HardenedBSD.org/HardenedBSD/ports/-/tree/HardenedBSD/main/hardenedbsd/portzap). <br>
|
||||||
`pkg install portzap` should work too but expect slower updates.
|
`pkg install portzap` should work too but expect slower updates.
|
||||||
|
|
||||||
**Source**
|
**Source**
|
||||||
|
@ -79,7 +78,7 @@ via git:
|
||||||
|
|
||||||
* [GitHub](https://github.com/0x1eef/portzap)
|
* [GitHub](https://github.com/0x1eef/portzap)
|
||||||
* [GitLab](https://gitlab.com/0x1eef/portzap)
|
* [GitLab](https://gitlab.com/0x1eef/portzap)
|
||||||
* [git.hardenedbsd.org](https://git.hardenedbsd.org/0x1eef/portzap)
|
* [git.HardenedBSD.org](https://git.HardenedBSD.org/0x1eef/portzap)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
|
@ -3,7 +3,7 @@
|
||||||
.Os
|
.Os
|
||||||
.Sh NAME
|
.Sh NAME
|
||||||
.Nm portzap
|
.Nm portzap
|
||||||
.Nd manages a copy of the hardenedbsd ports tree
|
.Nd manages a copy of the HardenedBSD ports tree
|
||||||
.Sh SYNOPSIS
|
.Sh SYNOPSIS
|
||||||
.br
|
.br
|
||||||
portzap clone
|
portzap clone
|
||||||
|
@ -15,16 +15,16 @@ portzap install
|
||||||
portzap erase
|
portzap erase
|
||||||
.Sh DESCRIPTION
|
.Sh DESCRIPTION
|
||||||
.Nm portzap
|
.Nm portzap
|
||||||
manages a copy of the hardenedbsd ports tree.
|
manages a copy of the HardenedBSD ports tree.
|
||||||
The copy of the ports tree is maintained by members of
|
The copy of the ports tree is maintained by members of
|
||||||
the '_portzap' group, and the copy of the ports tree
|
the '_portzap' group, and the copy of the ports tree
|
||||||
can be installed to /usr/ports/ by root.
|
can be installed into /usr/ports/ by root.
|
||||||
.Sh EXAMPLES
|
.Sh EXAMPLES
|
||||||
.sp
|
.sp
|
||||||
.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
|
||||||
|
@ -53,7 +53,7 @@ This command requires root privileges.
|
||||||
.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
|
||||||
|
|
Loading…
Reference in a new issue