Standardize debug main process

This commit is contained in:
Jessica Lord 2015-08-31 19:12:57 -07:00
parent 96bb9b2757
commit 0e4ae6f864

View file

@ -1,25 +1,26 @@
# Debugging the main process
# Debugging the Main Process
The devtools of browser window can only debug the renderer process scripts.
(I.e. the web pages.) In order to provide a way to debug the scripts of
the main process, Electron has provided the `--debug` and `--debug-brk`
switches.
The browser window devtools can only debug the renderer process scripts (i.e.
the web pages). In order to provide a way to debug the scripts from the main
process, Electron has provided the `--debug` and `--debug-brk` switches.
## Command line switches
## Command Line Switches
Use the following command line switches to debug Electron's main process:
### `--debug=[port]`
When this switch is used Electron would listen for V8 debugger protocol
messages on `port`, the `port` is `5858` by default.
When this switch is used Electron will listen for V8 debugger protocol
messages on `port`. The default `port` is `5858`.
### `--debug-brk=[port]`
Like `--debug` but pauses the script on the first line.
## Use node-inspector for debugging
## Use node-inspector for Debugging
__Note:__ Electron uses node v0.11.13, which currently doesn't work very well
with node-inspector, and the main process would crash if you inspect the
with node-inspector, and the main process will crash if you inspect the
`process` object under node-inspector's console.
### 1. Start the [node-inspector][node-inspector] server