NS3000/iX Operations and Maintenance Reference Manual (36922-90039)

104 Chapter6
Using NETTOOL
Adding Your Own Tools
To Add User Provided Help
To provide help on user tools, you must create the file
USERHELP.NET.SYS. This file should contain help text for all user tools
defined in USERINFO.net.sys.
Use the following format for help text:
1. There must be an \ENTRY=ROOT block which gives a one word list of
the user-defined NETTOOL commands. These commands are the
same as those defined in USERINFO.NET.SYS. This is the text that
will be displayed when the user types help with no parameters at
the root level.
2. Within the \ENTRY=ROOT block, there must be an \item=commands
block that contains a one line description of the user-defined
commands that run the tools. This is the text that will be displayed
when the user types help commands at the root level.
3. Within the \ENTRY=ROOT block, there must be an
\ITEM=command_name block for each of the tools. These blocks
contain the text that is displayed when the user types help
command_name at the root level where command_name is a user
command defined in USERINFO.NET.SYS.
4. There must be an \ALL directive at the end of the help text.
A sample USERhelp file is included as part of the NETTOOL package.
See the example on the next page.
For a user-defined tool defined as follows:
mytool
!file input=parms.net.sys
!run myprog.net.sys
The user help might look like this:
\ENTRY=ROOT MYTOOL
MYTOOL
\ITEM=COMMANDS
MYTOOLExamines the path cache and purges all entries
\ITEM=MYTOOL
If you suspect that the path cache is out of unused
entries or that duplicate IP addresses have been
defined, use MYTOOL to clear the entire cache.
\ALL
1. You must format the help file into a help catalog using
MAKECAT.PUB.SYS, as follows:
file input=sourcefilename
run makecat.pub.sys,help