aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Makefile3
-rw-r--r--doc/bus.534
2 files changed, 36 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index ccb2251..66f33e5 100644
--- a/Makefile
+++ b/Makefile
@@ -11,10 +11,11 @@ VERSION = 1.0
all: bus doc
doc: man
-man: man1
+man: man1 man5
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
bin/%.1: doc/%.1
@echo SED $@
diff --git a/doc/bus.5 b/doc/bus.5
new file mode 100644
index 0000000..f98c996
--- /dev/null
+++ b/doc/bus.5
@@ -0,0 +1,34 @@
+.TH BUS 5 BUS-%VERSION%
+.SH NAME
+bus - A simple daemonless system for broadcasting messages locally
+.SH DESCRIPTION
+\fBbus\fP is a simple interprocess communication system for broadcasting messages to other processes on the same machine. \fBbus\fP does not use any daemon. Instead all communication and synchronisation is managed using System V (XSI) semaphores and System V (XSI) shared memory.
+
+The command \fBbus create\fP can be used to new buses. By convention, buses should be stored in \fIXDG_RUNTIME_DIR/bus\fP, this is what \fBbus create\fP does if no pathname is given. The pathname of the bus should be tracked using \fIBUS_X\fP, where \fIX\fP is replaced with either:
+.TP
+.IR GENERIC
+For the bus used in generic cases. That is all but the cases of the buses listed below.
+.TP
+.IR AUDIO
+For the bus used in with the audio subsystem is involved.
+.TP
+.IR VIDEO
+For the bus used in with the video subsystem is involved.
+.TP
+.IR INPUT
+For the bus used in with the input subsystem is involved.
+.TP
+.IR FILES
+For the bus used in with the storage subsystem is involved.
+.SH
+
+Messages broadcasted on a bus cannot be longer than 2047 bytes, excluding NUL-termination. Message should be encoded in UTF-8, and most not contain the NUL-character.
+
+Broadcasted message should start with the process ID whence the message originated, followed by a single regular space.
+.SH SEE ALSO
+bus(1), libbus(7)
+.SH AUTHORS
+See the LICENSE file for the authors.
+.SH BUGS
+Please report them.
+