Skip to content

Commit 80b062e

Browse files
doc: add missing CLI options to node.1 manpage
1 parent 7b483d3 commit 80b062e

1 file changed

Lines changed: 172 additions & 0 deletions

File tree

doc/node.1

Lines changed: 172 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -678,6 +678,178 @@ Customizes the signal sent to the process on watch mode restarts.
678678
.It Fl -zero-fill-buffers
679679
Automatically zero-fills all newly allocated Buffer instances.
680680
.
681+
682+
.It Fl -build-snapshot
683+
Generates a snapshot blob when the process exits and writes it to disk,
684+
which can be loaded later with
685+
.Fl -snapshot-blob .
686+
.
687+
.It Fl -build-snapshot-config Ns = Ns Ar config.json
688+
Specifies the path to a JSON configuration file which configures snapshot
689+
creation behavior.
690+
.
691+
.It Fl -disable-sigusr1
692+
Disable the ability of starting a debugging session by sending a
693+
.Sy SIGUSR1
694+
signal to the process.
695+
.
696+
.It Fl -disable-warning Ns = Ns Ar code-or-type
697+
Disable specific process warnings by
698+
.Ar code
699+
or
700+
.Ar type .
701+
.
702+
.It Fl -dns-result-order Ns = Ns Ar order
703+
Set the default value of
704+
.Ar order
705+
in
706+
.Fn dns.lookup
707+
and
708+
.Fn dnsPromises.lookup .
709+
The value could be:
710+
.Ar ipv4first ,
711+
.Ar ipv6first ,
712+
or
713+
.Ar verbatim .
714+
.
715+
.It Fl -enable-network-family-autoselection
716+
Enables the family autoselection algorithm unless connection options explicitly
717+
disables it.
718+
.
719+
.It Fl -env-file Ns = Ns Ar file
720+
Loads environment variables from a file relative to the current directory,
721+
making them available to applications on
722+
.Sy process.env .
723+
.
724+
.It Fl -env-file-if-exists Ns = Ns Ar file
725+
Behavior is the same as
726+
.Fl -env-file ,
727+
but an error is not thrown if the file does not exist.
728+
.
729+
.It Fl -experimental-network-inspection
730+
Enable experimental support for the network inspection with Chrome DevTools.
731+
.
732+
.It Fl -experimental-print-required-tla
733+
If the ES module being
734+
.Fn require() 'd
735+
contains top-level
736+
.Sy await ,
737+
this flag allows Node.js to evaluate the module and try to locate the
738+
top-level awaits.
739+
.
740+
.It Fl -experimental-require-module
741+
Enable experimental CommonJS module requiring of ES modules.
742+
.
743+
.It Fl -experimental-sea-config Ns = Ns Ar config.json
744+
Use this flag to generate a blob that can be injected into the Node.js binary
745+
to produce a single executable application.
746+
.
747+
.It Fl -experimental-worker-inspection
748+
Enable experimental support for the worker inspection with Chrome DevTools.
749+
.
750+
.It Fl -force-node-api-uncaught-exceptions-policy
751+
Enforces
752+
.Sy uncaughtException
753+
event on Node-API asynchronous callbacks.
754+
.
755+
.It Fl -import Ns = Ns Ar module
756+
Preload the specified module at startup.
757+
Follows ECMAScript module resolution rules.
758+
.
759+
.It Fl -network-family-autoselection-attempt-timeout Ns = Ns Ar milliseconds
760+
Sets the default value for the network family autoselection attempt timeout.
761+
.
762+
.It Fl -no-async-context-frame
763+
Disables the use of
764+
.Sy AsyncLocalStorage
765+
backed by
766+
.Sy AsyncContextFrame
767+
and uses the prior implementation which relied on
768+
.Sy async_hooks .
769+
.
770+
.It Fl -no-experimental-detect-module
771+
Disable using syntax detection to determine module type.
772+
.
773+
.It Fl -no-experimental-global-navigator
774+
Disable exposition of Navigator API on the global scope.
775+
.
776+
.It Fl -no-experimental-require-module
777+
Legacy alias for
778+
.Fl -no-require-module .
779+
.
780+
.It Fl -no-network-family-autoselection
781+
Disables the family autoselection algorithm unless connection options explicitly
782+
enables it.
783+
.
784+
.It Fl -openssl-legacy-provider
785+
Enable OpenSSL 3.0 legacy provider.
786+
.
787+
.It Fl -openssl-shared-config
788+
Enable OpenSSL default configuration section,
789+
.Sy openssl_conf
790+
to be read from the OpenSSL configuration file.
791+
.
792+
.It Fl -report-dir
793+
Location at which the diagnostic report will be generated.
794+
.
795+
.It Fl -report-directory
796+
Location at which the diagnostic report will be generated.
797+
.
798+
.It Fl -report-exclude-env
799+
When passed the diagnostic report generated will not contain the
800+
.Sy environmentVariables
801+
data.
802+
.
803+
.It Fl -report-exclude-network
804+
Exclude
805+
.Sy header.networkInterfaces
806+
from the diagnostic report.
807+
.
808+
.It Fl -run Ns = Ns Ar command
809+
This runs a specified command from a package.json's
810+
.Sy "scripts"
811+
object.
812+
.
813+
.It Fl -snapshot-blob Ns = Ns Ar file
814+
When used with
815+
.Fl -build-snapshot ,
816+
.Fl -snapshot-blob
817+
specifies the path where the generated snapshot blob is written to.
818+
When used without
819+
.Fl -build-snapshot ,
820+
.Fl -snapshot-blob
821+
specifies the path to the blob that is used to restore the application state.
822+
.
823+
.It Fl -trace-env
824+
Print information about any access to environment variables done in the
825+
current Node.js instance to stderr.
826+
.
827+
.It Fl -trace-env-js-stack
828+
In addition to what
829+
.Fl -trace-env
830+
does, this prints the JavaScript stack trace of the access.
831+
.
832+
.It Fl -trace-env-native-stack
833+
In addition to what
834+
.Fl -trace-env
835+
does, this prints the native stack trace of the access.
836+
.
837+
.It Fl -trace-require-module Ns = Ns Ar mode
838+
Prints information about usage of loading ECMAScript modules using
839+
.Fn require() .
840+
.
841+
.It Fl -use-system-ca
842+
Node.js uses the trusted CA certificates present in the system store along with
843+
the
844+
.Fl -use-bundled-ca
845+
option and the
846+
.Ev NODE_EXTRA_CA_CERTS
847+
environment variable.
848+
.
849+
.It Fl -watch-preserve-output
850+
Disable the clearing of the console when watch mode restarts the process.
851+
.
852+
681853
.It Fl c , Fl -check
682854
Check the script's syntax without executing it.
683855
Exits with an error code if script is invalid.

0 commit comments

Comments
 (0)