diff options
author | June McEnroe <june@causal.agency> | 2021-10-15 17:42:11 -0400 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2021-10-15 17:48:49 -0400 |
commit | 44aa40b65c3d55f7ad6d5e2b51cd7885a3f5a3db (patch) | |
tree | 19990e1dc5be244522b0f3a1e8027a518e2503f4 | |
parent | Prefix example commands with $ prompt (diff) | |
download | pounce-44aa40b65c3d55f7ad6d5e2b51cd7885a3f5a3db.tar.gz pounce-44aa40b65c3d55f7ad6d5e2b51cd7885a3f5a3db.zip |
Add back pounce EXAMPLES section
-rw-r--r-- | pounce.1 | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/pounce.1 b/pounce.1 index 76bd63d..c81c615 100644 --- a/pounce.1 +++ b/pounce.1 @@ -646,6 +646,53 @@ New save files are created in The most likely location of save files. .El . +.Sh EXAMPLES +Start +.Nm : +.Bd -literal -offset indent +$ pounce -H irc.example.org -h irc.tilde.chat -j '#ascii.town' +.Ed +.Pp +Write an equivalent configuration file to +.Pa ~/.config/pounce/tilde.conf : +.Bd -literal -offset indent +local-host = irc.example.org +host = irc.tilde.chat +join = #ascii.town +.Ed +.Pp +Load the configuration file: +.Bd -literal -offset indent +$ pounce tilde.conf +.Ed +. +.Pp +Add a certificate to +.Xr acme-client.conf 5 : +.Bd -literal -offset indent +domain irc.example.org { + domain key "/home/user/.config/pounce/irc.example.org.key" + domain full chain certificate \e + "/home/user/.config/pounce/irc.example.org.pem" + sign with letsencrypt +} +.Ed +.Pp +Obtain the certificate +and make the private key readable by +.Nm : +.Bd -literal -offset indent +# acme-client irc.example.org +# chown user /home/user/.config/pounce/irc.example.org.key +.Ed +.Pp +Renew and reload the certificate with a +.Xr cron 8 +job: +.Bd -literal -offset indent +~ * * * * acme-client irc.example.org && pkill -USR1 pounce +.Ed +. .Sh DIAGNOSTICS Upon receiving the .Dv SIGINFO |