--- trunk/doc/manual.html 2007/08/14 16:58:47 18 +++ trunk/doc/manual.html 2007/08/14 17:06:58 19 @@ -279,6 +279,67 @@ report" button to launch the JSCoverage report.

+

Command line options

+ +

+The jscoverage program accepts the following options: +

+ +
+
-h, --help +
Display a brief help message. +
-V, --version +
Display the version of the program. +
-v, --verbose +
Explain what is being done. +
--exclude=PATH +
The command +
+jscoverage --exclude=PATH SOURCE-DIRECTORY DESTINATION-DIRECTORY
+
+copies SOURCE-DIRECTORY to DESTINATION-DIRECTORY +recursively, but does not copy SOURCE-DIRECTORY/PATH. +PATH must be a complete path relative to SOURCE-DIRECTORY +PATH can be a file or a directory (in which case the directory and +its entire contents are skipped). This option may be given multiple times. +
--no-instrument=PATH +
The command +
+jscoverage --exclude=PATH SOURCE-DIRECTORY DESTINATION-DIRECTORY
+
+copies SOURCE-DIRECTORY to DESTINATION-DIRECTORY +recursively, but does not instrument any JavaScript code in +SOURCE-DIRECTORY/PATH. PATH must be a complete +path relative to SOURCE-DIRECTORY PATH can be a +(JavaScript) file or a directory (in which case any JavaScript files located +anywhere underneath the directory are not instrumented). This option may be +given multiple times. +
+ +

Query string options

+ +

+When accessing jscoverage.html in a web browser, you may provide a +query string consisting of options separated by ampersand (&) +or semicolon (;). Any option not containing an equals sign +(=) is considered to be a URL which will be loaded in the "Browser" +tab. +

+ +
+
u=URL, url=URL +
Load URL in the "Browser" tab. (This is the same as specifying +an option without an equals sign.) +
m=BOOLEAN, missing=BOOLEAN +
Determines whether to initially display the "Missing" column in the "Summary" +tab. BOOLEAN can be +true, t, yes, y on, 1 +(to display the "Missing" column), or +false, f, no, n, off, 0 +(to hide the "Missing" column) +(By default, the "Missing" column is not displayed.) +
+

Caveats