diff options
Diffstat (limited to 'doc/bus_create.3')
| -rw-r--r-- | doc/bus_create.3 | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/bus_create.3 b/doc/bus_create.3 new file mode 100644 index 0000000..cfb7963 --- /dev/null +++ b/doc/bus_create.3 @@ -0,0 +1,26 @@ +.TH BUS_CREATE 1 BUS-%VERSION% +.SH NAME +bus_create - Create a new bus +.SH SYNOPSIS +#include <bus.h> + +int bus_create(const char *file, int flags, char **out_file); +.SH DESCRIPTION +The \fIbus_create\fP function shall create a bus with the asscoiated pathname specifed by the value of the parameter \fIfile\fP. If the \fIfile\iP is \fINULL\fP, a random pathname shall be selected. This random pathname must adhere to the convention set forth by bus(5). + +If \fIfile\fP is not \fINULL\fP, the \fIbus_create\fP function must fail if the file already exists if \fIflags\fP contains \fIBUS_EXCL\fP. Otherwise if \fIfile\fP is not \fINULL\fP, the \fIbus_create\fP function should do nothing if the file already exists. + +If and only if \fIflags\fP contains \fIBUS_INTR\fP, the function shall fail if it is interrupted. + +Unless \fIout_file\fP is \fINULL\P, the pathname of the bus should be stored in a new char array stored in \fI*out_file\fP. The caller must free the allocated stored in \fI*out_file\fP. +.SH RETURN VALUES +Upon successful completion, the function shall return 0. Otherwise the function shall return -1 and set \fIerrno\fP to indicate the error. +.SH SEE ALSO +bus-create(1), bus(5), libbus(7), bus_unlink(3), bus_open(3) +.SH AUTHORS +See the LICENSE file for the authors. +.SH LICENSE +See the LICENSE file for the terms of redistribution. +.SH BUGS +Please report them. + |