Building Xxy and Xyd

Prerequisites

• The following tools are needed to build the software.

  • A C compiler. gcc 2.95.4 works well.

  • Tcl/Tk (optional). Release 8.3.5 is the target release, but 8.3.x or later should work. If Tcl/Tk are not available, it will not be possible to build the user interface (xxy), but everything else should work.

• The following tools are optional. They are needed only to generate the documentation files (including the web pages).

  • jade

  • jadetex

  • docbook

  • ghostscript

  • tex

  • gzip

  • A C++ compiler. g++ 2.95.4 works well.

Installation

Note that instructions for building under Sun OS are not provided here. This requires some manual tweaking of the provided files.

1. Select a system type.

   Copy os.solaris.mk, os.linux.mk, os.freebsd.mk, or os.sunos.mk to os.mk. Copy host.alakai.mk (or one of the other provided host.*.mk files) to os.mk.

2. Edit sys.mk, os.mk, and src/config.h to match your local configuration.

   Follow the instructions in the provided files.

3. Type "make depend".

4. Type "make", then "make install".

   On SunOS, only the client libraries and examples can be built. Type "make sunos-all", then "make sunos-install".

5. A full set of documents, including the web pages, is provided, read-to-use. These documents were generated by a number of tools (including docbook, tex, and jade) from sgml and plain-text files. You should not remake the documents unless you have proper tools, or you may destroy the ready-to-use files. If you have the tools and if you modify the sgml files, then you can regenerate the documents by typing: "make documents".

Acknowledgments

This system is a reimplementation of the xy-stage control software that was build for the University of Hawaii 2.2m Telescope. Ed Sousa, Wes Nakamura, and Andrew Pickles provided information and assistance.

Software overview

Top level directory

• Makefile: Make all, make install

• os.*.mk: Set system configuration

• host.*.mk: Set host configuration

• src directory (Program source code).

• examples directory (Example source code).

• doc directory (Documentation):

  • Makefile: Rebuilds documents.

  • *.sgml, *.txt: Raw documentation files.

  • *.html, *.inc: Files generated from the raw files.