Browse Source

docs: Add Environment Variables

Cheng Zhao 9 years ago
parent
commit
6534a0e616
2 changed files with 33 additions and 0 deletions
  1. 1 0
      docs/README.md
  2. 32 0
      docs/api/environment-variables.md

+ 1 - 0
docs/README.md

@@ -30,6 +30,7 @@ select the tag that matches your version.
 * [Synopsis](api/synopsis.md)
 * [Process Object](api/process.md)
 * [Supported Chrome Command Line Switches](api/chrome-command-line-switches.md)
+* [Environment Variables](api/environment-variables.md)
 
 ### Custom DOM Elements:
 

+ 32 - 0
docs/api/environment-variables.md

@@ -0,0 +1,32 @@
+# Environment variables
+
+Some behaviors of Electron are controlled by environment variables, because they
+are initialized earlier than command line and the app's code.
+
+## `ELECTRON_RUN_AS_NODE`
+
+Starts the process as a normal Node.js process.
+
+## `ELECTRON_ENABLE_LOGGING`
+
+Prints Chrome's internal logging to console.
+
+## `ELECTRON_ENABLE_STACK_DUMPING`
+
+When Electron crashed, prints the stack trace to console.
+
+This environment variable will not work if `crashReporter` is started.
+
+## `ELECTRON_DEFAULT_ERROR_MODE` _Windows_
+
+Shows Windows's crash dialog when Electron crashed.
+
+This environment variable will not work if `crashReporter` is started.
+
+## `ELECTRON_FORCE_WINDOW_MENU_BAR` _Linux_
+
+Don't use global menu bar on Linux.
+
+## `ELECTRON_HIDE_INTERNAL_MODULES`
+
+Turns off compatibility mode for old built-in modules like `require('ipc')`.