diff --git a/man/Makefile.am b/man/Makefile.am index d5c6504..3199bf1 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -1 +1 @@ -man_MANS = subrelayd.8 +man_MANS = subrelayd.8 sbrlctrl.1 diff --git a/man/sbrlctrl.1 b/man/sbrlctrl.1 new file mode 100644 index 0000000..829ff63 --- /dev/null +++ b/man/sbrlctrl.1 @@ -0,0 +1,57 @@ +.TH SBRLCTRL 1 +.SH NAME +sbrlctrl \- control the Subrelay daemon +.SH SYNOPSIS +.B sbrlctrl +.RB [ \-s " " path ] +.I command +.RI [ args ...] +.br +.B sbrlctrl +.BR \-h +.SH DESCRIPTION +.B sbrlctrl +sends a command to the Subrelay daemon over its local UNIX socket and prints +the daemon's response. +.PP +The +.I command +must be one of: +.TP +.B ADD +.I email +Subscribe the email address. +.TP +.B DEL +.I email +Unsubscribe the email address. +.TP +.B LIST +List current subscribers. +.TP +.B STATUS +Show the daemon's operational status. +.SH OPTIONS +.TP +.BR \-s ", " \-\-socket " " path +Connect to the daemon using the UNIX socket at +.IR path . +If omitted, +.B sbrlctrl +uses +.IR /var/run/subrelay/subrelayd.sock . +.TP +.BR \-h ", " \-\-help +Print help and exit. +.SH EXAMPLES +.TP +.B sbrlctrl ADD person@example.com +Subscribe an address using the default socket. +.TP +.B sbrlctrl --socket /run/subrelay.sock LIST +List subscribers using a specified socket. +.SH SEE ALSO +.BR subrelayd (8), +.BR subrelay.conf (5) +.SH AUTHORS +Written by the Subrelay authors.