helpadm(8)                          CLIX                          helpadm(8)



  NAME

    helpadm - Makes changes to the Help Facility database

  SYNOPSIS

    /etc/helpadm

  DESCRIPTION

    The system Help Facility Administration command, helpadm, allows system
    administrators and command developers 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 displays a menu of 3 types of Help Facility data that
    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 Help Facility usage (login root and login bin only)

    ⊕  Permit monitoring Help Facility usage (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 entering <q> (for
    quit).

    If users select one of the first three choices, they are prompted for
    additional information; specifically, which startup screen, glossary term
    definition, or command description is to be modified.  The users can also
    be prompted for information to determine whether the changes to the
    database are additions, modifications, or deletions.  When users modify
    existing data or add new data, they are prompted to make the appropriate
    modifications/additions.  If users delete a glossary term or a command
    from the database, they must respond affirmatively to the next query in
    order for the deletion to be carried out.  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 users want to access
    a different editor, they should set the environment variable $EDITOR in
    their environment to the desired editor, then export $EDITOR.



  2/94 - Intergraph Corporation                                              1

  helpadm(8)                          CLIX                          helpadm(8)



    If users choose to monitor/prevent monitoring of the Help Facility usage,
    the choice made is acted on without further input from the users.

  FILES

    /usr/lib/help/HELPLOG   HELPLOG

    /usr/lib/help/helpclean helpclean

  NOTES

    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
    of the Help Facility may not work properly.

  DIAGNOSTICS

    The following messages are displayed if you attempt to enable or disable
    monitoring of Help Facility usage and are not logged in as either root or
    bin:

    ⊕  The only users who can prevent monitoring of the help facility are root
       and bin.

    ⊕  The only users who can enable monitoring of the help facility are root
       and bin.

  EXIT VALUES

    The exit values are not valid for the helpadm command.

  RELATED INFORMATION

    Commands: ed(1), glossary(1), help(1), locate(1), starter(1), usage(1)



















  2                                              Intergraph Corporation - 2/94