mirror/appium
1
0
Fork 0
mirror of https://github.com/appium/appium.git synced 2026-02-05 00:58:56 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs formatting

Browse Source
This commit is contained in:
Jonathan Lipps
2013-03-04 18:18:11 -08:00
parent 905ff38b7c
commit 36b6bb9378
2 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/server-args.md
View File

@@ -8,16 +8,16 @@ All flags are optional, but some are required in conjunction with certain others
|Flag|Default|Description|Example|
|----|-------|-----------|-------|
|`--app`|no|null|IOS: abs path to simulator-compiled .app file or the bundle_id of the desired target on device; Android: abs path to .apk file|`--app /abs/path/to/my.app`|
|`-V`, `--verbose`|no|null|Get verbose logging output||
|`-U`, `--udid`|no|null|(IOS-only) Unique device identifier of the connected physical device|`--udid 1adsf-sdfas-asdf-123sdf`|
|`-a`, `--address`|no|0.0.0.0|IP Address to listen on|`--address 0.0.0.0`|
|`-p`, `--port`|no|4723|Port to listen on|`--port 4723`|
|`-r`, `--remove`|no|true|(IOS-only) Remove Instruments trace directories||
|`-s`, `--reset`|no|true|Reset app state after each session (IOS: delete plist; Android: install app before session and uninstall after session)||
|`-l`, `--launch`|no|false|Pre-launch the application before allowing the first session (Requires --app and, for Android, --app-pkg and --app-activity)||
|`-g`, `--log`|no|null|Log output to this file instead of stdout|`--log /path/to/appium.log`|
|`-G`, `--webhook`|no|null|Also send log output to this HTTP listener|`--webhook localhost:9876`|
|`-w`, `--warp`|no|false|(IOS-only) IOS has a weird built-in unavoidable sleep. One way around this is to speed up the system clock. Use this time warp hack to speed up test execution (WARNING, actually alters clock, could be bad news bears!)||
|`--app-pkg`|no|null|(Android-only) Java package of the Android app you want to run (e.g., com.example.android.myApp)|`--app-pkg com.example.android.myApp`|
|`--app-activity`|no|MainActivity|(Android-only) Activity name for the Android activity you want to launch from your package (e.g., MainActivity)|`--app-activity MainActivity`|
|`--app`|null|IOS: abs path to simulator-compiled .app file or the bundle_id of the desired target on device; Android: abs path to .apk file|`--app /abs/path/to/my.app`|
|`-V`, `--verbose`|null|Get verbose logging output||
|`-U`, `--udid`|null|(IOS-only) Unique device identifier of the connected physical device|`--udid 1adsf-sdfas-asdf-123sdf`|
|`-a`, `--address`|0.0.0.0|IP Address to listen on|`--address 0.0.0.0`|
|`-p`, `--port`|4723|Port to listen on|`--port 4723`|
|`-r`, `--remove`|true|(IOS-only) Remove Instruments trace directories||
|`-s`, `--reset`|true|Reset app state after each session (IOS: delete plist; Android: install app before session and uninstall after session)||
|`-l`, `--launch`|false|Pre-launch the application before allowing the first session (Requires --app and, for Android, --app-pkg and --app-activity)||
|`-g`, `--log`|null|Log output to this file instead of stdout|`--log /path/to/appium.log`|
|`-G`, `--webhook`|null|Also send log output to this HTTP listener|`--webhook localhost:9876`|
|`-w`, `--warp`|false|(IOS-only) IOS has a weird built-in unavoidable sleep. One way around this is to speed up the system clock. Use this time warp hack to speed up test execution (WARNING, actually alters clock, could be bad news bears!)||
|`--app-pkg`|null|(Android-only) Java package of the Android app you want to run (e.g., com.example.android.myApp)|`--app-pkg com.example.android.myApp`|
|`--app-activity`|MainActivity|(Android-only) Activity name for the Android activity you want to launch from your package (e.g., MainActivity)|`--app-activity MainActivity`|

1
grunt-helpers.js
View File

@@ -344,7 +344,6 @@ module.exports.generateServerDocs = function(grunt, cb) {
var exampleArg = typeof arg[0][1] === "undefined" ? arg[0][0] : arg[0][1];
var argOpts = arg[1];
md += "|`" + argNames.join("`, `") + "`";
md += "|" + (argOpts.required ? "yes" : "no");
md += "|" + ((typeof argOpts.defaultValue === "undefined") ? "" : argOpts.defaultValue);
md += "|" + argOpts.help;
md += "|" + ((typeof argOpts.example === "undefined") ? "" : "`" + exampleArg + " " + argOpts.example + "`");