From 90675818eede96a063489109f86022dd13ad75cb Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Tue, 24 May 2016 17:04:39 -0700 Subject: [PATCH] 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 Reviewed-By: James M Snell Reviewed-By: Myles Borins --- doc/api/cli.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 82 insertions(+), 1 deletion(-) diff --git a/doc/api/cli.md b/doc/api/cli.md index edb375b5258861..e40ddada742bbe 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -2,7 +2,7 @@ -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. To view this documentation as a manual page in your terminal, run `man node`. @@ -24,38 +24,59 @@ _For more info about `node debug`, please see the [debugger][] documentation._ ## Options ### `-v`, `--version` + Print node's version. ### `-h`, `--help` + Print node command line options. The output of this option is less detailed than this document. ### `-e`, `--eval "script"` + Evaluate the following argument as JavaScript. The modules which are predefined in the REPL can also be used in `script`. ### `-p`, `--print "script"` + Identical to `-e` but prints the result. ### `-c`, `--check` + Syntax check the script without executing. ### `-i`, `--interactive` + Opens the REPL even if stdin does not appear to be a terminal. ### `-r`, `--require module` + Preload the specified module at startup. @@ -64,40 +85,64 @@ rules. `module` may be either a path to a file, or a node module name. ### `--no-deprecation` + Silence deprecation warnings. ### `--trace-deprecation` + Print stack traces for deprecations. ### `--throw-deprecation` + Throw errors for deprecations. ### `--no-warnings` + Silence all process warnings (including deprecations). ### `--trace-warnings` + Print stack traces for process warnings (including deprecations). ### `--trace-sync-io` + Prints a stack trace whenever synchronous I/O is detected after the first turn of the event loop. ### `--zero-fill-buffers` + Automatically zero-fills all newly allocated [Buffer][] and [SlowBuffer][] instances. ### `--preserve-symlinks` + Instructs the module loader to preserve symbolic links when resolving and caching modules. @@ -135,16 +180,25 @@ see those as two separate modules and would attempt to load the module multiple times, causing an exception to be thrown). ### `--track-heap-objects` + Track heap object allocations for heap snapshots. ### `--prof-process` + Process v8 profiler output generated using the v8 option `--prof`. ### `--v8-options` + Print v8 command line options. @@ -154,35 +208,53 @@ Note: v8 options allow words to be separated by both dashes (`-`) or underscores For example, `--stack-trace-limit` is equivalent to `--stack_trace_limit`. ### `--tls-cipher-list=list` + Specify an alternative default TLS cipher list. (Requires Node.js to be built with crypto support. (Default)) ### `--enable-fips` + Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with `./configure --openssl-fips`) ### `--force-fips` + Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.) (Same requirements as `--enable-fips`) ### `--icu-data-dir=file` + Specify ICU data load path. (overrides `NODE_ICU_DATA`) ## Environment Variables ### `NODE_DEBUG=module[,…]` + `','`-separated list of core modules that should print debug information. ### `NODE_PATH=path[:…]` + `':'`-separated list of directories prefixed to the module search path. @@ -190,17 +262,26 @@ _Note: on Windows, this is a `';'`-separated list instead._ ### `NODE_DISABLE_COLORS=1` + When set to `1` colors will not be used in the REPL. ### `NODE_ICU_DATA=file` + Data path for ICU (Intl object) data. Will extend linked-in data when compiled with small-icu support. ### `NODE_REPL_HISTORY=file` + 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