home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / ibmtool.zip / ihelp.h < prev    next >
Text File  |  1997-11-07  |  22KB  |  602 lines

  1.  
  2. struct IHELP {
  3.   char *cmd;
  4.   char *syntax[10];
  5. } IHelp[] =
  6. {
  7. { " ADDMC     ", { " ",
  8.                    " ",
  9.                    " ",
  10.                    "      Syntax: ADDMC xx xx xx xx xx xx",
  11.                    " Description: Calls the MAC's AddMulticastAddress function.",
  12.                    "     Example: ADDMC C0 00 80 03 04 05",
  13.                    " ",
  14.                    " ",
  15.                    " ",
  16.                    " "  }
  17. },
  18. { " CHKDATA   ", { " ",
  19.                    " ",
  20.                    " ",
  21.                    "      Syntax: CHKDATA {'ON' | 'OFF'} {'STOP' | 'NOSTOP'}",
  22.                    " Description: Sets data checking on received frames and",
  23.                    "              whether or not to halt execution.",
  24.                    " ",
  25.                    " ",
  26.                    " ",
  27.                    " " }
  28. },
  29. { " CHKIND    ", { " ",
  30.                    "      Syntax: CHKIND [<Count>] [<Type>]",
  31.                    "              Type = RX | TX | ICOMP | GENREQ | ",
  32.                    "                     STAT [<StatType>]",
  33.                    "              StatType = RING | ADAPTER | START | END |",
  34.                    "                         INT",
  35.                    " Description: Checks for a total Count or a Count of Type",
  36.                    "              indications received from the MAC.",
  37.                    " ",
  38.                    " " }
  39. },
  40. { " CHKLK     ", { " ",
  41.                    " ",
  42.                    " ",
  43.                    "      Syntax: CHKLK <Length>",
  44.                    " Description: Checks the last ReceiveLookahead Length",
  45.                    "              for a value of Length.",
  46.                    " ",
  47.                    " ",
  48.                    " ",
  49.                    " " }
  50. },
  51. { " CHKSTAT   ", { " ",
  52.                    " ",
  53.                    " ",
  54.                    " ",
  55.                    "      Syntax: CHKSTAT <Value>",
  56.                    " Description: Checks an internal variable for a value of Value.",
  57.                    " ",
  58.                    " ",
  59.                    " ",
  60.                    " " }
  61. },
  62. { " CHKTOKEN  ", { " ",
  63.                    " ",
  64.                    " ",
  65.                    "      Syntax: CHKTOKEN",
  66.                    " Description: Returns a status of SUCCESS if the MAC is",
  67.                    "              a TokenRing type, else returns GENERAL_FAILURE",
  68.                    " ",
  69.                    " ",
  70.                    " ",
  71.                    " " }
  72. },
  73. { " CLOSE     ", { " ",
  74.                    " ",
  75.                    " ",
  76.                    "      Syntax: CLOSE",
  77.                    " Description: Calls the MAC's CloseAdapter function.",
  78.                    " ",
  79.                    " ",
  80.                    " ",
  81.                    " ",
  82.                    " " }
  83. },
  84. { " CLRIND    ", { " ",
  85.                    " ",
  86.                    " ",
  87.                    "      Syntax: CLRIND",
  88.                    " Description: Zeroes out the indication counters used by CKHIND.",
  89.                    " ",
  90.                    " ",
  91.                    " ",
  92.                    " ",
  93.                    " " }
  94. },
  95. { " CLRMAC    ", { " ",
  96.                    " ",
  97.                    "      Syntax: CLRMAC",
  98.                    " Description: Sets packet filter to 0, clears the Multicast",
  99.                    "              Address List, closes the adapter, and sets the",
  100.                    "              Current Station Address to the Permanent",
  101.                    "              Station Address.",
  102.                    " ",
  103.                    " ",
  104.                    " " }
  105. },
  106. { " CSTAT     ", { " ",
  107.                    " ",
  108.                    " ",
  109.                    "      Syntax: CSTAT",
  110.                    " Description: Calls the MAC's ClearStatistics function.",
  111.                    " ",
  112.                    " ",
  113.                    " ",
  114.                    " ",
  115.                    " " }
  116. },
  117. { " DELMC     ", { " ",
  118.                    " ",
  119.                    " ",
  120.                    "      Syntax: DELMC xx xx xx xx xx xx",
  121.                    " Description: Calls the MAC's DeleteMulticastAddress function.",
  122.                    "     Example: DELMC C0 00 80 03 04 05",
  123.                    " ",
  124.                    " ",
  125.                    " ",
  126.                    " " }
  127. },
  128. { " ECHO      ", { " ",
  129.                    " ",
  130.                    " ",
  131.                    "      Syntax: ECHO",
  132.                    " Description: Toggles the echo mode.",
  133.                    "              If echo mode is on, all frames received by the",
  134.                    "              MAC are transmitted back to their source.",
  135.                    " ",
  136.                    " ",
  137.                    " " }
  138. },
  139. { " EDITBUF   ", { "      Syntax: EDITBUF <I | #> <hexdata>",
  140.                    " Description: Allows input of data into the Transmit Buffer.",
  141.                    "                I = Immediate Tx buffer; # = Tx buffer # (0 - n)",
  142.                    "     Example: EDITBUF I 10 40 62*FF",
  143.                    "                Sets the first 2 bytes of the Immed Tx buffer",
  144.                    "                to 0x10 and 0x40 and fills the next 62 bytes of",
  145.                    "                the Immed Tx buffer with FF's.",
  146.                    "              EDITBUF 0 100*11",
  147.                    "                Fills the first 100 bytes of Tx data buffer 0",
  148.                    "                with 0x11." }
  149. },
  150. { " EXIT      ", { " ",
  151.                    " ",
  152.                    " ",
  153.                    "      Syntax: EXIT",
  154.                    " Description: Exit the Test Tool.",
  155.                    " ",
  156.                    " ",
  157.                    " ",
  158.                    " ",
  159.                    " " }
  160. },
  161. { " FILTER    ", { " ",
  162.                    "      Syntax: FILTER <#>",
  163.                    "                 # = 0 - (Directed and Multicast) or",
  164.                    "                         (Group and Functional)",
  165.                    "                     1 - Broadcast",
  166.                    "                     2 - Promiscuous",
  167.                    "                     3 - Any Source Routing Packet",
  168.                    " Description: Calls the MAC's SetPacketFilter function.",
  169.                    " ",
  170.                    " " }
  171. },
  172. { " FUNADR    ", { " ",
  173.                    " ",
  174.                    " ",
  175.                    "      Syntax: FUNADR xx xx xx xx",
  176.                    " Description: Calls the MAC's SetFunctionalAddress function.",
  177.                    "     Example: FUNADR 01 02 03 04",
  178.                    " ",
  179.                    " ",
  180.                    " ",
  181.                    " " }
  182. },
  183. { " INDCOMP   ", { " ",
  184.                    " ",
  185.                    " ",
  186.                    "      Syntax: INDCOMP",
  187.                    " Description: Causes TestMAC to generate an IndicationComplete",
  188.                    "              indication to WEDGE.",
  189.                    " ",
  190.                    " ",
  191.                    " ",
  192.                    " " }
  193. },
  194. { " INDICOFF  ", { " ",
  195.                    " ",
  196.                    " ",
  197.                    "      Syntax: INDICOFF",
  198.                    " Description: Calls the MAC's IndicationOff function.",
  199.                    " ",
  200.                    " ",
  201.                    " ",
  202.                    " ",
  203.                    " " }
  204. },
  205. { " INDICON  ",  { " ",
  206.                    " ",
  207.                    " ",
  208.                    "      Syntax: INDICON",
  209.                    " Description: Calls the MAC's IndicationOn function.",
  210.                    " ",
  211.                    " ",
  212.                    " ",
  213.                    " ",
  214.                    " " }
  215. },
  216. { " INITDIAG  ", { " ",
  217.                    " ",
  218.                    " ",
  219.                    "      Syntax: INITDIAG",
  220.                    " Description: Calls the MAC's InitiateDiagnostics function.",
  221.                    " ",
  222.                    " ",
  223.                    " ",
  224.                    " ",
  225.                    " " }
  226. },
  227. { " INTREQ    ", { " ",
  228.                    " ",
  229.                    " ",
  230.                    "      Syntax: INTREQ",
  231.                    " Description: Calls the MAC's InterruptRequest function.",
  232.                    " ",
  233.                    " ",
  234.                    " ",
  235.                    " ",
  236.                    " " }
  237. },
  238. { " LOG       ", { " ",
  239.                    " ",
  240.                    " ",
  241.                    "      Syntax: LOG <Filename>",
  242.                    " Description: Causes all commands and messages to be logged.",
  243.                    " ",
  244.                    " ",
  245.                    " ",
  246.                    " ",
  247.                    " " }
  248. },
  249. { " MODOPEN   ", { " ",
  250.                    " ",
  251.                    "      Syntax: MODOPEN <OpenOptions> [ExtendedRet]",
  252.                    " Description: Modifies the Open Options for a",
  253.                    "              Token Ring Adapter.",
  254.                    "     Example: MODOPEN ????",
  255.                    "                 ??????????",
  256.                    " ",
  257.                    " ",
  258.                    " " }
  259. },
  260. { " MONITOR   ", { " ",
  261.                    " ",
  262.                    " ",
  263.                    "      Syntax: MONITOR",
  264.                    " Description: Sets the program into Monitor mode.",
  265.                    "              This essentially takes the program out of",
  266.                    "              Server mode or Workstation mode.",
  267.                    " ",
  268.                    " ",
  269.                    " " }
  270. },
  271. { " MULTRAN   ", { " ",
  272.                    "      Syntax: MULTRAN [FrameCount] [<Min> <Max>] [<Type>]",
  273.                    " Description: Broadcasts <FrameCount> frames of length <Min> to",
  274.                    "              length <Max>.",
  275.                    "     Example: MULTRAN 10 100 200",
  276.                    "                Broadcasts 10 frames with lengths ranging from",
  277.                    "                100 to 200 bytes.",
  278.                    "              MULTRAN 20",
  279.                    "                Broadcasts 20 frames ranging in length from the",
  280.                    "                the minimum to the maximum frame size." }
  281. },
  282. { " OPEN      ", { " ",
  283.                    " ",
  284.                    " ",
  285.                    "      Syntax: OPEN",
  286.                    " Description: Calls the MAC's OpenAdapter function.",
  287.                    " ",
  288.                    " ",
  289.                    " ",
  290.                    " ",
  291.                    " " }
  292. },
  293. { " READLOG   ", { " ",
  294.                    " ",
  295.                    " ",
  296.                    "      Syntax: READLOG <LogLen>",
  297.                    " Description: Calls the MAC's ReadErrorLog function.",
  298.                    "     Example: READLOG 10",
  299.                    "                Reads 10 bytes from the MAC's Error Log, if any.",
  300.                    " ",
  301.                    " ",
  302.                    " " }
  303. },
  304. { " READMAC   ", { " ",
  305.                    "      Syntax: READMAC <TableId> <ByteOffset> [<Op> <TestValue>]",
  306.                    "                 TableId  = MCC | MSC | MSS | MMC",
  307.                    "                 Operator = '=' | '&'",
  308.                    " Description: Reads a byte at <ByteOffset> from the given MAC",
  309.                    "              <TableId> and compares it for equality or masking",
  310.                    "              with the given <TestValue>.",
  311.                    "     Example: READMAC MSC 6 = 5",
  312.                    "                 Tests byte 6 of the MAC's Service-Specific",
  313.                    "                 Characteristics Table for a value of '5'." }
  314. },
  315. { " REQCONF   ", { " ",
  316.                    " ",
  317.                    " ",
  318.                    "      Syntax: REQCONF <Handle> <OriginalCommand> <Status>",
  319.                    " Description: Causes TestMAC to generate a General Request",
  320.                    "              Confirmation indication to WEDGE.",
  321.                    " ",
  322.                    " ",
  323.                    " ",
  324.                    " " }
  325. },
  326. { " RESET     ", { " ",
  327.                    " ",
  328.                    " ",
  329.                    "      Syntax: RESET",
  330.                    " Description: Calls the MAC's ResetAdapter function.",
  331.                    " ",
  332.                    " ",
  333.                    " ",
  334.                    " ",
  335.                    " " }
  336. },
  337. { " RUN       ", { " ",
  338.                    " ",
  339.                    " ",
  340.                    "      Syntax: RUN <Filename> [<LogFile>]",
  341.                    " Description: Processes commands from the given File.",
  342.                    " ",
  343.                    " ",
  344.                    " ",
  345.                    " ",
  346.                    " " }
  347. },
  348. { " RXBUF     ", { " ",
  349.                    " ",
  350.                    " ",
  351.                    "      Syntax: RXBUF ['P']",
  352.                    " Description: Displays the current Receive buffer.",
  353.                    "              'P' = pause mode",
  354.                    " ",
  355.                    " ",
  356.                    " ",
  357.                    " " }
  358. },
  359. { " RXCHAIN   ", { " ",
  360.                    " ",
  361.                    " ",
  362.                    "      Syntax: RXCHAIN [Type] [FrameLength] [PassFrameLength]",
  363.                    "                        [Handle]",
  364.                    " Description: Causes TestMAC to generate a ReceiveChain",
  365.                    "              indication to WEDGE.",
  366.                    " ",
  367.                    " ",
  368.                    " " }
  369. },
  370. { " RXLOOK    ", { " ",
  371.                    " ",
  372.                    " ",
  373.                    "      Syntax: RXLOOK [Type] [FrameLength] [PassFrameLength]",
  374.                    "                        [LookaheadLength]",
  375.                    " Description: Causes TestMAC to generate a ReceiveLookahead",
  376.                    "              indication to WEDGE.",
  377.                    " ",
  378.                    " ",
  379.                    " " }
  380. },
  381. { " RXRLS     ", { " ",
  382.                    " ",
  383.                    " ",
  384.                    "      Syntax: RXRLS",
  385.                    " Description: Calls the MAC's ReceiveRelease function.",
  386.                    " ",
  387.                    " ",
  388.                    " ",
  389.                    " ",
  390.                    " " }
  391. },
  392. { " RXSIZE    ", { " ",
  393.                    "      Syntax: RXSIZE [BufferSize(s)]",
  394.                    " Description: Sets the Receive data buffer size(s).",
  395.                    "              If no parameters are specified, the current",
  396.                    "              Receive data buffer sizes are displayed.",
  397.                    "     Example: RXSIZE 64 100 200",
  398.                    "                Sets the Immediate Data buffer size to 64 bytes",
  399.                    "                and adds 2 extra Tx data buffers of 100 and 200",
  400.                    "                bytes.",
  401.                    " " }
  402. },
  403. { " RXWAIT    ", { " ",
  404.                    " ",
  405.                    " " ,
  406.                    "      Syntax: RXWAIT",
  407.                    " Description: Causes WEDGE to return WAIT_FOR_RELEASE on",
  408.                    "              completion of a ReceiveChain indication.",
  409.                    " ",
  410.                    " ",
  411.                    " ",
  412.                    " " }
  413. },
  414. { " SERVER    ", { " ",
  415.                    " ",
  416.                    " ",
  417.                    "      Syntax: SERVER",
  418.                    " Description: Sets the program into Server mode.",
  419.                    " ",
  420.                    " ",
  421.                    " ",
  422.                    " ",
  423.                    " " }
  424. },
  425. { " SETLOOK   ", { " ",
  426.                    " ",
  427.                    " ",
  428.                    "      Syntax: SETLOOK <LookLength>",
  429.                    " Description: Calls the MAC's SetLookahead function.",
  430.                    "     Example: SETLOOK 256",
  431.                    "                Sets the MAC's ReceiveLookahead Length at 256.",
  432.                    " ",
  433.                    " ",
  434.                    " " }
  435. },
  436. { " SETSTAT   ", { " ",
  437.                    " ",
  438.                    " ",
  439.                    "      Syntax: SETSTAT <Value>",
  440.                    " Description: Sets an internal variable to the given Value.",
  441.                    " ",
  442.                    " ",
  443.                    " ",
  444.                    " ",
  445.                    " " }
  446. },
  447. { " SETSTN    ", { " ",
  448.                    " ",
  449.                    "      Syntax: SETSTN <AdaptAddr>",
  450.                    " Description: Calls the MAC's SetStationAddress function.",
  451.                    "     Example: SETSTN 01 02 03 04 05 06",
  452.                    "                 If supported, sets the MAC's Current Station",
  453.                    "                 Address at 01 02 03 04 05 06",
  454.                    " ",
  455.                    " ",
  456.                    " " }
  457. },
  458. { " SLEEP     ", { " ",
  459.                    " ",
  460.                    " ",
  461.                    "      Syntax: SLEEP <Seconds>",
  462.                    " Description: Cause the Test Tool to idle for given value.",
  463.                    " ",
  464.                    " ",
  465.                    " ",
  466.                    " ",
  467.                    " " }
  468. },
  469. { " SRVTX     ", { " ",
  470.                    " ",
  471.                    "      Syntax: SRVTX [FrameCount] [<Min> <Max>] [<Type>]",
  472.                    "              Type = 0 Broadcast (default)",
  473.                    "                   = 1 <NetAddr> - Directed to an address",
  474.                    "                   = 2 - Directed to the requester",
  475.                    " Description: Commands a server to transmit a packet similar to",
  476.                    "               the MULTRAN command.",
  477.                    " ",
  478.                    " " }
  479. },
  480. { " STATIND   ", { " ",
  481.                    " ",
  482.                    " ",
  483.                    "      Syntax: STATIND <Opcode> <Param>",
  484.                    " Description: Causes TestMAC to generate a Status Indication",
  485.                    "              indication to WEDGE.",
  486.                    " ",
  487.                    " ",
  488.                    " ",
  489.                    " " }
  490. },
  491. { " STRESS    ", { " ",
  492.                    "      Syntax: STRESS [FrmCount] [Tolerance] ['NOSTOP'] ['NOCHK']",
  493.                    "                FrameCount = stress frame limit (DEF = 1000000)",
  494.                    "                Tolerance  = xmit frame attempt fail limit",
  495.                    "                             (DEFAULT = 10000)",
  496.                    "                'NOSTOP'   = do not halt on data errors",
  497.                    "                'NOCHK'    = do not perform data validation",
  498.                    " Description: Starts the stress test.",
  499.                    " ",
  500.                    " " }
  501. },
  502. { " TRAN      ", { " ",
  503.                    " ",
  504.                    " ",
  505.                    "      Syntax: TRAN",
  506.                    " Description: Transmits the current Tx buffer.",
  507.                    " ",
  508.                    " ",
  509.                    " ",
  510.                    " ",
  511.                    " " }
  512. },
  513. { " TXBUF     ", { " ",
  514.                    " ",
  515.                    " ",
  516.                    "      Syntax: TXBUF ['P']",
  517.                    " Description: Displays the Transmit data buffer.",
  518.                    "              'P' = pause mode",
  519.                    " ",
  520.                    " ",
  521.                    " ",
  522.                    " " }
  523. },
  524. { " TXCONF    ", { " ",
  525.                    " ",
  526.                    " ",
  527.                    "      Syntax: TXCONF <Handle> <Status>",
  528.                    " Description: Causes TestMAC to generate a TransmitConfirm",
  529.                    "              indication to WEDGE.",
  530.                    " ",
  531.                    " ",
  532.                    " ",
  533.                    " " }
  534. },
  535. { " TXSIZE    ", { " ",
  536.                    "      Syntax: TXSIZE [BufferSize(s)]",
  537.                    " Description: Sets the Transmit data buffer size(s).",
  538.                    "              If no parameters are specified, the current",
  539.                    "              Receive data buffer sizes are displayed.",
  540.                    "     Example: TXSIZE 64 100 200",
  541.                    "                Sets the Immediate Data buffer size to 64 bytes",
  542.                    "                and adds 2 extra Tx data buffers of 100 and 200",
  543.                    "                bytes.",
  544.                    " " }
  545. },
  546. { " USEGDT    ", { " ",
  547.                    " ",
  548.                    " ",
  549.                    "      Syntax: USEGDT",
  550.                    " Description: Toggles GDT usage for Transmit commands",
  551.                    "              (i.e. TRAN and MULTRAN).",
  552.                    " ",
  553.                    " ",
  554.                    " ",
  555.                    " " }
  556. },
  557. { " USTAT     ", { " ",
  558.                    " ",
  559.                    " ",
  560.                    "      Syntax: USTAT",
  561.                    " Description: Calls the MAC's UpdateStatistics function.",
  562.                    " ",
  563.                    " ",
  564.                    " ",
  565.                    " ",
  566.                    " " }
  567. },
  568. { " WKSTA     ", { " ",
  569.                    " ",
  570.                    " ",
  571.                    "      Syntax: WKSTA",
  572.                    " Description: Sets the program into Workstation mode.",
  573.                    " ",
  574.                    " ",
  575.                    " ",
  576.                    " ",
  577.                    " " }
  578. },
  579. { " XFERDATA  ", { " ",
  580.                   " ",
  581.                   " ",
  582.                   "      Syntax: XFERDATA",
  583.                   " Description: Calls the MAC's TransferData function.",
  584.                   " ",
  585.                   " ",
  586.                   " ",
  587.                   " ",
  588.                   " " }
  589. },
  590. { "END"       , { "",
  591.                   "",
  592.                   "",
  593.                   "",
  594.                   "",
  595.                   "",
  596.                   "",
  597.                   "",
  598.                   "",
  599.                   "" }
  600. } };
  601.  
  602.