aboutsummaryrefslogtreecommitdiffstats
path: root/doc/bus.5
diff options
context:
space:
mode:
authorJoachim Nilsson <troglobit@gmail.com>2015-04-26 15:06:15 +0200
committerJoachim Nilsson <troglobit@gmail.com>2015-04-26 22:08:33 +0200
commit3dc3dd161837b314b24e8a9a00718bc1f33aa436 (patch)
tree3bfc53624f6dc78343ed27c64a1d25a258898c1e /doc/bus.5
parentfix doc (diff)
downloadbus-3dc3dd161837b314b24e8a9a00718bc1f33aa436.tar.gz
bus-3dc3dd161837b314b24e8a9a00718bc1f33aa436.tar.bz2
bus-3dc3dd161837b314b24e8a9a00718bc1f33aa436.tar.xz
Spell checking and cleanup.
- Fix minor spelling errors. - Replace empty lines with .PP (new paragraph) - Replace some underlines with .BR func(section) - Rephrase from spec. language to standard man page anguage. - Reflow too long and too short lines to standard < 72 chars. Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
Diffstat (limited to '')
-rw-r--r--doc/bus.536
1 files changed, 24 insertions, 12 deletions
diff --git a/doc/bus.5 b/doc/bus.5
index f98c996..0394b23 100644
--- a/doc/bus.5
+++ b/doc/bus.5
@@ -2,12 +2,20 @@
.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:
+\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
.IR GENERIC
-For the bus used in generic cases. That is all but the cases of the buses listed below.
+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.
@@ -21,14 +29,18 @@ For the bus used in with the input subsystem is involved.
.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.
+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.
+.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)
+bus(1), libbus(7), semop(2), shmop(2)
.SH AUTHORS
-See the LICENSE file for the 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 them.
-
+Please report bugs to https://github.com/maandree/bus/issues