Skip to content

Commit 657f8cb

Browse files
AlhadisMylesBorins
authored andcommitted
doc: fix linter warnings and typos in manpage
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>
1 parent 8781bcb commit 657f8cb

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

doc/node.1

+18-11
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
.Op Ar options
4040
.Op Ar v8-options
4141
.Op Fl e Ar string | Ar script.js | Fl
42-
.Op Fl \-
42+
.Op Fl -
4343
.Op Ar arguments ...
4444
.
4545
.Nm node
@@ -61,11 +61,11 @@ without arguments to start a REPL.
6161
.
6262
.Sh OPTIONS
6363
.Bl -tag -width 6n
64-
.It Sy \-
64+
.It Sy -
6565
Alias for stdin, analogous to the use of - in other command-line utilities.
6666
The executed script is read from stdin, and remaining arguments are passed to the script.
6767
.
68-
.It Fl \-
68+
.It Fl -
6969
Indicate the end of node options.
7070
Pass the rest of the arguments to the script.
7171
.Pp
@@ -80,15 +80,15 @@ Enable FIPS-compliant crypto at startup.
8080
Requires Node.js to be built with
8181
.Sy ./configure --openssl-fips .
8282
.
83-
.It Fl \-experimental-modules
83+
.It Fl -experimental-modules
8484
Enable experimental ES module support and caching modules.
8585
.
86-
.It Fl \-experimental-repl-await
86+
.It Fl -experimental-repl-await
8787
Enable experimental top-level
8888
.Sy await
8989
keyword support in REPL.
9090
.
91-
.It Fl \-experimental-vm-modules
91+
.It Fl -experimental-vm-modules
9292
Enable experimental ES module support in VM module.
9393
.
9494
.It Fl -force-fips
@@ -122,7 +122,8 @@ V8 Inspector integration allows attaching Chrome DevTools and IDEs to Node.js in
122122
It uses the Chrome DevTools Protocol.
123123
.
124124
.It Fl -napi-modules
125-
This option is a no-op. It is kept for compatibility.
125+
This option is a no-op.
126+
It is kept for compatibility.
126127
.
127128
.It Fl -no-deprecation
128129
Silence deprecation warnings.
@@ -145,7 +146,7 @@ Emit pending deprecation warnings.
145146
.It Fl -preserve-symlinks
146147
Instructs the module loader to preserve symbolic links when resolving and caching modules other than the main module.
147148
.
148-
.It F1 -preserve-symlinks-main
149+
.It Fl -preserve-symlinks-main
149150
Instructs the module loader to preserve symbolic links when resolving and caching the main module.
150151
.
151152
.It Fl -prof-process
@@ -173,7 +174,10 @@ A comma-separated list of categories that should be traced when trace event trac
173174
.
174175
.It Fl -trace-event-file-pattern Ar pattern
175176
Template string specifying the filepath for the trace event data, it
176-
supports \fB${rotation}\fR and \fB${pid}\fR.
177+
supports
178+
.Sy ${rotation}
179+
and
180+
.Sy ${pid} .
177181
.
178182
.It Fl -trace-events-enabled
179183
Enable the collection of trace event tracing information.
@@ -187,7 +191,7 @@ Print stack traces for process warnings (including deprecations).
187191
.It Fl -track-heap-objects
188192
Track heap object allocations for heap snapshots.
189193
.
190-
.It Fl -use-bundled\-ca, Fl -use-openssl-ca
194+
.It Fl -use-bundled-ca , Fl -use-openssl-ca
191195
Use bundled Mozilla CA store as supplied by current Node.js version or use OpenSSL's default CA store.
192196
The default store is selectable at build-time.
193197
.Pp
@@ -206,7 +210,10 @@ and
206210
.It Fl -v8-options
207211
Print V8 command-line options.
208212
.Pp
209-
Note: V8 options allow words to be separated by both dashes (\fB-\fR) or underscores (\fB_\fR).
213+
Note: V8 options allow words to be separated by both dashes
214+
.Sy ( - )
215+
or underscores
216+
.Sy ( _ ) .
210217
.Pp
211218
For example,
212219
.Fl -stack-trace-limit

0 commit comments

Comments
 (0)