Adobe RoboHelp for HTML

Command prompt options and examples

Use this format for entering commands at the command prompt:

rhcl [-?] [-h] [project path] [-l] [layout name] [-p] [server name:user name:password] [-o] [output folder path] [-d] [-b] [-g]

This format shows the order and description of options within brackets. Not all options are required when entering a command.

Primary options

Commands must start with rhcl and include the project path and name.

-l Generates a layout. Specify the layout name (for example, -l FlashHelp). The application generates the primary layout if a layout is not specified.

Examples:

    Rhcl Myproject\Myproject.Xpj

In this example, the -l option is not used, so the project generates the primary layout. Since no output is specified, output files are sent to the default folder in the Single Source layout setting for the primary layout.

        • rhcl "my project\my project.xpj"

This example is identical to the previous example, except for the quotation marks, which indicate there is a space between words in the path.

        • rhcl "c:\my project\my project.xpj"

This example uses a full path to the project because it is not stored in the same location as RoboHelp. Quotation marks are used.

The -l option is not included. The application generates the primary layout.

        • rhcl "c:\my project\my project.xpj" -l "WebHelp Pro"

This example has a specified a layout name (WebHelp). The application generates a layout named WebHelp Pro.

Quotation marks indicates spaces.

-p Publishes a layout. Configure all publishing destinations using the New Destination dialog box.

Examples:

This examples uses the -p option without specific publishing destinations. The primary layout is generated and published to associated destinations.

This example uses a full path to the project because it is not stored in the same location as RoboHelp. Quotation marks indicate spaces.

This example specifies a layout name (FlashHelp) with the -l option. The application generates and publishes the layout FlashHelp.

Does not include publishing destination information. The application publishes output to associated destinations.

Does not use quotation marks because the layout name does not contain a space.

    Rhcl "C:\My Project\My Project.Xpj" -L Flashhelp -P Server1

This example specifies a publishing destination (server1). The application generates the layout FlashHelp, and publishes to the destination server1. If server1 is not defined for FlashHelp, the application ignores -p flag.

    Rhcl "C:\My Project\My Project.Xpj" -L Flashhelp -P Server1 -P Server2:User1:Password1

This is the same as the previous example, except that a second publishing destination (server2) has been added. This second server requires a username and password. So the username (user1) and password (password1) have been included between colons. This means that the layout named "FlashHelp" will be generated for this project, and published to the destinations named "server1" and "server2."

Define server1 and server2 for FlashHelp Layout. User1 and password1 details override username and password settings for server2 after publishing.

-o Sends the output to a folder. The default output subfolder is !SSL!.

Examples:

    Rhcl Myproject\Myproject.Xpj -O Myoutput

This example does not use the -l option. The project generates the primary layout.

The custom folder uses a relative path (myoutput.). The output goes to the myoutput subfolder, which resides in the RoboHelp installation folder.

This example uses quotation marks to indicate spaces in the path.

    Rhcl "C:\My Project\My Project.Xpj" -O "My Output"

This examples uses a full path to the project because it is not stored in the RoboHelp installation folder. Quotation marks indicate spaces in the path and custom output folder.

    Rhcl "C:\My Project\My Project.Xpj" -L -O "My Output"

This example uses the -l option. No layout is specified so the project generates the primary layout.

    Rhcl "C:\My Project\My Project.Xpj" -L Webhelp -O "C:\My Output"

This example specifies a layout (WebHelp). The project generates the WebHelp layout. The layout name does not contain spaces so there are no quotation marks.

-d Displays layout and publishing destination names at the command prompt.

Examples:

    Rhcl Myproject\Myproject.Xpj -D

This example uses a relative path to the project because the Help project and RoboHelp reside in the same folder (C:\Program Files\Adobe RoboHelp 7\RoboHTML).

    Rhcl "My Project\My Project.Xpj" -D -L Webhelp

This example uses quotation marks to indicate spaces between words in the path. Other command line arguments of command line (-l in this case) are ignored.

-b Generates the layouts set for batch generation. Outputs to the output folder for a particular single-source layout.

Examples:

    Rhcl Myproject\Myproject.Xpj -B

This example uses a relative path to the project because the Help project and RoboHelp reside in the same folder (C:\Program Files\Adobe RoboHelp 7\RoboHTML).

This example uses a relative path to the project because the Help project and RoboHelp reside in the same folder (C:\Program Files\Adobe RoboHelp 7\RoboHTML).

The -b option specifies that project layouts are batch-generated. It ignores output folder argument (-o).

This example uses a relative path to the project because the Help project and RoboHelp reside in the same folder (C:\Program Files\Adobe RoboHelp 7\RoboHTML.

The -b option specifies that project layouts are batch-generated.

Batch-generated layouts are published to server1 if it is a valid server name for the layout.

-h Displays Help.

- g Specifies a log file name.

If this option is specified with the RHCL command on the command line, RHCL writes the output into the specified log file. The output is not sent to the console. As the RoboHelp command line does not support Unicode characters, ensure that the log file name you specify, does not contain Unicode characters. If a file by this name already exists, that file is overwritten.

Example:

This example uses a relative path to the log file because the Help project and RoboHelp reside in the same folder (C:\Program Files\Adobe RoboHelp 7\RoboHTML) and log is to be generated in the same folder as the project.

rhcl myproject\myproject.xpj &endash;l WebHelp &endash;g myproject\LogFile.txt

For the above case this example uses an absolute path to the log file. Quotation marks indicate spaces in the path and custom output folder.

rhcl myproject\myproject.xpj &endash;l WebHelp &endash;g ”C:\Program Files\Adobe RoboHelp 7\RoboHTML\myproject\LogFile.txt”

As the system command prompt does not support characters outside the system locale (code-page), ensure that the log file name you specify does not contain characters outside your system locale

Related Topics