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_unlink.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_unlink.3')
| -rw-r--r-- | doc/bus_unlink.3 | 33 |
1 files changed, 22 insertions, 11 deletions
diff --git a/doc/bus_unlink.3 b/doc/bus_unlink.3 index 7044922..47b62d8 100644 --- a/doc/bus_unlink.3 +++ b/doc/bus_unlink.3 @@ -6,9 +6,13 @@ bus_unlink - Remove a bus int bus_unlink(const char *file); .SH DESCRIPTION -The \fIbus_unlink\fP function shall remove the bus assoicated with the pathname stored in \fIfile\fP. The \fIbus_unlink\fP function shall also unlink the file. +The +.BR bus_unlink(3) +function removes the bus assoicated with the pathname stored in +\fIfile\fP. The function also unlinks the file. .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 .TP .IR EINVAL @@ -19,16 +23,23 @@ Operation permission is denied to the calling process. .TP .IR EPERM The user does not have permission to remove the bus. -.SH -.BR -The \fIbus_unlink\fP() function may also fail and set \fIerrno\fP to any of the errors specified for the rutines unlink(2), open(2), semget(3) and shmget(3). -.BR +.PP +The +.BR bus_unlink(3) +function may also fail and set \fIerrno\fP to any of the errors +specified for the routines +.BR unlink(2), +.BR open(2), +.BR semget(3) +and +.BR shmget(3). .SH SEE ALSO -bus-create(1), bus(5), libbus(7), bus_create(3), bus_close(3) +bus-create(1), bus(5), libbus(7), bus_create(3), bus_close(3), +unlink(2), open(2), semget(3) and shmget(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 |