S2PLOT:Environment Variables
From S2PLOT
(Difference between revisions)
| Revision as of 04:38, 4 December 2007 S2plot admin (Talk | contribs) (→Recommended (Build-related)) ← Previous diff |
Revision as of 04:38, 4 December 2007 S2plot admin (Talk | contribs) (→OPTIONAL (BUILD-RELATED)) Next diff → |
||
| Line 110: | Line 110: | ||
| ===OPTIONAL (BUILD-RELATED)=== | ===OPTIONAL (BUILD-RELATED)=== | ||
| - | <table width=100%> | + | <table width=100% border=1> |
| - | <tr><td width=25%>S2FREEGLUT</td><td>Set to "no" or "yes" to choose whether the re-entrant [[Function:s2disp | s2disp]] function will be used on Linux systems that use the freeglut library. NB. only works on Linux systems with freeglut version >= 2.2.0.</td></tr> | + | <tr><td width=15% valign=top>S2FREEGLUT</td><td>Set to "no" or "yes" to choose whether the re-entrant [[Function:s2disp | s2disp]] function will be used on Linux systems that use the freeglut library. NB. only works on Linux systems with freeglut version >= 2.2.0.</td></tr> |
| - | <tr><td>S2FREETYPE</td><td>Set to "no" or "yes" to choose whether the freetype2 extensions will be linked in with programs. | + | <tr><td valign=top>S2FREETYPE</td><td>Set to "no" or "yes" to choose whether the freetype2 extensions will be linked in with programs. |
| Freetype2 is assumed to be installed in the following base directories: | Freetype2 is assumed to be installed in the following base directories: | ||
| Line 121: | Line 121: | ||
| If you have freetype2 installed somewhere else you may need to modify your s2plot.csh or ${S2ARCH}.in file. | If you have freetype2 installed somewhere else you may need to modify your s2plot.csh or ${S2ARCH}.in file. | ||
| </td></tr> | </td></tr> | ||
| - | <tr><td>S2MESHLIB</td><td>Only set this if recommended by your MirrorDome supplier.</td></tr> | + | <tr><td valign=top>S2MESHLIB</td><td>Only set this if recommended by your MirrorDome supplier.</td></tr> |
| </table> | </table> | ||
Revision as of 04:38, 4 December 2007
Contents |
Environment Variables
This is intended to be a comprehensive list of all the environment variables in S2PLOT as well as a description of how they are used. For the relevant version of the environment variables for your S2PLOT installation, see the ENVIRONMENT.TXT file that came with the distribution.
Required (Build-related)
| S2PATH | Full path to S2PLOT directory |
Recommended (Build-related)
| S2ARCH | Operating system, compiler and architecture specification for compiling and linking S2PLOT programs. Valid options are as follows. If not set, s2plot.csh attempts to figure out S2ARCH, but may fail to do so. |
| S2SHARED | Set to "no" or "yes" to indicate preference for static or dynamic linking of binaries. |
Darwin users with PowerPC architecture should generally choose
darwin-gnu-ppc over darwin-gnu-univ.
Darwin users with Intel architecture should generally choose
darwin-gnu-i386 over darwin-gnu-univ.
Windows users must install Cygwin to use S2PLOT.
linux-gnu-i386
Build system: SuSE Linux 9.3 (i386)
Kernel 2.6.11
gcc, gfortran 4.1.0
NVidia OpenGL 1.0.8762
freeglut 2.2.0
Distributed: shared and static libraries
dynamic binaries
FORTRAN extension: .f90
linux-gnu-x86_64
Build system: SuSE Linux 9.3 (x86-64)
Kernel 2.6.11
gcc, g77 3.3.5
NVidia OpenGL 1.0.8762
freeglut 2.2.0
Distributed: shared and static libraries
dynamic binaries
FORTRAN extension: .f
darwin-gnu-i386
Build system: Mac OS X 10.4.8 (i386)
gcc 4.0.1 (Apple build 5363)
gfortran 4.2 (darwinports)
Apple Framework OpenGL, GLUT
Distributed: shared and static libraries
dynamic binaries
FORTRAN extension: .f90
darwin-gnu-univ
Build system: Mac OS X 10.4.8 (i386)
gcc 4.0.1 (Apple build 5363)
*** NO FORTRAN SUPPORT ***
Apple Framework OpenGL, GLUT
Distributed: shared and static libraries
dynamic binaries
darwin-gnu-ppc
Build system: Mac OS X 10.4.7 (powerpc)
gcc 3.3 (Apple build 1819)
g77 3.4.3 (Fink g77-3.4.3-100)
Apple Framework OpenGL, GLUT
Distributed: shared and static libraries
dynamic binaries
FORTRAN extension: .f
cygwin-gnu-i386
Build system: Windows XP Professional 2002 Service Pack 2
CYGWIN_NT-5.1 1.5.22(0.156/4/2)
gcc, g77 3.4.4 (cygming special)
NVidia Driver 7.1.2.4 (15/12/2004)
Distributed: static libraries
static binaries
Notes: install the gcc-g77, freeglut, opengl and
tcsh CYGWIN packages. Also install the
scaleable fonts package (xorg-X11-fscl).
Set S2SHARED to "no".
linux-intel-i386 (*** NOT IN STANDARD RELEASE ***)
Build system: SuSE Linux 9.3 (i386)
Kernel 2.6.11
icc, ifort 9.0
NVidia OpenGL 1.0.8762
freeglut 2.2.0
Distributed: shared and static libraries
dynamic binaries
FORTRAN extension: .f90
darwin-intel-i386 (*** NOT IN STANDARD RELEASE ***)
Build system: Mac OSX 10.4.8 (i386)
icc, ifort 9.0
Apple Framework OpenGL, GLUT
Distributed: shared and static libraries
dynamic binaries
sunos-gnu-sparc (*** NOT IN STANDARD RELEASE ***)
Build system: SunOS 5.8 (Solaris 2.8) (sun4u sparc)
gcc, g77 3.1.1
GLUT 3.7 (1998)
Sun (openwin) GLU and GL libs
Distributed: shared and static libraries
dynamic binaries
FORTRAN extension: .f
OPTIONAL (BUILD-RELATED)
| S2FREEGLUT | Set to "no" or "yes" to choose whether the re-entrant s2disp function will be used on Linux systems that use the freeglut library. NB. only works on Linux systems with freeglut version >= 2.2.0. |
| S2FREETYPE | Set to "no" or "yes" to choose whether the freetype2 extensions will be linked in with programs.
Freetype2 is assumed to be installed in the following base directories:
If you have freetype2 installed somewhere else you may need to modify your s2plot.csh or ${S2ARCH}.in file. |
| S2MESHLIB | Only set this if recommended by your MirrorDome supplier. |
OPTIONAL (RUNTIME-RELATED)
S2PATH: full path to S2PLOT directory
S2PLOT_WIDTH: Provide initial width (in pixels) of S2PLOT display
windows. If not given, width is by default 800 pixels.
S2PLOT_HEIGHT: Provide initial height (in pixels) of S2PLOT display
windows. If not given, height is by default 3/4 of
width.
S2PLOT_MESHFILE: Only set this if recommended by your MirrorDome
supplier.
S2PLOT_DEV: Set this to choose your default S2PLOT output device.
Only relevant when programs specify an empty device string,
or prompt on the terminal for the device choice.
S2PLOT_TEXPATH: Set this to provide an "external" path to texture files,
colormap files and LaTeX template files. When using
textures / colormaps / LaTeX templates in S2PLOT, the
following strategy is used to find named files:
1. if name begins with "." or "/", look for the precisely
named file and nowhere else.
OTHERWISE
2. first look in the current working directory
then look in $S2PLOT_TEXPATH if it is defined
then look in $S2PATH/textures
3. on failure:
for textures: load a "red X" texture for use
for colormaps: load a colormap that has three colors
(red, green then blue)
(red, green then blue)
for LaTeX templates: fail on LaTeX generation and
load a "red X" texture for use
S2PLOT_LATEXBIN: Set this to the fully-qualified path of the LaTeX binary
(latex) if you want to use LaTeX features in S2PLOT.
If your latex binary is in a standard path location, eg.
/usr/bin, then this won't be necessary.
S2PLOT_DVIPNGBIN: Set this to the fully-qualified path of the DVI to PNG
conversion binary (dvipng) if you want to use LaTeX
features in S2PLOT. If your dvipng binary is in a
standard path location, eg. /usr/bin, then this won't
be required.
S2PLOT_IMPATH: Set this to the path containing your ImageMagick binaries.
Without this setting, texturise script/s and LaTeX support
may fail silently.
S2PLOT_FADETIME: Set this to control the fade-in and fade-out time (in
seconds) of S2PLOT programs. The default is to fade-in
and fade-out over approximately 0.2 seconds.
S2PLOT_RUNTIME: If set, S2PLOT programs will be forcibly quit after this
period in seconds. The S2PLOT_RUNTIME period *does not*
include the S2PLOT_FADETIME period at start and end of
the program.
S2PLOT_EVENTFILE:
If set, this is the name of a file containing events that
are pushed into the S2PLOT event stream. Currently only
simple (ASCII code) keypresses are supported. Zero time
commences at the end of the fade-in time.
S2PLOT_X1, S2PLOT_X2, S2PLOT_Y1, S2PLOT_Y2:
In range [0,1], these environment variables can be used
to constrain the area of screen used for S2PLOT graphics.
Typically these would be used in concert with S2PLOT_BGIMG
to provide a full-screen background image, eg. from
Powerpoint, then draw S2PLOT graphics in only a particular
region.
S2PLOT_BGIMG: Filename of a background image to use instead of clearing
the screen.
S2PLOT_INTERSCANBUMP:
If scan-line interleaved stereo is being used, bump the
first line down the screen by one row, thus flipping the
left and right lines in the display. Only useful when
fullscreen windows are being created, or windows are known
to be created at a particular position on the screen.
