diff options
| author | Joachim Nilsson <troglobit@gmail.com> | 2015-04-26 15:06:15 +0200 |
|---|---|---|
| committer | Joachim Nilsson <troglobit@gmail.com> | 2015-04-26 22:08:33 +0200 |
| commit | 3dc3dd161837b314b24e8a9a00718bc1f33aa436 (patch) | |
| tree | 3bfc53624f6dc78343ed27c64a1d25a258898c1e /doc/bus_write.3 | |
| parent | fix doc (diff) | |
| download | bus-3dc3dd161837b314b24e8a9a00718bc1f33aa436.tar.gz bus-3dc3dd161837b314b24e8a9a00718bc1f33aa436.tar.bz2 bus-3dc3dd161837b314b24e8a9a00718bc1f33aa436.tar.xz | |
Spell checking and cleanup.
- Fix minor spelling errors.
- Replace empty lines with .PP (new paragraph)
- Replace some underlines with .BR func(section)
- Rephrase from spec. language to standard man page anguage.
- Reflow too long and too short lines to standard < 72 chars.
Signed-off-by: Joachim Nilsson <troglobit@gmail.com>
Diffstat (limited to 'doc/bus_write.3')
| -rw-r--r-- | doc/bus_write.3 | 24 |
1 files changed, 16 insertions, 8 deletions
diff --git a/doc/bus_write.3 b/doc/bus_write.3 index 643b3fe..d4329cc 100644 --- a/doc/bus_write.3 +++ b/doc/bus_write.3 @@ -6,17 +6,25 @@ bus_write - Broadcast a message a bus int bus_write(const bus_t *bus, const char *message); .SH DESCRIPTION -The \fIbus_write\fP function shall broadcast a message on the bus whose information is stored in \fIbus\fP. The message read by the function is stored in the parameter \fImessage\fIP. It may not exceeed 2048 bytes including NUL-termiantion. +The \fIbus_write()\fP function broadcasts a message on the bus whose +information is stored in \fIbus\fP. The message read by the function is +stored in the parameter \fImessage\fP. It may not exceeed 2048 bytes, +including NUL termination. .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. +Upon successful completion, the function returns 0. Otherwise the +function returns -1 and sets \fIerrno\fP to indicate the error. .SH ERRORS -The \fIbus_read\fP() function may fail and set \fIerrno\fP to any of the errors specified for the rutine semop(3). +The +.BR bus_read(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_raed(3) +bus-create(1), bus(5), libbus(7), bus_open(3), bus_read(3) .SH AUTHORS -See the LICENSE file for the authors. +Principal author, Mattias Andrée. See the LICENSE file for the full +list of authors. .SH LICENSE -See the LICENSE file for the terms of redistribution. +MIT/X Consortium License. .SH BUGS -Please report them. - +Please report bugs to https://github.com/maandree/bus/issues |