HELPADM(1M)         RISC/os Reference Manual          HELPADM(1M)



NAME
     helpadm - make changes to the Help Facility database

SYNOPSIS
     /etc/helpadm

DESCRIPTION
     The UNIX system Help Facility Administration command, hel-
     padm, allows UNIX system administrators and command develop-
     ers to define the content of the Help Facility database for
     specific commands and to monitor use of the Help Facility.
     The helpadm command can only be executed by login root,
     login bin, or a login that is a member of group bin.

     The helpadm command prints a menu of 3 types of Help Facil-
     ity data which can be modified, and 2 choices relating to
     monitoring use of the Help Facility.  The five choices are:

     - modify startup data

     - add, modify, or delete a glossary term

     - add, modify, or delete command data (description, options,
       examples, and keywords)

     - prevent monitoring use of the Help Facility (login root
       and login bin only)

     - permit monitoring use of the Help Facility (login root and
       login bin only)

     The user may make one of the above choices by entering its
     corresponding letter (given in the menu), or may exit to the
     shell by typing q (for "quit").

     If one of the first three choices is chosen, then the user
     is prompted for additional information; specifically, which
     startup screen, glossary term definition, or command
     description is to be modified.  The user may also be
     prompted for information to identify whether the changes to
     the database are additions, modifications, or deletions.  If
     the user is modifying existing data or adding new data, then
     they are prompted to make the appropriate
     modifications/additions.  If the user is deleting a glossary
     term or a command from the database, then they must respond
     affirmatively to the next query in order for the deletion to
     be done.  In any case, before the user's changes are final,
     they must respond affirmatively when asked whether they are
     sure they want their requested database changes to be done.

     By default, helpadm will put the user into ed(1) to make
     additions/modifications to database information.  If the



                        Printed 11/19/92                   Page 1

HELPADM(1M)         RISC/os Reference Manual          HELPADM(1M)



     user wishes to be put into a different editor, then they
     should set the environment variable EDITOR in their environ-
     ment to the desired editor, and then export EDITOR .

     If the user chooses to monitor/prevent monitoring use of the
     Help Facility, the choice made is acted on with no further
     interaction by the user.

SEE ALSO
     ed(1), glossary(1), help(1), locate(1), starter(1),
     usage(1).

WARNINGS
     When the UNIX system is delivered to a customer,
     /etc/profile exports the environment variable LOGNAME. If
     /etc/profile has been changed so that LOGNAME is not
     exported, then the options to monitor/prevent monitoring use
     of the Help Facility may not work properly.

FILES
     HELPLOG        /usr/lib/help/HELPLOG
     helpclean      /usr/lib/help/helpclean

































 Page 2                 Printed 11/19/92