This chapter summarizes the command-line options available when the help commands are run manually in a terminal window. Desktop actions and data types provided by the Help System enable you to compile and view run-time help files by clicking a help file icon or choosing a menu item. However, if you want to select particular command options, you must enter the command manually in a terminal window or create new actions. Help actions and data types are defined in two files, dthelp.dt and dtdocbook.dt, located in the /usr/dt/appconfig/types/lang directory. The commands summarized here are: dtDocBook Compiles DocBook source files into a run-time file. dthelpview Displays a help volume, help topic, text file, or man page. dthelpgen Collects help family files into a new help volume, index.hv, which contains an entry for each family file. The DocBook software, invoked with the dtdocbookcommand, compiles your DocBook source files into a run-time help file. You run dtdocbook in the directory where your volume.sgm source file is located. dtdocbook [command-options] volume Where command-options are options entered before the volume name. -c Compress an existing SDL file; assume an input file name extension of “.sdl” -d Decompress an existing SDL file; assume an input file name extension of “.sdl” -h (Help) Emit a synopsis of the dtdocbook command and a list of option to the standard output -l Leave a log file in basename.log -m (Map) Add additional SDATA and/or character mapping files -o file Use file as the output file name; do not add any file name extension -r Remove any intermediate files and the output file; do not complain if none exist -u (Uncompressed) Do not compress the output file during translation -v (Verbose) Cause dtdocbook to generate and display parser messages during processing If the -c option is specified and the file is already compressed, the file will be decompressed and recompressed. This action is useful as a means to verify the integrity of a compressed SDL file. If the -d is specified and the file is already decompressed, the file will be re-parsed, all precomputations will be performed, and the file will be re-written. This action is useful as a means to verify the integrity of an SDL file. It is also useful for forcing a recomputation of the table of contents, including byte offsets to individual help topics, when such recomputation is made necessary, for example, by editing the SDL file directly. dtdocbook(1) man page The dthelpview command can be used to display a help volume, individual help topic, text file, or man page. The various ways to invoke Helpview are: dthelpview -helpVolume volume [ -locationId id ] dthelpview -man dthelpview -manPage man dthelpview -file filename Where: -helpVolume volume Specifies the name of the volume.sdl file you want to view. A path name is not required unless the volume is not in the current directory and the volume has not been registered. -locationId id Specifies an ID. dthelpview displays the topic that contains id. If you do not specify an ID, Helpview uses _hometopic by default. -man Displays a dialog that prompts for a man page to view, then displays the requested man page. -manPage man Specifies that a particular man page be displayed. -file filename Specifies that a particular text file be displayed. The default volume and id can be set in dthelpview's app-defaults file, /usr/dt/app-defaults/C/Dthelpview. dthelpview(1) man page The dthelpgen utility creates a special help volume that enables users to display help volumes registered on their system using the Front Panel Help Viewer. When a user initially clicks the Help Viewer control in the Front Panel, dthelpgen is run automatically. It locates help family files by searching the help search path directories (local or networked), and then creates an index volume (index.hv) in the user's HomeDirectory/.dt/help/$DTUSERSESSIONdirectory. Once built, the volume is updated in response to any of these actions: Add, remove, or modify family files or help volumes Change the LANG environment variable Invoke the ReloadApps action Run dthelpgen manually in a terminal window The index volume is displayed by clicking the Help Viewer control in the Front Panel. Or, you can manually run dthelpview and supply the index volume name as shown in this command line: dthelpview -h index.hv dthelpgen -dir [options] Where: -dir Specifies the directory in which to place the index volume and intermediate files. This is a required parameter. -generate Specifies that a new index help volume should be created even if the family files and help volumes on the system have not been modified. -file basename Specifies the name of the help volume and any intermediate files generated by dthelpgen. The default name is index.hv. -lang Specifies which language directories to search for help families and help volumes. If the -lang option is set, it takes precedence over the current value of the LANG environment variable. If you run dthelpgen while the index volume is displayed in a help window, you should close the window, then reopen the index volume. dthelpgen(1) man page