From 3b3a7a7ccb0736b8b89012d85f19ad7d1c1e1329 Mon Sep 17 00:00:00 2001 From: Brian White Date: Wed, 23 Jan 2019 11:48:49 -0500 Subject: [PATCH] readme: remove references to stderr for shell() --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b9d11ab0..2807bbbf 100644 --- a/README.md +++ b/README.md @@ -95,9 +95,7 @@ conn.on('ready', function() { console.log('Stream :: close'); conn.end(); }).on('data', function(data) { - console.log('STDOUT: ' + data); - }).stderr.on('data', function(data) { - console.log('STDERR: ' + data); + console.log('OUTPUT: ' + data); }); stream.end('ls -l\nexit\n'); }); @@ -982,12 +980,12 @@ This is a normal **streams2** Duplex Stream (used both by clients and servers), * If there was an `exit` event, the `close` event will be passed the same arguments for convenience. + * A `stderr` property contains a Readable stream that represents output from stderr. + * For shell() and exec(): * The readable side represents stdout and the writable side represents stdin. - * A `stderr` property contains a Readable stream that represents output from stderr. - * **signal**(< _string_ >signalName) - _boolean_ - Sends a POSIX signal to the current process on the server. Valid signal names are: 'ABRT', 'ALRM', 'FPE', 'HUP', 'ILL', 'INT', 'KILL', 'PIPE', 'QUIT', 'SEGV', 'TERM', 'USR1', and 'USR2'. Some server implementations may ignore this request if they do not support signals. Note: If you are trying to send SIGINT and you find `signal()` doesn't work, try writing `'\x03'` to the Channel stream instead. Returns `false` if you should wait for the `continue` event before sending any more traffic. * **setWindow**(< _integer_ >rows, < _integer_ >cols, < _integer_ >height, < _integer_ >width) - _boolean_ - Lets the server know that the local terminal window has been resized. The meaning of these arguments are described in the 'Pseudo-TTY settings' section. Returns `false` if you should wait for the `continue` event before sending any more traffic.