The installation procedures described in this chapter assume that you are performing a standard installation on a single computer. For installation on multiple architectures, please contact KRI's Engineering Support Team.
All of the Advanced Khoros installation scripts, kinstall, kbuild, and kconfigure, are designed to have the same basic, three-part, operational structure, as listed below:
The next few sections provide important definitions and background information about the various software toolboxes that make up Advanced Khoros. This background can be very helpful in answering some of the prompts of the kinstall and kbuild scripts, especially if you want to save some disk space by not installing toolboxes you don't need.
The Advanced Khoros software system is divided into several toolboxes. A toolbox is a collection of programs and/or libraries that are managed as a single entity, or object. A toolbox imposes a predefined directory structure on its contents to provide consistency and predictability in software and documentation organization. Typically, a toolbox contains programs and libraries which have a similar function or common objective.
Some toolboxes, such as BOOTSTRAP, comprise the foundation of Advanced Khoros. Without them, Advanced Khoros cannot run. The descriptions below explain the various toolboxes and their role in the whole Advanced Khoros software environment. For more information, see the Introduction to the Advanced Khoros User's Guide.
Bootstrap is the entry level toolbox containing the Advanced Khoros base utilities and portability tools. It is required by all other toolboxes.
Dataserv contains data services libraries for accessing and manipulating arbitrarily large multidimensional data sets. Data type conversion is handled transparently providing a very robust and powerful system that is very easy to use. Dataserv is needed by every other toolbox, except Bootstrap.
Datamanip provides a rich set of 1-D through n-D data manipulation operators. Datamanip is required by all toolboxes except Bootstrap and Dataserv.
Design contains libraries and applications that make up the visual programming system and the toolbox programmer's system. The Design toolbox is needed by all other toolboxes except Bootstrap, Dataserv, and Datamanip.
Matrix and Image offer numerical analysis and image processing operators. Matrix requires a FORTRAN environment for development and, on some platforms, for use and installation.
Envision and Geometry contain interactive 2-D and 3-D data exploration and visualization applications. In the Geometry toolbox, the ggridder2d command (kroutine) requires the FORTRAN environment for development and, on some platforms, for use and installation.
Support provides miscellaneous utility programs, most of which serve to augment functions of the software development environment.
Migration consists of tools and documentation to aid in the conversion of earlier versions of Advanced Khoros.
Sampledata contains, you guessed it, sample data of various dimensions and data types. This toolbox is the exception to some of the previous statements, since it is not dependent on other toolboxes for installation.
Retro is a Caveat Emptor toolbox that is not supported by KRI. It is provided as a courtesy for those of you still using these Khoros 1.x backward compatibility features. We strongly encourage you to convert all Khoros 1.x programs to the Advanced Khoros standard.
To install on a supported platform from the Advanced Khoros ftp site, perform the following steps:
We assume that you know how to do Step 1; otherwise, you wouldn't be reading this document. Steps 2 through 4 are described in more detail, below.
Remember that we refer to the directory where you previously downloaded and untarred the Advanced Khoros source file as the distribution directory. The kinstall script will copy, uncompress, and unpack any or all of the components of Advanced Khoros from the distribution directory into your Advanced Khoros installation directory. If you choose to install all of Advanced Khoros, this may take anywhere from 20-60 minutes depending on the speed of your computer.
The installation procedure described in this section assumes that you are performing a standard installation on a single computer.
Create a directory to contain the Advanced Khoros installation, if you have not already done so. In the examples below, we will refer to this as your <Khoros Installation Directory>.
For example:
Before you proceed, you should use make sure you have between 200-600 MB of free space on the disk containing your Advanced Khoros installation directory. This space is needed to uncompress, unpack, and compile Khoros . The space you need varies depending on your platform, whether you're compiling optimized or debug versions, compiling static or dynamic versions, running the test suites and examples, and how many toolboxes you install. Use the df command as shown:
For example:
To install Advanced Khoros from your distribution directory, copying and uncompressing the desired components of Advanced Khoros into your Advanced Khoros installation directory, go to your <Khoros Installation Directory> and run the kinstall script, which is located in the <Khoros Distribution Directory>:
For example:
The following screen will appear:
Is this where the Advanced Khoros 2.2.0.0 software is located <Khoros Distribution Directory> (y/n) [y]?
This should be the correct Advanced Khoros distribution directory. Press <Return>.
The following prompt will be displayed:
Khoros 2.2.0 [<Khoros Installation Directory>]:
The default shown should be the correct Advanced Khoros installation directory. Press <Return>.
You will be asked:
If you select n for no, the following menu will appear which will allow you to select the toolboxes you wish to install.1
You may install multiple toolboxes by listing their corresponding numbers, separated by spaces. Toolboxes Dependent on Description 1. bootstrap Foundation Services (10222 KB all) 2. dataserv bootstrap Data Services (5205 KB all) 3. design bootstrap dataserv GUI & Viz Services (13962 KB all) 4. datamanip bootstrap dataserv design Data Manipulation (10881 KB all) 5. envision datamanip Data Visualization (5960 KB all) 6. geometry bootstrap dataserv design 3D visualization (2785 KB all) 7. image datamanip Multiband Image (1280 KB all) 8. matrix bootstrap dataserv design Matrix Operators (6741 KB all) 9. migration bootstrap dataserv design Migration Tools (1138 KB all) 10. support bootstrap dataserv design Miscellaneous Tools (1311 KB all) 11. retro bootstrap dataserv design Khoros 1 Programs (9263 KB all) 12. sampledata bootstrap dataserv design Data files (81672 KB all) N. None A. All P. Print description of toolbox Enter the number(s) of the corresponding toolbox(es) to install [1 2 3 4 5 6 7 8 9 10 11 12]:
Press <Return>.
After you have specified the toolboxes to install by entering a set of numbers or a letter (or by answering yes to the initial question about installing all the toolboxes), the following menu appears (Note that the sizes in bytes are dynamic, and may be different from what displays on your machine during installation):
Choose either 1 or 2 as desired.
The following message is displayed:
Press <Return>.
If you are missing any of the 3rd-party system software requirements, the following prompt appears:
You should choose to install these if they are not installed on your system. Press <Return>.
If you answered "yes," above, the following prompt is displayed:
The following required third-party binaries were determined to be necessary for your system: groff perl gzip They were compiled to be located in /usr/local/gnu. The directory /usr/local/gnu is the root directory where a binary directory will be created along with other directories for the third party software being installed. If you can not install them there you may need to set some environment variables for groff and perl to work, if either or both of them appear in the list above. These values will be given to you after this script has installed the binaries. Enter 'none' if you do not wish to install these third-party binaries. Please enter the root directory for the binaries?
Enter the name of the directory where you want these 3rd-party tools installed. We recommend the /usr/local/gnu/src directory. Make sure you have write permission to this directory. For example:
The checking permissions prompt appears:
If you have the disk space to spare, we recommend that you install the source code in order to get complete documentation. Press <Return> to get the default "yes", or type "n" and press <Return> to indicate "no.".
The following prompt is shown:
Again, if you have the disk space to spare, we recommend that you install the source code in order to get complete documentation. Type "y" or "n" and press <Return>.
The following prompt appears:
Enter the name of the directory where you want these 3rd-party tools installed. We recommend the /usr/local/gnu directory.
The primary installation menu will be shown. The defaults listed
below may differ a little for your installation depending on how
you answered the previous questions.
(Primary Installation Menu) Advanced Khoros 2.2.0.0 Installation This script will install the Advanced Khoros 2.2.0.0 system. 0. Change the location of the Khoros distribution Advanced Khoros 2.2.0.0 Installation < Khoros Distribution Directory > 1. Select location for the source < Khoros Installation Directory > 2. Select which toolboxes to install [All] 3. Type of Khoros environment to install [Development Environment] 4. Choose platform to install [binaries & libraries are being installed ] 5. Select location for executable binaries [ ] 6. Select location for library archives [ ] 7. Select which third party software source to install [ None ] 8. Select location for installing third party software source [ No Default ] 9. Select which third party binaries to install [ No Default ] 10. Select location for installing third party binaries [ No Default ] 11. Install other miscellaneous files [testsuite & examples] I. Start install Q. Quit kinstall; do not install Advanced Khoros 2.2.0.0 after all (If you experience any problems with this script, please report them to khoros-bugs@khoral.com) Enter installation step to perform [I]?
Select any of the numbered items 1 through 11 in order to modify the default setting for that item. The default setting is displayed in square brackets.
If you are installing on a development or ported platform, the only setting you may wish to change is item 8 if you are missing some of the required 3rd-party system software.
Other than that, simply press <Return> to engage the default item "I" and continue with the install.
A final check is performed to see if the installation will fit on your disk. If the check is successful, the following prompt is displayed:
If everything is correct, press <Return>, to execute the install. This may take 20-60 minutes, depending on what you are installing and the speed of your computer.
If you wish to change anything, then answer "no" at the prompt. You will then be returned to the primary installation menu, as shown just above. Then, as before, select any of the numbered items, 1 through 10, in order to modify the default setting for that item. The default setting is displayed in square brackets. After making the desired changes, simply press <Return> to engage the default item "I" and continue with the install.
The script will display messages like the following, as each toolbox is uncompressed and unpacked.
After the final message displays, the installation is complete.
You must successfully complete running the kinstall script, as described in the previous section, before you may proceed with the kbuild script. Recall that when you ran kinstall, you created an installation directory. We refer to the full path name of this directory as: <Khoros Installation Directory>.
The kbuild script compiles all programs, libraries, and documentation from the source code in your Advanced Khoros installation directory. This may take anywhere from 1-24 hours depending on the speed of your computer and which Advanced Khoros toolboxes you are building.
The installation procedure described in this section assumes that you are performing a standard installation on a single computer.
Note: You must add your <Khoros Installation Directory>/bin directory to your path before running the kbuild script.
For C Shell (csh) type:
et path=(<Khoros Installation Directory>/bin $path)
For Bourne or Korn Shell (sh or ksh) type:
$ PATH=<Khoros Installation Directory>/bin:$PATH $ export PATH
The kbuild script will fail to execute properly if this is not done. Instructions
You should change to your Advanced Khoros installation directory now and verify you are in the right place:
> cd <Khoros Installation Directory> > pwd <Khoros Installation Directory> >
For example:
> cd /usr/local/khoros2200 > pwd /usr/local/khoros2200 >
After you ran the kinstall script to uncompress and copy the desired Advanced Khoros components into <Khoros Installation Directory>, the resulting directory should look something like this (you may not have bin or lib directories, depending on how you ran kinstall):
> ls -l total 32 drwxr-xr-x 3 <user> <group> 512 May 31 00:03 ReadMes/ -rw-r--r-- 1 <user> <group> 1189 May 31 10:35 Toolboxes drwxr-xr-x 3 <user> <group> 512 May 31 14:19 bin/ drwxr-xr-x 8 <user> <group> 512 May 31 10:25 bootstrap/ drwxr-xr-x 7 <user> <group> 512 May 31 00:12 datamanip/ drwxr-xr-x 6 <user> <group> 512 May 31 00:14 dataserv/ drwxr-xr-x 7 <user> <group> 512 May 31 00:18 design/ drwxr-xr-x 8 <user> <group> 512 May 31 00:23 envision/ drwxr-xr-x 7 <user> <group> 512 May 31 00:25 geometry/ drwxr-xr-x 7 <user> <group> 512 May 31 00:26 image/ drwxr-xr-x 2 <user> <group> 512 May 31 10:27 lib/ drwxr-xr-x 7 <user> <group> 512 May 31 00:28 matrix/ drwxr-xr-x 6 <user> <group> 512 May 31 00:29 migration/ drwxr-xr-x 7 <user> <group> 512 May 31 00:32 retro/ drwxr-xr-x 6 <user> <group> 512 May 31 00:34 support/ >
If something is missing, please rerun the kinstall script and verify that it worked properly. All Advanced Khoros source code necessary to build the Advanced Khoros libraries, programs, and documentation is contained within these directories. To build Advanced Khoros from the source code, go to the <Khoros Installation Directory> and run the kbuild script:
> cd <Khoros Installation Directory> > bin/kbuild
The kbuild script prompts you with the following message:
Khoros 2.2.0.0 Installation
This script makes sure that your environment is set up correctly and helps you install Khoros 2.2.0.0. You will be prompted for the Khoros 2.2.0.0 top level directory, operating system, machine architecture, multiple architecture support, global directories for the binaries & libraries, C compiler, the BOOTSTRAP flags necessary to compile kgenmake and the toolboxes in Khoros 2.2.0.0 you wish to install. You will be prompted for the Fortran compiler to use if you install a toolbox that requires Fortran. The script will then compile the bootstrap program kgenmake, and if that stage is successful, will compile the required Khoros toolboxes and your choice of other toolboxes in the distribution. You will be given a chance to edit the Architecture Configuration File and the Compiler Configuration File before the toolboxes are compiled. The output of the compile for each Khoros toolbox will be logged to the file {TOOLBOX}/objects/make.World.
(If you experience any problems with this script, please report them to support@khoral.com)
At the bottom of these paragraphs, you are presented with the following query to which you can answer yes or no:
Do you wish to continue the installation? (y/n) [y]:
Type <n> and press <Return> to terminate the installation process and exit the script. Type <y> and press <Return> to continue the script. The following message appears
Please enter the full path to the toplevel of Khoros 2.2.0.0[<Khoros Installation Directory>]:
Verify the pathname, and if it is not correct, type in the correct pathname, as shown below. If this is <Khoros Installation Directory>, press <Return>.
If you have moved the files to some other directory, enter the name of the this directory like so:
Please enter the full path to the toplevel of Khoros 2.2.0.0[<Khoros Installation Directory>]: <some other directory>
If the pathname is incorrect, the script informs you and again requests that you supply the correct pathname. When the pathname is correct and the script accepts it, you are prompted with the following message: You are ready to continue.
Do you wish to continue? (y/n) [y]: Press <Return> to accept the default, "y." Choose "n" to exit the installation script.
Choose "y" to continue. The following message appears:
What Operating System (OS) are you building Khoros on? Enter the number corresponding to the OS or type the OS string. 1. solaris: Solaris 2.x (2.4 supported) 2. irix: Irix 5.x & 6.x (5.3 supported) 3. linux: Linux 1.2.x & 2.0.x (2.0.x supported) 4. osf: Digital Unix 3.x (3.2 supported) 5. sunos: SunOS 4.1.X (development) 6. aix: AIX 3.2.x & 4.x (development) 7. dgux: DGUX (development) 8. bsdi: BSDI's BSD/OS (development) 9. unicos: Unicos 8 & 9 (ported) 10. unicosmk: Unicos/MK 1.2.530 (ported) 11. freebsd: FreeBSD (development) 12. ultrix: Digital Ultrix (ported) 13. exemplar: Convex Exemplar HPUX(ported) 14. osf1: Paragon's OSF1 (ported) 15. dynix: Dynix (ported) 16. hpux: HPUX (ported) 17. netbsd: NetBSD (not ported) 18. convex: ConvexOS (not ported) 19. newsos: NewsOS (not ported) 20. interactive: Interactive 386/486 (not ported) 21. Q: Quit the installation Enter the Operating System [<default OS>]:
If the default OS detected by the script is correct, press <Return>. Otherwise, enter the number or string abbreviation corresponding to the correct OS, or enter "q" to terminate the installation script.
Again you are presented with a list of options, this time for machine architecture:
What machine architecture are you building Khoros on? Enter the number corresponding to the architecture or type the architecture string 1. sparc: Sun SPARCstation (ULTRASparc) 2. alpha: Dec Alpha 3. i386: 386/486 PC, Sequent 4. i486: 486 PC 5. i586: Pentium PC 6. i686: Pentium Pro 7. mips: SGI Mips, Mips 8. rs6000: IBM RS/6000 9. powerpc: IBM PowerPC 10. hppa: HP 9000 (s700, s800), Convex Exemplar 11. ymp: Cray 12. t3e: Cray T3E 13. convex: Convex 14. i860: Paragon 15. ns32k: Sequent, Encore 16. m88k: DG, Luna, Motorola 88K 17. dap: CPP-DAP 18. vax: Vax 19. mipsel: DEC 3100/5000 20. apollo: APOLLO DN10000 21. m68k: Sun 3, Motorola 68K, HP 9000 (s300, s400), NeXT, Mac, Sony 22. Q: Quit the installation Enter the machine architecture [ <default architecture> ]:
As before, if the default architecture detected by the script is correct, press <Return>. If not, then enter the number or string abbreviation corresponding to the correct machine architecture, or enter "q" to exit the installation script.
You are then prompted with the following options:
Configuration Name In order to compile Khoros 2.2.0.0 you must specify a configuration name to be used in the name of the system specific config files. This name is used to provide a unique name to the build system for each architecture you want to build Khoros on. What configuration name would you like to use [ <default configuration> ] ? Do you wish to continue the installation? (y/n) [y]:
For now, we assume you select the default and answer "yes" to the question.
Answering "yes" on Solaris, Irix, Linux, OSF/1, SunOS, FreeBSD, configuration and HP-UX moves to the next step in the installation process and yields the following message (All other platforms do not have dynamic library support):
Dynamic Library Support You are running a system that supports dynamic libraries. Do you want to create Khoros dynamic libraries? (y/n) [y]:
Selecting the default option, by pressing <Return>, is highly recommended. This leads to the following message and prompt:
Global Binary Directory Support This option allows you to compile the Khoros 2.2.0.0 system so that all the binaries are in one directory and the libraries are in an other directory. For example /usr/local/khoros/bin and /usr/local/khoros/lib, respectively. If you do not use this option the binaries and libraries for each toolbox will be in TOOLBOX/bin and TOOLBOX/lib. Do you want to use global binary directories? (y/n) [y]:
Again, we assume that you select the default option (which is highly recommended) and answer "yes," which yields the following message and prompt:
replacing the globaldir=false in the Toolboxes file with globaldir=true [Press <Return> to continue]
When you press <Return>, you are prompted with the following message concerning the location for installing Advanced Khoros binaries:
Directory for Khoros binaries Enter the directory where you would like Khoros binaries to be installed. The file <Khoros Installation Directory>/bootstrap/config/Dir.<Configuration Name> will be updated with the path you specify here. Press <Enter> to use the default, given below. Bin directory [<Khoros Installation Directory>/bin]:
Accept the default by pressing <Return>. However you may enter an alternate pathname if desired. The message appears:
Changing the variable 'BinDir' to '<Khoros Installation Directory>/bin' in the < Khoros Installation Directory>/bootstrap/config/Dir.<Configuration Name> [Press <Return> to continue]
Pressing <Return> yields the message below concerning the location for installing Advanced Khoros libraries:
Directory for Khoros libraries Enter the directory where you want Khoros libraries to be installed. The file <Khoros Installation Directory>/bootstrap/config/Dir.<Configuration Name> will be updated with the path. Press <Return> to use the default. Lib directory [<Khoros Installation Directory>/lib]:
Accept the default by pressing <Return> or enter an alternate pathname, then press <Return>.
Changing the variable 'LibDir' to ' <Khoros Installation Directory>/lib' in the <Khoros Installation Directory>/bootstrap/config/Dir.<Configuration Name> [Press <Return> to continue]
Pressing <Return> yields a prompt for identifying the C compiler you intend to use:
C Compiler Are you using a C-compiler other than 'cc'? For example 'gcc' or 'acc'? If you are using a C-compiler other than 'cc', please enter the C-compiler you wish to use. If the name of the compiler is cc, but it is really gcc, set the HasGcc flag in the file <Khoros Installation Directory>/bootstrap/config/Site.<your OS> to YES. If it is gcc 2.x, set HasGcc2 to YES in the same file. To determine if the cc is really gcc, do cc -v or cc -version. NOTE: You will have a chance to edit the <Khoros Installation Directory>/bootstrap/config/Site.<your OS> later on in this script. NOTE: Whatever C-compiler you use must be ANSI C compliant. Enter C-compiler [cc]:
Enter the compiler name, or press <Return>, and, if necessary, follow the instructions regarding your Site configuration file. The script then asks for confirmation of the compiler you have specified:
Using the C-compiler <your C compiler> Is this correct? (y/n) [y]: y
Press <Return> if the compiler name is correct or enter <n> to correct the compiler name. After you have confirmed the correct compiler name, the following message is shown:
Updating <Khoros Installation Directory>/bootstrap/config/Site.<your OS> Setting the C compiler parameters. [Press <Return> to continue]
The Advanced Khoros toolboxes selection box appears. As you can see, bootstrap, dataserv, and design toolboxes are required. The default installation also includes datamanip, envision, and support toolboxes. Select the toolboxes you wish to install by typing the corresponding number.
Toolbox Selection The first three toolboxes are required by all the others. So please select them first if they have not already been installed. If not specified and not installed they will be added. You may install multiple toolboxes by listing their corresponding numbers, separated by spaces. Toolboxes Dependent on Description 1. bootstrap Foundation Services 2. dataserv bootstrap Data Services 3. design bootstrap dataserv GUI & Viz Services 4. datamanip bootstrap dataserv design Data Manipulation Operators 5. envision datamanip Data Visualization Applications 6. geometry bootstrap dataserv design 3D visualization (need Fortran) 7. image datamanip Multiband Image Operators 8. matrix bootstrap dataserv design Matrix Operators (need Fortran) 9. migration bootstrap dataserv design Migration Tools K1 to K2 & K2 to K2 10. support bootstrap dataserv design Miscellaneous Tools 11. retro bootstrap dataserv design Programs from Khoros 1 N. None A. All P. Print description of toolbox Q. Quit kbuild Enter the number(s) of the corresponding toolbox(es) [1 2 3 4 5 10]:
You may specify the desired set of toolboxes by entering a sequence of numbers (separated by spaces, no commas) or by entering "A" for all toolboxes. Press <Return> to accept the default set of toolboxes. The Advanced Khoros toolbox confirmation prompt appears:
Here are the toolboxes to be installed: bootstrap dataserv design datamanip envision support Is this correct? (y/n) [y]:
Enter <y> if everything is correct. Enter <n> if you wish to make corrections, then enter your corrections and press <y>. The Architecture Configuration file prompt appears:
Architecture Configuration File/bootstrap/config/Site. A template architecture configuration file has been installed You will need to edit this architecture configuration file and set the imake symbols to the correct setting for your architecture Do you wish to edit the architecture configuration file? (y/n) [y]:
If you choose "yes," the script brings the configuration file up in your default text editor. If you choose "no," the script goes onto the next question. If you are using the supported or development platforms, you should not need to change this file. If you are using source code, press <n> to see the following prompt concerning platform configuration:
Compiler Configuration File A template platform configuration file has been installed/bootstrap/config/ .cf You will need to edit this platform configuration file and set the imake symbols to the correct setting for your architecture. Do you wish to edit the platform configuration file? (y/n) [y]:
If you are using the supported or development platforms, you should not need to change this file. If you wish to edit either bootstrap/config/Site.<your OS> or bootstrap/config/<your OS>.cf, you can always do so at a later time. Answer "no" to produce the following prompt:
OK, we're ready to roll. The first stage of compilation is the 'bootstrap' program: kgenmake Do you wish to continue? (y/n) [y]:
Press <Return>, and you should see messages like so:
Ok, let's try and build the bootstrap program. If the bootstrap build fails, then you must determine what happened and run kbuild again: Compiling and Installing Khoros 2 Bootstrap Programs ... (lengthy make and compile messages) Bootstrap programs compiling complete The bootstrap program seemed to build and install correctly, so let's go try to build Khoros. [Press <Return> to continue]
Press <Return>. The prompt appears:
Do you want to watch the compiles as they proceed? (y/n)[n]: Answer as desired.
The last prompt appears
This is going to take a while. Anywhere from 1 to 24 hours depending on the number of toolboxes installed and how fast your machine compiles. Last chance to chicken out before compiling Khoros ... Do you wish to continue? (y/n) [y]:
Press <Return>, and watch the compiler crank and crunch. Take a break and relax; this will take a long time.
That's it, you're done with kbuild.
After running kbuild, then you can do a "make clean" for all objects in the toolbox:
> cd <install dir.>/<$TOOLBOX>/objects > make clean
Running "make clean" here will free up space used to compile and run the test suites.
Proceed to the next section to set up your environment.
Before you go on to this step, be sure to complete all steps above. Those steps are necessary for all platforms.
Note that kconfigure may prompt you for a configuration name along with a list of options from which to choose. If you are unsure what the configuration name is, ask your system administrator.
To access the Advanced Khoros software from your login environment, the following issues must be addressed:
or shell configuration file (e.g., .profile),
Log out and log back in for the changes to take effect.
You can set up your environment by hand, or by executing the kconfigure script. Both methods are described below. However, we recommend that you use kconfigure.
The following items describe the conventions used in this section.
<Khoros Installation Directory>
The term <Khoros Installation Directory> refers to the top level directory under which all the Advanced Khoros software was installed.
$HOME
The term $HOME refers to the user's top level (home) directory.
The kconfigure script is an interactive program that will prompt you for various information. This program will also modify your .cshrc file. To run it, type
The kconfigure script will ask you what directory Advanced Khoros is installed in. It will also ask you if you want to install a local .Toolboxes file. (Note that you must install the .Toolboxes file in order for Khoros to run.) It will ask you to install the .khoros_env file which sets all the Advanced Khoros environment variables, and it will ask you if you want your .cshrc file modified with the above information.
After running kconfigure to set up your environment, you
can run any of the Advanced Khoros applications.
Try a couple:
Note:The second example will work only if you have the Sampledata Toolbox installed.
To set up your environment by hand, you will need to set some environment variables and add the path to the Advanced Khoros binaries to your .cshrc or .login file.
For C-shell users, environment variables for Advanced Khoros are typically put in a file called .khoros_env. This file is then sourced by your .cshrc file when you log in. Standard shell users usually set up environment variables in their .profile file.
A sample .khoros_env file for C-shell is given below. Create this file in your home directory.
# ------------------------------------------------------------ # This file should be sourced (source .khoros_env) or included # in your .login or .cshrc. # ------------------------------------------------------------ # # This file contains default values for environment # variables used by KHOROS. # # set path = ($path /usr/local/khoros2200/bin) setenv KHOROS_LOG $HOME/khoros.cmdlog setenv KHOROS_MAIL $USER setenv KHOROS_NAME $USER setenv KHOROS_NOTIFY KSTANDARD setenv KHOROS_ANSFILE $HOME/khoros.ans setenv TMPDIR /tmp # # Set platform-specific run-time library environment variables # for Khoros # # if ( $?LD_LIBRARY_PATH ) then # setenv LD_LIBRARY_PATH /research/test/test1/lib:${LD_LIBRARY_PATH} # else # setenv LD_LIBRARY_PATH /research/test/test1/lib # endif setenv GROFF_FONT_PATH .:/usr/local/gnu/share/groff/font setenv GROFF_TMAC_PATH /usr/local/gnu/share/groff/tmac setenv PERLLIB /usr/local/gnu/lib/perl
Below is a description of each of these environment variables.
Khoros has a built-in information and warning message system. All applications take advantage of this mechanism. The KHOROS_NOTIFY environment variable controls the type and number of messages that are displayed when you run a program. Set the KHOROS_NOTIFY environment variable to the level that you feel most comfortable with; KSTANDARD is recommended. Note that all error messages will be displayed regardless of the setting of KHOROS_NOTIFY.
where level is one of the following:
The KQUIET mode will silence all output of all information and warning messages; only error messages will appear. It will suppress all messages generated by statements such as:
kinfo(KSTANDARD, "Input file read from ", filename);
kwarn(KVERBOSE, "You may want to verify that is correct", filename);
The KSTANDARD mode will only report information and warning messages
that are necessary to let you know the status of the application
or an event that occurs. For example, an application might display
a message stating that a file has changed and ask for you acknowledgment.
This is the normal mode. It causes messages to be displayed that
have been programmed with a statement such as:
kinfo(KSTANDARD, "Output file written to ", filename);
The KVERBOSE mode will display detailed information and warning
messages generated by any routine that is called during the execution
of the program. Typically this level of verbosity will display
messages about every detail of the application that the programmer
thought you should know about. The danger of using this setting
is that often you will see warnings generated from deep in the
library routine call stack trace that may make it appear as if
there have been errors in the program run, when in fact, the program
is running normally. Messages will appear that have been programmed
with a statement like:
for (i = 0; i < linenum; i++)
kinfo(KVERBOSE,"line 0 of reads, ",linenum,filename,line[i]);
The KDEBUG mode is used mainly by programmers who have put inline
debug statements in their code in the form:
kinfo(KDEBUG, "Here we are at line 233");
This mode will display screenfulls of information.
The KHOROS_MAIL variable is used when some Advanced Khoros program needs to mail you a message. There are not many places where this variable is used. If this variable is set, then craftsman will use it as
the default value for the author's email address for new toolboxes.
The KHOROS_NAME variable is used when some part of Advanced Khoros needs to know your name. Currently, craftsman uses it as the default author name for new toolboxes.
Another important environment variable that is used by Advanced Khoros is the TMPDIR variable. Advanced Khoros uses this directory as the location of all temporary files. It should be set to a large directory, as in:
For best results with Advanced Khoros, the TMPDIR environment variable should be set to a directory containing at least 32 megabytes of free disk space.
The KHOROS_EDITOR environment variable is used whenever a program needs to spawn an xterm containing a session with a text editor (currently, both Composer and Guise spawn text editor sessions). Previously, programs would get the EDITOR variable and run that inside an xterm. This was not a good practice, since many editors (such as emacs) create their own window under X, so you would get an unnecessary xterm popping up. Composer and Guise first look for KHOROS_EDITOR. If that is not set, the EDITOR environment variable is checked. If neither environment variable is set, they will resort to a vi session inside an xterm.
If you set the KHOROS_EDITOR variable, it is assumed that the string contains a command which will create an xterm if necessary. For example, if you use vi, you might set it as follows:
or if you're an emacs user:
or, setting the title:
If you have set KHOROS_EDITOR, then some substitutions are performed before executing the string:
0.000000 | the name of the file being edited. This must appear at least once in the string. |
0 | this will be interpolated to an X-style geometry specification. In Composer, if you are editing a UIS style, this will be set to a short, wide window; a tall, 80-column window will be set for everything else. |
If you use an editor other than vi, let us know a good setting for KHOROS_EDITOR appropriate for that editor. Also if there are any other ' 0nterpolations' you'd like to see, please mail them to us.
The KHOROS_ANSFILE variable specifies the default file to be used with command line user interface answer files. A database file stores the values of a program's command line arguments any time the program is run using the standard [-A] command line option. Later, you can invoke the program quickly with the exact same values for its command line options using the [-a] command line option; the database file is queried to get the stored values that you specified previously when you ran the program with the [-A] option. The name and location of the database file to save answer file command line argument values is specified with the KHOROS_ANSFILE environment variable.
For the Advanced Khoros system to work correctly, the Advanced Khoros environment file (described above) must be sourced at login. This can be done by adding a source statement at the bottom of the .cshrc file (for C-shell users) or the .profile file (Bourne or Korn shell users). The Advanced Khoros binary directory and any other Toolbox binary directories must also be added to your search path. To indicate where Advanced Khoros X applications will be displayed, the DISPLAY environment variable must be set to your workstation.
To accomplish these actions in C-shell, modify your .cshrc file with the following changes:
To accomplish these actions in Bourne of Korn shell, modify your .profile file with the following changes:
If you do not run kconfigure, you will have to create a .Toolboxes file by hand and place it in your $HOME directory. The file has three components. The first is a #include statement that allows you to link to other Toolboxes files. These other Toolboxes files have the same syntax as the main .Toolboxes file being described here. The second is a list of toolbox names followed by a colon, which in turn is followed by a path to the main toolbox directory for that toolbox. You may list as many toolboxes in this fashion as you like. The third is a # used as a comment marker for any lines you do not want read by the Khoros. An example .Toolboxes file is shown below.
#include /research/devel/mirage/Toolboxes IX_ANALYSIS:/research/vision/charlie/kixl/ix_analysis # # All following toolboxes are in the beta stage # TRAINING:/research/data10/paula/training KERNEL:/research/devel/mirage/kernel SRCMACH:/research/devel/mirage/srcmach IMAGEDATA:/research/devel/mirage/general/data/imagedata XIL:/research/devel/mirage/xil TESTIMAGES:/research/devel/mirage/testimages
If you installed the binaries for the third-party software groff and perl, you will need to set up some environment variables if you have not installed them in the default directory, /usr/local/gnu.
The groff environement variables GROFF_FONT_PATH and GROFF_TMAC_PATH can be set in C-shell by adding the following lines to your .cshrc file:
setenv GROFF_TMAC_PATH <where 3rd-party binaries
are installed>/share/groff/tmac
For Bourne or Korn shell, add the following lines to your .profile file:
GROFF_TMAC_PATH=<where 3rd-party binaries
are installed>/share/groff/tmac
export GROFF_FONT_PATH GROFF_TMAC_PATH
Set the perl environment variable PERLLIB in C-shell by adding the following line to your .cshrc file:
For Bourne or Korn shell, add the following lines to your .profile file:
The directory, <where 3rd-party binaries are installed> should match the answer to the following kinstall prompt:
If you encounter technical difficulties, please follow these steps: