Using Command-Line

You can use Word-2-CHM command line when you need Word-2-CHM to create CHM file automatically for you in batch file, or in scheduled task, etc. The command line of Word-2-CHM is as below:

Word-2-CHM.exe  /pFile=file[;Option1=value1][;Option2=value2][;OptionX=valuex]

            Or

Word-2-CHM.exe  /pFile=file  [/pOption1=value1]  [/pOptionX=valuex]

Options:

 

Option

Description

Value

 

File

Source file, can be .word2chm project, Word file and HTML file

filename

 

OutPath

Path of output CHM file

path

 

Auto

Create the CHM file automatically and then close

true/false

 

Overwrite

Overwrite existing CHM file without prompts

true/false

 

op:ShowNavigator

UI option “Show navigator”

true/false

 

op:ShowHeader

UI option “Show header”

true/false

 

op:ShowFooter

UI option “Show footer”

true/false

 

op:ShowCoverPage

UI option “Show cover page”

true/false

 

op:CoverPageTitle

Title text of option “Show cover page”

title text

 

op:ShowRelatedTopic

UI option “Show related topics”

true/false

 

op:RelatedTopicTitle

Title text of option “Show related topics”

title text

 

op:ShowChapterNo

UI option “Show chapter number”

true/false

 

op:RefToLink

UI option “Cross-reference to hyperlink”

true/false

 

op:IndexToIndex

UI option “Add index entry”

true/false

 

op:UsePNG

UI option “High-quality images”

true/false

 

op:KeepChmProject

UI option “Keep HTML help project”

true/false

 

op:MergeSubDocuments

UI option “Merge sub docs”

true/false

 

op:CustomRootLevel

UI option “Custom root level”

4-9

 

op:MaxTreeLevel

UI option “Max tree level”

1-9

 

op:MergeAtLevel

UI option “Merge topics at level”

1-9

 

op:HelpIdTemplate

Template filename of “Auto help id”

filename

 

op:PageFileNameRule

UI option “Page filename rule”

value = Default/HeadingText/HelpId/ChapterNumber

 

op:Language

CHM option “Language”

language id

 

 

 

 

 

[Note]

CHM options, Theme options and Add-in options cannot be set in command-line. Create a .word2chm project file for command-line is recommended.