Skip to content

Commit

Permalink
doc: fix linter warnings and typos in manpage
Browse files Browse the repository at this point in the history
Refs: #19911

PR-URL: #20741
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
Alhadis authored and MylesBorins committed May 22, 2018
1 parent 8781bcb commit 657f8cb
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions doc/node.1
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
.Op Ar options
.Op Ar v8-options
.Op Fl e Ar string | Ar script.js | Fl
.Op Fl \-
.Op Fl -
.Op Ar arguments ...
.
.Nm node
Expand All @@ -61,11 +61,11 @@ without arguments to start a REPL.
.
.Sh OPTIONS
.Bl -tag -width 6n
.It Sy \-
.It Sy -
Alias for stdin, analogous to the use of - in other command-line utilities.
The executed script is read from stdin, and remaining arguments are passed to the script.
.
.It Fl \-
.It Fl -
Indicate the end of node options.
Pass the rest of the arguments to the script.
.Pp
Expand All @@ -80,15 +80,15 @@ Enable FIPS-compliant crypto at startup.
Requires Node.js to be built with
.Sy ./configure --openssl-fips .
.
.It Fl \-experimental-modules
.It Fl -experimental-modules
Enable experimental ES module support and caching modules.
.
.It Fl \-experimental-repl-await
.It Fl -experimental-repl-await
Enable experimental top-level
.Sy await
keyword support in REPL.
.
.It Fl \-experimental-vm-modules
.It Fl -experimental-vm-modules
Enable experimental ES module support in VM module.
.
.It Fl -force-fips
Expand Down Expand Up @@ -122,7 +122,8 @@ V8 Inspector integration allows attaching Chrome DevTools and IDEs to Node.js in
It uses the Chrome DevTools Protocol.
.
.It Fl -napi-modules
This option is a no-op. It is kept for compatibility.
This option is a no-op.
It is kept for compatibility.
.
.It Fl -no-deprecation
Silence deprecation warnings.
Expand All @@ -145,7 +146,7 @@ Emit pending deprecation warnings.
.It Fl -preserve-symlinks
Instructs the module loader to preserve symbolic links when resolving and caching modules other than the main module.
.
.It F1 -preserve-symlinks-main
.It Fl -preserve-symlinks-main
Instructs the module loader to preserve symbolic links when resolving and caching the main module.
.
.It Fl -prof-process
Expand Down Expand Up @@ -173,7 +174,10 @@ A comma-separated list of categories that should be traced when trace event trac
.
.It Fl -trace-event-file-pattern Ar pattern
Template string specifying the filepath for the trace event data, it
supports \fB${rotation}\fR and \fB${pid}\fR.
supports
.Sy ${rotation}
and
.Sy ${pid} .
.
.It Fl -trace-events-enabled
Enable the collection of trace event tracing information.
Expand All @@ -187,7 +191,7 @@ Print stack traces for process warnings (including deprecations).
.It Fl -track-heap-objects
Track heap object allocations for heap snapshots.
.
.It Fl -use-bundled\-ca, Fl -use-openssl-ca
.It Fl -use-bundled-ca , Fl -use-openssl-ca
Use bundled Mozilla CA store as supplied by current Node.js version or use OpenSSL's default CA store.
The default store is selectable at build-time.
.Pp
Expand All @@ -206,7 +210,10 @@ and
.It Fl -v8-options
Print V8 command-line options.
.Pp
Note: V8 options allow words to be separated by both dashes (\fB-\fR) or underscores (\fB_\fR).
Note: V8 options allow words to be separated by both dashes
.Sy ( - )
or underscores
.Sy ( _ ) .
.Pp
For example,
.Fl -stack-trace-limit
Expand Down

0 comments on commit 657f8cb

Please sign in to comment.