
kinstall(1)                  Khoros                   kinstall(1)

PROGRAM
     kinstall - A utility for installing new routines in the
     khoros environment.

SYNTAX
     kinstall

     -name          program name

     -conf          input config file

     [-toolbox]     input toolbox name

     [-fprog]       fprog option

     [-force]       Force option

     [-V]           Gives the version for kinstall

     [-U]           Gives the usage for kinstall

     [-P]           Prompts for command line options

     [-A [file1]]   Creates the answer file called kinstall.ans
                    or file1

     [-a [file1]]   Uses kinstall.ans or file1 as the answer file

DESCRIPTION
     kinstall is a routine for installing new routines within the
     khoros environment.  The driver program "kinstall" calls a
     shell script to do the work.  This command is usually exe-
     cuted in the directory that contains the routine to install.
     The routine to install can consist of a pane file (*.pane),
     a prog file (*.prog), a main.c file, a l*.c file, and a
     main.h file. Provision is made for an optional library
     include file.  The routine will prompt for a path for the
     destination of this file.  These files will be installed in
     the source area as specified by the paths in the config file
     (*.conf).

     There are four arguments to kinstall.  Two of the arguments
     are required; -name and -conf, while the other two arguments
     are optional.

     The -name argument specifies the name of the program to
     install.  This should simply be the name of the program
     without any file type extensions.  For example, a valid name
     would be myprogram.

     The -conf argument specifies where to install the files
     associated with a specific routine.  Note that ghostwriter
     creates a template *.conf file.  To correctly install a rou-
     tine, this file must be filled out with the correct path
     information.  This can be accomplished by filling in the
     correct path information or by running the kgenconf program.

     The -toolbox argument specifies which toolbox this routine
     will be installed in. Note, if the -toolbox argument is not
     used, then kinstall assumes that the routine is to be
     installed in KHOROS_HOME. Kinstall uses a mach file to
     determine where the top of the source is. This mach file is
     located in $TOOLBOX_NAME/repos/config/src_conf and is called
     ToolboxName_mf.

     The mach file specifies the information required by all of
     the khoros tools concerning the particular toolbox environ-
     ment, specific machine names, srcmach directories,
     TOOLBOX_NAME src location for each machine, and the top of
     the src directory for the local machine.  Note that if mul-
     tiple machines are used, then there should exist a mach file
     for each machine( i.e. ToolboxName_mf.joe.edu). This is
     necessary since each machine may have a different path for
     the top of src, and the khoros tools require specific paths
     when linking files from one directory to another across dif-
     ferent machines with disk partitions mounted at different
     points.

     For information on toolboxes and mach files, see the Khoros
     Manual Vol. 2, Chapters 1 and 9.  Additionally, the program-
     mer may also wish to use the existing default mach file as
     an example located in $KHOROS_HOME/repos/config/src_conf
     called default_mach.

     The -fprog argument tells the Imakefile system that the rou-
     tine depends on FORTRAN, and the appropriate information
     will be added to the Imakefile.

     The -force argument will allow the programmer to install a
     routine that has already been installed once in Khoros.
     This will bypass the file overwrite prompts and editing of
     the online documentation and cantata pane files.  Note that
     this option will not be allowed if the routine has not been
     previously installed.

     If a new routine is being installed, then kinstall will
     prompt the installer to edit the subform file and add the
     pane file to the subform. Kinstall will automatically put
     the user in the editor specified in their environment vari-
     able, or will default to use vi to edit the subform file.

     Kinstall will prompt for the inclusion of a library include
     file, which will be installed in the path specified by the
     programmer.

REQUIRED ARGUMENTS
     -name  type: string
            desc: program name

     -conf  type: infile
            desc: input config file

OPTIONAL ARGUMENTS
     -toolbox
            type: string
            desc: input toolbox name
            default:

     -fprog type: boolean
            desc: fprog option
            default: false

     -force type: boolean
            desc: Force option
            default: false

EXAMPLES
     kinstall -name vadd -conf vadd.conf -force 1

     Install the program "vadd" in the locations specified in the
     config file (*.conf).  Since no -toolbox option is speci-
     fied, the routine will be installed as part of the main
     Khoros distribution.

     kinstall -name vnew -conf vnew.conf -toolbox medic_toolbox

     Install the program "vnew" in the locations specified in the
     config file (*.conf). This routine will then be associated
     with the Toolbox "medic_toolbox". Kinstall will use the mach
     file $MEDIC_TOOLBOX/repos/config/src_conf/medic_toolbox_mf.

SEE ALSO
     intro(1), verror(3), vgparms(3), vutils(3) ghostwriter(1),
     intro(1), ghostreader(1), ghostcheck(1) ksrcconf(1), kmak-
     eall(1)

RESTRICTIONS
COPYRIGHT
     Copyright 1991, University of New Mexico.  All rights
     reserved.

Khoros                    Release: 1.0                          1

