HelpNDoc handles various command line parameters to be able to update and generate documentation without user interface. This is useful to integrate the documentation generation process with an automated build process for example. HelpNDoc's command line options use the syntax "hnd3.exe [FileName] [Parameters]" where [FileName] is the optional HND file to be processed and the parameters are described bellow. When run using the command line parameters bellow, HelpNDoc won't show any user interface except for a DOS prompt window.
Command line help
At any time, use the "hnd3.exe /?" command line to get help on the various command line syntax and parameters.
Command line parameters
/c - Compile the HelpNDoc "FileName" using project's settings
/sxc - Set the CHM generation flag for the project
/sxh - Set the HTML generation flag for the project
/sxp - Set the PDF generation flag for the project
/sxr - Set the RTF generation flag for the project
/uxc - Unset the CHM generation flag for the project
/uxh - Unset the HTML generation flag for the project
/uxp - Unset the PDF generation flag for the project
/uxr - Unset the RTF generation flag for the project
/oxc=[value] - Set the CHM generator output file
/oxh=[value] - Set the HTML generator output file
/oxp=[value] - Set the PDF generator output file
/oxr=[value] - Set the RTF generator output file
/txc=[value] - Set the CHM generator template name
/txh=[value] - Set the HTML generator template name
/txp=[value] - Set the PDF generator template name
/txr=[value] - Set the RTF generator template name
/v[name]=[value] - Set the [value] of variable [name] or create a new variable named [name]
/s - Save back command line settings to the project
/silent - Silent mode: no user input required
Command line examples
The following is a simple example of a possible use of the HelpNDoc's command line options:
> hnd3.exe myHelp.hnd /c
This translates to: compile the file "myHelp.hnd" according to the settings saved in that file.
> hnd3.exe myHelp.hnd /c /sxc /uxh /oxc="c:\myHelp\myFile.chm" /vMyVariable=MyValue /s
This translates to: compile the file "myHelp.hnd" to CHM but not HTML, set the output CHM directory to "c:\myHelp" and modify or declare the variable "MyVariable" with the value "MyValue". Finally the "/s" parameter will save the command line options back to the "myHelp.hnd" file, this includes the export options, and modified variables.