aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbors-servo <lbergstrom+bors@mozilla.com>2016-05-03 06:31:38 -0700
committerbors-servo <lbergstrom+bors@mozilla.com>2016-05-03 06:31:38 -0700
commit3f2ceeff5dd1966dafe34381e20ec405ab72ccee (patch)
tree34681c8be12fa63c0a6940a47db59c0d304216c5
parent4594f71b0ef17b1321824d26f67e26f0874c9e95 (diff)
parent998afeed48bfbaeb8961c7dd94886163df83e433 (diff)
downloadservo-3f2ceeff5dd1966dafe34381e20ec405ab72ccee.tar.gz
servo-3f2ceeff5dd1966dafe34381e20ec405ab72ccee.zip
Auto merge of #10914 - shinglyu:docs, r=aneeshusa
Added documents for commandline arguments An initial draft for #10878 <!-- Reviewable:start --> --- This change is [<img src="https://reviewable.io/review_button.svg" height="35" align="absmiddle" alt="Reviewable"/>](https://reviewable.io/reviews/servo/servo/10914) <!-- Reviewable:end -->
-rw-r--r--docs/COMMAND_LINE_ARGS.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/COMMAND_LINE_ARGS.md b/docs/COMMAND_LINE_ARGS.md
new file mode 100644
index 00000000000..b8898e3f4f4
--- /dev/null
+++ b/docs/COMMAND_LINE_ARGS.md
@@ -0,0 +1,32 @@
+Command Line Arguments
+========================
+# General
+
+You can see available commands with:
+```
+./mach -h
+./mach <sub-command> -h
+```
+Only arguments that need more explanation will be documented here.
+
+# Run
+## Enable Experimental Features
+Use `--pref` to enable experimental features like experimental DOM API, JavaScript API and CSS properties.
+
+e.g. To enable `flex` and `flex-direction` css properties:
+```
+./mach run -d -- --pref layout.flex.enabled --pref layout.flex-direction.enabled ...
+```
+
+You can find all the available preferences at [resources/prefs.json](http://mxr.mozilla.org/servo/source/resources/prefs.json).
+
+# Debugging
+## Remote Debugging
+Use `--devtools 6000` to start the devtools server on port 6000.
+
+e.g.
+```
+./mach run -d --devtools 6000 https://servo.org
+```
+
+To connect to the server, follow [this guide](https://developer.mozilla.org/en-US/docs/Tools/Remote_Debugging/Debugging_Firefox_Desktop#Connect).