Browse Source

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
Jeremy C. Reed 15 years ago
parent
commit
aefefeb876
1 changed files with 35 additions and 6 deletions
  1. 35 6
      src/bin/msgq/msgq.8

+ 35 - 6
src/bin/msgq/msgq.8

@@ -4,7 +4,7 @@
 .Os
 .Os
 .Sh NAME
 .Sh NAME
 .Nm msgq
 .Nm msgq
-.Nd message routing daemon for the Command channel
+.Nd message routing daemon for the Command Channel
 .\" TODO: spell out CC
 .\" TODO: spell out CC
 .Sh SYNOPSIS
 .Sh SYNOPSIS
 .Nm
 .Nm
@@ -16,9 +16,36 @@
 .Sh DESCRIPTION
 .Sh DESCRIPTION
 The
 The
 .Nm
 .Nm
-daemon handles message routing for the Command channel.
+daemon handles message routing for the Command Channel.
-It listens on 127.0.0.1.
+.Pp
-.\" TODO: point to Command channel specification or document some here
+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
 .Sh OPTIONS
 The arguments are as follows:
 The arguments are as follows:
 .
 .
@@ -36,15 +63,17 @@ Display more about what
 is doing.
 is doing.
 .El
 .El
 .\" .Sh SEE ALSO
 .\" .Sh SEE ALSO
+.\" TODO: point to Command channel specification or document some here.
 .\" .Sh STANDARDS
 .\" .Sh STANDARDS
 .Sh HISTORY
 .Sh HISTORY
 The python version of
 The python version of
 .Nm
 .Nm
 was first coded in December 2009.
 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
 .Sh AUTHORS
 The
 The
 .Nm
 .Nm
-daemon and Control channel specification
+daemon and Control Channel specification
 were initially designed by Michael Graff of ISC.
 were initially designed by Michael Graff of ISC.
 .\" .Sh BUGS
 .\" .Sh BUGS