You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

224 lines
5.3 KiB

.TH NODE 1 2016 Node.js Node.js
.\" This is a man page comment.
.\" Man page syntax (actually roff syntax) is somewhat obscure, but the
.\" important part is is that .<letter> specifies <letter>'s syntax for that
.\" line, and \f<letter> specifies it for the characters that follow.
.\" .B Bold line
.\" .I Italic line (Rendered as underlined text in terminals)
.\" .BI Alternating bold/italics without spaces between arguments.
.\" Use `\ ` to include an "unpaddable" (literal) space in the output.
.\" .RI Alternating roman/italic
.\" See http://liw.fi/manpages/ for an overview, or http://www.troff.org/54.pdf
.\" for detailed language reference.
.\" Macro to display an underlined URL in bold
.de ur
.nr CF \\n(.f
.ft 4
\\$1
.ft \\n(CF
..
.SH NAME
node \- Server-side JavaScript runtime
.SH SYNOPSIS
.B node
.RI [ options ]
.RI [ v8\ options ]
.RI [ script.js \ |
.B -e
.RI \&" script \&"]
.RI [ arguments ]
.br
.B node debug
.RI [ script.js " | "
.B \-e
.RI \&" script \&"\ |
.IR <host>:<port> ]
.I ...
.br
.B node
.RB [ \-\-v8-options ]
Execute without arguments to start the REPL.
.SH DESCRIPTION
Node.js is a set of libraries for JavaScript which allows it to be used outside
of the browser. It is primarily focused on creating simple, easy to build
network clients and servers.
.SH OPTIONS
.TP
.BR \-v ", " \-\-version
Print node's version.
.TP
.BR \-h ", " \-\-help
Print node command line options.
The output of this option is less detailed than this document.
.TP
.BR \-e ", " \-\-eval " " \fR"\fIscript\fR"
Evaluate the following argument as JavaScript.
.TP
.BR \-p ", " \-\-print " " \fR"\fIscript\fR"
Identical to \fB-e\fR but prints the result.
.TP
.BR \-c ", " \-\-check
Syntax check the script without executing.
.TP
.BR \-i ", " \-\-interactive
Open the REPL even if stdin does not appear to be a terminal.
.TP
.BR \-r ", " \-\-require " " \fImodule\fR
Preload the specified module at startup. Follows `require()`'s module resolution
rules. \fImodule\fR may be either a path to a file, or a node module name.
.TP
.BR \-\-no\-deprecation
Silence deprecation warnings.
.TP
.BR \-\-trace\-deprecation
Print stack traces for deprecations.
.TP
.BR \-\-throw\-deprecation
Throw errors for deprecations.
process: add &#39;warning&#39; event and process.emitWarning() In several places throughout the code we write directly to stderr to report warnings (deprecation, possible eventemitter memory leak). The current design of simply dumping the text to stderr is less than ideal. This PR introduces a new &#34;process warnings&#34; mechanism that emits &#39;warning&#39; events on the global process object. These are invoked with a `warning` argument whose value is an Error object. By default, these warnings will be printed to stderr. This can be suppressed using the `--no-warnings` and `--no-deprecation` command line flags. For warnings, the &#39;warning&#39; event will still be emitted by the process, allowing applications to handle the warnings in custom ways. The existing `--no-deprecation` flag will continue to supress all deprecation output generated by the core lib. The `--trace-warnings` command line flag will tell Node.js to print the full stack trace of warnings as part of the default handling. The existing `--no-deprecation`, `--throw-deprecation` and `--trace-deprecation` flags continue to work as they currently do, but the exact output of the warning message is modified to occur on process.nextTick(). The stack trace for the warnings and deprecations preserve and point to the correct call site. A new `process.emitWarning()` API is provided to permit userland to emit warnings and deprecations using the same consistent mechanism. Test cases and documentation are included. PR-URL: https://github.com/nodejs/node/pull/4782 Reviewed-By: Rod Vagg &lt;rod@vagg.org&gt; Reviewed-By: Wyatt Preul &lt;wpreul@gmail.com&gt; Reviewed-By: Jeremiah Senkpiel &lt;fishrock123@rocketmail.com&gt;
9 years ago
.TP
.BR \-\-no\-warnings
Silence all process warnings (including deprecations).
.TP
.BR \-\-trace\-warnings
Print stack traces for process warnings (including deprecations).
.TP
.BR \-\-trace\-sync\-io
Print a stack trace whenever synchronous I/O is detected after the first turn
of the event loop.
.TP
.BR \-\-zero\-fill\-buffers
Automatically zero-fills all newly allocated Buffer and SlowBuffer instances.
.TP
.BR \-\-preserve\-symlinks
Instructs the module loader to preserve symbolic links when resolving and
caching modules.
.TP
.BR \-\-track\-heap-objects
Track heap object allocations for heap snapshots.
.TP
.BR \-\-prof\-process
Process v8 profiler output generated using the v8 option \fB\-\-prof\fR
.TP
.BR \-\-v8\-options
Print v8 command line options.
Note: v8 options allow words to be separated by both dashes (\fB-\fR) or
underscores (\fB_\fR).
For example, \fB\-\-stack\-trace\-limit\fR is equivalent to
\fB\-\-stack\_trace\_limit\fR
.TP
.BR \-\-v8\-pool\-size =\fInum\fR
Set v8's thread pool size which will be used to allocate background jobs.
If set to 0 then v8 will choose an appropriate size of the thread pool based
on the number of online processors. If the value provided is larger than v8's
max then the largest value will be chosen.
.TP
.BR \-\-tls\-cipher\-list =\fIlist\fR
Specify an alternative default TLS cipher list. (Requires Node.js to be built
with crypto support. (Default))
.TP
.BR \-\-enable\-fips
Enable FIPS-compliant crypto at startup. (Requires Node.js to be built with
\fB./configure \-\-openssl\-fips\fR)
.TP
.BR \-\-force\-fips
Force FIPS-compliant crypto on startup. (Cannot be disabled from script code.)
(Same requirements as \fB\-\-enable\-fips\fR)
.TP
.BR \-\-icu\-data\-dir =\fIfile\fR
Specify ICU data load path. (overrides \fBNODE_ICU_DATA\fR)
.SH ENVIRONMENT VARIABLES
.TP
.BR NODE_DEBUG =\fImodule\fR[,\fI...\fR]
\',\'\-separated list of core modules that should print debug information.
.TP
.BR NODE_PATH =\fIpath\fR[:\fI...\fR]
\':\'\-separated list of directories prefixed to the module search path.
.TP
.BR NODE_DISABLE_COLORS=1
When set to 1 colors will not be used in the REPL.
.TP
.BR NODE_ICU_DATA =\fIfile\fR
Data path for ICU (Intl object) data. Will extend linked-in data when compiled
with small\-icu support.
.TP
.BR NODE_REPL_HISTORY =\fIfile\fR
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 to an empty string ("" or " ") disables persistent REPL history.
.TP
.BR NODE_TTY_UNSAFE_ASYNC=1
When set to 1, writes to stdout and stderr will be non-blocking and asynchronous
when outputting to a TTY on platforms which support async stdio.
Setting this will void any guarantee that stdio will not be interleaved or
dropped at program exit. \fBAvoid use.\fR
.SH RESOURCES AND DOCUMENTATION
Website:
.ur https://nodejs.org/
Documentation:
.ur https://nodejs.org/api/
GitHub repository & Issue Tracker:
.ur https://github.com/nodejs/node
Mailing list:
.ur http://groups.google.com/group/nodejs
IRC (general questions):
.ur "chat.freenode.net #node.js"
IRC (node core development):
.ur "chat.freenode.net #node-dev"