Skip to content

Commit 641ba5e

Browse files
yamalightrefack
authored andcommitted
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: #16104 Fixes: #14100 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Gireesh Punathil <[email protected]>
1 parent a36aa04 commit 641ba5e

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

BUILDING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,12 @@ note1 - The gcc4.8-libs package needs to be installed, because node
5959
by Joyent. SmartOS images >= 16.4 are not supported because
6060
GCC 4.8 runtime libraries are not available in their pkgsrc repository
6161

62+
*Note*: On Windows, running Node.js in windows terminal emulators like `mintty`
63+
requires the usage of [winpty](https://github.com/rprichard/winpty) for
64+
Node's tty channels to work correctly (e.g. `winpty node.exe script.js`).
65+
In "Git bash" if you call the node shell alias (`node` without the `.exe`
66+
extension), `winpty` is used automatically.
67+
6268
### Supported toolchains
6369

6470
Depending on host platform, the selection of toolchains may vary.

0 commit comments

Comments
 (0)