### INSTALLATION INSTRUCTIONS ###

                                IMAGIX 4D
                               Release 10.X
                              Linux Platforms


==========================
INTRODUCTION
==========================

This set of installation instructions contains the following sections:

A. Installing software
B. Installing eval/product license
C. Installing separate license server
D. Installing newer software
E. Uninstalling
F. Using Imagix 4D


==========================
A. INSTALLING SOFTWARE
==========================

--- Obtaining a License ---

The Imagix 4D software distribution includes a file containing a demo
license.  By completing installation of the software, you are agreeing
to the terms and conditions of the license agreement.


--- Installation ---

Use the following procedure to install Imagix 4D:

1. Get the necessary Imagix 4D software.
      (If installing from the Imagix website, download the installer
       for Linux.)

2. Decide which workstation you will install the software on.
      (The Imagix 4D license floats across workstations and operating
       systems.  You need to chose one workstation in your network as
       your Imagix 4D file server.  It will be the workstation where
       you will install the software.  This may or may not be the
       same workstation that you use as the license server -- see
       section B.

       Once you have decided where you will install the Imagix 4D
       application software, move all of the files from step 1 to
       the directory that will hold the top-level Imagix tool
       directory.)

3. Log into the Imagix 4D file server, gaining server access.
      (If you are installing on a remote server, disable access
       control to the window manager as appropriate to your system.
       For example, you might enter "xhost +".)

4. Expand the imgx.linux.tar.gz file.
          gzip -d imgx.linux.tar.gz

5. Un-tar the imgx.linux.tar file:
	  tar xvfo imgx.linux.tar ...
      (You might use the o function modifier so that the right
       ownership of the tar-ed files gets established. See tar
       manpages.)

6. Run "imagix/bin/imagix".
      (This starts Imagix 4D.  In most cases, the demo license is
       automatically installed.  If it does not automatically install,
       the Imagix License Installer will provide you information and
       may ask you to take action.)

7. Exit Imagix 4D, using File > Exit.

8. Exit the Imagix 4D file server.

You are now ready to run the trial version of Imagix 4D from any
networked Linux workstation.  To start the tool, cd to the
../imagix/bin directory, and enter `./imagix'.  To make invoking the
tool easier, users should add the directory ../imagix/bin in their path.

-----

If you encounter problems running imagix (a start-up script), the
following modification may help.  Change the first line of the imagix
script to reflect the full path to the imagix script in your
environment:

        set prog=$0
   should change to something like:
        set prog=/usr/your_full_path/.../imagix/bin/imagix



--- Patches ---

There may be patches available for this version of Imagix 4D.  All
current patches, along with an index and installation instructions,
are available electronically:

    www.imagix.com/download/patches


--- Using the demo software ---

Running under the demo license, Imagix 4D is fully functional,
except that the data import functions have been disabled.  Sample
data (a demo project) is automatically loaded and you can use all the
capabilities of the Imagix 4D tool to explore the sample data.  If
you'd like to evaluate Imagix 4D on your own code, please contact
Imagix Corporation or your local distributor.  We would be delighted
to provide you with a temporary evaluation license.


==========================
B. INSTALLING EVAL/PRODUCT LICENSE
==========================

--- Obtaining a License ---

In order to explore your own software, you need to install an evaluation
or product license.  To obtain a license, contact your local distributor
or Imagix:

                Imagix Corporation
                6025 White Oak Lane
                San Luis Obispo, CA, USA  93401

		tel:   1.805.781.6002
		email: sales@imagix.com
                https: www.imagix.com

--- Installation ---

There are two approaches of installing the Imagix 4D floating license
under Linux.  The file-based approach is easier to install and
administer, but only supports Imagix 4D clients running under Linux
that are able to invoke the executables installed on the license
server machine.  If you want to also be able to run Imagix 4D under
Windows, or if you want to run Imagix 4D client applications on
workstations which cannot read / execute software from the license
server machine, then you'll need to install the Imagix 4D floating
license using the license server-based approach.  The actual floating
license file supports both approaches.

Section C provides instructions for when you are using the license
server-based approach, and want to install only the license server,
without the Imagix 4D client application, on the license server
machine.  Otherwise, these following (section B) instructions apply.

If you have not yet installed the demo software, first install it
according to the section A instructions.  Note that if installing a
final product license, the software installation in section A needs
to be on the same machine that the license key was issued for.  Once
you've installed the software, you'll use the Imagix license installer
to install the license.

1. Copy the license file to a location in your file system.
      (While you may copy the license to anywhere in your file system.
       the preferred location is ../imagix/data.  Note that there is
       already a file named ../imagix/data/license.  This is the demo
       license; do not delete it.  Typically, the evaluation or product
       license is named imgx_lic, but any name is acceptable.)

2. Log into the Imagix 4D file server, gaining server access.
      (If you are installing on a remote server, disable access
       control to the window manager as appropriate to your system.
       For example, you might enter "xhost +".)

3. Change directory to `imagix'.

4. Run "bin/imagix" and the license server
      (The Imagix license installer is started by invoking Imagix 4D.
       If your current (demo) license is not valid, this starts the
       Imagix license installer directly.  Otherwise, it starts Imagix
       4D, from which you can access the license installer through the
       Help > License > Install menu.)

5a. Either install using the file-based approach.
      (If your license file is of the node-locked license type, at
       this point you can simply follow the steps in the license 
       installer.  In the final dialog, you'll need to specify the
       license file.  This refers to the license that you copied over
       in step 2, above.  The browser opens in ../imagix/data.  Remember
       that the file named license in that directory is the demo license,
       not the evaluation or product license.)

5b. Or install using the server-based approach on the license server.
      (If you decide to install using the server-based floating
       license approach, you'll need to know the hostname (such as
       dilbert) or the ip address (such as 123.456.78.90) of the
       machine you're using as the license server.  This needs to
       be the same machine that the license key was issued for.
       You'll also need to choose a port number to use for the
       tcp/ip socket communications.  You can refer to /etc/services
       to find which ports are already being used by your system
       applications.  Numbers in the range 8100-9999 are usually
       good choices.

       To install the license server, you can follow the steps in the
       license installer.  In the final dialog, you'll need to specify
       the license file.  This refers to the license that you copied
       over in step 2, above.  The Browse opens in ../imagix/data. 
       Remember that the file named license in that directory is the
       demo license, not the evaluation or product license.  You'll also
       need to specify the hostname or ip address in the IP Address
       field, and the port number in the Port field.

       Once you've set up server-based licensing, the Imagix license
       server on the license server machine will need to be running
       before you can start the Imagix 4D clients themselves.  Start the
       license server by invoking ../imagix/bin/imagix-licsrv.

       You can configure your system so that imagix-licsrv is
       automatically started at boot-up on the license server machine.
       A sample systemd service file and a sample System V rc script
       are included as sample_licsrc_xxx in the ../imagix/bin directory.)

5c. Or install using the server-based approach on a client workstation.
      (This applies if you already have the Imagix License Server 
       installed and running on a different machine, and want to install
       Imagix 4D simply as a client application on a given workstation.

       Follow the steps of the Imagix license installer.  In the final
       dialog, you will need to specify some information about the
       configuration of the Imagix License Server running on the actual
       license server machine.  For the IP Address entry field, you'll
       need to enter either the hostname (such as dilbert) or the ip
       address (such as 123.456.78.90) of the license server machine.
       For the Port entry field, you'll need to enter the port/socket
       which has been specified for communication with the license
       server.  This will be some number in the range 1024-49151.)

6. Exit the Imagix 4D file server.

7. Set the paths for Imagix 4D by asking users to add .../imagix/bin
     to their paths.

You are now ready to use the product version of Imagix 4D.  To run the
tool, enter `imagix'.


==========================
C. INSTALLING SEPARATE LICENSE SERVER
==========================

The following are instructions for installing the Imagix license server
on a Linux machine separate from the machine being used as the Imagix 4D
file server.  For an overview of license installation alternatives, and
a description to this approach, see section B.

1. Determine where you'll install the Imagix license server.
      (If you decide to install using the server-based floating
       license approach, you'll need to know the hostname (such as
       dilbert) or the ip address (such as 123.456.78.90) of the
       machine you're using as the license server.  This needs to
       be the same machine that the license key was issued for.
       You'll also need to choose a port number to use for the
       tcp/ip socket communications.  You can refer to /etc/services
       to find which ports are already being used by your system
       applications.  Numbers in the range 8100-9999 are usually
       good choices.

       Make a note of the port number as well as the hostname /
       ip address.  Users will need to have this information to
       configure licensing on the Imagix 4D application, in order
       to direct the application to communicate with the license
       server.  You'll also use this information in step 8.)

2. Get the necessary Imagix 4D software.
      (If installing from the Imagix website, download the installer
       for Linux.)

3. Expand the imgx.linux.tar.gz file.
          gzip -d imgx.linux.tar.gz

4. Un-tar the imgx.linux.tar file:
	  tar xvfo imgx.linux.tar ...
      (You might use the o function modifier so that the right
       ownership of the tar-ed files gets established. See tar
       manpages.

       The location where the untarred files reside is temporary.
       The files must be visible to the license server machine,
       but they will later be deleted in step 10.)

5. Run "bin/install-licsrv".
      (This will copy the license server-specific portions of the
       full Imagix 4D installation to the location you select for
       running the license server.  Invoking "bin/install-licsrv"
       initially will provide the full syntax for the install-licsrv
       command.  Once you have reviewed this, rerun "bin/install-licsrv"
       with the required arguments.)

6. Copy the license key to the appropriate location.
      (Upon successful completion of step 5, you'll receive a message
       indicating where to copy the license key.)

7. Log into the license server machine and change directory to `imagix'
      (This is the license server location created in step 5, not
       the temporary location created in step 4.  If you're already
       logged into the license server machine, then you only need
       to cd to the directory.)

8. On the license server machine, run "bin/imagix-licsrv".
      (The first time this is invoked, it will walk you through the
       steps necessary to complete the license server installation.)

9. (Optional) Create and configure installation files.
      (Once you've set up server-based licensing, the Imagix license
       server on the license server machine will need to be running
       before you can start the Imagix tools themselves.  Start the
       license server by invoking ../imagix/bin/imagix-licsrv.

       You can configure your system so that imagix-licsrv is
       automatically started at boot-up on the license server machine.
       A sample systemd service file and a sample System V rc script
       are included as sample_licsrc_xxx in the ../imagix/bin directory.)

10. Delete the installation artifacts.
      (Once you have the Imagix License Server successfully running,
       delete any software remaining in the temporary locations created
       in step 4.)

You are now ready to use the Imagix license server.  Users wanting to
run Imagix 4D will need the information from step 1 to configure the
Imagix 4D client applications.  You may also want to record this
information in case you later want to install newer versions of the
software.


==========================
D. INSTALLING NEWER SOFTWARE
==========================

You may want to periodically check the website for the latest release
of Imagix 4D.  You can find information about the latest Imagix 4D
release at:

        www.imagix.com/download/history.html

If you decide to download and install the current version, first back
up any customized files that you have created in ../imagix/user and
its subdirectories.  Then, after moving or deleting your current
installation of Imagix 4D, follow the instructions in sections A and
B to install the new version.

Typically, the license server software remains compatible between minor
releases (9.x) in the same major release (9).  Therefore, there is not
usually a need to reinstall the license server if it is separate from
the file server where the Imagix 4D software itself is installed; if
you've installed the license server using the approach described in
section C, you don't normally need to reinstall it.


==========================
E. UNINSTALLING
==========================

If you have installed a license server for a floating license (as
described in Section B step 5b), first stop that license server.

Then go to where you have installed Imagix 4D, and use "rm -rf Imagix"
to delete the entire Imagix 4D installation.


==========================
F. USING IMAGIX 4D
==========================

--- Getting Started ---

Imagix 4D comes with extensive documentation, including an on-line
user guide, a built-in tutorial, and tooltips (balloon help).  While
you're using Imagix 4D, you can use the F1 key in to open the user
guide to the appropriate page.  The tooltips can be controlled
through the Files > Options... dialog.

Imagix 4D is a unique tool with very powerful functionality.  You're
likely to find that its significantly different from other tools you
have used.  If you take a few minutes to read the introduction of the
user guide and run the tutorials (see Help > Tour), you'll be able
to use Imagix 4D more efficiently, and be able to apply more of its
powerful functionality.

For instructions on how to load your own code into the Imagix tool,
once you have installed the product license, refer to Help >
QuickStart.


--- Releasing Shared Memory ---

To maximize graphics performance, Imagix 4D uses shared memory whenever
your configuration supports it.  Under most exits, the shared memory is
released by Imagix 4D.  In general, we recommend that you use the
window's quit, the File > Exit menu, a Control-C, or a SIGINT to exit
Imagix 4D.

Under a forced exit, such as a kill -9, the shared memory is not
released, and you need to use ipcs and ipcrm to free it.  Refer to
their respective man pages for how to find and release the shared
memory identifiers.


--- Releasing Licenses ---

Imagix 4D offers a concurrent or `floating' user license model, so that
you can realize maximum benefit from your investment.  A license can be
`checked-out' by any developer at any workstation on your network and
then returned for others to use.  At any time, you can see who currently
has licenses checked out by running ../imagix/bin/imagix-licstatus.

Under most exits, the license is released by Imagix 4D.  In general, we
recommend that you use the window's quit, the File > Exit menu, a
Control-C, or a SIGINT to exit Imagix 4D.

Under a forced exit, such as a kill -9 or a segfault, the license is
not released, but remains `checked-out' by the user.  You can free the
license by having the same user invoke Imagix 4D from the same
workstation and then do a normal exit.