diff options
author | Mattias Andrée <maandree@operamail.com> | 2015-11-28 23:44:00 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@operamail.com> | 2015-11-28 23:44:00 +0100 |
commit | d26658642e018e36e848caa7d7587a213808913b (patch) | |
tree | 8fd12037ab8c61a7a2e33ca1e7a59a106d3947b2 /doc/man/bus.5 | |
parent | man: broadcast 0 instead of pid if ephemeral (diff) | |
download | bus-d26658642e018e36e848caa7d7587a213808913b.tar.gz bus-d26658642e018e36e848caa7d7587a213808913b.tar.bz2 bus-d26658642e018e36e848caa7d7587a213808913b.tar.xz |
move manpages from doc/ to doc/man/
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc/man/bus.5')
-rw-r--r-- | doc/man/bus.5 | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/man/bus.5 b/doc/man/bus.5 new file mode 100644 index 0000000..0a5de7e --- /dev/null +++ b/doc/man/bus.5 @@ -0,0 +1,50 @@ +.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. +.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) +.SH AUTHORS +Principal author, Mattias Andrée. See the LICENSE file for the full +list of authors. +.SH LICENSE +MIT/X Consortium License. +.SH BUGS +Please report bugs to https://github.com/maandree/bus/issues or to +maandree@member.fsf.org |