aboutsummaryrefslogtreecommitdiffstats
path: root/bus.5
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-12-11 23:13:37 +0100
committerMattias Andrée <maandree@kth.se>2017-12-11 23:13:37 +0100
commite35ba8684be9951fa2129503477ccd5ed6e4e5fc (patch)
tree756292d5a18ad6011a9311fdea8159f474385b65 /bus.5
parenttypo (diff)
downloadbus-01857be159c44428ef738590c9d2370bb2204247.tar.gz
bus-01857be159c44428ef738590c9d2370bb2204247.tar.bz2
bus-01857be159c44428ef738590c9d2370bb2204247.tar.xz
Simplify, do not install examples or info manual, and change license3.1.7
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'bus.5')
-rw-r--r--bus.542
1 files changed, 42 insertions, 0 deletions
diff --git a/bus.5 b/bus.5
new file mode 100644
index 0000000..213f2d2
--- /dev/null
+++ b/bus.5
@@ -0,0 +1,42 @@
+.TH BUS 5 BUS
+.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.
+.PP
+The command \fBbus create\fP can be used to create new buses. By
+convention, buses should be stored in \fI$XDG_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
+.B GENERIC
+For the bus used in generic cases. That is all but the cases of the
+buses listed below.
+.TP
+.B AUDIO
+For the bus used in with the audio subsystem is involved.
+.TP
+.B VIDEO
+For the bus used in with the video subsystem is involved.
+.TP
+.B INPUT
+For the bus used in with the input subsystem is involved.
+.TP
+.B FILES
+For the bus used in with the storage subsystem is involved.
+.PP
+Messages broadcasted on a bus cannot be longer than 2047 bytes,
+excluding NULL termination. Message should be encoded in UTF-8,
+and most not contain the NULL character.
+.PP
+Broadcasted message should start with the process ID, or 0 if ephemeral,
+whence the message originated, followed by a single regular space.
+.SH SEE ALSO
+.BR bus (1),
+.BR libbus (7),
+.BR semop (2),
+.BR shmop (2)