next up previous contents index
Next: The helpreset Command Up: Miscellaneous Commands Previous: The bug Command   Contents   Index


The help Command

The help command brings up a help window describing the topic keyword passed as an argument to the command, or the top-level entry if no argument is given.

help [-c | topic]
When graphics is not available, the help text is presented in a text-only format on the terminal. The HTML to ASCII text converter only handles the most common HTML tags, so some descriptions may look a little strange. The figures (and all images) are not shown, and links are not available, except for the ``subtopics'' and ``references'' lists.

The help data files are found in directories specified in the helppath variable, or from the
SPICE_HLP_PATH environment variable. If for some reason the help directory is not found, a very minimal internal text-mode help system will be provided. The single character `?' is internally aliased to ``help''.

If the single argument ``-c'' is given, the internal topic hash tables are cleared. Since the topics are hashed as offsets into the files, if a topic text changes, the offsets will be incorrect. After changes are made to a help file, or new help files are added, if in WRspice and the help database has already been cached by viewing any help topic, giving ``help -c'' will ensure that new topics are found and present topics display correctly. This is the same effect as giving the helpreset command.

The helpinitxpos variable specifies the distance in pixels from the left edge of the screen to the left edge of the help window, when it first appears. If not set, the value taken is 100 pixels. The helpinitypos variable specifies the distance in pixels from the top edge of the screen to the top edge of the help window, when it first appears. If not set, the value taken is 100 pixels.

See 3.15 for more information about the WRspice help system.


next up previous contents index
Next: The helpreset Command Up: Miscellaneous Commands Previous: The bug Command   Contents   Index
Stephen R. Whiteley 2017-03-28