The following is an explanation of how to use the command line options of the MadCap Help Viewer application. Command line syntax:
HelpViewer.exe -file <path to help system> [-cshid <identifier>] [-search <search_string>]
| Parameter | Description |
|---|---|
| file | Path to the DotNet Help output file (.mchelp extension) |
| cshid | CSH ID of the desired topic to display. This can be either the identifier name or value. Alternatively, the ID may contain a topic path. When using a topic path, it must be relative to the Content folder of the Help system. |
| search | Search string that the help system will automatically search for when it is opened |
>HelpViewer.exe -file "C:\My Help System\Manual.mchelp"
Opens the specified help system.
>HelpViewer.exe -file "C:\My Help System\Manual.mchelp" -cshid MyID
Opens the specified help system and opens the topic associated with "MyID".
>HelpViewer.exe -file "C:\My Help System\Manual.mchelp" -cshid MyTopic.htm
Opens the specified help system and opens the topic located at MyTopic.htm.
>HelpViewer.exe -file "C:\My Help System\Manual.mchelp" -search "bikes and trikes"
Opens the specified help system and displays search results for "bikes and trikes".
>HelpViewer.exe -file "C:\My Help System\Manual.mchelp" -cshid MyID -search "bikes and trikes"
Opens the specified help system, opens the topic associated with "MyID", and displays search results for "bikes and trikes".