help

www.altova.com Expand/Collapse All Print this Topic Previous Page Up One Level Next page

Home >  Command Line Interface (CLI) > Help and License Commands  >

help

The help command takes a single argument: the name of the command for which help is required. It displays the syntax of the command and other information relevant to the correct execution of the command.

 

Windows

RaptorXML help Command

Linux

raptorxml help Command

Mac

raptorxml help Command

 

Note:When no argument is submitted, running the help command causes all available commands to be displayed, each with a short description of what it does.

 

Example

Example of the help command:

 

 raptorxml help valany

 

The command above contains one argument: the command valany, for which help is required. When this command is executed, it will display help information about the valany command.

 

Click to expand/collapseCasing and slashes on the command line

RaptorXML on Windows

raptorxml on Unix (Linux, Mac)

 

* Note that lowercase (raptorxml) works on all platforms (Windows, Linux, and Mac), while upper-lower (RaptorXML) works only on Windows and Mac.

* Use forward slashes on Linux and Mac, backslashes on Windows.

 

The --help option

Help information about a command is also available by using the --help option with that command. For example, using the --help option with the valany command, as follows:

 

 raptorxml valany --help

 

achieves the same result as does using the help command with an argument of valany:

 

 raptorxml help valany

 

In both cases, help information about the valany command is displayed.

 

Click to expand/collapseCasing and slashes on the command line

RaptorXML on Windows

raptorxml on Unix (Linux, Mac)

 

* Note that lowercase (raptorxml) works on all platforms (Windows, Linux, and Mac), while upper-lower (RaptorXML) works only on Windows and Mac.

* Use forward slashes on Linux and Mac, backslashes on Windows.

 

 


© 2019 Altova GmbH