Deploy manpages

This commit is contained in:
наб 2020-10-18 03:42:29 +02:00
parent a007176d65
commit 2860520271
No known key found for this signature in database
GPG Key ID: BCFD0B018D2658F1
2 changed files with 22 additions and 7 deletions

View File

@ -1,4 +1,6 @@
image: debian/sid
secrets:
- ccb6777e-650b-4fa2-87e1-e2342f5bb605 # tzpfms SSH key
packages:
- clang
- pkg-config
@ -18,3 +20,15 @@ tasks:
cd tzpfms
CC=clang CXX=clang++ make
find out/ -maxdepth 1 -type f -exec readelf -d {} +
- manpages: |
git -C tzpfms/ worktree add ../tzpfms-man man
cd tzpfms-man
git ls-tree -z --name-only HEAD | xargs -0 rm -r
mv ../tzpfms/out/man/* .
git add .
git config user.email "nabijaczleweli/autouploader@nabijaczleweli.xyz"
git config user.name "наб autouploader"
git commit -m "Manpage update by job $JOB_ID" || exit 0
git remote set-url origin 'git@git.sr.ht:~nabijaczleweli/tzpfms'
ssh-keyscan git.sr.ht > ~/.ssh/known_hosts
git push

View File

@ -1,7 +1,7 @@
# tzpfms [![builds.sr.ht badge](//builds.sr.ht/~nabijaczleweli/tzpfms.svg)](https://builds.sr.ht/~nabijaczleweli/tzpfms) [![Licence](//img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)
TPM-based encryption keys for ZFS datasets.
## [Manpage](//git.sr.ht/~nabijaczleweli/tzpfms-man#NAME)
## [Manpages](//git.sr.ht/~nabijaczleweli/tzpfms/tree/man)
### Why?
@ -14,12 +14,13 @@ Plus it's a pretty good annoyed sigh onomatopoeia.
### Building
You'll need `pkg-config`, `libzfslinux-dev`, `libtss2-dev`<!-- , to initialise the submodules -->, and `make` should hopefully Just Work™ if you have a C++17-capable compiler.
The output binaries are trimmed of extraneous dependencies, so they're all just libc + libzfs and friends + TPM back-end, if any.
You'll need `pkg-config`, `libzfslinux-dev`, `libtss2-dev`, and `make` should hopefully Just Work™ if you have a C++17-capable compiler.
The output binaries are trimmed of extraneous dependencies, so they're all just libc + libzfs and friends + TPM back-end.
### Installation
Copy `out/tzpfms` to `/sbin` and write a `/etc/tzpfms/{description,cmdline}`, as seen in the [manpage](//git.sr.ht/~nabijaczleweli/tzpfms/tree/trunk/man/tzpfms.md),
Copy the `out/zfs-tpm*` binaries corresponding to the back-ends you want to `/sbin`,
continue as the [manpage](//git.sr.ht/~nabijaczleweli/tzpfms/tree/trunk/man/zfs-tpm2-change-key.md) instructs,
<!-- #### From Debian repository
@ -46,13 +47,13 @@ See the [repository README](//debian.nabijaczleweli.xyz/README) for more informa
## Reporting bugs
<!-- There's [the tracker](//todo.sr.ht/~nabijaczleweli/tzpfms), but also see the list below. -->
There's [the tracker](//todo.sr.ht/~nabijaczleweli/tzpfms), but also see the list below.
## Contributing
<!-- Send a patch inline, as an attachment, or a git link and a ref to pull from to
Send a patch inline, as an attachment, or a git link and a ref to pull from to
[the list](//lists.sr.ht/~nabijaczleweli/tzpfms) ([~nabijaczleweli/tzpfms@lists.sr.ht](mailto:~nabijaczleweli/tzpfms)) or [me](mailto:nabijaczleweli@nabijaczleweli.xyz)
directly. I'm not picky, just please include the repo name in the subject prefix. -->
directly. I'm not picky, just please include the repo name in the subject prefix.
## Discussion