help
Syntax and description
The help command takes a single argument (Command), which is the name of the command for which help is required. It displays the command's syntax, its options, and other relevant information. If the Command argument is not specified, then all commands of the executable are listed, with each having a brief text description. The help command can be called from either executable: raptorxmlxbrl or raptorxmlxbrlserver.
raptorxmlxbrl help Command raptorxmlxbrlserver help Command |
RaptorXMLXBRL (and RaptorXMLXBRLServer for administration commands) on Windows raptorxmlxbrl (and raptorxmlxbrlserver for administration commands) on Windows and Unix (Linux, Mac)
* Note that lowercase (raptorxmlxbrl and raptorxmlxbrlserver) works on all platforms (Windows, Linux, and Mac), while upper-lower (RaptorXMLXBRL) works only on Windows and Mac. * Use forward slashes on Linux and Mac, backslashes on Windows.
|
Example
Examples of the help command to display information about the licenserver command (this command is available in both executables):
raptorxmlxbrl help licenseserver
raptorxmlxbrlserver help licenseserver
The --help option
Help information about a command is also available by using the --help option of the command for which help information is required. The two commands below produce the same results:
raptorxmlxbrl licenseserver --help
The command above uses the --help option of the licenseserver command.
raptorxmlxbrl help licenseserver
The help command takes licenseserver as its argument.
Both commands display help information about the licenseserver command.