


!=====================================================================
!        This file is NOT to be edited.  Edit the input file (see
!        RUNOFF Source File:) to make the changes that you want, and
!        then use the RNOTOHLP tool on it.
!
! RUNOFF Source File:
!        $RNOTOHLP.TMP
!
! Command Used:
!        $ RNOTOHLP  $RNOTOHLP.TMP  "HLBQUALS.HLP"  "1" "HLBQUALS"
!
! History:
!        This file was created by AMBY on the CSD630 system
!        at  9-FEB-1991 11:14:39.74 with the RNOTOHLP tool.
!=====================================================================
1 HLBQUALS

This tool was put together in a attempt to provide some convenient way to
help document what qualifiers are defined for what tools. This will generate
an output file that lists the qualifiers for a particular help topic from a
help library.

         $ HLBQUALS  hlp_topic  [out_file  [hlb_lib]]


Optional parameters are indicated by square brackets [optional-parm]. Null
parameters on the command line are indicated by a "".
2 Parameters

The following are the parameters that can be included on the command line,
in the order of their appearance.

         hlp_topic       Help topic for qualifiers.
         out_file        Output file. If omitted, the default is used.
         hlb_lib         Help library (defualt is system help library).
3 hlp_topic

This is the help topic for which you wish to generate a listing of the
qualifiers. This must exist in the help library that you use.
3 out_file

This is the name of the output file. If omitted, then the name is
determined from the 'hlp_topic'. The 'hlp_topic' is the filename and the
filetype is ".QUALIFIERS".

For example, if the hlp_topic is MACRO, then the default output file will
be MACRO.QUALIFIERS.
3 hlb_lib

This is the name of the help library that you will find the 'hlp_topic'
in. If you omit this, then the default is to use the system help library.
2 Tools_Used

The following tools are used within this tool.

         GREP    This is a Unix-like search tool, that is very powerful.
2 Logicals

There are several logical names that you may use to specify user specific
features to this tool.
3 HLBQUALS_DEBUG

If defined to be "TRUE" the tool runs in DEBUG mode. This can be useful
during testing, as it causes additional output to let you know what the
tool is 'really' doing.

If undefined, the default is "FALSE".

         $ DEFINE HLBQUALS_DEBUG TRUE
3 HLBQUALS_VERIFY

If defined to be "TRUE" verification is turned on within the tool. This
does require that you have READ access to the DCL procedure for the tool
(if there is one).

         $ DEFINE HLBQUALS_VERIFY        TRUE
3 TOOLS$MODE

This is used to allow you to tailor the user interface, by giving the
minimal amount of information when prompting you for parameters, etc.,
when it is defined as "EXPERT".

If undefined, "NOVICE" is assumed.

         $ DEFINE TOOLS$MODE     EXPERT
3 USER$EDIT

This defines a DCL command string that is used for any user edit commands
within the tool. This allows you to specify what editor you want to use,
when the tool invokes a text editor interactivele.

If undefined, then "EDIT/EDT" is assumed.

         $ DEFINE USER$EDIT      LSEDIT  ! to use LSEDIT
3 SYS$SCRATCH

This logical name is used to point to where temporary files can be
created. It is defined at login time to point to your SYS$LOGIN
directory, but you can redefined it to point to any other directory that
you wish.
2 Examples

The following are some examples of how to use this tool.

      *  Generate a listing of qualifiers for the MACRO topic, from the
         system help library, and have the output in the default output
         file (MACRO.QUALIFIERS).

                 $ HLBQUALS MACRO

      *  As previous example, but this time have the output written to the
         file MACRO.LST.

                 $ HLBQUALS MACRO MACRO.LST

2 Author

         Donald E. Amby

         Harnischfeger Engineers, Inc.
         P.O. Box 1512             or    13400 Bishops Lane
         Milwaukee, WI 53201             Brookfield, WI 53005

         414-797-6713, 414-797-6533 (FAX)

         DECUServe,DCS:  AMBY
         CompuServe:     73547,3256
         Internet:       don@amby.mixcom.com     (home)
                         amby@eisner.decus.org   (DECUServe)
         UUCP:           uunet!mixcom!amby!don   (home)
                         {decwrl,nosc,crash}!simpact!eisner!amby
