NAME

edsysadm - sysadm interface editing tool

SYNOPSIS

edsysadm

DESCRIPTION

edsysadm is an interactive tool that adds or changes either menu and task definitions in the sysadm interface. It can be used to make changes directly on-line on a specific machine or to create changes that will become part of a software package. The command creates the administration files necessary to achieve the requested changes in the interface and either places them in the appropriate place for on-line changes or saves them to be included in a software package. edsysadm presents several screens, first prompting for which type of menu item you want to change, menu or task, and then for what type of action to take, add or change. When you select add, a blank menu or task definition (as described below) is provided for you to fill in. When you select change, a series of screens is presented to help identify the definition you wish to change. The final screen presented is the menu or task definition filled in with its current values, which you can then edit. The menu definition prompts and their descriptions are:

Menu Name The name of the new menu (as it should appear in the lefthand column of the screen). This field has a maximum length of 16 alphanumeric characters.

Menu Description A description of the new menu (as it should appear in the righthand column of the screen). This field has a maximum length of 58 characters and can consist of any alphanumeric character except at sign (@), carat (^), tilde (~), back grave (`), grave ('), and double quotes (").

Menu Location The location of the menu in the menu hierarchy, expressed as a menu pathname. The pathname should begin with the main menu followed by all other menus that must be traversed (in the order they are traversed) to access this menu. Each menu name must be separated by colons. For example, the menu location for a menu entry being added to the Applications menu is main:applications. Do not include the menu name in this location definition. The complete pathname to this menu entry will be the menu location plus the menu name defined at the first prompt.

This is a scrollable field, showing a maximum of 50 alphanumeric characters at a time.

Menu Help File Name Pathname to the item help file for this menu entry. If it resides in the directory from which you invoked edsysadm, you do not need to give a full pathname. If you name an item help file that does not exist, you are placed in an editor (as defined by $EDITOR) to create one. The new file is created in the current directory and named Help. The task definition prompts and their descriptions are:

Task Name The name of the new task (as it should appear in the lefthand column of the screen). This field has a maximum length of 16 alphanumeric characters.

Task Description A description of the new task (as it should appear in the righthand column of the screen). This field has a maximum length of 58 characters and can consist of any alphanumeric character except at sign (@), carat (^), tilde (~), back grave (`), grave ('), and double quotes (").

Task Location The location of the task in the menu hierarchy, expressed as a pathname. The pathname should begin with the main menu followed by all other menus that must be traversed (in the order they are traversed) to access this task. Each menu name must be separated by colons. For example, the task location for a task entry being added to the applications menu is main:applications. Do not include the task name in this location definition. The complete pathname to this task entry will be the task location as well as the task name defined at the first prompt.

This is a scrollable field, showing a maximum of 50 alphanumeric characters at a time.

Task Help File Name Pathname to the item help file for this task entry. If it resides in the directory from which you invoked edsysadm, you do not need to give a full pathname. If you name an item help file that does not exist, you are placed in an editor (as defined by $EDITOR) to create one. The new file is created in the current directory and named Help.

Task Action The FACE form name or executable that will be run when this task is selected. This is a scrollable field, showing a maximum of 58 alphanumeric characters at a time. This pathname can be relative to the current directory as well as absolute.

Task Files               Any FACE objects or  other  execut-
                         ables  that support the task action
                         listed above and  might  be  called
                         from  within  that  action.  Do not
                         include the help file name  or  the
                         task  action  in  this list.  Path-
                         names  can  be  relative   to   the
                         current  directory as well as abso-
                         lute.  A dot (.) implies "all files
                         in   the   current  directory"  and
                         includes files in subdirectories.
                         This is a scrollable field, showing
                         a  maximum of 50 alphanumeric char-
                         acters at a time.  Once the menu or
                         task  has been defined, screens for
                         installing the menu or task or sav-
                         ing    them   for   packaging   are
                         presented.  The package creation or
                         on-line  installation  is  verified
                         and   you   are    informed    upon
                         completion.

NOTES

For package creation or modification, this command automatically creates a menu information file and a prototype file in the current directory (the directory from which the command is executed). The menu information file is used during package installation to modify menus in the menu structure. A prototype file is an installation file which gives a listing of package contents. The prototype file created by edsysadm lists the files defined under task action and gives them the special installation class of "admin". The contents of this prototype file must be incorporated in the package prototype file. For on-line installation, edsysadm automatically creates a menu information file and adds or modifies the interface menu structure directly. The item help file must follow the format shown in the Application Programmer's Guide in the ``Customizing the Administration Interace'' chapter or in the System Administrator's Guide in the ``Customizing the sysadm Interface'' appendix.

SEE ALSO

delsysadm(1M), pkgmk(1), prototype(4), sysadm(1M)