aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-04-26 22:49:59 +0200
committerMattias Andrée <maandree@operamail.com>2015-04-26 22:49:59 +0200
commit6147cdbb2f5b3cf7b7f92a0dc7532671f82674ee (patch)
treeeda34d1445219e5027053e24ccaf5a8640496f61 /doc
parentMerge pull request #3 from troglobit/master (diff)
downloadbus-6147cdbb2f5b3cf7b7f92a0dc7532671f82674ee.tar.gz
bus-6147cdbb2f5b3cf7b7f92a0dc7532671f82674ee.tar.bz2
bus-6147cdbb2f5b3cf7b7f92a0dc7532671f82674ee.tar.xz
formatting
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/bus.54
-rw-r--r--doc/bus_close.32
-rw-r--r--doc/bus_create.32
-rw-r--r--doc/bus_open.312
-rw-r--r--doc/bus_unlink.36
5 files changed, 13 insertions, 13 deletions
diff --git a/doc/bus.5 b/doc/bus.5
index 0394b23..09a1ce2 100644
--- a/doc/bus.5
+++ b/doc/bus.5
@@ -13,7 +13,7 @@ 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
+.B GENERIC
For the bus used in generic cases. That is all but the cases of the
buses listed below.
.TP
@@ -28,7 +28,7 @@ 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
+.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.
diff --git a/doc/bus_close.3 b/doc/bus_close.3
index 025544f..c83b200 100644
--- a/doc/bus_close.3
+++ b/doc/bus_close.3
@@ -15,7 +15,7 @@ Upon successful completion, the function returns 0. Otherwise the
function returns -1 and sets \fIerrno\fP to indicate the error.
.SH ERRORS
.TP
-.IR EINVAL
+.B EINVAL
The bus does not exist.
.SH SEE ALSO
bus-create(1), bus(5), libbus(7), bus_open(3), bus_unlink(3)
diff --git a/doc/bus_create.3 b/doc/bus_create.3
index b9cb66d..9e5795d 100644
--- a/doc/bus_create.3
+++ b/doc/bus_create.3
@@ -32,7 +32,7 @@ Upon successful completion, the function returns 0. Otherwise the
function return -1 with \fIerrno\fP set to indicate the error.
.SH ERRORS
.TP
-.IR ENOMEM
+.B ENOMEM
The process cannot allocate more memory.
.PP
The
diff --git a/doc/bus_open.3 b/doc/bus_open.3
index 0bedf00..9fd9df7 100644
--- a/doc/bus_open.3
+++ b/doc/bus_open.3
@@ -17,26 +17,26 @@ functions.
Values for \fIflags\fP are constructed by a bitwise inclusive OR of
flags from the following list.
.TP
-.IR BUS_RDONLY
+.B BUS_RDONLY
The process will only be using the bus for receiving messages.
.TP
-.IR BUS_WRONLY
+.B BUS_WRONLY
The process will only be using the bus for sending messages.
.TP
-.IR BUS_RDWR
+.B BUS_RDWR
The process will use the bus for both receiving and sending messages.
.SH RETURN VALUES
Upon successful completion the function returns 0. Otherwise the
function returns -1 and set \fIerrno\fP to indicate the error.
.SH ERRORS
.TP
-.IR ENOMEM
+.B ENOMEM
The process cannot allocate more memory.
.TP
-.IR EACCES
+.B EACCES
Operation permission is denied to the calling process.
.TP
-.IR EINVAL
+.B EINVAL
The described bus does not exist.
.PP
The
diff --git a/doc/bus_unlink.3 b/doc/bus_unlink.3
index 47b62d8..a5f4150 100644
--- a/doc/bus_unlink.3
+++ b/doc/bus_unlink.3
@@ -15,13 +15,13 @@ Upon successful completion, the function returns 0. Otherwise the
function returns -1 and sets \fIerrno\fP to indicate the error.
.SH ERRORS
.TP
-.IR EINVAL
+.B EINVAL
The bus does not exist.
.TP
-.IR EACCES
+.B EACCES
Operation permission is denied to the calling process.
.TP
-.IR EPERM
+.B EPERM
The user does not have permission to remove the bus.
.PP
The