~bitfehler/rolf

6579dd09be853d77e2f553b48e0525cbba7df266 — Conrad Hoffmann 2 months ago 8517fed master
README: packages, link to man page, contributing
1 files changed, 27 insertions(+), 0 deletions(-)

M README.md
M README.md => README.md +27 -0
@@ 24,6 24,8 @@ process. If the child process exits normally, rolf will exit with the same exit
code as the child process. If the child exits abnormally (i.e. without exit
code), rolf will exit with exit code -1.

The [man page][man] has more details.

## Rationale

Many process supervisors support some sort of log capturing facilities for


@@ 38,6 40,31 @@ Rolf is meant to help with that. Simply have `supervise-daemon` run your
service using rolf as proxy. You can then re-open logfiles by running
`supervise-daemon <SERVICE> -s SIGHUP`.

The [man page][man] has as example OpenRC service to illustrate this.

[man]: https://git.sr.ht/~bitfehler/rolf/tree/master/item/man/rolf.1.scd

## Alpine packages

Alpine packages are available:

```
curl -o /etc/apk/keys/conrad-6297636d.rsa.pub https://apk.bitfehler.net/conrad-6297636d.rsa.pub
echo "https://apk.bitfehler.net/v3.19/apk" >> /etc/apk/repositories
apk update && apk add rolf
```

**Note:** also available for 3.18, simply adjust the URL.

## Contributing

This project has no dedicated mailing list at this time. You can send
questions, comments, or patches to my [public inbox][inbox]. If you don't like
sending patches by email, feel free to create a fork on
Github/Gitlab/Codeberg/... and send my a link.

[inbox]: https://lists.sr.ht/~bitfehler/public-inbox

## License

SPDX-License-Identifier: GPL-3.0-or-later