diff options
author | Mattias Andrée <maandree@operamail.com> | 2015-05-01 14:19:46 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@operamail.com> | 2015-05-01 14:19:57 +0200 |
commit | 87b5e28fb0bfcfa67f82c994e86b4f0fbf7e9868 (patch) | |
tree | 5c9ffc1b4cff1f8598d308ebfa05012643a9fdd5 /doc | |
parent | add todos for timed operations (diff) | |
download | bus-87b5e28fb0bfcfa67f82c994e86b4f0fbf7e9868.tar.gz bus-87b5e28fb0bfcfa67f82c994e86b4f0fbf7e9868.tar.bz2 bus-87b5e28fb0bfcfa67f82c994e86b4f0fbf7e9868.tar.xz |
fix manpages + add manpages for bus_chown and bus_chmod
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/bus_chmod.3 | 50 | ||||
-rw-r--r-- | doc/bus_chown.3 | 38 | ||||
-rw-r--r-- | doc/bus_close.3 | 2 | ||||
-rw-r--r-- | doc/bus_create.3 | 2 | ||||
-rw-r--r-- | doc/bus_open.3 | 2 | ||||
-rw-r--r-- | doc/bus_read.3 | 2 | ||||
-rw-r--r-- | doc/bus_unlink.3 | 2 | ||||
-rw-r--r-- | doc/bus_write.3 | 7 | ||||
-rw-r--r-- | doc/libbus.7 | 2 |
9 files changed, 98 insertions, 9 deletions
diff --git a/doc/bus_chmod.3 b/doc/bus_chmod.3 new file mode 100644 index 0000000..c61fcd3 --- /dev/null +++ b/doc/bus_chmod.3 @@ -0,0 +1,50 @@ +.TH BUS_CHMOD 3 BUS-%VERSION% +.SH NAME +bus_chmod - Change bus mode bits +.SH SYNOPSIS +#include <bus.h> + +int bus_chmod(const char *file, mode_t mode); +.SH DESCRIPTION +The \fIbus_chmod()\fP function shall give access to the bus associated +with \fIfile\fP according to the following rules: +.TP +* +If (\fImode\fP &S_IRWXU) the owner should be given full access to +the bus. Otherwise the owner should have no access. +.TP +* +If (\fImode\fP &S_IRWXG) the group should be given read and write +access to the bus. Otherwise the group should have no access. +.TP +* +If (\fImode\fP &S_IRWXO) others (except the group) should be given +read and write access to the bus. Otherwise others should have no +access. +.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 +The +.BR bus_chown(3) +function may fail and set \fIerrno\fP to any of the +errors specified for +.BR bus_open(3), +.BR chmod(3), +.BR semget(3), +.BR shmget(3) +and +.BR shmctl(3) +as well as any errors specified for the \fIIPC_STAT\fP and +\fIIPC_SET\fP commands for +.BR semctl(3). +.SH SEE ALSO +bus-create(1), bus(5), libbus(7), bus_open(3), bus_read(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 diff --git a/doc/bus_chown.3 b/doc/bus_chown.3 new file mode 100644 index 0000000..7bfe60a --- /dev/null +++ b/doc/bus_chown.3 @@ -0,0 +1,38 @@ +.TH BUS_CHOWN 3 BUS-%VERSION% +.SH NAME +bus_chown - Change bus owner and group +.SH SYNOPSIS +#include <bus.h> + +int bus_chown(const char *file, uid_t owner, gid_t group); +.SH DESCRIPTION +The \fIbus_chown()\fP function shall change the owner and the group of +the bus associated with \fIfile\fP to the \fIowner\fP and \fIgroup\fP, +respectively. +.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 +The +.BR bus_chown(3) +function may fail and set \fIerrno\fP to any of the +errors specified for +.BR bus_open(3), +.BR chown(3), +.BR semget(3), +.BR shmget(3) +and +.BR shmctl(3) +as well as any errors specified for the \fIIPC_STAT\fP and +\fIIPC_SET\fP commands for +.BR semctl(3). +.SH SEE ALSO +bus-create(1), bus(5), libbus(7), bus_open(3), bus_read(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 diff --git a/doc/bus_close.3 b/doc/bus_close.3 index 0eb7849..41e2a97 100644 --- a/doc/bus_close.3 +++ b/doc/bus_close.3 @@ -1,4 +1,4 @@ -.TH BUS_CLOSE 1 BUS-%VERSION% +.TH BUS_CLOSE 3 BUS-%VERSION% .SH NAME bus_close - Close a bus .SH SYNOPSIS diff --git a/doc/bus_create.3 b/doc/bus_create.3 index 2644e3a..d18f3c0 100644 --- a/doc/bus_create.3 +++ b/doc/bus_create.3 @@ -1,4 +1,4 @@ -.TH BUS_CREATE 1 BUS-%VERSION% +.TH BUS_CREATE 3 BUS-%VERSION% .SH NAME bus_create - Create a new bus .SH SYNOPSIS diff --git a/doc/bus_open.3 b/doc/bus_open.3 index c0d78d7..34ffb5f 100644 --- a/doc/bus_open.3 +++ b/doc/bus_open.3 @@ -1,4 +1,4 @@ -.TH BUS_OPEN 1 BUS-%VERSION% +.TH BUS_OPEN 3 BUS-%VERSION% .SH NAME bus_open - Open a bus .SH SYNOPSIS diff --git a/doc/bus_read.3 b/doc/bus_read.3 index e09fe8b..7ad0189 100644 --- a/doc/bus_read.3 +++ b/doc/bus_read.3 @@ -1,4 +1,4 @@ -.TH BUS_CLOSE 1 BUS-%VERSION% +.TH BUS_READ 3 BUS-%VERSION% .SH NAME bus_read - Listen for new messages a bus .SH SYNOPSIS diff --git a/doc/bus_unlink.3 b/doc/bus_unlink.3 index cada819..625b308 100644 --- a/doc/bus_unlink.3 +++ b/doc/bus_unlink.3 @@ -1,4 +1,4 @@ -.TH BUS_UNLINK 1 BUS-%VERSION% +.TH BUS_UNLINK 3 BUS-%VERSION% .SH NAME bus_unlink - Remove a bus .SH SYNOPSIS diff --git a/doc/bus_write.3 b/doc/bus_write.3 index fd758be..8fbecbf 100644 --- a/doc/bus_write.3 +++ b/doc/bus_write.3 @@ -1,4 +1,4 @@ -.TH BUS_CLOSE 1 BUS-%VERSION% +.TH BUS_WRITE 3 BUS-%VERSION% .SH NAME bus_write - Broadcast a message a bus .SH SYNOPSIS @@ -19,12 +19,13 @@ Upon successful completion, the function returns 0. Otherwise the function returns -1 and sets \fIerrno\fP to indicate the error. .SH ERRORS The -.BR bus_read(3) +.BR bus_write(3) function may fail and set \fIerrno\fP to any of the errors specified for .BR semop(3). .SH SEE ALSO -bus-create(1), bus(5), libbus(7), bus_open(3), bus_read(3) +bus-create(1), bus(5), libbus(7), bus_open(3), bus_read(3), +bus_chown(3), bus_chmod(3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. diff --git a/doc/libbus.7 b/doc/libbus.7 index 4b0ead4..73c289e 100644 --- a/doc/libbus.7 +++ b/doc/libbus.7 @@ -14,7 +14,7 @@ Private and abstract buses might be interesting. Timed out read and writes might be too. .SH SEE ALSO bus(1), bus(5), bus_create(3), bus_unlink(3), bus_open(3), bus_close(3), -bus_read(3), bus_write(3) +bus_read(3), bus_write(3), bus_chown(3), bus_chmod(3) .SH AUTHORS Principal author, Mattias Andrée. See the LICENSE file for the full list of authors. |