1<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 3//EN"> 2<HTML><HEAD> 3 <TITLE>User's Guide - Appendix C. Environment Variables and Command Line Options</TITLE> 4 <META HTTP-EQUIV="keywords" CONTENT="GRAPHICS VISUALIZATION VISUAL PROGRAM DATA 5MINING"> 6 <meta http-equiv="content-type" content="text/html;charset=ISO-8859-1"> 7</HEAD><BODY BGCOLOR="#FFFFFF" link="#00004b" vlink="#4b004b"> 8 <TABLE width=510 border=0 cellpadding=0 cellspacing=0> 9 <TR> 10 <TD><IMG SRC="../images/spacer.gif" WIDTH=80 HEIGHT=1></TD> 11 <TD><IMG SRC="../images/spacer.gif" WIDTH=49 HEIGHT=1></TD> 12 <TD><IMG SRC="../images/spacer.gif" WIDTH=24 HEIGHT=1></TD> 13 <TD><IMG SRC="../images/spacer.gif" WIDTH=100 HEIGHT=1></TD> 14 <TD><IMG SRC="../images/spacer.gif" WIDTH=3 HEIGHT=1></TD> 15 <TD><IMG SRC="../images/spacer.gif" WIDTH=127 HEIGHT=1></TD> 16 <TD><IMG SRC="../images/spacer.gif" WIDTH=6 HEIGHT=1></TD> 17 <TD><IMG SRC="../images/spacer.gif" WIDTH=50 HEIGHT=1></TD> 18 <TD><IMG SRC="../images/spacer.gif" WIDTH=71 HEIGHT=1></TD> 19 </TR> 20 <TR> 21 <TD colspan=9><IMG src="../images/flcgh_01.gif" width=510 height=24 border="0" alt="OpenDX - Documentation"></TD> 22 </TR> 23 <TR> 24 <TD colspan=2><A href="../allguide.htm"><IMG src="../images/flcgh_02.gif" width=129 height=25 border="0" alt="Full Contents"></A></TD> 25 <TD colspan=3><A href="../qikguide.htm"><IMG src="../images/flcgh_03.gif" width=127 height=25 border="0" alt="QuickStart Guide"></A></TD> 26 <TD><A href="../usrguide.htm"><B><IMG src="../images/flcgh_04d.gif" width=127 height=25 border="0" alt="User's Guide"></B></A></TD> 27 <TD colspan=3><A href="../refguide.htm"><IMG src="../images/flcgh_05.gif" width=127 height=25 border="0" alt="User's Reference"></A></TD> 28 </TR> 29 <TR> 30 <TD><A href="usrgu072.htm"><IMG src="../images/flcgh_06.gif" width=80 height=17 border="0" alt="Previous Page"></A></TD> 31 <TD colspan=2><A href="usrgu074.htm"><IMG src="../images/flcgh_07.gif" width=73 height=17 border="0" alt="Next Page"></A></TD> 32 <TD><A href="../usrguide.htm"><IMG src="../images/flcgh_08.gif" width=100 height=17 border="0" alt="Table of Contents"></A></TD> 33 <TD colspan=3><A href="usrgu067.htm"><IMG src="../images/flcgh_09.gif" width=136 height=17 border="0" alt="Partial Table of Contents"></A></TD> 34 <TD><A href="usrgu080.htm"><IMG src="../images/flcgh_10.gif" width=50 height=17 border="0" alt="Index"></A></TD> 35 <TD><A href="../srchindx.htm"><IMG SRC="../images/flcgh_11.gif" width=71 height=17 border="0" alt="Search"></A></TD> 36 </TR> 37 </TABLE> 38 <H2><A name="HDRAPB" ></A>Appendix C. Environment Variables and Command Line Options</H2> 39 <P><A NAME="PToC16" HREF="../usrguide.htm">Partial Table-of-Contents</A> 40 <MENU> 41<LI><A NAME="PToC_477" HREF="#HDRENVVAR">C.1 Environment Variables</A> 42<MENU> 43<LI><A NAME="PToC_478" HREF="#HDRPATHVAR">Path Variables</A> 44<LI><A NAME="PToC_484" HREF="#HDRMOREVAR">Other Environment Variables</A> 45</MENU> 46<LI><A NAME="PToC_509" HREF="usrgu074.htm#HDRCMDLOPT">C.2 Command Line 47Options</A> 48</MENU><HR><P> 49<HR> 50<H2><A NAME="HDRENVVAR" ></A>C.1 Environment Variables</H2> 51<A NAME="IDX1030"></A> 52<A NAME="IDX1031"></A> 53<P> 54The environment variables described in this section can be set in your 55login profile to customize Data Explorer. 56Note also that these variables can be overridden on the command line 57(see <A HREF="usrgu074.htm#HDRCMDLOPT">C.2 , "Command Line Options"</A>). 58<P> 59<H3><A NAME="HDRPATHVAR" ></A>Path Variables</H3> 60<P> 61Path variables specify a directory or directories to be searched for 62files. 63Directories are searched in the order of their appearance in the 64variable, reading from left to right, with successive path names 65separated by a colon (:). 66Thus when a file appears in more than one directory, Data Explorer will choose 67the first copy it finds (i.e., in the leftmost directory 68containing a copy). 69<P> 70<H5><U>DXDATA</U></H5> 71specifies directories to be searched for importable 72data files. 73If the data to be imported is in your current directory or one of the 74specified directories, you do not need to enter the complete 75path name in the Configuration dialog box for the 76Import tool: 77given just the file name, the Import module will search all of these 78directories. 79<P> 80<H5><U>DXINCLUDE</U></H5> 81specifies directories to be searched 82for include scripts. 83Data Explorer uses include scripts in script mode. 84It is not necessary to specify this variable in Edit mode. 85<P> 86See <A HREF="usrgu056.htm#HDRFILINCL">"File Inclusion"</A> for more information. 87<P> 88<H5><U>DXMACROS</U></H5> 89specifies directories to be searched for macros when Data Explorer 90starts up. 91If DXMACROS is not specified, you will have to load 92macros individually (see <A HREF="usrgu044.htm#HDRMACROS">7.2 , "Creating and 93Using Macros"</A>). 94<P> 95<H5><U>DXMODULES</U></H5> 96specifies the directories to be searched for outboard modules. 97<P> 98<H4><U>Setting a Path Variable: Examples</U></H4> 99<P> 100Note the colon (:) separating successive path names. 101<UL> 102<P><LI>To set DXMACROS for both the Bourne (sh) and the Korn (ksh) shells: 103<PRE> 104DXMACROS=/usr/mydirectory/projectAmacros:/usr/mydirectory/projectBmacros 105export DXMACROS 106</PRE> 107<P><LI>To set DXDATA for the Korn shell (ksh) only: 108<PRE> 109export DXDATA=/usr/mydirectory/mydata:/usr/group/groupdata 110</PRE> 111<P><LI>To set DXDATA for the C shell (csh): 112<PRE> 113setenv DXDATA /usr/mydirectory/mydata:/usr/group/groupdata 114</PRE> 115</UL> 116<P> 117<H3><A NAME="HDRMOREVAR" ></A>Other Environment Variables</H3> 118<P> 119<H5><U>DX8BITCMAP</U></H5> 120sets the level at which the change to using a private color map is made. 121The allowed values are -1 and the range from 0 (zero) to 1 (one) 122and represent the Euclidean distance in RGB color space, 123normalized to 1 (one) for the maximum 124allowed discrepancy. 125The default value is 0.1. 126If this variable is set to 1, a private color map will never be used; 127conversely, if it is set to -1, a private color map will always 128be used. 129(See Display in <I>IBM Visualization Data Explorer User's Reference</I>.) 130<P> 131<H5><U>DXARGS</U></H5> 132specifies the default set of arguments for Data Explorer start-up. 133An option specified on the command line will override the corresponding 134setting in the variable. 135 136<P> 137<H5><U>DXAXESMAXWIDTH</U></H5> 138sets the number of digits in axes tick labels at which a switch to 139scientific notation is made. The default is 7. 140 141 142<P> 143 <H5><U>DXCOLORS</U></H5> 144 145specifies a file name containing 146string and RGB value pairs as an alternate for 147/usr/local/dx/lib/colors.txt. 148The string name can be used by any Data Explorer tool where a color can be 149specified by name (for example, Color). 150The RGB value specifies the specific numeric value for the color. 151 152 <P> 153<H5><U>DXDELAYEDCOLORS</U></H5> 154enables ReadImage to create delayed color images if the image is a tiff 155format image saved in a byte-with-colormap format or a GIF format. 156This feature is enabled if this variable is set to any value. 157Delayed colors use less memory. 158<P> 159<H5><U>DXEXEC</U></H5> 160specifies an executive to be run at start-up. 161You should set this variable only for a customized version of Data Explorer. 162 163<P> 164<H5><U>DXFLING</U></H5> 165If DXFLING is set to 1, then for hardware-rendered images, in rotation 166mode and execute-on-change mode, if you drag the mouse across the image, 167and release the mouse button outside the image, the object in the image 168will begin to rotate, and will continue to rotate until you click inside 169the image. The direction and speed of the mouse motion before release 170will affect the rotation direction and rotation speed of the object in 171the window. 172 173<P> 174<H5><U>DXGAMMA</U></H5> 175sets the gamma correction for 176 177software-rendered 178 179images displayed to the screen by a 180Display or Image tool. 181On many display devices a given change in the digital brightness of the 182image is not reflected in a corresponding change in screen 183brightness. 184A gamma correction is a nonlinear adjustment of the pixel values to 185compensate for this difference and produce a more accurate 186representation on the screen. 187By default (except for 188 1898-bit windows on 190 191the sgi architecture), the correction factor 192(exponent) is 2 (two), on the assumption that the display 193is not otherwise gamma corrected. 194The <TT>DXGAMMA</TT> variable allows you to override this default. 195In particular, if the display device is already gamma corrected, set 196the variable to 1 (one). 197(See Display in <I>IBM Visualization Data Explorer User's Reference</I>, and 198README_sgi in /usr/local/dx.) 199<P> 200<H5><U>DXGAMMA_8BIT, DXGAMMA_12BIT, and DXGAMMA_24BIT</U></H5> 201set the gamma correction for 202 203software-rendered 204 205images displayed to the screen in 8-, 12-, 206or 24-bit windows by a Display or Image tool. 207This variable overrides the value set by DXGAMMA. 208<P> 209<H5><U>DXHOST</U></H5> 210specifies the machine name of the server on which the executive is to 211be run. 212The default is "localhost". 213(See <A HREF="usrgu049.htm#HDRCONSERV">9.3 , "Connecting to the Server"</A> for 214information on how to connect to the 215server.) 216To determine the host name, enter the command: 217<PRE> 218uname -n 219</PRE> 220 221<P> 222<H5><U>DXHWGAMMA</U></H5> 223sets the gamma correction for hardware-rendered images displayed to the 224screen by a Display or Image tool. On many display devices a given 225change in the digital brightness of the image is not reflected in a 226corresponding change in screen brightness. A gamma correction is a 227non-linear adjustment of the pixel values to compensate for this 228difference and produce a more accurate representation on the screen. 229By default, the correction factor is 2, on the assumption that the 230display is not otherwise gamma corrected. The <TT>DXHWGAMMA</TT> 231variable allows you to override this default. In particular, if the 232display device is already gamma corrected, set the variable to 1. 233<P> 234<H5><U>DXHWMOD</U></H5> 235if both GL and OpenGL are supported, you can override the default 236library (which is platform-specific; please see the appropriate README 237file for your architecture in <TT>/usr/local/dx</TT>) 238by using this environment variable. It should be set to either DXhwdd.o 239(for GL) or DXhwddOGL.o (for OpenGL). 240 241<P> 242<H5><U>DXMDF</U></H5> 243specifies the name of the .mdf file that contains 244custom-added modules for customized versions of Data Explorer. 245<P> 246<H5><U>DXMEMORY</U></H5> 247sets the amount of memory (in megabytes) that can be used by the 248executive. 249 250<P> 251<H5><U>DX_SIMPLE_LOOPS</U></H5>for faces, loops, and edges data, if set, will calculate loops such that the enclosing loop for a face must be listed first. This will increase performance; however, if faces, loops, and edges data do not conform, the executive will crash. 252 <P> 253 <H5><U>DXNO_BACKING_STORE</U></H5> 254 if set to anything, disables framebuffer readbacks. Setting this environment variable will improve performance of interaction with hardware rendered images, especially for machines for which readback is slow. However, some of the interactions in the image window (such as zoom) will result in a black image while interaction is taking place. If you are not planning on using the Image tool, then it is strongly recommended that this environment variable be set. The default is that framebuffer readbacks are enabled. 255 <P></P> 256 <H5><U>DXPIXELTYPE</U></H5> 257 258sets the image type to either 24-bit color images or 259floating-point-based 96-bit images (the default). 260This affects the behavior of Render and ReadImage. 261This variable can be set to either DXByte (24 bits) or DXFloat (96 bits). 262Setting this variable to DXByte will result in images taking up less 263memory. 264<P> 265<H5><U>DXPROCESSORS</U></H5> 266 267sets the number of processors for Data Explorer SMP. 268 269 <P></P> 270 <H5><U>DXRSH</U></H5> 271 specifies the remote shell command to use when connecting to other systems (such as those when using distributed execution). The default is the the path to rsh. 272 <P></P> 273 <H5><U>DXRSH_NOENV</U></H5> 274 prevents the remote "invoke dxexec" script from being written with a full carbon copy of the local environment (only DISPLAY is set). 275 <P></P> 276 <H5><U>DXROOT</U></H5> 277specifies the top-level directory for all the files and 278directories needed by Data Explorer. 279The default is /usr/local/dx. 280 281<P> 282<H5><U>DXSHMEM</U></H5> 283specifies whether or not shared memory should be used. The amount of 284memory allocated by Data Explorer for its data and object management can be set 285at runtime with the <TT>-memory</TT> command line option. At startup, 286Data Explorer either allocates a shared memory segment or expands the existing 287data segment to create this space. 288<P> 289SMP (multiprocessor) systems are required to use shared memory so each 290processor can share a common data space. SGI systems also use shared 291memory for space. IBM systems use shared memory if the size to be 292allocated is larger than 256 MB. In all other cases Data Explorer extends the 293existing data segment using the brk() system call. 294<P> 295Each architecture (SGI, IBM, HP, ...) has a different way of 296configuring the maximum user data segment size, and a different way of 297setting the limit on the maximum size of a single shared memory segment. 298Consult your system administrator or system documentation if you have 299problems getting Data Explorer to use the amount of memory which should be 300available to you. 301<P> 302If you have problems using a large data segment, you can force Data Explorer to 303use shared memory by setting the <TT>DXSHMEM</TT> environment variable 304to any value other than -1. This will override the defaults and use 305shared memory for space. Alternatively, you can force Data Explorer to extend 306the 307data segment (if allowed for the architecture) by setting 308<TT>DXSHMEM</TT> to -1. 309<P><B>Note: </B>Regardless of the setting of <TT>DXSHMEM</TT>, the aviion and 310sun4 architectures always use the data segment. 311<P> 312<H5><U>DXSHMEMSEGMAX</U></H5> 313Some architectures have a default configuration which limits the size of 314shared memory segments (see the architecture specific README file in 315<TT>/usr/local/dx</TT>), and the system configuration must be changed as 316root to increase the maximum allowed size of a shared memory segment. If 317the maximum is not reset or if it is already set to a different limit, 318then you can use <TT>DXSHMEMSEGMAX</TT> to tell Data Explorer what the current 319limit is in megabytes (e.g. 128 == 128 MB). Data Explorer will allocate 320multiple shared memory segments if necessary to get the total amount of 321space, but it must be able to allocate them at contiguous virtual memory 322addresses. 323 324 <P> 325 <H5><U>DX_HW_TMESH_ORIENT_SENSITIVE</U></H5>allows the user to set how triangle meshes are generated. If not set, then dx will try and extend a mesh by flipping triangles. This can cause problems with two sided hardware rendering. If set to a value other than 0, then the meshes will not be extended. <H5></H5> 326 <H5><U>DX_SMALL_ARENA_FACTOR</U></H5> 327 allows the user to specify the ratio between the large and small arena. The value must be set greater than 0 and up to 8. Typically the small arena is 1/16 of the large arena, setting this environment variable to 8 will make dx allocate an equal amount of memory to the large and small arena. 328 <P></P> 329 <H5><U>DXUINOCATCHERROR</U></H5> 330 Setting this environment variable informs the user interface to ignore OS signals. The user interface normally traps OS signals so that it may save networks on the event that the UI crashes. So setting this variable results in a standard crash. 331 <P></P> 332 <H5><U>DX_USER_INTERACTOR_FILE</U></H5> 333 334Specifies a file containing user interactors for use by the 335SuperviseState and SuperviseWindow modules (see 336<A HREF="refgu152.htm#HDRSUPSTAT">SuperviseState</A> and <A 337HREF="refgu153.htm#HDRSUPWIND">SuperviseWindow</A> in <I>IBM Visualization Data 338Explorer User's Reference</I>). 339 340 <P> 341 <H5><U>DX_WEB_BROWSER</U></H5>under UNIX specifies the web browser to launch for viewing the HTML documentation. Under Windows and MacOS X setting this environment variable will launch the systems default web browser. 342 <HR> 343 <P> </P> 344 <DIV align="center"> 345 <P><A href="../allguide.htm"><IMG src="../images/foot-fc.gif" width="94" height="18" border="0" alt="Full Contents"></A> <A href="../qikguide.htm"><IMG src="../images/foot-qs.gif" width="94" height="18" border="0" alt="QuickStart Guide"></A> <A href="../usrguide.htm"><IMG src="../images/foot-ug.gif" width="94" height="17" border="0" alt="User's Guide"></A> <A href="../refguide.htm"><IMG src="../images/foot-ur.gif" width="94" height="18" border="0" alt="User's Reference"></A></P> 346 </DIV> 347 <DIV align="center"> 348 <P><FONT size="-1">[ <A href="http://www.research.ibm.com/dx">OpenDX Home at IBM</A> | <A href="http://www.opendx.org/">OpenDX.org</A> ] </FONT></P> 349 <P></P> 350 </DIV> 351 <P></P> 352 </BODY></HTML> 353
