Allows user to override default usage display.
<usage> This section describes the script </usage> |
Remarks
The <usage> element is similar to the <example> and <description> elements — it contains text that the developer can include in the usage. The difference is that if a <usage> element exists, everything else in the <runtime> element is ignored, and only the text in the <usage> element is displayed. This is so you can completely override the usage display.
Note |
---|
The <usage> element should always be enclosed by a <runtime> element. |
Example
The following script demonstrates the use of the <usage> element:
Copy Code | |
---|---|
<job> <runtime> <named name="arg1" helpstring="the first arg"/> <usage> Your usage text goes here. </usage> </runtime> <script language="vbscript"> WScript.Arguments.ShowUsage </script> </job> |
When this script is run, it produces the following:
Copy Code | |
---|---|
Your usage text goes here. |