home *** CD-ROM | disk | FTP | other *** search
/ Encyclopedia of Graphics File Formats Companion / GFF_CD.ISO / software / unix / saoimage / sao1_07.tar / vms / readme.vms < prev    next >
Text File  |  1991-07-22  |  9KB  |  245 lines
  1.  
  2.  
  3.     -------------------------------------------------
  4.     Notes on building/running SAOimage on VMS (Jun91)
  5.     -------------------------------------------------
  6.  
  7.  
  8. These notes describe how to build and run this release of SAOimage
  9. on a VAX/VMS system.  VMS/IRAF imtool usage is also discussed. 
  10.  
  11.  
  12. --------
  13. Building
  14. --------
  15.  
  16.  
  17. DCL command procedures with input file lists are used to build SAOimage
  18. on VMS.  They are designed to run on any VMS system with the DEC VAX C
  19. compiler and are not dependent on any special build software such as DEC
  20. MMS or IRAF mkpkg.  A rudimentary Make-like strategy is used. 
  21.  
  22. In the top-level SAOimage source directory and the [.BTNLIB] and
  23. [.VMS] subdirectories, the following files perform the build:
  24.  
  25.     MAKE.COM    DCL command procedure to compile local source
  26.             files and insert them into an object library;
  27.             top-level MAKE.COM also links the executable
  28.  
  29.     MAKE.LST    input list of SAOimage source files
  30.  
  31.  
  32. To build SAOimage:
  33.  
  34. 1.  Verify the build options.  These are set in the "/define=(...)"
  35.     part of the "compile" command definition in each MAKE.COM file.
  36.     The current options that can be changed on VMS:
  37.  
  38.       IFLAGS: image reading code to be built into SAOimage
  39.  
  40.     FITS   - reads array files with FITS headers
  41.     OIF   - reads IRAF .imh/(.pix) files with detached headers
  42.     IMTOOL - support imtool interactions with IRAF
  43.     DEBUG  - turn on various internal debug messages
  44.  
  45.       MFLAGS: machine or library specific code
  46.  
  47.     XV11R2  - Xlib not up to full XV11R3 standards (leave enabled for VMS)
  48.     PSCRIPT - hard copy output to a PostScript printer (else no hardcopy)
  49.     LSB    - (least signif. byte) byte swap relative to FITS standard
  50.  
  51.     For example, if you do not want IRAF imtool support, change the
  52.     "IMTOOL" to "NOIMTOOL"
  53.  
  54.     There is no need to define VMS or VAX; these are automatically defined
  55.     by the VAX C compiler.
  56.  
  57. 2.  From the main directory of SAOimage source, execute the MAKE.COM
  58.     procedure via @MAKE.  (Running this as a subprocess or batch job
  59.     with the output to a log file is advisable; it can take a while.)
  60.  
  61. Note:  If [.VMS]ZFIOVI.C will not build, compile it separately (without
  62.        defining IMTOOL) or change ZFIOVI.C to !ZFIOVI.C in [.VMS]MAKE.LST
  63.        and ignore the linker complaints.  This source is currently used
  64.        for IRAF imtool support only.
  65.  
  66.  
  67. To update VMS/IRAF (imtool support only):
  68.  
  69. 1.  Verify that the file IRAFDISK:[IRAF.VMS.GDEV...]ZFIOVI.C exists.
  70.  
  71.     Verify that the file IRAFDISK:[IRAF.VMS.GDEV]ZFIOGD.X references
  72.     the routine "zopnvi".
  73.  
  74.     Note: The IRAF top-level directory may be different on your system.
  75.  
  76. 2.  If the above is verified, then VMS/IRAF already supports imtool,
  77.     and there is no need to go further with this step.
  78.  
  79.     If not, then update VMS/IRAF and rebuild as follows:
  80.  
  81.     From [.VMS] subdirectory ...
  82.  
  83.     $ copy ZFIOGD.X IRAFDISK:[IRAF.VMS.GDEV]
  84.     $ copy ZFIOVI.C IRAFDISK:[IRAF.VMS.GDEV]
  85.     $ copy MKPKG.   IRAFDISK:[IRAF.VMS.GDEV]
  86.  
  87.     In IRAFDISK:[IRAF.VMS.GDEV] ...
  88.  
  89.     $ mkpkg                    ! update the LIBSYS library
  90.  
  91.     Then, either
  92.  
  93.         - rebuild the VMS/IRAF shareable image
  94.         - relink all of IRAF
  95.         or
  96.         - rebuild some executables without the shareable image:
  97.  
  98.         pkg/cl/            (for stdimage cursor)
  99.         pkg/images/tv/display/    (for images.display task)
  100.         noao/proto/        (for noao.imexamine and tvmark tasks)
  101.  
  102.         $ mkpkg -vz update
  103.  
  104.  
  105. ------------
  106. Installation
  107. ------------
  108.  
  109.  
  110. Install the SAOimage executable and the startup .COM file, along with the
  111. configuration file needed for communication with IRAF.  If you intend to
  112. install the files in a system location, you must be logged in as SYSTEM.
  113. For our purposes here, let's assume you are going to put the files in
  114. SYS$LOCAL:[SAOIMAGE].
  115.  
  116.         $ @[.vms]install SYS$LOCAL:[SAOIMAGE]       # or wherever
  117.  
  118. All of the "run-time" files (there are 4) are installed in the same place
  119. on VMS systems.
  120.  
  121. You may wish to install the help information in a standard help library
  122. on your system:
  123.  
  124.         $ lib/help/log sys$help:localtools SYS$LOCAL:[SAOIMAGE]saoimage.hlp
  125.  
  126. You may wish to set up a symbol that users can use to run the startup
  127. command procedure; global symbols such as this are often defined in
  128. SYS$MANAGER:SYLOGIN.COM.
  129.  
  130.         $ saosetup :== @SYS$LOCAL:[SAOIMAGE]saosetup
  131.  
  132. The file SAOSETUP.COM performs the following setup functions for users:
  133.  
  134.     A foreign command needs to be defined to run the program from DCL
  135.     with command line arguments a la C/Unix conventions, for example,
  136.  
  137.     $ saoimage :== $disk:[directory]saoimage.exe
  138.  
  139.     SAOSETUP makes this definition based on its own location.  (SAOSETUP.COM
  140.     and SAOIMAGE.EXE should be in the same directory.)
  141.  
  142.     If your site supports PostScript printer output, the R_DISPOSE foreign
  143.     command should define a command which prints (and deletes) a PostScript
  144.     file, for example,
  145.  
  146.     $ r_dispose :== print/delete/notify/queue=... "%s"
  147.  
  148.     There are several choices for the r_dispose symbol in SAOSETUP.COM;
  149.     you should uncomment the relevant definition.  Read the comments in
  150.     SAOSETUP.COM for more information.  Note that the "%s" string will be
  151.     replaced with the filename by SAOimage.  (It is in double quotes
  152.     because the "s" must be lower case in SAOimage.)
  153.  
  154.     SAOSETUP also accepts a nodename argument that will be set up as
  155.     a remote display.  (If there is no command line argument, the local
  156.     display is used.)
  157.  
  158. There is no special setup for running under DECwindows.  The standard
  159. "SET DISPLAY" command can be used to define which workstation will be
  160. used as the display.  Alternatively, the "-d" option can be supplied
  161. as an argument to SAOimage, for example,
  162.  
  163.     $ saoimage -d mynode::0.0 imagefile.imh 
  164.  
  165. where "mynode" is replaced by the DECnet node name of the workstation. 
  166.  
  167. The command line options are documented in the User Manual [.DOC]MANUAL.TEX
  168. as well as the help page [.VMS]SAOIMAGE.HLP.
  169.  
  170.  
  171. --------
  172. VMS/IRAF
  173. --------
  174.  
  175.  
  176. Using SAOimage in imtool mode with VMS/IRAF is the same as on Sun or
  177. DECstation systems, except for the usual VMS/Unix differences in file
  178. names, etc.  There may also be differences in the window environments
  179. and window managers (i.e., DECwindows vs various Unix X servers, etc). 
  180.  
  181. The imtool configuration file that is supplied with SAOimage is used by
  182. default.  If users want to have custom frame buffer configurations, they
  183. should make a personal copy of the configuration file.  (The default
  184. file is pointed to by the IMTOOLRC logical name after SAOSETUP is run,
  185. so users could `copy imtoolrc sys$login:.imtoolrc' to get a copy.)
  186. The custom imtoolrc file should be in the user's home directory (named
  187. SYS$LOGIN:.IMTOOLRC) or else the logical name IMTOOLRC should point
  188. to this file, for example,
  189.  
  190.     $ DEFINE IMTOOLRC DISK:[USER.IRAF]IMTOOL.RC
  191.  
  192. A sample IMTOOLRC file is attached below, if one can't be found otherwise.
  193.  
  194. SAOimage is started as an imtool server with
  195.  
  196.     $ saoimage +imtool        OR
  197.     $ spawn/nowait/in=nl: saoimage +imtool
  198.  
  199. This is typically run in one window, while the IRAF CL is running in
  200. another.  On the IRAF side, set stdimage to your favorite imtool
  201. configuration in the login.cl file (or interactively).  The standard
  202. configurations are listed below in the sample IMTOOLRC file. 
  203.  
  204. Once SAOimage and IRAF are both running, the standard IRAF tv.display,
  205. noao.imexamine, and noao.tvmark tasks can be used to display and control
  206. the image display window supported by SAOimage. 
  207.  
  208.  
  209. --------------------
  210. Sample IMTOOLRC file
  211. --------------------
  212.  
  213.  
  214. # IMTOOL -- Defined frame buffer configurations.  Note that the given nframes
  215. # is only a starting point, and may be modified during execution, hence smaller
  216. # values are preferred.  The configuration numbers may be given in any order,
  217. # but must be unique and in the range 1-64.  NOTE - corresponding entries must
  218. # be present in the dev$graphcap file, for use with IRAF.
  219. #
  220. # Format:  configno nframes width height
  221.  
  222.  1  2  512  512        # imt1|imt512
  223.  2  2  800  800        # imt2|imt800
  224.  3  2 1024 1024        # imt3|imt1024
  225.  4  1 1600 1600        # imt4|imt1600
  226.  5  1 2048 2048        # imt5|imt2048
  227.  6  1 4096 4096        # imt6|imt4096
  228.  7  1 4096 1024        # imt7|imt4x1
  229.  8  1 1024 4096        # imt8|imt1x4
  230.  9  2 1144  880        # imt9|imtfs    full screen (1152x900 minus frame)
  231. 10  2 1144  764        # imt10|imtfs35    full screen at 35mm film aspect ratio
  232. 11  2  128  128        # imt11|imt128
  233. 12  2  256  256        # imt12|imt256
  234.  
  235. # Some site specific formats for NOAO.
  236. 20  2  388  576        # imt20|imtgec    GEC CCD detector format
  237. 21  1 3040  976        # imt21|imtkpca    KPCA detector format (also 2D-Frutti)
  238. 22  1  128 1520        # imt22|imt2df1 2D-Frutti
  239. 23  1  256 1520        # imt23|imt2df2 2D-Frutti
  240. 24  1  512 1520        # imt24|imt2df5 2D-Frutti
  241. 25  1  960 1520        # imt25|imt2df9 2D-Frutti
  242. 26  1  512  800        # imt26|imtcryo Cryogenic Camera
  243. 27  1  348  800        # imt27|imtgcam Gold Camera
  244. 28  1  976 3040        # imt28|imt2df9x3 2D-Frutti 
  245.