Skip to content

Commit f1984c7

Browse files
committed
doc: add missing CLI options to node manpage
1 parent d7e4108 commit f1984c7

File tree

1 file changed

+156
-0
lines changed

1 file changed

+156
-0
lines changed

doc/node.1

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,15 @@ Allow execution of WASI when using the permission model.
9797
.It Fl -allow-worker
9898
Allow creating worker threads when using the permission model.
9999
.
100+
101+
.It Fl -build-snapshot
102+
Generate a V8 startup snapshot during the build process.
103+
.
104+
105+
.It Fl -build-snapshot-config Ar file
106+
Specify a configuration file to customize snapshot generation.
107+
.
108+
100109
.It Fl -completion-bash
101110
Print source-able bash completion script for Node.js.
102111
.
@@ -129,6 +138,7 @@ The default is
129138
File name of the V8 CPU profile generated with
130139
.Fl -cpu-prof .
131140
.
141+
132142
.It Fl -diagnostic-dir
133143
Set the directory for all diagnostic output files.
134144
Default is current working directory.
@@ -140,6 +150,12 @@ Affects the default output directory of:
140150
.Fl -heap-prof-dir .
141151
.Fl -redirect-warnings .
142152
.
153+
154+
.It Fl -dns-result-order Ns = Ns Ar order
155+
Set the default value of dns.setDefaultResultOrder().
156+
Possible values are ipv4first, ipv6first, and verbatim.
157+
.
158+
143159
.It Fl -disable-proto Ns = Ns Ar mode
144160
Disable the `Object.prototype.__proto__` property. If
145161
.Ar mode
@@ -148,24 +164,79 @@ is `delete`, the property will be removed entirely. If
148164
is `throw`, accesses to the property will throw an exception with the code
149165
`ERR_PROTO_ACCESS`.
150166
.
167+
168+
.It Fl -disable-sigusr1
169+
Disable SIGUSR1 signal handling by Node.js.
170+
.
171+
172+
.It Fl -disable-warning
173+
Disable process warnings.
174+
.
175+
151176
.It Fl -disable-wasm-trap-handler Ns = Ns Ar mode
152177
Disable trap-handler-based WebAssembly bound checks and fall back to
153178
inline bound checks so that WebAssembly can be run with limited virtual
154179
memory.
155180
.
181+
156182
.It Fl -disallow-code-generation-from-strings
157183
Make built-in language features like `eval` and `new Function` that generate
158184
code from strings throw an exception instead. This does not affect the Node.js
159185
`vm` module.
160186
.
187+
188+
189+
190+
191+
161192
.It Fl -enable-fips
162193
Enable FIPS-compliant crypto at startup.
163194
Requires Node.js to be built with
164195
.Sy ./configure --openssl-fips .
165196
.
197+
198+
.It Fl -enable-network-family-autoselection
199+
Enable automatic network family selection when resolving DNS.
200+
.
201+
166202
.It Fl -enable-source-maps
167203
Enable Source Map V3 support for stack traces.
168204
.
205+
206+
.It Fl -env-file Ns = Ns Ar file
207+
Load environment variables from the specified file.
208+
.
209+
210+
.It Fl -env-file-if-exists Ns = Ns Ar file
211+
Load environment variables from the specified file if it exists.
212+
.
213+
214+
.It Fl -experimental-network-inspection
215+
Enable experimental network inspection support.
216+
.
217+
218+
.It Fl -experimental-print-required-tla
219+
Print required top-level await modules.
220+
.
221+
222+
.It Fl -experimental-require-module
223+
Enable experimental support for require() in ES modules.
224+
.
225+
226+
.It Fl -experimental-sea-config Ns = Ns Ar file
227+
Specify a configuration file for experimental Single Executable Applications (SEA).
228+
.
229+
230+
.It Fl -experimental-worker-inspection
231+
Enable experimental inspection support for worker threads.
232+
.
233+
234+
.It Fl -expose-gc
235+
Expose the gc() function to the global scope.
236+
.
237+
238+
239+
169240
.It Fl -entry-url
170241
Interpret the entry point as a URL.
171242
.
@@ -238,6 +309,13 @@ Enable experimental support for inspector network resources.
238309
.It Fl -force-context-aware
239310
Disable loading native addons that are not context-aware.
240311
.
312+
313+
.It Fl -force-node-api-uncaught-exceptions-policy
314+
Force the Node-API uncaught exceptions policy to be enabled.
315+
This ensures that uncaught exceptions originating from Node-API callbacks
316+
are handled according to the Node-API specification.
317+
.
318+
241319
.It Fl -force-fips
242320
Force FIPS-compliant crypto on startup
243321
(Cannot be disabled from script code).
@@ -287,6 +365,11 @@ Overrides
287365
.It Fl -input-type Ns = Ns Ar type
288366
Set the module resolution type for input via --eval, --print or STDIN.
289367
.
368+
.It Fl -import Ns = Ns Ar module
369+
Preload the specified ECMAScript module before running the entry point.
370+
.
371+
372+
290373
.It Fl -inspect-brk Ns = Ns Ar [host:]port
291374
Activate inspector on
292375
.Ar host:port
@@ -384,11 +467,45 @@ Silence all process warnings (including deprecations).
384467
Enable extra debug checks for memory leaks in Node.js internals. This is
385468
usually only useful for developers debugging Node.js itself.
386469
.
470+
471+
.It Fl -network-family-autoselection-attempt-timeout Ns = Ns Ar ms
472+
Set the timeout in milliseconds for network family auto-selection attempts.
473+
.
474+
475+
.It Fl -no-async-context-frame
476+
Disable async context propagation in stack traces.
477+
.
478+
479+
.It Fl -no-experimental-detect-module
480+
Disable experimental automatic module type detection.
481+
.
482+
483+
.It Fl -no-experimental-global-navigator
484+
Disable the experimental global navigator object.
485+
.
486+
487+
.It Fl -no-experimental-require-module
488+
Disable experimental support for require() in ES modules.
489+
.
490+
491+
.It Fl -no-network-family-autoselection
492+
Disable automatic network family selection.
493+
.
494+
387495
.It Fl -openssl-config Ns = Ns Ar file
388496
Load an OpenSSL configuration file on startup.
389497
Among other uses, this can be used to enable FIPS-compliant crypto if Node.js is built with
390498
.Sy ./configure --openssl-fips .
391499
.
500+
501+
.It Fl -openssl-legacy-provider
502+
Enable the OpenSSL legacy provider.
503+
.
504+
505+
.It Fl -openssl-shared-config
506+
Use the shared OpenSSL configuration.
507+
.
508+
392509
.It Fl -pending-deprecation
393510
Emit pending deprecation warnings.
394511
.
@@ -410,6 +527,18 @@ Write process warnings to the given
410527
.Ar file
411528
instead of printing to stderr.
412529
.
530+
.It Fl -report-exclude-env
531+
Exclude environment variables from diagnostic reports.
532+
.
533+
534+
.It Fl -report-exclude-network
535+
Exclude network information from diagnostic reports.
536+
.
537+
538+
.It Fl -run Ns = Ns Ar file
539+
Run the specified file as the entry point.
540+
.
541+
413542
.It Fl -report-compact
414543
Write
415544
.Sy diagnostic reports
@@ -454,6 +583,11 @@ Enables
454583
to be generated on un-caught exceptions. Useful when inspecting JavaScript
455584
stack in conjunction with native stack and other runtime environment data.
456585
.
586+
587+
.It Fl -snapshot-blob Ns = Ns Ar file
588+
Use the specified snapshot blob file.
589+
.
590+
457591
.It Fl -secure-heap Ns = Ns Ar n
458592
Specify the size of the OpenSSL secure heap. Any value less than 2 disables
459593
the secure heap. The default is 0. The value must be a power of two.
@@ -568,6 +702,23 @@ Print stack traces for deprecations.
568702
A comma-separated list of categories that should be traced when trace event tracing is enabled using
569703
.Fl -trace-events-enabled .
570704
.
705+
706+
.It Fl -trace-env
707+
Trace environment variable access.
708+
.
709+
710+
.It Fl -trace-env-js-stack
711+
Include JavaScript stack traces when tracing environment variables.
712+
.
713+
714+
.It Fl -trace-env-native-stack
715+
Include native stack traces when tracing environment variables.
716+
.
717+
718+
.It Fl -trace-require-module
719+
Trace module loading via require().
720+
.
721+
571722
.It Fl -trace-event-file-pattern Ar pattern
572723
Template string specifying the filepath for the trace event data, it
573724
supports
@@ -665,6 +816,11 @@ Starts Node.js in watch mode and specifies what paths to watch. When in watch mo
665816

666817
This will turn off watching of required or imported modules, even when used in combination with --watch.
667818
.
819+
820+
.It Fl -watch-preserve-output
821+
Preserve terminal output when restarting in watch mode.
822+
.
823+
668824
.It Fl -watch-kill-signal
669825
Customizes the signal sent to the process on watch mode restarts.
670826
.

0 commit comments

Comments
 (0)