[ KLOE Online Page ] [ Index ] [ Bottom ]

Getting-Started with KLOE online software rules and methods

This is a Getting-Started about how to use the software management tools to develop, use and distrubute software in the KLOE Online UNIX environment. The main concepts, organisation, rules and tools are already described in KLOE memo #40. In the meantime I have introduced some small modifications which are described in an up-to-date document.

This Getting-Started will use the package skel to demonstrate the general concept and to get familiar with the tools and skills needed to manage and distribute the software. The package skel is also a set of skeleton files which can be used to create a package from scratch. Just follow all the instructions and links and you will quickly learn and understand.

Package import and installation

On the LNF UNIX cluster an Anonymous FTP service has been enabled on hpkloe01.lnf.infn.it to allow easy distribution of software packages which are located under the root for KLOE online software /kloe/soft/onl.

If you do not have direct access to this root because you are outside LNF or the system has no NFS access like most of the real-time systems you must install the software packages on your local system first. But to get familiar it is recommanded to make the installation in you home directory ... otherwise go directly to the next chapter

Setup your local online software tree on your system if it does not already exist and copy the script packimport.csh.
```
tcsh> mkdir <root for online software>
tcsh> cd    <root for online software>
tcsh> ftp hpkloe01.lnf.infn.it
anonymous
<user name>
ftp> cd dist/online
ftp> get packimport.csh
ftp> quit
tcsh> chmod u+x packimport.csh
```
Now you have the script packimport.csh which easily allows you to import packages from the KLOE online software respository. Some quick remark about the shells: for the moment only the tcsh shell is fully supported. You can find more information here.
Install, configure and setup the package manage which contains all the management tools needed:
```
tcsh> packimport.csh manange v1
tcsh> cd manage/v1/mgr
tcsh> ./packconf.csh
tcsh> source setup.csh
```
Now you have the package manage installed, configured and setup and from now on you can use the package management utility packman ... how? This you will see later (see also packman.html).

Install, configure and setup the package skel to get the skeleton files used for this Getting-Started:

tcsh> cd <root for online software>
tcsh> packimport.csh skel v1
tcsh> cd skel/v1/mgr
tcsh> $MANAGEMGR/packconf.csh
tcsh> source setup.csh

This is the basic way to do it. With the utility packman the above configuration and setup steps can be done in one line:

tcsh> cd <root for online software>
tcsh> packimport.csh skel v1
tcsh> packman -c -s skel v1
tcsh> cd $SKELMGR

Package management tools setup at login

To have the package manage setup at login time put the line

source /kloe/soft/onl/manage/v1/mgr/setup.csh

into your tcsh startup script e.g. ~.tcshrc or ~/.cshrc. If necessary replace kloe/soft/onl with your local root for the online software. And if you want to use a none default flavor put

setenv MANAGEFLAVOR HP-RT
source /kloe/soft/onl/manage/v1/mgr/setup.csh

instead. Then type

tcsh> uname

to retrieve your system name which is the default flavor. If you work for example on a cross development environment like for HP-RT the default system name is not appropriate. You can do the same with:

tcsh> packman -f HP-RT

Package configuration

Now let's have a look to the stucture and how the package configuration is done:

From your local root for online software move down the directrory tree skel/v1/mgr step by step and have a look how it is structured. The mgr directrory contains the files needed for configuration and setup:
```
tcsh> cd <root for online software>
tcsh> cd skel
tcsh> cd v1
tcsh> cd mgr
```
The files to be customized are skel/v1/mgr/requirements the global Makefile skel/v1/mgr/Makefile and eventually skel/v1/mgr/setup.csh Follow the link to the files to get further information about the scope and then do
```
tcsh> packman -c
```
to configure the package. Maybe you remember that you have already done that at the previous installation step. Here it's just repeated to explain the steps in more detail.
First the package tree you saw is created or completed including the binary directories for each flavor for example HP-UX or OSF1.
Second the setup files are created based on the definitions in file requirements for the selected flavor. Have a look in setup.csh first. It defines the default environment variables
```
SKELROOT, SKELMGR, SKELSRC, SKELDOC, SKELBIN 
```
for the package. It then calls the flavor specific setup file, here HP-UX.csh which contains the c-shell specific definitions defined in requirements. Between the lines
```
#--- User area -----------------------------------
#--- End of user area ----------------------------
```
you can put user specific definitions , which can not be handled with the requirements file like setting up a offline package for example setup rbio.
A (re)configuration of the package is needed at installation time or if the file requirements was modified or if the absolute pathname has changed. And it must be done on each flavor or platform seperately.

Package setup

Finally you can setup the package with one of the following commands:
```
tcsh> packman -s
tcsh> packman -s skel v1
```
For the first one you must be in the mgr directory which simply performs the command:
```
tcsh> source setup.csh
```
If a symbolic link default in skel is pointing to the default version, you can omit the version number.

Package building

For global package building a Makefile must exist as mgr/Makefile. Have a look to this makefile to get further information about the rules. In this case it calls another Makefile ../src/Makefile which is written in a special way to create all flavor dependent files in $SKELBIN. Now type

tcsh> gmake
tcsh> myskel

to completely build the package and run myskel which is defined as alias in requirements. You can also move to ../src. and do a make there ... it's actually the same. Note that we should use Gnu-Make available as gmake on most systems.

Package export and backup

To make a backup of the package an appropriate tag should exist in the global Makefile skel/v1/mgr/Makefile. Then with the command:

tcsh> cd $SKELMGR
tcsh> gmake tar

a compressed tar file will be created in the $MANAGESAVE directory.

In a second step the compressed tar file can then be moved from the backup directory $MANAGESAVE to the official distribution place $MANAGEFTP which is accessabile via Anonymous FTP with:

tcsh> packman -e skel v1

The envirnonment variables MANAGESAVE and MANAGEFTP are defined in the requirements file of package manage. This scheme allows enough flexibility in case it must be modified in future.

[ KLOE Online Page ] [ Top ] [ Index ]

Suggestions, comments or questions? Please contact:

18/3/96