diff options
| author | James M Snell <jasnell@gmail.com> | 2021-02-22 10:50:01 -0800 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2021-02-26 11:35:35 -0800 |
| commit | fc6d8f4b841bfca1b231b9975511ee54a91ef7fb (patch) | |
| tree | d2b2744b52d172d884bc7a59297be43f9294f24c /doc/node.1 | |
| parent | 5d240c5efc7c3064e01be18f1b8ca66f5afe811f (diff) | |
| download | node-new-fc6d8f4b841bfca1b231b9975511ee54a91ef7fb.tar.gz | |
doc: document the NO_COLOR and FORCE_COLOR env vars
Signed-off-by: James M Snell <jasnell@gmail.com>
Fixes: https://github.com/nodejs/node/issues/37404
PR-URL: https://github.com/nodejs/node/pull/37477
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/node.1')
| -rw-r--r-- | doc/node.1 | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/node.1 b/doc/node.1 index 6357413187..6b091f5a79 100644 --- a/doc/node.1 +++ b/doc/node.1 @@ -530,6 +530,26 @@ Print node's version. .\" ===================================================================== .Sh ENVIRONMENT .Bl -tag -width 6n +.It Ev FORCE_COLOR +Used to enable ANSI colorized output. The value may be one of: +.Ar 1 +, +.Ar true +, or +.Ar an empty string +to +indicate 16-color support, +.Ar 2 +to indicate 256-color support, or +.Ar 3 +to indicate 16 million-color support. When used and set to a supported +value, both the NO_COLOR and NODE_DISABLE_COLORS environment variables +are ignored. Any other value will result in colorized output being +disabled. +. +.It Ev NO_COLOR +Alias for NODE_DISABLE_COLORS +. .It Ev NODE_DEBUG Ar modules... Comma-separated list of core modules that should print debug information. . |