REPORTER 22.1

Command Line Arguments

Command line arguments

The following command line arguments are available in REPORTER . Unless stated otherwise, all command line options are evaluated in the order that they are given.

Argument	Description
file.orrx or -file=file.orrx	Opens REPORTER file "file.orrx"
-pdf=file.pdf	Creates a pdf file "file.pdf"
-html=file.html	Creates a HTML file "file.html"
-print=printer	Prints report to printer
-varNAME[!#][::type]=value[::description]	Creates a variable "NAME" in REPORTER with value "value" and description "description". ::description and ::type can be omitted. If the type is omitted it defaults to "General". By default variables defined on the command line will not be marked as temporary. If the variable name is suffixed by '#' then the variable will be temporary. '!' can also be used to mark the variable as not being temporary (although this is not needed as it is the default).
-pptx=file.pptx (or -ppt=file.pptx)	Create PowerPoint file "file.pptx".
-log=logfile	Save the logfile REPORTER produces in the file "logfile" as plain text after processing all the command line options.
-loghtml=logfile	Save the logfile REPORTER produces in the file "logfile" as HTML after processing all the command line options.
-generate	Generate a report (previously read with -file argument). Note: this is not required if you use any of the -ps, -pdf, -html, or -pptx options (they do this automatically)
-report=file.orrx	Saves generated report (previously read with -file argument) to file.orrx
-script=script.js -js=script.js	Runs JavaScript script script.js.
-js_arg="passing a sentence"	Defining an argument to be used in JavaScript files. Multiple arguments can be given to a script by using more than one -js_arg command line argument. The arguments can be accessed in the script by using the global arguments array. Note: The first argument in the arguments array will by default always be the file path of the script being run.
-argfile=argfile	Reads command line arguments from file argfile, one argument per line. This could be useful if you want to read lots of variables on the command line and you reach the command line length limit.
-exit	Automatically exit after processing all other command line options
-iconise	Start REPORTER iconised. This is useful for running reporter from scripts when you want to continue working on something else and you do not want the REPORTER window to interfere.
-new	Create a new template.
-batch	Batch mode. This stops REPORTER prompting the user. For example, normally if an error occurs when generating REPORTER brings up a warning box allowing the user to look at the error. Giving the -batch argument stops this. Note that this does NOT make REPORTER run without the user interface (see -iconise )
-oasys_batch	On Windows run D3PLOT and T/HIS without any windows being shown.
-combine	Combine multiple report output into pdf, html or pptx.

So for example:

reporter -file=/job/templates/example.orrx                  /
         -pdf=/local/output.pdf                             /
         -print=printer                                     /
         -varKEYWORD=/job/keyword/example.key::example deck /
         -html=/local/example.html                          /
         -exit

Will:

Load the file "/job/templates/example.orrx" into REPORTER
Install a variable called KEYWORD with value "/job/keyword/example.key" and description "example deck"
Create a pdf file "/local/output.pdf"
Print the file on printer "printer"
Create a HTML file "/local/example.html"
automatically exit

Previous | Next