diff options
| author | Sam Roberts <sam@strongloop.com> | 2014-10-27 11:03:13 -0700 |
|---|---|---|
| committer | Trevor Norris <trev.norris@gmail.com> | 2014-11-18 16:19:21 -0800 |
| commit | 13a992b1c2e1d0e69567fb94bc35f978c4c37ce5 (patch) | |
| tree | fb982ff13bbc4e549e2c008b8ef8e0ff29482131 | |
| parent | 5ff59453a483a43f1563504989f8e2d0ec253de1 (diff) | |
| download | node-13a992b1c2e1d0e69567fb94bc35f978c4c37ce5.tar.gz | |
doc: document the fds behind stdin/out/err
Its common knowledge on unix, but node documentation depends on knowing
this, as it exposes both streams named after stdio, and the fd numbers,
so make this explicit.
Fixes: https://github.com/joyent/node/pull/8624
PR-URL: https://github.com/joyent/node/pull/8454
Reviewed-by: Trevor Norris <trev.norris@gmail.com>
| -rw-r--r-- | doc/api/process.markdown | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/process.markdown b/doc/api/process.markdown index 04da4a6f8..663d9c159 100644 --- a/doc/api/process.markdown +++ b/doc/api/process.markdown @@ -116,7 +116,7 @@ emulation with `process.kill()`, and `child_process.kill()`: ## process.stdout -A `Writable Stream` to `stdout`. +A `Writable Stream` to `stdout` (on fd `1`). Example: the definition of `console.log` @@ -150,7 +150,7 @@ See [the tty docs](tty.html#tty_tty) for more information. ## process.stderr -A writable stream to stderr. +A writable stream to stderr (on fd `2`). `process.stderr` and `process.stdout` are unlike other streams in Node in that writes to them are usually blocking. @@ -164,7 +164,7 @@ that writes to them are usually blocking. ## process.stdin -A `Readable Stream` for stdin. +A `Readable Stream` for stdin (on fd `0`). Example of opening standard input and listening for both events: |