xref: /netbsd-src/external/mit/libuv/dist/docs/src/index.rst (revision 5f2f42719cd62ff11fd913b40b7ce19f07c4fd25)
10e552da7Schristos
20e552da7SchristosWelcome to the libuv documentation
30e552da7Schristos==================================
40e552da7Schristos
50e552da7SchristosOverview
60e552da7Schristos--------
70e552da7Schristos
80e552da7Schristoslibuv is a multi-platform support library with a focus on asynchronous I/O. It
90e552da7Schristoswas primarily developed for use by `Node.js`_, but it's also used by `Luvit`_,
10*5f2f4271Schristos`Julia`_, `uvloop`_, and `others`_.
110e552da7Schristos
120e552da7Schristos.. note::
130e552da7Schristos    In case you find errors in this documentation you can help by sending
140e552da7Schristos    `pull requests <https://github.com/libuv/libuv>`_!
150e552da7Schristos
160e552da7Schristos.. _Node.js: https://nodejs.org
170e552da7Schristos.. _Luvit: https://luvit.io
180e552da7Schristos.. _Julia: https://julialang.org
19*5f2f4271Schristos.. _uvloop: https://github.com/MagicStack/uvloop
20*5f2f4271Schristos.. _others: https://github.com/libuv/libuv/blob/v1.x/LINKS.md
210e552da7Schristos
220e552da7Schristos
230e552da7SchristosFeatures
240e552da7Schristos--------
250e552da7Schristos
260e552da7Schristos* Full-featured event loop backed by epoll, kqueue, IOCP, event ports.
270e552da7Schristos* Asynchronous TCP and UDP sockets
280e552da7Schristos* Asynchronous DNS resolution
290e552da7Schristos* Asynchronous file and file system operations
300e552da7Schristos* File system events
310e552da7Schristos* ANSI escape code controlled TTY
320e552da7Schristos* IPC with socket sharing, using Unix domain sockets or named pipes (Windows)
330e552da7Schristos* Child processes
340e552da7Schristos* Thread pool
350e552da7Schristos* Signal handling
360e552da7Schristos* High resolution clock
370e552da7Schristos* Threading and synchronization primitives
380e552da7Schristos
390e552da7Schristos
400e552da7SchristosDocumentation
410e552da7Schristos-------------
420e552da7Schristos
430e552da7Schristos.. toctree::
440e552da7Schristos   :maxdepth: 1
450e552da7Schristos
460e552da7Schristos   design
470e552da7Schristos   api
480e552da7Schristos   guide
490e552da7Schristos   upgrading
500e552da7Schristos
510e552da7Schristos
520e552da7SchristosDownloads
530e552da7Schristos---------
540e552da7Schristos
550e552da7Schristoslibuv can be downloaded from `here <https://dist.libuv.org/dist/>`_.
560e552da7Schristos
570e552da7Schristos
580e552da7SchristosInstallation
590e552da7Schristos------------
600e552da7Schristos
610e552da7SchristosInstallation instructions can be found in `the README <https://github.com/libuv/libuv/blob/master/README.md>`_.
620e552da7Schristos
63