Commit 8da3b51
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 <vsemozhetbyt@gmail.com>
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>1 parent 3f56ac4 commit 8da3b51
1 file changed
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -60,6 +60,12 @@ note1 - The gcc4.8-libs package needs to be installed, because node | |||
| 60 | 60 | by Joyent. SmartOS images >= 16.4 are not supported because | |
| 61 | 61 | GCC 4.8 runtime libraries are not available in their pkgsrc repository | |
| 62 | 62 | ||
| 63 | + *Note*: On Windows, running Node.js in windows terminal emulators like `mintty` | ||
| 64 | + requires the usage of [winpty](https://github.com/rprichard/winpty) for | ||
| 65 | + Node's tty channels to work correctly (e.g. `winpty node.exe script.js`). | ||
| 66 | + In "Git bash" if you call the node shell alias (`node` without the `.exe` | ||
| 67 | + extension), `winpty` is used automatically. | ||
| 68 | + | ||
| 63 | 69 | ### Supported toolchains | |
| 64 | 70 | ||
| 65 | 71 | Depending on host platform, the selection of toolchains may vary. | |
0 commit comments