Browse Source

doc: add `added: ` data for cli.md

PR-URL: https://github.com/nodejs/node/pull/6960
Refs: https://github.com/nodejs/node/issues/6578
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Myles Borins <myles.borins@gmail.com>
v4.x
Rich Trott 9 years ago
committed by Myles Borins
parent
commit
eb08c17a20
  1. 68
      doc/api/cli.md

68
doc/api/cli.md

@ -2,7 +2,7 @@
<!--type=misc--> <!--type=misc-->
Node.js comes with a wide variety of CLI options. These options expose built-in Node.js comes with a variety of CLI options. These options expose built-in
debugging, multiple ways to execute scripts, and other helpful runtime options. debugging, multiple ways to execute scripts, and other helpful runtime options.
To view this documentation as a manual page in your terminal, run `man node`. To view this documentation as a manual page in your terminal, run `man node`.
@ -24,37 +24,58 @@ _For more info about `node debug`, please see the [debugger][] documentation._
## Options ## Options
### `-v`, `--version` ### `-v`, `--version`
<!-- YAML
added: v0.1.3
-->
Print node's version. Print node's version.
### `-h`, `--help` ### `-h`, `--help`
<!-- YAML
added: v0.1.3
-->
Print node command line options. Print node command line options.
The output of this option is less detailed than this document. The output of this option is less detailed than this document.
### `-e`, `--eval "script"` ### `-e`, `--eval "script"`
<!-- YAML
added: v0.5.2
-->
Evaluate the following argument as JavaScript. Evaluate the following argument as JavaScript.
### `-p`, `--print "script"` ### `-p`, `--print "script"`
<!-- YAML
added: v0.6.4
-->
Identical to `-e` but prints the result. Identical to `-e` but prints the result.
### `-c`, `--check` ### `-c`, `--check`
<!-- YAML
added: v4.2.0
-->
Syntax check the script without executing. Syntax check the script without executing.
### `-i`, `--interactive` ### `-i`, `--interactive`
<!-- YAML
added: v0.7.7
-->
Opens the REPL even if stdin does not appear to be a terminal. Opens the REPL even if stdin does not appear to be a terminal.
### `-r`, `--require module` ### `-r`, `--require module`
<!-- YAML
added: v1.6.0
-->
Preload the specified module at startup. Preload the specified module at startup.
@ -63,48 +84,75 @@ rules. `module` may be either a path to a file, or a node module name.
### `--no-deprecation` ### `--no-deprecation`
<!-- YAML
added: v0.8.0
-->
Silence deprecation warnings. Silence deprecation warnings.
### `--trace-deprecation` ### `--trace-deprecation`
<!-- YAML
added: v0.8.0
-->
Print stack traces for deprecations. Print stack traces for deprecations.
### `--throw-deprecation` ### `--throw-deprecation`
<!-- YAML
added: v0.11.14
-->
Throw errors for deprecations. Throw errors for deprecations.
### `--trace-sync-io` ### `--trace-sync-io`
<!-- YAML
added: v2.1.0
-->
Prints a stack trace whenever synchronous I/O is detected after the first turn Prints a stack trace whenever synchronous I/O is detected after the first turn
of the event loop. of the event loop.
### `--zero-fill-buffers` ### `--zero-fill-buffers`
<!-- YAML
added: v4.5.0
-->
Automatically zero-fills all newly allocated [Buffer][] and [SlowBuffer][] Automatically zero-fills all newly allocated [Buffer][] and [SlowBuffer][]
instances. instances.
### `--track-heap-objects` ### `--track-heap-objects`
<!-- YAML
added: v2.4.0
-->
Track heap object allocations for heap snapshots. Track heap object allocations for heap snapshots.
### `--prof-process` ### `--prof-process`
<!-- YAML
added: v4.4.0
-->
Process v8 profiler output generated using the v8 option `--prof`. Process v8 profiler output generated using the v8 option `--prof`.
### `--v8-options` ### `--v8-options`
<!-- YAML
added: v0.1.3
-->
Print v8 command line options. Print v8 command line options.
### `--tls-cipher-list=list` ### `--tls-cipher-list=list`
<!-- YAML
added: v4.0.0
-->
Specify an alternative default TLS cipher list. (Requires Node.js to be built Specify an alternative default TLS cipher list. (Requires Node.js to be built
with crypto support. (Default)) with crypto support. (Default))
@ -123,6 +171,9 @@ Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)
### `--icu-data-dir=file` ### `--icu-data-dir=file`
<!-- YAML
added: v0.11.15
-->
Specify ICU data load path. (overrides `NODE_ICU_DATA`) Specify ICU data load path. (overrides `NODE_ICU_DATA`)
@ -130,11 +181,17 @@ Specify ICU data load path. (overrides `NODE_ICU_DATA`)
## Environment Variables ## Environment Variables
### `NODE_DEBUG=module[,…]` ### `NODE_DEBUG=module[,…]`
<!-- YAML
added: v0.1.32
-->
`','`-separated list of core modules that should print debug information. `','`-separated list of core modules that should print debug information.
### `NODE_PATH=path[:…]` ### `NODE_PATH=path[:…]`
<!-- YAML
added: v0.1.32
-->
`':'`-separated list of directories prefixed to the module search path. `':'`-separated list of directories prefixed to the module search path.
@ -142,17 +199,26 @@ _Note: on Windows, this is a `';'`-separated list instead._
### `NODE_DISABLE_COLORS=1` ### `NODE_DISABLE_COLORS=1`
<!-- YAML
added: v0.3.0
-->
When set to `1` colors will not be used in the REPL. When set to `1` colors will not be used in the REPL.
### `NODE_ICU_DATA=file` ### `NODE_ICU_DATA=file`
<!-- YAML
added: v0.11.15
-->
Data path for ICU (Intl object) data. Will extend linked-in data when compiled Data path for ICU (Intl object) data. Will extend linked-in data when compiled
with small-icu support. with small-icu support.
### `NODE_REPL_HISTORY=file` ### `NODE_REPL_HISTORY=file`
<!-- YAML
added: v3.0.0
-->
Path to the file used to store the persistent REPL history. The default path is Path to the file used to store the persistent REPL history. The default path is
`~/.node_repl_history`, which is overridden by this variable. Setting the value `~/.node_repl_history`, which is overridden by this variable. Setting the value

Loading…
Cancel
Save