Copyright (c) 2007-2008 Cisco Systems, Inc.  All rights reserved.
Copyright (C) 2018 OpenCFD Ltd.

Preamble
========

The openfoam-selector an OpenFOAM-specific adaptation of the
mpi-selector provided by Jeff Squyres and Cisco Systems.

Overview
========

openfoam-selector is simple tool to help manage multiple OPENFOAM
versions installed on a single host (or cluster).  It allows system
administrators to set a site-wide default OPENFOAM version, but also
allows users to selectively override that site-wide default with their
own choice of OPENFOAM version.

Both selections are optional and independent; system administrators
may choose not to set a site-wide default while users do choose to
their own default (and vice versa).

More information is contained in the openfoam-selector.1 man page.

Installation
============

openfoam-selector is installed with a traditional "configure" / "make"
combination common. The main option that you'll need for "configure"
is the --prefix option, which specifies the top directory where
openfoam-selector and its files are installed.

  shell$ ./configure --prefix=/where/to/install

Then run "make install" to install (you may need root permissions if
installing into restricted directories):

  shell# make install

This command will install the following files:

  $bindir/openfoam-selector
    --> $bindir defaults to "$prefix/bin", unless overridden on
        the "configure" command line
  $mandir/man1/openfoam-selector.1
    --> $mandir defaults to "$prefix/man", unless overridden on
        the "configure" command line
  $pkgdatadir/openfoam-selector.sh
  $pkgdatadir/openfoam-selector.csh
    --> $pkgdatadir defaults to "$prefix/share/openfoam-selector", unless
        overridden on the "configure" command line (RPMs will
        typically change this value -- YMMV).

The two files installed in $pkgdatadir are intended for site-wide
shell startup usage.  For example, on RedHat systems, they should be
copied to /etc/profile.d so that all shells will execute them upon
startup.

These last two files will examine both the site-wide and per user OPENFOAM
version selection, and if one is set, setup the shell's
environment for it.

The shell version also provides an "openfoam_select" function that can
be used directly from the user shell after changing versions and
without logging out.

Contact
=======

If you need assistance with openfoam-selector, first read the
openfoam-selector(1) man page; it contains more information than
listed here.

If that still does not answer your question, please post a gitlab issue
https://develop.openfoam.com/Community/feature-scripts

2018-12-03 OpenCFD Ltd.
