aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--Makefile3
-rw-r--r--doc/libbus.716
2 files changed, 18 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 66f33e5..f9738f3 100644
--- a/Makefile
+++ b/Makefile
@@ -11,11 +11,12 @@ VERSION = 1.0
all: bus doc
doc: man
-man: man1 man5
+man: man1 man5 man7
bus: bin/bus bin/libbus.so.$(LIB_VERSION) bin/libbus.so.$(LIB_MAJOR) bin/libbus.so bin/libbus.a
man1: bin/bus.1 bin/bus-broadcast.1 bin/bus-create.1 bin/bus-listen.1 bin/bus-remove.1 bin/bus-wait.1
man5: bin/bus.5
+man7: bin/libbus.7
bin/%.1: doc/%.1
@echo SED $@
diff --git a/doc/libbus.7 b/doc/libbus.7
new file mode 100644
index 0000000..f934c7a
--- /dev/null
+++ b/doc/libbus.7
@@ -0,0 +1,16 @@
+.TH LIBBUS 7 BUS-%VERSION%
+.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 message.
+.SH RATIONALE
+We need an interprocess communication system similar to message queues. But it we need broadcasting rather than anycasting, so we have a fast, simple and daemonless system for announcing events to all processes whom might be interested.
+.SH FUTURE DIRECTION
+Perhaps the ability to have groups and other permissions on bus, so they can be shared among users and be system-wide. Private and abstract buses might be interesting too.
+.SH SEE ALSO
+bus(1), bus(5), bus_create(3), bus_unlink(3), bus_open(3), bus_close(3), bus_read(3), bus_write(3)
+.SH AUTHORS
+See the LICENSE file for the authors.
+.SH BUGS
+Please report them.
+