doc: link system and library calls to man pages
PR-URL: https://github.com/libuv/libuv/pull/236 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
This commit is contained in:
Saúl Ibarra Corretgé
parent
5ba687f422
commit
3b0998c935
@ -59,7 +59,7 @@ API
|
||||
|
||||
.. c:function:: int uv_getaddrinfo(uv_loop_t* loop, uv_getaddrinfo_t* req, uv_getaddrinfo_cb getaddrinfo_cb, const char* node, const char* service, const struct addrinfo* hints)
|
||||
|
||||
Asynchronous ``getaddrinfo(3)``.
|
||||
Asynchronous :man:`getaddrinfo(3)`.
|
||||
|
||||
Either node or service may be NULL but not both.
|
||||
|
||||
@ -84,7 +84,7 @@ API
|
||||
|
||||
.. c:function:: int uv_getnameinfo(uv_loop_t* loop, uv_getnameinfo_t* req, uv_getnameinfo_cb getnameinfo_cb, const struct sockaddr* addr, int flags)
|
||||
|
||||
Asynchronous ``getnameinfo(3)``.
|
||||
Asynchronous :man:`getnameinfo(3)`.
|
||||
|
||||
Returns 0 on success or an error code < 0 on failure. If successful, the
|
||||
callback will get called sometime in the future with the lookup result.
|
||||
|
||||
@ -162,46 +162,46 @@ API
|
||||
|
||||
.. c:function:: int uv_fs_close(uv_loop_t* loop, uv_fs_t* req, uv_file file, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``close(2)``.
|
||||
Equivalent to :man:`close(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_open(uv_loop_t* loop, uv_fs_t* req, const char* path, int flags, int mode, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``open(2)``.
|
||||
Equivalent to :man:`open(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_read(uv_loop_t* loop, uv_fs_t* req, uv_file file, const uv_buf_t bufs[], unsigned int nbufs, int64_t offset, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``preadv(2)``.
|
||||
Equivalent to :man:`preadv(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_unlink(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``unlink(2)``.
|
||||
Equivalent to :man:`unlink(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_write(uv_loop_t* loop, uv_fs_t* req, uv_file file, const uv_buf_t bufs[], unsigned int nbufs, int64_t offset, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``pwritev(2)``.
|
||||
Equivalent to :man:`pwritev(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_mkdir(uv_loop_t* loop, uv_fs_t* req, const char* path, int mode, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``mkdir(2)``.
|
||||
Equivalent to :man:`mkdir(2)`.
|
||||
|
||||
.. note::
|
||||
`mode` is currently not implemented on Windows.
|
||||
|
||||
.. c:function:: int uv_fs_mkdtemp(uv_loop_t* loop, uv_fs_t* req, const char* tpl, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``mkdtemp(3)``.
|
||||
Equivalent to :man:`mkdtemp(3)`.
|
||||
|
||||
.. note::
|
||||
The result can be found as a null terminated string at `req->path`.
|
||||
|
||||
.. c:function:: int uv_fs_rmdir(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``rmdir(2)``.
|
||||
Equivalent to :man:`rmdir(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_scandir(uv_loop_t* loop, uv_fs_t* req, const char* path, int flags, uv_fs_cb cb)
|
||||
.. c:function:: int uv_fs_scandir_next(uv_fs_t* req, uv_dirent_t* ent)
|
||||
|
||||
Equivalent to ``scandir(3)``, with a slightly different API. Once the callback
|
||||
Equivalent to :man:`scandir(3)`, with a slightly different API. Once the callback
|
||||
for the request is called, the user can use :c:func:`uv_fs_scandir_next` to
|
||||
get `ent` populated with the next directory entry data. When there are no
|
||||
more entries ``UV_EOF`` will be returned.
|
||||
@ -210,49 +210,49 @@ API
|
||||
.. c:function:: int uv_fs_fstat(uv_loop_t* loop, uv_fs_t* req, uv_file file, uv_fs_cb cb)
|
||||
.. c:function:: int uv_fs_lstat(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``(f/l)stat(2)``.
|
||||
Equivalent to :man:`stat(2)`, :man:`fstat(2)` and :man:`fstat(2)` respectively.
|
||||
|
||||
.. c:function:: int uv_fs_rename(uv_loop_t* loop, uv_fs_t* req, const char* path, const char* new_path, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``rename(2)``.
|
||||
Equivalent to :man:`rename(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_fsync(uv_loop_t* loop, uv_fs_t* req, uv_file file, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``fsync(2)``.
|
||||
Equivalent to :man:`fsync(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_fdatasync(uv_loop_t* loop, uv_fs_t* req, uv_file file, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``fdatasync(2)``.
|
||||
Equivalent to :man:`fdatasync(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_ftruncate(uv_loop_t* loop, uv_fs_t* req, uv_file file, int64_t offset, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``ftruncate(2)``.
|
||||
Equivalent to :man:`ftruncate(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_sendfile(uv_loop_t* loop, uv_fs_t* req, uv_file out_fd, uv_file in_fd, int64_t in_offset, size_t length, uv_fs_cb cb)
|
||||
|
||||
Limited equivalent to ``sendfile(2)``.
|
||||
Limited equivalent to :man:`sendfile(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_access(uv_loop_t* loop, uv_fs_t* req, const char* path, int mode, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``access(2)`` on Unix. Windows uses ``GetFileAttributesW()``.
|
||||
Equivalent to :man:`access(2)` on Unix. Windows uses ``GetFileAttributesW()``.
|
||||
|
||||
.. c:function:: int uv_fs_chmod(uv_loop_t* loop, uv_fs_t* req, const char* path, int mode, uv_fs_cb cb)
|
||||
.. c:function:: int uv_fs_fchmod(uv_loop_t* loop, uv_fs_t* req, uv_file file, int mode, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``(f)chmod(2)``.
|
||||
Equivalent to :man:`chmod(2)` and :man:`fchmod(2)` respectively.
|
||||
|
||||
.. c:function:: int uv_fs_utime(uv_loop_t* loop, uv_fs_t* req, const char* path, double atime, double mtime, uv_fs_cb cb)
|
||||
.. c:function:: int uv_fs_futime(uv_loop_t* loop, uv_fs_t* req, uv_file file, double atime, double mtime, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``(f)utime(s)(2)``.
|
||||
Equivalent to :man:`utime(2)` and :man:`futime(2)` respectively.
|
||||
|
||||
.. c:function:: int uv_fs_link(uv_loop_t* loop, uv_fs_t* req, const char* path, const char* new_path, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``link(2)``.
|
||||
Equivalent to :man:`link(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_symlink(uv_loop_t* loop, uv_fs_t* req, const char* path, const char* new_path, int flags, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``symlink(2)``.
|
||||
Equivalent to :man:`symlink(2)`.
|
||||
|
||||
.. note::
|
||||
On Windows the `flags` parameter can be specified to control how the symlink will
|
||||
@ -265,12 +265,12 @@ API
|
||||
|
||||
.. c:function:: int uv_fs_readlink(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``readlink(2)``.
|
||||
Equivalent to :man:`readlink(2)`.
|
||||
|
||||
.. c:function:: int uv_fs_chown(uv_loop_t* loop, uv_fs_t* req, const char* path, uv_uid_t uid, uv_gid_t gid, uv_fs_cb cb)
|
||||
.. c:function:: int uv_fs_fchown(uv_loop_t* loop, uv_fs_t* req, uv_file file, uv_uid_t uid, uv_gid_t gid, uv_fs_cb cb)
|
||||
|
||||
Equivalent to ``(f)chown(2)``.
|
||||
Equivalent to :man:`chown(2)` and :man:`fchown(2)` respectively.
|
||||
|
||||
.. note::
|
||||
These functions are not implemented on Windows.
|
||||
|
||||
@ -101,7 +101,8 @@ API
|
||||
descriptor. Usually this will be used during initialization to guess the
|
||||
type of the stdio streams.
|
||||
|
||||
For ``isatty()`` functionality use this function and test for ``UV_TTY``.
|
||||
For :man:`isatty(3)` equivalent functionality use this function and test
|
||||
for ``UV_TTY``.
|
||||
|
||||
.. c:function:: unsigned int uv_version(void)
|
||||
|
||||
@ -195,8 +196,8 @@ API
|
||||
.. c:function:: int uv_inet_ntop(int af, const void* src, char* dst, size_t size)
|
||||
.. c:function:: int uv_inet_pton(int af, const char* src, void* dst)
|
||||
|
||||
Cross-platform IPv6-capable implementation of the 'standard' ``inet_ntop()``
|
||||
and ``inet_pton()`` functions. On success they return 0. In case of error
|
||||
Cross-platform IPv6-capable implementation of :man:`inet_ntop(3)`
|
||||
and :man:`inet_pton(3)`. On success they return 0. In case of error
|
||||
the target `dst` pointer is unmodified.
|
||||
|
||||
.. c:function:: int uv_exepath(char* buffer, size_t* size)
|
||||
|
||||
@ -5,7 +5,7 @@
|
||||
===================================
|
||||
|
||||
Poll handles are used to watch file descriptors for readability and
|
||||
writability, similar to the purpose of poll(2).
|
||||
writability, similar to the purpose of :man:`poll(2)`.
|
||||
|
||||
The purpose of poll handles is to enable integrating external libraries that
|
||||
rely on the event loop to signal it about the socket status changes, like
|
||||
@ -29,7 +29,7 @@ closed immediately after a call to :c:func:`uv_poll_stop` or :c:func:`uv_close`.
|
||||
|
||||
.. note::
|
||||
On windows only sockets can be polled with poll handles. On Unix any file
|
||||
descriptor that would be accepted by poll(2) can be used.
|
||||
descriptor that would be accepted by :man:`poll(2)` can be used.
|
||||
|
||||
|
||||
Data types
|
||||
|
||||
@ -104,7 +104,7 @@ API
|
||||
.. c:function:: int uv_listen(uv_stream_t* stream, int backlog, uv_connection_cb cb)
|
||||
|
||||
Start listening for incoming connections. `backlog` indicates the number of
|
||||
connections the kernel might queue, same as ``listen(2)``. When a new
|
||||
connections the kernel might queue, same as :man:`listen(2)`. When a new
|
||||
incoming connection is received the :c:type:`uv_connection_cb` callback is
|
||||
called.
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user