Navigation: Command Line Parameters >

Command Line Parameters

Send comments on this topic.

  

 

HelpSmith supports command line parameters that you can use to automate the compilation of a help project.

 

Command Line Format


The format of the command line to compile a help project is as follows:

 

HELPSMITH <ProjectFile> <Format>[=<Output>]

 

where:

 

HELPSMITH

HelpSmith's executable file.

 

For example: "C:\Program Files (x86)\HelpSmith\HelpSmith.exe"

<ProjectFile>

Specifies the help project file (HSM) to compile. For example: "C:\My Projects\Sample.hsm".

<Format>

Specifies the output help format to which you want to compile your help project.

 

Supported values:

/hh for HTML Help

/wh for Web Help

/pdf for Adobe PDF Document

/word for MS Word Document

/epub for ePub eBook

<Output>

An optional parameter that specifies the output directory or filename depending on the output format.

 

If this parameter is omitted, the default output directory for the specific output format will be used.

 

The value can contain either the full path such as "C:\My Output Dir\", or a directory (folder) relative to the <ProjectFile>, for example "WebHelp".

 

The HTML Help, PDF, Word, and ePub formats allow you to specify either a directory path, or a filename of the output help file or document. For example: "c:\Files\MyHelpFile.chm".

 

For the Web Help format, you can specify only a directory path.

Additional switches:

 

/bt=<BuildTags>

An optional parameter that specifies a build tag or a list of build tags (separated with the comma character) to apply to the compilation.

 

If this parameter is omitted, a system build tag that corresponds to the output format will be used.

/tv=<file>

An optional parameter that specifies a file that contains alternative values of text variables.

 

You can use this switch if you want to compile your help project with variable values different from the values defined in the help project.

 

<file> is a plain text file that stores each variable on a separate line in the following format:

VariableName=Value

 

You can create such a file manually or by exporting the variables from the Text Variables dialog.

/nc

Closes the console window without a confirmation after a successful compilation.

/?

Displays quick help on the command line parameters.

 

Examples


Below are examples of the command line using different parameters:

"C:\Program Files\HelpSmith\HelpSmith.exe" "C:\My Projects\Help.hsm" /hh

HelpSmith.exe "c:\Help\Work.hsm" /wh=WebHelp "/tv=C:\Helps\my vars.txt"

HelpSmith.exe "c:\Help\Sample.hsm" /hh /bt=HTMLHelp,Custom1



Copyright © 2007-2019 HelpSmith.com