diff options
Diffstat (limited to 'doc/api/cli.md')
| -rw-r--r-- | doc/api/cli.md | 54 |
1 files changed, 30 insertions, 24 deletions
diff --git a/doc/api/cli.md b/doc/api/cli.md index 2314886f79a..48bfd090f65 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -136,7 +136,7 @@ Specify the directory where the CPU profiles generated by `--cpu-prof` will be placed. The default value is controlled by the -[--diagnostic-dir](#cli_diagnostic_dir_directory) command-line option. +[`--diagnostic-dir`][] command-line option. ### `--cpu-prof-interval` <!-- YAML @@ -163,9 +163,9 @@ Set the directory to which all diagnostic output files are written. Defaults to current working directory. Affects the default output directory of: -* [--cpu-prof-dir](#cli_cpu_prof_dir) -* [--heap-prof-dir](#cli_heap_prof_dir) -* [--redirect-warnings](#cli_redirect_warnings_file) +* [`--cpu-prof-dir`][] +* [`--heap-prof-dir`][] +* [`--redirect-warnings`][] ### `--disable-proto=mode` <!-- YAML @@ -458,7 +458,7 @@ Specify the directory where the heap profiles generated by `--heap-prof` will be placed. The default value is controlled by the -[--diagnostic-dir](#cli_diagnostic_dir_directory) command-line option. +[`--diagnostic-dir`][] command-line option. ### `--heap-prof-interval` <!-- YAML @@ -514,7 +514,7 @@ Useful when activating the inspector by sending the `SIGUSR1` signal. Default host is `127.0.0.1`. -See the [security warning](#inspector_security) below regarding the `host` +See the [security warning][] below regarding the `host` parameter usage. ### `--inspect[=[host:]port]` @@ -528,6 +528,7 @@ V8 inspector integration allows tools such as Chrome DevTools and IDEs to debug and profile Node.js instances. The tools attach to Node.js instances via a tcp port and communicate using the [Chrome DevTools Protocol][]. +<!-- Anchor to make sure old links find a target --> <a id="inspector_security"></a> #### Warning: binding inspector to a public IP:port combination is insecure @@ -750,7 +751,7 @@ warning will be written to stderr instead. The `file` name may be an absolute path. If it is not, the default directory it will be written to is controlled by the -[--diagnostic-dir](#cli_diagnostic_dir_directory) command-line option. +[`--diagnostic-dir`]() command-line option. ### `--report-compact` <!-- YAML @@ -1767,35 +1768,40 @@ $ node --max-old-space-size=1536 index.js ``` [Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/ -[ECMAScript Module loader]: esm.md#esm_loaders +[ECMAScript Module loader]: esm.md#loaders [REPL]: repl.md [ScriptCoverage]: https://chromedevtools.github.io/devtools-protocol/tot/Profiler#type-ScriptCoverage [Source Map]: https://sourcemaps.info/spec.html [Subresource Integrity]: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity [V8 JavaScript code coverage]: https://v8project.blogspot.com/2017/12/javascript-code-coverage.html -[`--openssl-config`]: #cli_openssl_config_file +[`--cpu-prof-dir`]: #--cpu-prof-dir +[`--diagnostic-dir`]: #--diagnostic-dirdirectory +[`--heap-prof-dir`]: #--heap-prof-dir +[`--openssl-config`]: #--openssl-configfile +[`--redirect-warnings`]: #--redirect-warningsfile [`Atomics.wait()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Atomics/wait -[`Buffer`]: buffer.md#buffer_class_buffer +[`Buffer`]: buffer.md#class-buffer [`CRYPTO_secure_malloc_init`]: https://www.openssl.org/docs/man1.1.0/man3/CRYPTO_secure_malloc_init.html -[`NODE_OPTIONS`]: #cli_node_options_options +[`NODE_OPTIONS`]: #node_optionsoptions [`NO_COLOR`]: https://no-color.org -[`SlowBuffer`]: buffer.md#buffer_class_slowbuffer -[`dns.lookup()`]: dns.md#dns_dns_lookup_hostname_options_callback -[`dns.setDefaultResultOrder()`]: dns.md#dns_dns_setdefaultresultorder_order -[`dnsPromises.lookup()`]: dns.md#dns_dnspromises_lookup_hostname_options -[`process.setUncaughtExceptionCaptureCallback()`]: process.md#process_process_setuncaughtexceptioncapturecallback_fn -[`tls.DEFAULT_MAX_VERSION`]: tls.md#tls_tls_default_max_version -[`tls.DEFAULT_MIN_VERSION`]: tls.md#tls_tls_default_min_version -[`unhandledRejection`]: process.md#process_event_unhandledrejection -[`worker_threads.threadId`]: worker_threads.md#worker_threads_worker_threadid -[conditional exports]: packages.md#packages_conditional_exports -[context-aware]: addons.md#addons_context_aware_addons -[customizing ESM specifier resolution]: esm.md#esm_customizing_esm_specifier_resolution_algorithm +[`SlowBuffer`]: buffer.md#class-slowbuffer +[`dns.lookup()`]: dns.md#dnslookuphostname-options-callback +[`dns.setDefaultResultOrder()`]: dns.md#dnssetdefaultresultorderorder +[`dnsPromises.lookup()`]: dns.md#dnspromiseslookuphostname-options +[`process.setUncaughtExceptionCaptureCallback()`]: process.md#processsetuncaughtexceptioncapturecallbackfn +[`tls.DEFAULT_MAX_VERSION`]: tls.md#tlsdefault_max_version +[`tls.DEFAULT_MIN_VERSION`]: tls.md#tlsdefault_min_version +[`unhandledRejection`]: process.md#event-unhandledrejection +[`worker_threads.threadId`]: worker_threads.md#workerthreadid +[conditional exports]: packages.md#conditional-exports +[context-aware]: addons.md#context-aware-addons +[customizing ESM specifier resolution]: esm.md#customizing-esm-specifier-resolution-algorithm [debugger]: debugger.md [debugging security implications]: https://nodejs.org/en/docs/guides/debugging-getting-started/#security-implications -[emit_warning]: process.md#process_process_emitwarning_warning_type_code_ctor +[emit_warning]: process.md#processemitwarningwarning-options [jitless]: https://v8.dev/blog/jitless [libuv threadpool documentation]: https://docs.libuv.org/en/latest/threadpool.html [remote code execution]: https://www.owasp.org/index.php/Code_Injection +[security warning]: #warning-binding-inspector-to-a-public-ipport-combination-is-insecure [timezone IDs]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones [ways that `TZ` is handled in other environments]: https://www.gnu.org/software/libc/manual/html_node/TZ-Variable.html |