"Fossies" - the Fresh Open Source Software Archive

Member "SAOImageDS9/funtools/INSTALL" (13 Nov 2019, 12724 Bytes) of package /linux/misc/ds9.8.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 Quick Summary
    2 =============
    3 
    4 To build and install the Funtools package, simply execute:
    5 
    6    	./mkconfigure		# generate all configure scripts
    7 	./configure		# site-specific configuration
    8 	make			# build the software
    9 	make install		# install it
   10 	make clean		# clean up unneeded temp files
   11 
   12 The configure scripts are not part of the GitHub repository, so you must
   13 generate them for your site (you might need to install autoconf for this
   14 purpose):
   15 
   16         ./mkconfigure
   17 
   18 You might want to install in a directory other than /usr/local, so as not to
   19 require root access. To do this, configure for a different install directory:
   20 
   21 	./configure --prefix=<top_level_install_dir>
   22 e.g.,
   23 	./configure --prefix=/soft/saord
   24 
   25 Programs will be installed in /soft/saord/bin, libraries in /soft/saord/lib,
   26 and include files in /soft/saord/include. Indeed, we do this at SAO and
   27 recommend it as a general rule, in order to keep SAORD software in one place
   28 that does not conflict with other installations. Note that you will need to
   29 add the bin directory to your path.
   30 
   31 The build ("make") takes only a minute or so on modern machines.  To
   32 monitor its progress and/or check for errors, redirect output to a file
   33 and use the 'tail' command:
   34 
   35 	make >& foo.log &; tail -f foo.log		# csh
   36 or
   37 	make 1>foo.log 2>&1 &; tail -f foo.log		# sh, bash
   38 
   39 
   40 NB: Windows users
   41 =================
   42 
   43 To build funtools on a Windows platform, you first need to install
   44 the Cygwin package from:
   45 
   46       http://cygwin.com/
   47 
   48 From the Web page:
   49 
   50   Cygwin is a Linux-like environment for Windows. It consists of two
   51   parts: A DLL (cygwin1.dll) which acts as a Linux API emulation layer
   52   providing substantial Linux API functionality.  A collection of tools
   53   which provide Linux look and feel.
   54 
   55 When installing cygwin, make sure you install 'gcc' and 'make' from the
   56 Development package. I think that's all you need ...
   57 
   58 Details of Installation
   59 =======================
   60 
   61   
   62 
   63 NB: These are generic installation instructions, modified for Funtools.
   64 
   65   The `configure' shell script attempts to guess correct values for
   66 various system-dependent variables used during compilation.  It uses
   67 those values to create a `Makefile' in each directory of the package.
   68 It may also create one or more `.h' files containing system-dependent
   69 definitions.  Finally, it creates a shell script `config.status' that
   70 you can run in the future to recreate the current configuration, a file
   71 `config.cache' that saves the results of its tests to speed up
   72 reconfiguring, and a file `config.log' containing compiler output
   73 (useful mainly for debugging `configure').
   74 
   75    If you need to do unusual things to compile the package, please try
   76 to figure out how `configure' could check whether to do them, and mail
   77 diffs or instructions to the address given in the `README' so they can
   78 be considered for the next release.  If at some point `config.cache'
   79 contains results you don't want to keep, you may remove or edit it.
   80 
   81    The file `configure.in' is used to create `configure' by a program
   82 called `autoconf'.  You only need `configure.in' if you want to change
   83 it or regenerate `configure' using a newer version of `autoconf'.
   84 
   85 The simplest way to compile this package is:
   86 
   87      `./configure' to configure the package for your system.  If you're
   88      using `csh' on an old version of System V, you might need to type
   89      `sh ./configure' instead to prevent `csh' from trying to execute
   90      `configure' itself.
   91 
   92      Running `configure' takes awhile.  While running, it prints some
   93      messages telling which features it is checking for.
   94 
   95   1. `cd' to the directory containing the package's source code and type
   96     "./configure".  This runs a configuration script created by GNU
   97     autoconf, which configures Funtools for your system and creates a
   98     Makefile.  The configure script allows you to customize the Funtools
   99     configuration for your site; for details on how you can do this,
  100     type "./configure -help" or refer to the autoconf documentation (not
  101     included here).  The Funtools "configure" script supports the following
  102     special switch(es) in addition to the standard ones:
  103 
  104         --enable-shared=yes|link|no
  105 				Build shared libraries in addition to the
  106 				default static library. There are two options:
  107 
  108 				If the value is "yes", shared libraries are
  109 				built but not used to link xpa programs.
  110 
  111 				If the value is "link", shared libraries are
  112 				used to link xpa programs. If therefore becomes
  113 				your responsibility to put the shared library
  114 				where it can be found (or use LD_LIBRARY_PATH).
  115 
  116         --enable-dl=yes|no
  117 				With gcc available, perform on-the-fly filtering
  118 				by compiling a shared object and dynamically
  119 				loading it into the executable. The default is
  120 				to compile and link a separate slave program.
  121 				(Surprisingly, processing speed is about the	
  122 				same for both methods.)
  123 
  124         --enable-mainlib=yes|no
  125 				Build funtools mainlib support, which allows
  126 				user programs to call funtools as subroutines.
  127 				This is an experimental interface.
  128 
  129     Standard options are listed below. the most important of which
  130     is --prefix (to specify where to install) and --exec-prefix (where to
  131     install executables, if the top level is different from where libraries
  132     and include files are being installed. At SAO, we just use --prefix.
  133     We recommend --prefix be set to a directory that will hold saord software
  134     (e.g., --prefix=/soft/saord) in order to make management of our software
  135     easier.
  136 
  137     NB: be sure to use only absolute path names (those starting with "/")
  138     in the --prefix and --exec_prefix options. (The configure options we
  139     use at SAO for various machines are given as examples in the script
  140     file called "saoconfig" in this directory.)
  141 
  142     NB: Please avoid use of --prefix with 'make install' to change the
  143     install directory. We use the original value of --prefix to determine
  144     where compiled objects are located for linking slave filter programs.
  145     The slave will look in that directory for imregions.o and evregions.o.
  146     If you change the install directory, you will not be able to use these
  147     precompiled objects. Instead, each filter will have to recompile the
  148     region code.
  149 
  150     Compiler flags can be placed on the configure command line after the
  151     switches. For example, to use the icc compiler under Linux, you can
  152     configure this way:
  153 
  154 	./configure --prefix=... CC=icc CFLAGS="..."
  155 
  156      If you are going to be dealing with data files larger than 2Gb,
  157      you will need to build in large file support. For gcc and many other
  158      compilers, this is done using the following CFLAGS:
  159 
  160 	./configure CFLAGS="-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64"
  161 
  162      Of course, you can put other switches into CFLAGS as needed:
  163 
  164      ./configure CFLAGS="-D_LARGEFILE64_SOURCE -D_FILE_OFFSET_BITS=64 -Wall -g"
  165 
  166   2. Type `make' to compile the package. This will create the libfuntools.a
  167      library and the Funtools utility programs (funcnts, fundisp, etc.)
  168 
  169   3. You can build the libxpa.so shared library manually by executing:
  170 
  171 	make shlib
  172 
  173      at this point.
  174 
  175   4. Type "make install" to install Funtools libraries and binaries in
  176      standard places.  You'll need write permission on the installation
  177      directories to do this.  The installation directories are
  178      determined by the "configure" script and may be specified with
  179      the --prefix option to "configure".  See the Makefile for information
  180      on what directories were chosen.
  181 
  182   5. There are .html help files in the doc directory. You can copy
  183      these files to a more convenient location, if you like. We
  184      did not automate this step because we did not know where to
  185      copy these files by default. (NB: The help.html file is the
  186      top level index file.)
  187 
  188   6. You can remove the program binaries and object files from the
  189      source code directory by typing `make clean'.  To also remove the
  190      files that `configure' created (so you can compile the package for
  191      a different kind of computer), type `make Distclean'. The latter
  192      also removes all Makefiles (except the one at the top level).
  193 
  194 Compilers and Options
  195 =====================
  196 
  197    Some systems require unusual options for compilation or linking that
  198 the `configure' script does not know about.  You can give `configure'
  199 initial values for variables by setting them in the environment:
  200 
  201      ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix 
  202 
  203 You also can use this facility to specify a compiler other than the default
  204 gcc (if it exists).
  205 
  206 Installation Names
  207 ==================
  208 
  209    By default, `make install' will install the package's files in
  210 `/usr/local/bin', `/usr/local/lib', etc.  You can specify an
  211 installation prefix other than `/usr/local' by giving `configure' the
  212 option `--prefix=PATH':
  213 
  214 e.g.,
  215 	./configure --prefix=/soft/saord
  216 
  217 Programs will be installed in /soft/saord/bin, libraries in /soft/saord/lib,
  218 and include files in /soft/saord/include. We recommend this as a general rule,
  219 in order to keep SAORD software in one place that does not conflict with other
  220 installations. Note that you will need to add the bin directory to your path.
  221 
  222    You can specify separate installation prefixes for architecture-specific
  223 files and architecture-independent files.  If you give `configure' the option
  224 `--exec-prefix=PATH', the package will use PATH as the prefix for installing
  225 programs and libraries. Documentation and other data files will still use the
  226 regular prefix.
  227 
  228    In addition, if you use an unusual directory layout you can give
  229 options like `--bindir=PATH' to specify different values for particular
  230 kinds of files.  Run `configure --help' for a list of the directories
  231 you can set and what kinds of files go in them.
  232 
  233    If the package supports it, you can cause programs to be installed
  234 with an extra prefix or suffix on their names by giving `configure' the
  235 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
  236 
  237 Optional Features
  238 =================
  239 
  240    Some packages pay attention to `--enable-FEATURE' options to
  241 `configure', where FEATURE indicates an optional part of the package.
  242 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
  243 is something like `gnu-as' or `x' (for the X Window System).  The
  244 `README' should mention any `--enable-' and `--with-' options that the
  245 package recognizes.
  246 
  247 Specifying the System Type
  248 ==========================
  249 
  250    There may be some features `configure' can not figure out
  251 automatically, but needs to determine by the type of host the package
  252 will run on.  Usually `configure' can figure that out, but if it prints
  253 a message saying it can not guess the host type, give it the
  254 `--host=TYPE' option.  TYPE can either be a short name for the system
  255 type, such as `sun4', or a canonical name with three fields:
  256      CPU-COMPANY-SYSTEM
  257 
  258 See the file `config.sub' for the possible values of each field.  If
  259 `config.sub' isn't included in this package, then this package doesn't
  260 need to know the host type.
  261 
  262    If you are building compiler tools for cross-compiling, you can also
  263 use the `--target=TYPE' option to select the type of system they will
  264 produce code for and the `--build=TYPE' option to select the type of
  265 system on which you are compiling the package.
  266 
  267 Sharing Defaults
  268 ================
  269 
  270    If you want to set default values for `configure' scripts to share,
  271 you can create a site shell script called `config.site' that gives
  272 default values for variables like `CC', `cache_file', and `prefix'.
  273 `configure' looks for `PREFIX/share/config.site' if it exists, then
  274 `PREFIX/etc/config.site' if it exists.  Or, you can set the
  275 `CONFIG_SITE' environment variable to the location of the site script.
  276 A warning: not all `configure' scripts look for a site script.
  277 
  278 Operation Controls
  279 ==================
  280 
  281    `configure' recognizes the following options to control how it
  282 operates.
  283 
  284 `--cache-file=FILE'
  285      Use and save the results of the tests in FILE instead of
  286      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
  287      debugging `configure'.
  288 
  289 `--help'
  290      Print a summary of the options to `configure', and exit.
  291 
  292 `--quiet'
  293 `--silent'
  294 `-q'
  295      Do not print messages saying which checks are being made.  To
  296      suppress all normal output, redirect it to `/dev/null' (any error
  297      messages will still be shown).
  298 
  299 `--srcdir=DIR'
  300      Look for the package's source code in directory DIR.  Usually
  301      `configure' can determine that directory automatically.
  302 
  303 `--version'
  304      Print the version of Autoconf used to generate the `configure'
  305      script, and exit.
  306 
  307 `configure' also accepts some other, not widely useful, options.
  308 
  309 If you have questions, please contact us at: saord@cfa.harvard.edu.
  310 
  311 							Eric Mandel
  312