aboutsummaryrefslogtreecommitdiffstats
path: root/doc/libbus.7
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-05-17 13:29:35 +0200
committerMattias Andrée <maandree@operamail.com>2015-05-17 13:29:35 +0200
commit31403008097ad8137fc70df22ab41a84e146446a (patch)
treee40e4c3bce6c51ada8ff7c129ad183efc24e81b2 /doc/libbus.7
parentadd -x option to create command, and -n option to broadcast command (diff)
downloadbus-31403008097ad8137fc70df22ab41a84e146446a.tar.gz
bus-31403008097ad8137fc70df22ab41a84e146446a.tar.bz2
bus-31403008097ad8137fc70df22ab41a84e146446a.tar.xz
specifications for timed functions + fix manpage formatting
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--doc/libbus.726
1 files changed, 20 insertions, 6 deletions
diff --git a/doc/libbus.7 b/doc/libbus.7
index 18c1d6e..804ee97 100644
--- a/doc/libbus.7
+++ b/doc/libbus.7
@@ -2,19 +2,33 @@
.SH NAME
libbus - A simple daemonless system for broadcasting messages locally
.SH DESCRIPTION
-\fBbus\fP is a stupid-simple, thrilless, daemonless interprocess
-communication system for broadcasting messages.
+.BR bus
+is a stupid-simple, thrilless, daemonless interprocess communication
+system for broadcasting messages.
.SH RATIONALE
We need an interprocess communication system similar to message queues.
But we need broadcasting rather than anycasting, so we have a fast,
simple and daemonless system for announcing events to any processes that
might be interested.
.SH FUTURE DIRECTION
-Timed out read and writes will be added.
+None.
.SH SEE ALSO
-bus(1), bus(5), bus_create(3), bus_unlink(3), bus_open(3), bus_close(3),
-bus_write(3), bus_read(3), bus_poll_start(3), bus_poll_stop(3),
-bus_poll(3), bus_chown(3), bus_chmod(3)
+.BR bus (1),
+.BR bus (5),
+.BR bus_create (3),
+.BR bus_unlink (3),
+.BR bus_open (3),
+.BR bus_close (3),
+.BR bus_write (3),
+.BR bus_write_timed (3),
+.BR bus_read (3),
+.BR bus_read_timed (3),
+.BR bus_poll_start (3),
+.BR bus_poll_stop (3),
+.BR bus_poll (3),
+.BR bus_poll_timed (3),
+.BR bus_chown (3),
+.BR bus_chmod (3)
.SH AUTHORS
Principal author, Mattias Andrée. See the LICENSE file for the full
list of authors.