diff --git a/docs/README.md b/docs/README.md index 6d2ec76a73db..aaf27d6d95a9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,6 +3,7 @@ * [Quick start](tutorial/quick-start.md) * [Application distribution](tutorial/application-distribution.md) * [Use native node modules](tutorial/use-native-node-modules.md) +* [Debugging browser process](tutorial/debugging-browser-process.md) ## API references diff --git a/docs/tutorial/debugging-browser-process.md b/docs/tutorial/debugging-browser-process.md new file mode 100644 index 000000000000..0e4a3ebbf5f0 --- /dev/null +++ b/docs/tutorial/debugging-browser-process.md @@ -0,0 +1,15 @@ +# Debugging browser process + +The devtools of browser window can only debug the scripts of the web pages +(e.g. the renderer process), in order to provide a way to debug the scripts of +the browser side (e.g. the browser process), atom-shell has provided the +`--debug` and `--debug-brk` switches. + +## `--debug=[port]` + +When this switch is used atom-shell would listen for V8 debugger protocol on +`port`, the `port` is `5858` by default. + +## `debug-brk=[port]` + +Like `--debug` but pauses the script on the first line.