Commit aefefeb8 authored by Jeremy C. Reed's avatar Jeremy C. Reed
Browse files

Add some more details and some cleanup for this manual.


git-svn-id: svn://bind10.isc.org/svn/bind10/trunk@930 e5f2f494-b856-4b98-b285-d166d9295462
parent 9964f279
......@@ -4,7 +4,7 @@
.Os
.Sh NAME
.Nm msgq
.Nd message routing daemon for the Command channel
.Nd message routing daemon for the Command Channel
.\" TODO: spell out CC
.Sh SYNOPSIS
.Nm
......@@ -16,9 +16,36 @@
.Sh DESCRIPTION
The
.Nm
daemon handles message routing for the Command channel.
It listens on 127.0.0.1.
.\" TODO: point to Command channel specification or document some here
daemon handles message routing for the Command Channel.
.Pp
The Command Channel is a message bus and subscription manager.
Programs may subscribe to certain groups to receive messages
for that group.
Every new connection to the
.Nm
receives a unique identifier -- this is the local name.
The commands it handles are:
.Bl -tag -compact -offset indent
.It getlname
receive local name.
.It send
send a message to defined subscribers.
.It subscribe
add a subscription. This means it is a listener for messages
for a specific group.
.It unsubscribe
remove a subscription.
.El
.Pp
.Nm
listens on 127.0.0.1.
.Pp
The
.Nm
daemon may be cleanly stopped by sending the
.Dv SIGTERM
signal to the process.
This shutdown does not notify the subscribers.
.Sh OPTIONS
The arguments are as follows:
.
......@@ -36,15 +63,17 @@ Display more about what
is doing.
.El
.\" .Sh SEE ALSO
.\" TODO: point to Command channel specification or document some here.
.\" .Sh STANDARDS
.Sh HISTORY
The python version of
.Nm
was first coded in December 2009.
An older C version with different wire format was coded in September 2009.
The C version with now deprecated wire format was coded in September
2009.
.Sh AUTHORS
The
.Nm
daemon and Control channel specification
daemon and Control Channel specification
were initially designed by Michael Graff of ISC.
.\" .Sh BUGS
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment