summaryrefslogtreecommitdiffstats
path: root/src/Authoring/Studio/Docs/CmdLineOptions.txt
diff options
context:
space:
mode:
Diffstat (limited to 'src/Authoring/Studio/Docs/CmdLineOptions.txt')
-rw-r--r--src/Authoring/Studio/Docs/CmdLineOptions.txt27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/Authoring/Studio/Docs/CmdLineOptions.txt b/src/Authoring/Studio/Docs/CmdLineOptions.txt
new file mode 100644
index 00000000..42610e8a
--- /dev/null
+++ b/src/Authoring/Studio/Docs/CmdLineOptions.txt
@@ -0,0 +1,27 @@
+-t, -test <Test Path> - Runs the specified Unit Test(s) (TEST_CMD_LINE)
+-n <File Name> - Normal operation (NORMAL)
+-replay - Replay File
+-export - Export the file. Usage: Studio.exe -export AMWFilename AMCFilename DOMPath [ slide index(optional and defaults to 1) ]
+-silent - Run silent run deep
+-refresh - Refresh resources
+
+Unused:
+-u, -xml <File Name> - TEST_XML
+-i, -testInfo - TEST_INFO
+
+It is possible to stack command line options, with left to right operation precedence. With the exception of
+-test and -silent which take effect regardless of ordering. Any failed operations would result in the
+aborting of subsequent operations, and a -1 (failure) value will be returned.
+
+Example 1:
+StudioC -silent -refresh myFile.uip -export myOutput.amc Scene.Layer.Component
+Refreshes the myFile.uip, then exports to myOutput.amc the component found at the indicated DOM path. No dialogs are
+displayed. Error messages are piped to stdout.
+
+Example 2:
+Studio -refresh myFile.uip myOutput.xgf -export
+Refreshes myFile.uip then exports to myOutput.xgf using the XGF exporter.
+
+Example 3:
+StudioC -silent -export myFile.uip -refresh myOutput.avi
+Exports myFile.uip to myOutput.avi THEN refreshes myFile.uip. Error messages are piped to stdout. \ No newline at end of file