forked from mirrors/gecko-dev
Bug 1747444 - Fix rendering of geckodriver command line arguments in docs, r=webdriver-reviewers,jdescottes,whimboo
Differential Revision: https://phabricator.services.mozilla.com/D134626
This commit is contained in:
James Graham
parent
473d81c092
commit
019fbe76f6
1 changed files with 23 additions and 25 deletions
|
|
@ -1,7 +1,7 @@
|
|||
<!-- markdownlint-disable MD033 -->
|
||||
# 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 +12,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 +27,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
|
||||
|
|
@ -55,28 +55,28 @@ By default `auto` is used.
|
|||
<tr>
|
||||
<td>auto
|
||||
<td>Best suitable location based on whether the device is rooted.<br/>
|
||||
If the device is rooted <code>internal</code> is used, otherwise <code>app</code>.
|
||||
If the device is rooted `internal` is used, otherwise `app`.
|
||||
<tr>
|
||||
<td>app
|
||||
<td><p>Location: <code>/data/data/%androidPackage%/test_root</code></p>
|
||||
Based on the <code>androidPackage</code> capability that is passed as part of
|
||||
<code>moz:firefoxOptions</code> when creating a new session. Commands that
|
||||
<td><p>Location: `/data/data/%androidPackage%/test_root`</p>
|
||||
Based on the `androidPackage` capability that is passed as part of
|
||||
`moz:firefoxOptions` when creating a new session. Commands that
|
||||
change data in the app's directory are executed using run-as. This requires
|
||||
that the installed app is debuggable.
|
||||
<tr>
|
||||
<td>internal
|
||||
<td><p>Location: <code>/data/local/tmp/test_root</code></p>
|
||||
<td><p>Location: `/data/local/tmp/test_root`</p>
|
||||
The device must be rooted since when the app runs, files that are created
|
||||
in the profile, which is owned by the app user, cannot be changed by the
|
||||
shell user. Commands will be executed via <code>su</code>.
|
||||
shell user. Commands will be executed via `su`.
|
||||
<tr>
|
||||
<td>sdcard
|
||||
<td><p>Location: <code>$EXTERNAL_STORAGE/Android/data/%androidPackage%/files/test_root</code></p>
|
||||
<td><p>Location: `$EXTERNAL_STORAGE/Android/data/%androidPackage%/files/test_root`</p>
|
||||
This location is supported by all versions of Android whether if the device
|
||||
is rooted or not.
|
||||
</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 +104,7 @@ scanning the Windows registry.
|
|||
[creating a new session]: https://w3c.github.io/webdriver/#new-session
|
||||
[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
|
||||
|
|
@ -112,18 +112,16 @@ session.
|
|||
|
||||
The existing Firefox instance must have [Marionette] enabled.
|
||||
To enable the remote protocol in Firefox, you can pass the
|
||||
`-marionette` flag. Unless the `marionette.port` preference
|
||||
`--marionette` flag. Unless the `marionette.port` preference
|
||||
has been user-set, Marionette will listen on port 2828. So when
|
||||
using `--connect-existing` it is likely you will also have to use
|
||||
`--marionette-port` to set the correct port.
|
||||
|
||||
`--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>-\\-jsdebugger</code>
|
||||
|
||||
Attach [browser toolbox] debugger when Firefox starts. This is
|
||||
useful for debugging [Marionette] internals.
|
||||
|
|
@ -156,21 +154,21 @@ argument is passed to geckodriver.
|
|||
|
||||
[browser toolbox]: https://developer.mozilla.org/en-US/docs/Tools/Browser_Toolbox
|
||||
|
||||
## <code>--log <var>LEVEL</var></code>
|
||||
## <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>--log-no-truncate</code>
|
||||
## <code>-\\-log-no-truncate</code>
|
||||
|
||||
Disables truncation of long log lines.
|
||||
|
||||
## <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.
|
||||
|
|
@ -184,14 +182,14 @@ 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>--profile-root <var>PROFILE_ROOT</var></code>
|
||||
## <code>-\\-profile-root <var>PROFILE_ROOT</var></code>
|
||||
|
||||
Path to the directory to use when creating temporary profiles. By
|
||||
default this is the system temporary directory. Both geckodriver and
|
||||
|
|
@ -202,13 +200,13 @@ 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).
|
||||
|
||||
## <code>-v<var>[v]</var></code>
|
||||
## <code>-v[v]</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.
|
||||
|
||||
## <code>--websocket-port<var>PORT</var></code>
|
||||
## <code>-\\-websocket-port<var>PORT</var></code>
|
||||
|
||||
Port to use to connect to WebDriver BiDi. Defaults to 9222.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue