aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/bus_open.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/bus_open.3')
-rw-r--r--doc/man/bus_open.367
1 files changed, 0 insertions, 67 deletions
diff --git a/doc/man/bus_open.3 b/doc/man/bus_open.3
deleted file mode 100644
index 683ae9b..0000000
--- a/doc/man/bus_open.3
+++ /dev/null
@@ -1,67 +0,0 @@
-.TH BUS_OPEN 3 BUS-%VERSION%
-.SH NAME
-bus_open - Open a bus
-.SH SYNOPSIS
-.LP
-.nf
-#include <bus.h>
-.P
-int bus_open(bus_t *\fIbus\fP, const char *\fIfile\fP, int \fIflags\fP);
-.fi
-.SH DESCRIPTION
-The
-.BR bus_open ()
-function acquires resources required for the process to use the bus
-associated with the filename stored in \fIfile\fP. The function also
-stores the resources in \fIbus\fP for use by other
-.BR bus
-functions.
-.PP
-Values for \fIflags\fP are constructed by a bitwise inclusive OR of
-flags from the following list.
-.TP
-.B BUS_RDONLY
-The process will only be using the bus for receiving messages.
-.TP
-.B BUS_WRONLY
-The process will only be using the bus for sending messages.
-.TP
-.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
-.B ENOMEM
-The process cannot allocate more memory.
-.TP
-.B EACCES
-Operation permission is denied to the calling process.
-.TP
-.B EINVAL
-The described bus does not exist.
-.PP
-The
-.BR bus_open ()
-function may also fail and set \fIerrno\fP to any of the errors
-specified for the routine
-.BR open (2).
-.SH SEE ALSO
-.BR bus-create (1),
-.BR bus (5),
-.BR libbus (7),
-.BR bus_close (3),
-.BR bus_unlink (3),
-.BR bus_write (3),
-.BR bus_read (3),
-.BR bus_poll (3),
-.BR open (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