commit 5169add85db2bafc6dc680db0206d6b6a499dd95 from: noodle date: Thu Jan 15 18:05:53 2026 UTC matabot.8: document the RSS feature and add more info commit - 16d0d03f980f192b1d5fbb3efbce9ed1aaf2f1ed commit + 5169add85db2bafc6dc680db0206d6b6a499dd95 blob - a0ba990b2d5ffc622315636b5524039670915232 blob + a82136acad4a50fd365b859909a69adde1ddd7a3 --- matabot.8 +++ matabot.8 @@ -9,6 +9,7 @@ .Sh SYNOPSIS .Nm matabot .Op Fl d | v +.Op Fl r .Op Fl H Ar path .Op Fl b Ar path .Op Fl j Ar join @@ -23,8 +24,14 @@ starts an IRC bot nicknamed and joins the channel .Sq #testmatabot on localhost (port 6667) with with TLS turned off by default. -It's typically started as a daemon via an rc.d script. +It's typically started as a daemon via an rc.d script on OpenBSD. .Pp +To use the rc.d script and the RSS feature via the +.Fl r +flag, create a user like so: +.Pp +.Dl # useradd -m -c 'mata_bot daemon' -d /var/matabot -k /var/empty -s /sbin/nologin _matabot +.Pp The options are as follows: .Bl -tag -width Ds .It Fl H Ar path @@ -54,6 +61,8 @@ Connect to Load the quotes file from .Ar path .Po default: Pa /usr/local/share/matabot/quotes Pc Ns . +.It Fl r +Turn on RSS news from https://analognowhere.com/feed/rss.xml (updated hourly). .It Fl t Turn on TLS. .It Fl v @@ -107,6 +116,17 @@ Mention him! This boy talks back!? .El .Sh FILES .Bl -tag -width Ds +.It Pa ./rss +RSS last-read link database file. +Currently, it tracks only one RSS feed. +The file is written to the current working directory; preferably, a user +.Sq _matabot +should be created as explained above with it's +.Xr passwd 5 +home_dir field set to +.Pa /var/matabot +and the script ran as that user, as to protect it from accidental change or +removal. .It Pa /etc/rc.d/matabot OpenBSD rc script for running matabot as a service. .It Pa /usr/local/share/matabot/ball @@ -129,7 +149,7 @@ comic. Typical invocation .Po use these flags in your Pa /etc/rc.conf.local Pc Ns : .Pp -.Dl $ matabot -t -h irc.server.tld -j analognowhere -p 6697 +.Dl $ matabot -r -t -h irc.server.tld -j analognowhere -p 6697 .Pp Test on a local ircd with verbose logging turned on. (No TLS): @@ -140,7 +160,9 @@ Test on a local ircd with verbose logging turned on. .Xr perl 1 , .Xr HTTP::Tiny 3p , .Xr IO::Socket 3p , -.Xr IO::Socket::SSL 3p +.Xr IO::Socket::SSL 3p , +.Xr passwd 5 , +.Xr useradd 8 . .Sh STANDARDS .Bl -item