Fix #7065: cli help documentation for --inspect

Adding documentation to node.1 and cli.md PR-URL: #11660 Reviewed-By: Eugene Ostroukhov <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
nodejs · Mar 21, 2017 · 0c00b65 · 0c00b65
1 parent 60ad7af
commit 0c00b65
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -94,6 +94,26 @@ Follows `require()`'s module resolution
 rules. `module` may be either a path to a file, or a node module name.
 
 
+### `--inspect[=host:port]`
+<!-- YAML
+added: v6.3.0
+-->
+
+Activate inspector on host:port. Default is 127.0.0.1:9229.
+
+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 Debugging Protocol][].
+
+
+### `--inspect-brk[=host:port]`
+<!-- YAML
+added: v7.6.0
+-->
+
+Activate inspector on host:port and break at start of user script.
+
+
 ### `--no-deprecation`
 <!-- YAML
 added: v0.8.0
@@ -425,6 +445,7 @@ OpenSSL, it may cause them to trust the same CAs as node.
 
 [emit_warning]: process.html#process_process_emitwarning_warning_name_ctor
 [Buffer]: buffer.html#buffer_buffer
+[Chrome Debugging Protocol]: https://chromedevtools.github.io/debugger-protocol-viewer
 [debugger]: debugger.html
 [REPL]: repl.html
 [SlowBuffer]: buffer.html#buffer_class_slowbuffer

diff --git a/doc/node.1 b/doc/node.1
@@ -92,6 +92,17 @@ Open the REPL even if stdin does not appear to be a terminal.
 Preload the specified module at startup. Follows `require()`'s module resolution
 rules. \fImodule\fR may be either a path to a file, or a node module name.
 
+.TP
+.BR \-\-inspect \fI[=host:port]\fR
+Activate inspector on host:port. Default is 127.0.0.1:9229.
+
+V8 Inspector integration allows attaching Chrome DevTools and IDEs to Node.js
+instances for debugging and profiling. It uses the Chrome Debugging Protocol.
+
+.TP
+.BR \-\-inspect-brk \fI[=host:port]\fR
+Activate inspector on host:port and break at start of user script.
+
 .TP
 .BR \-\-no\-deprecation
 Silence deprecation warnings.