H[ELP]

Syntax

   H[ELP] [topic] [options]

Parameters

topic

The topic for which help is desired. Help is available for a single:

• Command name.

• Environment variable name.

• Predefined function name.

• Macro name.

• User variable name.

Use the CMDLIST, ENVLIST, FUNCLIST, MACLIST, and VARLIST commands to see all of the names that are defined for each respective class listed above.

options

The options available depend upon the class of the topic. In general, the following options are available:

USE/NOUSE

Short summary of usage.

PARMS/NOPARMS

Information about parameters.

DESC/NODESC

General description.

EXAMPLE/NOEXAMPLE

Examples.

ACCESS/NOACCESS

Access rights information.

ALL

Everything.

The following table indicates which combination of topics/options are valid (invalid options are ignored).

	USE	PARMS	DESC	EXAMPLE
Commands	YES	YES	YES	YES
ENV variables	NO	NO	YES	NO
Functions	YES	YES	YES	YES
Macros	YES	YES	YES	YES
User variables	NO	NO	NO	NO

Examples

   $nmdat > help dc
   "dc" is a NUMBER, and a COMMAND name.


   cmd DC          display     nm cm

   USE:

   DC  logaddr  [count]  [base]  [recw]  [bytew]

   PARMS:

   logaddr  The logical code address of the first byte of code to be
            displayed.  Short pointers are treated as program file off-
            sets (NM) or offsets in the currently executing code segment
            (CM).  Long pointers are unambiguous in NM, but are treated
            as a CM program file seg.offset in CM.
   count    The number of words to be displayed (default = 1).
   base     The desired output base/mode of representation:
            OCT, %     Octal.
            DEC, #     Decimal.
            HEX, $     Hexadecimal.
            ASCII      Character output, separated at word boundaries.
            BOTH       Both numeric (current output base) and ASCII.
            CODE       Disassembled code.
            STRING     Continuous character output.
   recw     The number of words to be displayed per line when the code
            is not disassembled.  Defaults are 4 (CM) and 8 (NM).
   bytew    The width in bytes of the displayed values when the code is
            not disassembled.  Used to determine the output spacing, and
            may be 1, 2 (CM default) or 4 (NM default).

   DESC:

   The DC (Display Code) command displays CM or NM program file code.
   Library code may also be displayed based on the type of the LOGADDR
   parameter (e.g., GRP(1.70), SYS(1.40)), or by using the appropriate
   Display Code command variant (e.g., DCG, DCS, and so on.).
   By default, disassembled code is displayed one instruction per line.

   EXAMPLE:

   $ nmdebug > dc FOPEN,4
   SYS $a.3714f8
   003714f8  FOPEN     6bc23fd9  STW      2,-20(0,30)
   003714fc  FOPEN+$4  37de00d0  LDO      104(30),30
   00371500  FOPEN+$8  6bda3ee9  STW      26,-140(0,30)
   00371504  FOPEN+$c  67d93ee5  STH      25,-142(0,30)

   $nmdat > help dc, desc

   "dc" is a NUMBER, and a COMMAND name.

   cmd DC          display     nm cm

   DESC:

   The DC (Display Code) command displays CM or NM program file code.
   Library code may also be displayed based on the type of the LOGADDR
   parameter (e.g., GRP(1.70), SYS(1.40)), or by using the appropriate
   Display Code command variant (e.g., DCG, DCS, and so on.).
   By default, disassembled code is displayed one instruction per line.

   $nmdat >

   $nmdat > help 123
   "123" is a NUMBER.

Limitations, Restrictions