aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/bus_close.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/bus_close.3')
-rw-r--r--doc/man/bus_close.336
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/man/bus_close.3 b/doc/man/bus_close.3
new file mode 100644
index 0000000..734f18d
--- /dev/null
+++ b/doc/man/bus_close.3
@@ -0,0 +1,36 @@
+.TH BUS_CLOSE 3 BUS-%VERSION%
+.SH NAME
+bus_close - Close a bus
+.SH SYNOPSIS
+.LP
+.nf
+#include <bus.h>
+.P
+int bus_close(bus_t *\fIbus\fP);
+.fi
+.SH DESCRIPTION
+The
+.BR bus_close (3)
+function disposes of resources allocated to the process, as referenced
+in the \fIbus\fP argument.
+.SH RETURN VALUES
+Upon successful completion, the function returns 0. Otherwise the
+function returns -1 and sets \fIerrno\fP to indicate the error.
+.SH ERRORS
+.TP
+.B EINVAL
+The bus does not exist.
+.SH SEE ALSO
+.BR bus-create (1),
+.BR bus (5),
+.BR libbus (7),
+.BR bus_open (3),
+.BR bus_unlink (3)
+.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