S2PLOT:Environment Variables

From S2PLOT

(Difference between revisions)
Jump to: navigation, search
Revision as of 04:37, 4 December 2007
S2plot admin (Talk | contribs)
(→OPTIONAL (BUILD-RELATED))
← Previous diff		 Current revision
S2plot admin (Talk | contribs)
(→Optional (runtime-related))
Line 4: Line 4:
===Required (Build-related)=== ===Required (Build-related)===
-<table width=100%>+<table width=100% border=1>
-<tr><td width=25%>S2PATH</td><td>Full path to S2PLOT directory</td></tr>+<tr><td width=15%>S2PATH</td><td>Full path to S2PLOT directory</td></tr>
</table> </table>
===Recommended (Build-related)=== ===Recommended (Build-related)===
-<table width=100%>+<table width=100% border=1>
-<tr><td width=25%>S2ARCH</td><td>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.</td></tr>+<tr><td width=15% valign=top>S2ARCH</td><td>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. See [[S2PLOT:Installation | installation notes]] for recommended values for each operating system.
-<tr><td>S2SHARED</td><td>Set to "no" or "yes" to indicate preference for static or dynamic linking of binaries.</td></tr>+ 
 +* Darwin users with PowerPC architecture should generally choose <tt>darwin-gnu-ppc</tt> over
 +<tt>darwin-gnu-univ</tt>.
 +* Darwin users with Intel architecture should generally choose <tt>darwin-gnu-i386</tt> over <tt>darwin-gnu-univ</tt>.
 +* See [[S2PLOT:Builds | here]] for more information on tested build environments.
 +</td></tr>
 +<tr><td valign=top>S2SHARED</td><td>Set to "no" or "yes" to indicate preference for static or dynamic linking of binaries.</td></tr>
</table> </table>
 +===Optional (build-related)===
-S2ARCH: +<table width=100% border=1>
- +<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>
- Darwin users with PowerPC architecture should generally choose+<tr><td valign=top>S2FREETYPE</td><td>Set to "no" or "yes" to choose whether the freetype2 extensions will be linked in with programs.
- 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)===+
- +
-<table width=100%>+
-<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>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:
* Mac OS X: /usr/X11R6 (ie. installed with Apple X) * Mac OS X: /usr/X11R6 (ie. installed with Apple X)
* Linux: /usr * Linux: /usr
-* Cygwin: /usr 
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>
 +<tr><td valign=top>S2EXTRAINC</td><td>Additional compiler flags for <tt>cbuild.csh</tt> and <tt>ccbuild.csh</tt> scripts, typically used to provide additional include paths for compiling S2PLOT programs.</td></tr>
 +<tr><td valign=top>S2EXTRALIB</td><td>Additional flags for <tt>cbuild.csh</tt> and <tt>ccbuild.csh</tt> scripts typically used to provide additional library search paths and libraries for linking S2PLOT programs
 +</td></tr>
</table> </table>
-===OPTIONAL (RUNTIME-RELATED)===+===Optional (runtime-related)===
 +<table width=100% border=1>
 +<tr><td width=15% valign=top>S2PLOT_WIDTH</td><td> Provide initial width (in pixels) of S2PLOT display windows. If not given, width is by default 800 pixels.</td><tr>
 +<tr><td valign=top>S2PLOT_HEIGHT</td><td>Provide initial height (in pixels) of S2PLOT display windows. If not given, height is by default 3/4 of width.</td></tr>
 +<tr><td valign=top>S2PLOT_ESCQUIT</td><td>If set, S2PLOT programs can be quit by hitting the ESC key alone, without requiring Shift-ESC.</td></tr>
 +<tr><td valign=top>S2PLOT_DEV</td><td>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.</td></tr>
 +<tr><td valign=top>S2PLOT_TEXPATH</td><td>Set this to provide an "external" path to texture files,
 +colourmap files and LaTeX template files. When using textures / colormaps / LaTeX templates in S2PLOT, the following strategy is used to find named files:
-S2PATH: full path to S2PLOT directory+# If name begins with "." or "/", look for the precisely named file and nowhere else.
 +# Look in the current working directory then look in $S2PLOT_TEXPATH if it is defined then look in $S2PATH/textures.
 +# On failure:
 +* for textures: load a "red X" texture for use
 +* for colormaps: load a colormap that has sequences of RGB color triples with values in the range [0...255]:
 +<code><pre>
 +R G B
 +R G B
 +</pre></code>
 +* for LaTeX templates: fail on LaTeX generation and load a "red X" texture for use
 +</td></tr>
 +<tr><td valign=top>S2PLOT_LATEXBIN</td><td>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 environment variable can be left unset.
 +</td></tr>
 +<tr><td valign=top>
 +S2PLOT_DVIPNGBIN</td><td> 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 environment variable can be left unset.
 +</td></tr>
 +<tr><td valign=top>
 +S2PLOT_IMPATH</td><td>Set this to the path containing your ImageMagick binaries. Without this setting, texturise script/s and LaTeX support may fail silently.
 +</td></tr>
 +<tr><td valign=top>
 +S2PLOT_FADETIME</td><td>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.
 +</td></tr>
 +<tr><td valign=top>
 +S2PLOT_RUNTIME</td><td>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.
 +</td></tr>
 +<tr><td valign=top>
 +S2PLOT_EVENTFILE</td><td>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.
 +</td></tr>
 +<tr><td valign=top>
 +S2PLOT_X1
-S2PLOT_WIDTH: Provide initial width (in pixels) of S2PLOT display +S2PLOT_X2
- windows. If not given, width is by default 800 pixels.+
-S2PLOT_HEIGHT: Provide initial height (in pixels) of S2PLOT display+S2PLOT_Y1
- windows. If not given, height is by default 3/4 of+
- width.+
-S2PLOT_MESHFILE: Only set this if recommended by your MirrorDome +S2PLOT_Y2</td><td>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.
- supplier.+</td></tr>
- +<tr><td valign=top>
-S2PLOT_DEV: Set this to choose your default S2PLOT output device.+S2PLOT_BGIMG</td><td>Filename of a background image to use instead of clearing the screen.
- Only relevant when programs specify an empty device string,+</td></tr>
- or prompt on the terminal for the device choice.+<tr><td valign=top>
- +S2PLOT_INTERSCANBUMP</td><td>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.
-S2PLOT_TEXPATH: Set this to provide an "external" path to texture files,+</td></tr>
- colormap files and LaTeX template files. When using +<tr><td valign=top>
- textures / colormaps / LaTeX templates in S2PLOT, the +S2PLOT_INTERSCANATI</td><td>If you are using /s2inter mode on an ATI graphics card on darwin (and possibly linux), you must set this environment variable (to anything): this enables a workaround for a defect in the ATI OpenGL driver code for anti-aliasing.
- following strategy is used to find named files:+</td></tr>
- +<tr><td valign=top>
- 1. if name begins with "." or "/", look for the precisely+S2PLOT_REMOTEPORT</td><td>If set, then S2PLOT will listen on the provided port number for remote control commands. The text strings received can be processed by S2PLOT, and/or forwarded to the callback registered with [[Function:s2srcb | s2srcb]].</td></tr>
- named file and nowhere else.+<tr><td valign=top>
- +S2PLOT_PRCDRIVER</td><td>If set, then S2PLOT will search for a loadable module called <tt>${S2PLOT_PRCDRIVER}.so</tt> (in <tt>$S2PATH/$S2ARCH</tt>) at runtime when the user requests PRC output (typically by pressing Shift-P in an interactive S2PLOT session). The S2PLOT PRC driver module is distributed and built separately to S2PLOT.</td></tr>
- 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.+

Current revision

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)

S2PATHFull path to S2PLOT directory

Recommended (Build-related)

S2ARCHOperating 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. See installation notes for recommended values for each operating system.
  • 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.
  • See here for more information on tested build environments.
S2SHAREDSet to "no" or "yes" to indicate preference for static or dynamic linking of binaries.

Optional (build-related)

S2FREEGLUTSet 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.
S2FREETYPESet 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:

  • Mac OS X: /usr/X11R6 (ie. installed with Apple X)
  • Linux: /usr

If you have freetype2 installed somewhere else you may need to modify your s2plot.csh or ${S2ARCH}.in file.

S2MESHLIBOnly set this if recommended by your MirrorDome supplier.
S2EXTRAINCAdditional compiler flags for cbuild.csh and ccbuild.csh scripts, typically used to provide additional include paths for compiling S2PLOT programs.
S2EXTRALIBAdditional flags for cbuild.csh and ccbuild.csh scripts typically used to provide additional library search paths and libraries for linking S2PLOT programs

Optional (runtime-related)

S2PLOT_WIDTH Provide initial width (in pixels) of S2PLOT display windows. If not given, width is by default 800 pixels.
S2PLOT_HEIGHTProvide initial height (in pixels) of S2PLOT display windows. If not given, height is by default 3/4 of width.
S2PLOT_ESCQUITIf set, S2PLOT programs can be quit by hitting the ESC key alone, without requiring Shift-ESC.
S2PLOT_DEVSet 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_TEXPATHSet this to provide an "external" path to texture files,

colourmap 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.
  2. 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 sequences of RGB color triples with values in the range [0...255]: 
R G B
R G B
  • for LaTeX templates: fail on LaTeX generation and load a "red X" texture for use
S2PLOT_LATEXBINSet 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 environment variable can be left unset.
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 environment variable can be left unset.
S2PLOT_IMPATHSet this to the path containing your ImageMagick binaries. Without this setting, texturise script/s and LaTeX support may fail silently.
S2PLOT_FADETIMESet 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_RUNTIMEIf 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_EVENTFILEIf 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_BGIMGFilename of a background image to use instead of clearing the screen.
S2PLOT_INTERSCANBUMPIf 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.
S2PLOT_INTERSCANATIIf you are using /s2inter mode on an ATI graphics card on darwin (and possibly linux), you must set this environment variable (to anything): this enables a workaround for a defect in the ATI OpenGL driver code for anti-aliasing.
S2PLOT_REMOTEPORTIf set, then S2PLOT will listen on the provided port number for remote control commands. The text strings received can be processed by S2PLOT, and/or forwarded to the callback registered with s2srcb.
S2PLOT_PRCDRIVERIf set, then S2PLOT will search for a loadable module called ${S2PLOT_PRCDRIVER}.so (in $S2PATH/$S2ARCH) at runtime when the user requests PRC output (typically by pressing Shift-P in an interactive S2PLOT session). The S2PLOT PRC driver module is distributed and built separately to S2PLOT.
Retrieved from "https://astronomy.swin.edu.au/s2plot/index.php?title=S2PLOT:Environment_Variables"
Personal tools