diff options
Diffstat (limited to 'doc/Flags.md')
| -rw-r--r-- | doc/Flags.md | 103 |
1 files changed, 60 insertions, 43 deletions
diff --git a/doc/Flags.md b/doc/Flags.md index 2299e9e..9bc156d 100644 --- a/doc/Flags.md +++ b/doc/Flags.md @@ -1,7 +1,6 @@ -Flags -===== +# Flags -#### <code>--allow-hosts <var>ALLOW_HOSTS</var>...</code> +## <code>--allow-hosts <var>ALLOW_HOSTS</var>...</code> Values of the `Host` header to allow for incoming requests. @@ -12,7 +11,7 @@ with `Host` set to `geckodriver.test` or `webdriver.local`. Requests with `Host` set to an IP address are always allowed. -#### <code>--allow-origins <var>ALLOW_ORIGINS</var>...</code> +## <code>--allow-origins <var>ALLOW_ORIGINS</var>...</code> Values of the `Origin` header to allow for incoming requests. @@ -27,7 +26,7 @@ origin will be able to make requests to geckodriver. For example service on the origin with scheme `https`, hostname `webdriver.test`, and port `8080` to access the geckodriver instance. -#### <code>--android-storage <var>ANDROID_STORAGE</var></code> +## <code>--android-storage <var>ANDROID_STORAGE</var></code> **Deprecation warning**: This argument is deprecated and planned to be removed with the 0.31.0 release of geckodriver. As such it shouldn't be used with version @@ -77,7 +76,7 @@ By default `auto` is used. </table> -#### <code>-b <var>BINARY</var></code> / <code>--binary <var>BINARY</var></code> +## <code>-b <var>BINARY</var></code> / <code>--binary <var>BINARY</var></code> Path to the Firefox binary to use. By default geckodriver tries to find and use the system installation of Firefox, but that behaviour @@ -104,7 +103,7 @@ scanning the Windows registry. [whereis(1)]: http://www.manpagez.com/man/1/whereis/ -#### <code>--connect-existing</code> +## <code>--connect-existing</code> Connect geckodriver to an existing Firefox instance. This means geckodriver will abstain from the default of starting a new Firefox @@ -120,24 +119,56 @@ using `--connect-existing` it is likely you will also have to use [`--marionette-port`]: #marionette-port -#### <code>--host <var>HOST</var></code> +## <code>--host <var>HOST</var></code> Host to use for the WebDriver server. Defaults to 127.0.0.1. +## <code>--jsdebugger</code> -#### <code>--log <var>LEVEL</var></code> +Attach [browser toolbox] debugger when Firefox starts. This is +useful for debugging [Marionette] internals. + +To be prompted at the start of the test run or between tests, +you can set the `marionette.debugging.clicktostart` preference to +`true`. + +For reference, below is the list of preferences that enables the +chrome debugger. These are all set implicitly when the +argument is passed to geckodriver. + +* `devtools.browsertoolbox.panel` -> `jsdebugger` + + Selects the Debugger panel by default. + +* `devtools.chrome.enabled` → true + + Enables debugging of chrome code. + +* `devtools.debugger.prompt-connection` → false + + Controls the remote connection prompt. Note that this will + automatically expose your Firefox instance to localhost. + +* `devtools.debugger.remote-enabled` → true + + Allows a remote debugger to connect, which is necessary for + debugging chrome code. + +[browser toolbox]: https://developer.mozilla.org/en-US/docs/Tools/Browser_Toolbox + +## <code>--log <var>LEVEL</var></code> Set the Gecko and geckodriver log level. Possible values are `fatal`, `error`, `warn`, `info`, `config`, `debug`, and `trace`. -#### <code>--marionette-host <var>HOST</var></code> +## <code>--marionette-host <var>HOST</var></code> Selects the host for geckodriver’s connection to the [Marionette] remote protocol. Defaults to 127.0.0.1. -#### <code>--marionette-port <var>PORT</var></code> +## <code>--marionette-port <var>PORT</var></code> Selects the port for geckodriver’s connection to the [Marionette] remote protocol. @@ -152,52 +183,38 @@ under geckodriver’s control, it will simply connect to <var>PORT</var>. [`--connect-existing`]: #connect-existing -#### <code>-p <var>PORT</var></code> / <code>--port <var>PORT</var></code> +## <code>-p <var>PORT</var></code> / <code>--port <var>PORT</var></code> Port to use for the WebDriver server. Defaults to 4444. A helpful trick is that it is possible to bind to 0 to get the system to atomically assign a free port. -#### <code>--jsdebugger</code> - -Attach [browser toolbox] debugger when Firefox starts. This is -useful for debugging [Marionette] internals. - -To be prompted at the start of the test run or between tests, -you can set the `marionette.debugging.clicktostart` preference to -`true`. -For reference, below is the list of preferences that enables the -chrome debugger. These are all set implicitly when the -argument is passed to geckodriver. +## <code>--profile-root <var>PROFILE_ROOT</var></code> - * `devtools.browsertoolbox.panel` -> `jsdebugger` +Path to the directory to use when creating temporary profiles. By +default this is the system temporary directory. Both geckodriver and +Firefox must have read-write access to this path. - Selects the Debugger panel by default. - - * `devtools.chrome.enabled` → true - - Enables debugging of chrome code. +This setting can be useful when Firefox is sandboxed from the host +filesystem such that it doesn't share the same system temporary +directory as geckodriver (e.g. when running Firefox inside a container +or packaged as a snap). - * `devtools.debugger.prompt-connection` → false - - Controls the remote connection prompt. Note that this will - automatically expose your Firefox instance to localhost. - * `devtools.debugger.remote-enabled` → true - - Allows a remote debugger to connect, which is necessary for - debugging chrome code. - - -[browser toolbox]: https://developer.mozilla.org/en-US/docs/Tools/Browser_Toolbox - - -#### <code>-v<var>[v]</var></code> +## <code>-v<var>[v]</var></code> Increases the logging verbosity by to debug level when passing a single `-v`, or to trace level if `-vv` is passed. This is analogous to passing `--log debug` and `--log trace`, respectively. [Marionette]: /testing/marionette/index.rst + + +## <code>--websocket-port<var>PORT</var></code> + +Port to use to connect to WebDriver BiDi. Defaults to 9222. + +A helpful trick is that it is possible to bind to 0 to get the +system to atomically assign a free port. |