aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bus.5
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/bus.5
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/bus.513
1 files changed, 8 insertions, 5 deletions
diff --git a/doc/bus.5 b/doc/bus.5
index 4c2e7a1..f96538e 100644
--- a/doc/bus.5
+++ b/doc/bus.5
@@ -7,9 +7,9 @@ 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
+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
+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
@@ -30,13 +30,16 @@ For the bus used in with the input subsystem is involved.
For the bus used in with the storage subsystem is involved.
.PP
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.
+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 whence the message
originated, followed by a single regular space.
.SH SEE ALSO
-bus(1), libbus(7), semop(2), shmop(2)
+.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.