sbrlctrl manual page;
This commit is contained in:
parent
bccf4d7003
commit
6753624c52
@ -1 +1 @@
|
||||
man_MANS = subrelayd.8
|
||||
man_MANS = subrelayd.8 sbrlctrl.1
|
||||
|
||||
57
man/sbrlctrl.1
Normal file
57
man/sbrlctrl.1
Normal file
@ -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.
|
||||
Loading…
x
Reference in New Issue
Block a user