From 8da3b51472edbb8f9cbd330509d1be5848bbbf0c Mon Sep 17 00:00:00 2001 From: Tim Ermilov Date: Mon, 9 Oct 2017 13:10:54 -0400 Subject: [PATCH] doc: document windows shell support explain that Git Bash and Cygwin require winpty to work correctly. Added info on Git Bash running winpty automatically when running node without .exe extension. PR-URL: https://github.com/nodejs/node/pull/16104 Fixes: https://github.com/nodejs/node/issues/14100 Reviewed-By: Vse Mozhet Byt Reviewed-By: Gibson Fahnestock Reviewed-By: Refael Ackermann Reviewed-By: Gireesh Punathil --- BUILDING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/BUILDING.md b/BUILDING.md index 4de36f5a398d32..5095a036c05f73 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -60,6 +60,12 @@ note1 - The gcc4.8-libs package needs to be installed, because node by Joyent. SmartOS images >= 16.4 are not supported because GCC 4.8 runtime libraries are not available in their pkgsrc repository +*Note*: On Windows, running Node.js in windows terminal emulators like `mintty` + requires the usage of [winpty](https://github.com/rprichard/winpty) for + Node's tty channels to work correctly (e.g. `winpty node.exe script.js`). + In "Git bash" if you call the node shell alias (`node` without the `.exe` + extension), `winpty` is used automatically. + ### Supported toolchains Depending on host platform, the selection of toolchains may vary.