diff options
| author | Mattias Andrée <maandree@kth.se> | 2018-11-05 22:12:03 +0100 |
|---|---|---|
| committer | Mattias Andrée <maandree@kth.se> | 2018-11-05 22:12:03 +0100 |
| commit | 8f8fb5ef585236f968797ca4c71664199ae42e0e (patch) | |
| tree | ec81d296b6385d1f48d365a9ad1d0115f4dd5f19 | |
| parent | Add tests and small fixes (diff) | |
| download | libsimple-8f8fb5ef585236f968797ca4c71664199ae42e0e.tar.gz libsimple-8f8fb5ef585236f968797ca4c71664199ae42e0e.tar.bz2 libsimple-8f8fb5ef585236f968797ca4c71664199ae42e0e.tar.xz | |
Add man page for libsimple_close
Signed-off-by: Mattias Andrée <maandree@kth.se>
| -rw-r--r-- | man/libsimple_close.3 | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/man/libsimple_close.3 b/man/libsimple_close.3 new file mode 100644 index 0000000..d5e18c6 --- /dev/null +++ b/man/libsimple_close.3 @@ -0,0 +1,49 @@ +.TH LIBSIMPLE_CLOSE 3 2018-11-05 libsimple +.SH NAME +libsimple_close \- close file descriptor and mark it as closed +.SH SYNOPSIS +.nf +#include <libsimple.h> + +static inline int libsimple_close(int *\fIfdp\fP); +.fi +.PP +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_close () +function calls +.I close(*fdp) +and sets +.I *fdp +to +.IR \-1 . +However if +.IR *fdp<0 , +does not except return 0. +.SH RETURN VALUE +The +.BR libsimple_close () +function returns 0 upon successful completion; +otherwise \-1 is returned. +.SH ERRORS +The +.BR libsimple_close () +function fail for the reasons specified for the +.BR close (3) +function. +.SH EXAMPLES +None. +.SH APPLICATION USAGE +None. +.SH RATIONALE +None. +.SH FUTURE DIRECTIONS +None. +.SH NOTES +None. +.SH BUGS +None. +.SH SEE ALSO +.BR close (3) |