Env Variables
Env Variables
Variables
Version 6
© 2003 Alias|Wavefront, a division of Silicon Graphics Limited. All rights reserved.
Alias and the Alias|Wavefront logo are registered trademarks and Alias|Wavefront, Conductors, Trax, IPR, Maya Shockwave 3D
Exporter, Maya Artisan, Maya Cloth, Maya Complete, Maya Fluid Effects, Maya Fur, Maya Live, Maya Paint Effects, Maya Unlimited,
and MEL are trademarks of Alias|Wavefront, a division of Silicon Graphics Limited. Maya is a registered trademark of Silicon
Graphics, Inc., used exclusively by Alias|Wavefront, a division of Silicon Graphics Limited. IRIX, Open GL, and Silicon Graphics are
registered trademarks and SGI is a trademark of Silicon Graphics, Inc. mental ray and mental images are registered trademarks of
mental images GmbH & Co. KG. Lingo is a trademark and Macromedia, Director, Shockwave and Macromedia Flash are registered
trademarks of Macromedia, Inc. Wacom is a trademark of Wacom Co., Ltd. NVidia is a registered trademark and Gforce is a
trademark of NVidia Corporation. Linux is a registered trademark of Linus Torvalds. Intel and Pentium are registered trademarks of
Intel Corporation. Red Hat is a registered trademark of Red Hat, Inc. ActiveX, Microsoft, and Windows are trademarks of Microsoft
Corporation in the United States and/or other countries. Mac, Macintosh and QuickTime are trademarks of Apple Computer, Inc.,
registered in the United States and other countries. Adobe, Acrobat, and Photoshop are trademarks of Adobe Systems Incorporated.
UNIX is a registered trademark, licensed exclusively through X/Open Company, Ltd. All other trade names, trademarks and/or service
marks are trademarks or registered trademarks of their respective owners. AutoCAD is a registered trademark of Autodesk, Inc.
Adobe Illustrator and Acrobat are registered trademarks of Adobe Systems Incorporated. OpenFlight is a registered trademark of
MultiGen Inc. Java is a registered trademark of Sun Microsystems, Inc. All other trademarks, trade names, services marks, or product
names mentioned herein are property of their respective owners.
This document contains proprietary and confidential information of Alias|Wavefront, a division of Silicon Graphics Limited, and is
protected by Federal copyright law and international intellectual property agreements and treaties. The contents of this document
may not be disclosed to third parties, translated, copied, or duplicated in any form, in whole or in part, or by any means, electronic,
mechanical, photocopying, recording or otherwise, without the express prior written consent of Alias|Wavefront, a division of Silicon
Graphics Limited. The information contained in this document is subject to change without notice. Neither Alias|Wavefront, a division
of Silicon Graphics Limited, nor its affiliates, nor their respective directors, officers, employees, or agents are responsible for punitive
or multiple damages or lost profits or any other direct, indirect, special, indirect, incidental, or consequential damages including any
damages resulting from loss of business arising out of or resulting from the use of this material, or for technical or editorial omissions
made herein.
Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1 Environment Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
About Environment variables . . . . . . . . . . . . . . . . . . . . . . . . . 5
Setting environment variables using Maya.env . . . . . . . . . . . . . . . . . . 5
Setting environment variables using system commands on Windows
and IRIX and Linux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Standard paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
General variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
File path variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Rendering variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Mac OS X specific variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Linux and IRIX specific variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Basics
3
Table of Contents
Basics
4
1 Environment
Variables
About Environment variables
Setting environment variables using
Maya.env
Environment variables are a useful way to modify the standard path
locations and behavior used by Maya. For example, you can:
• Set Maya to look in a different directory than the default for custom
scripts using the MAYA_SCRIPT_PATH environment variable.
• Point to an area with more disk space so you have enough room for
temporary render cache files using the TEMPDIR environment
variable.
Many of the variables used by Maya are set automatically when you start
Maya.
There are two ways to set environment variables: using the standard
operating system commands, or editing the Maya.env file. Using the
Maya.env file is recommended so that you don’t clutter the standard
environment settings with Maya-specific variables. You can also set up
Maya.env as a roaming profile to be shared by many machines; this can be
useful, for example, when you are performing distributed rendering
among several Windows machines. See your networking documentation
for details on setting up roaming profiles.
Basics
5
1 | Environment Variables
About > Setting environment variables using Maya.env
Examples
• This example uses Mac OS X-specific formatting and typical folders.
USER_SCRIPT_PATH = /Volumes/Sapphire/render/scenes/lego pov library/Library;/
Volumes/Sapphire/render/scenes/maya/scripts;
MAYA_SCRIPT_PATH = $USER_SCRIPT_PATH;$MAYA_SCRIPT_BASE/scripts/
test;$MAYA_SCRIPT_BASE/scripts/unsupported;
• The following example shows how you can define your own variable
(SHARED_MAYA_DIR) and use it to set the value of other Maya
variables.
SHARED_MAYA_DIR = HostName:/usr/localhome/public/maya/6.0
MAYA_SCRIPT_PATH = $SHARED_MAYA_DIR/scripts:$MAYA_APP_DIR/scripts/custom
MAYA_PLUG_IN_PATH = $SHARED_MAYA_DIR/plug-ins
Basics
6
1 | Environment Variables
About > Setting environment variables using system commands on Windows and IRIX
and Linux
TMPDIR = /disk2/tempspace
• This example is the same as IRIX and Linux, but with Windows-
specific formatting.
MAYA_SCRIPT_PATH = %MAYA_APP_DIR%\scripts\test
MAYA_PLUG_IN_PATH = %MAYA_LOCATION%\devkit\plug-ins;%MAYA_LOCATION%\devkit\test
TMPDIR = D:\tempspace
Standard paths
When Maya loads environment variable settings into its memory, it adds
some standard paths to certain environment variables to ensure that some
things Maya requires to run are always available. This affects the
following variables:
MAYA_PLUG_IN_PATH
MAYA_MODULE_PATH
Basics
7
1 | Environment Variables
About > General variables
MAYA_SCRIPT_PATH
XBMLANGPATH
When you set these paths yourself, variables you set using the operating
system methods override all other settings, variables you set in Maya.env
override standard settings, and the standard settings are used if not
overridden by system variables or Maya.env.
Because your path settings take priority over standard Maya paths, it is
possible to override Maya needs to run.
On Windows and IRIX and Linux, you can try starting Maya with only
default settings by typing maya -default at the following at the
command line.
General variables
MAYA_DEBUG_ENABLE_CRASH_REPORTING (Windows, IRIX, and
Linux)
When Maya encounters a fatal error, this variable writes a crash report
file (.crash) in the current working directory. This file contains a
detailed description of what Maya was doing when the failure
occurred.
To enable this option, set the value equal to 1. To disable it, set the
value to 0 (zero) or leave it undefined.
MAYA_DISABLE_BACKSPACE_DELETE (Windows, IRIX, and Linux)
Disables the functionality of the Backspace key. To enable this option,
set the value equal to 1. To disable it, set the value to 0 (zero) or leave
it undefined.
MAYA_FUR_LIGHT_CLAMPING
In a scene in which the intensity of the lights exceeded 1.0, rendered
fur would never be brighter than the diffuse and specular color values
defined for the fur. You would expect the rendered fur to become
increasingly brighter as the lighting increased. This is not only logical,
but also consistent with how other renderers, including the Maya
Basics
8
1 | Environment Variables
About > General variables
Basics
9
1 | Environment Variables
About > File path variables
You can use this to point Maya to a central help server, or set it to a
file: URL to have Maya get its help files directly from the filesystem
instead of a help server (make sure to unzip the help directories
before you try to use a file: URL).
Incorrect use of this flag will prevent online help from working within
Maya.
MAYA_OVERRIDE_UI
If this environment variable is set, Maya won’t load the file
initialLayout.mel, which creates the interface. You must specify an
alternate file to run (for example, MAYA_OVERRIDE_UI = test.mel).
This variable should only be specified if you want to completely
replace Maya’s UI for your own, custom-programmed interface.
MAYA_PAINT_EFFECTS_THREADS
Paint Effects uses the multiple processors on your machine when
painting and rendering. You can set this variable to control the
number of processors used by Maya. The minimum is one (1) and the
maximum is three (3).
WINEDITOR (Windows, IRIX and Linux)
Allows you to override the Expression Editor and use your own
editor. The editor must be set to run in the foreground.
Basics
10
1 | Environment Variables
About > File path variables
%MAYA_APP_DIR%\maya\6.0\modules $MAYA_APP_DIR/maya/6.0/modules
%MAYA_APP_DIR%\maya\modules $MAYA_APP_DIR/maya/modules
C:\AW\Modules\maya\6.0 /usr/aw/modules/maya/6.0
C:\AW\Modules\maya /usr/aw/modules/maya
MAYA_MOVIE_DIR
This variable is used to override the directory where movie files are
found. The default is $MAYA_LOCATION/extras/Movies/en_US/.
e.g. MAYA_MOVIE_DIR=$MAYA_LOCATION/extras/Movies/
ja_JP.EUC/
MAYA_LOCATION
The path for the Maya installation directory. If it is not set, it defaults
to /usr/aw/mayaVersionNumber (IRIX and Linux) or C:\Program
Files\Alias \MayaVersionNumber (Windows).
On Mac OS X, Maya is installed as /Applications/Maya 6.0/
Maya.app. Since OS X architecture makes it difficult to access the
contents of the Maya application package, we strongly discourage the
use of MAYA_LOCATION on Mac OS X. Instead, use the following
alternate locations:
Basics
11
1 | Environment Variables
About > File path variables
• /Users/Shared/Alias/maya/6.0
• /Users/Shared/Alias/maya
• under your Home folder, in Library/Preferences/Alias/maya/6.0
• under your Home folder, in Library/Preferences/Alias/maya.
MAYA_PLUG_IN_PATH
Search path for plug-ins. When a plug-in is specified by relative path
name, the directories in this path will be searched for the given plug-
in name. This path also determines which directories will be listed in
the Plug-in Manager.
Default for Windows Default for IRIX and Linux Default for Mac OS X
MAYA_PRESET_PATH
Defines the location for Maya presets. Each entry in the path points to
the directory above the attrPresets directory.
MAYA_PROJECT
Defines the default location of your project. You can change the
location at any time by choosing File > Project. This variable simply
defines the default.
Basics
12
1 | Environment Variables
About > File path variables
MAYA_SCRIPT_PATH
Colon-separated search path for Mel scripts. If an unresolved Mel
procedure is called, then this path will be searched for a script that
implements it. Also, if a Mel file is sourced without giving the full
path, then this path will be searched.
The following table lists the default paths, which will always follow
any path that you specify.
Default for Windows Default for IRIX and Linux Default for Mac OS X
TEMP or TMPDIR
This variable specifies the directory location Maya uses for various
temporary files, such as:
• temporary render cache files during a render
• crash files if Maya crashes
Basics
13
1 | Environment Variables
About > Rendering variables
On IRIX and Linux, set TMPDIR only. On Windows, set both TEMP
and TMPDIR. If not set, the temporary directory is /tmp (IRIX and
Linux), or C:/temp (Windows), or under your Home folder in
Documents/temp.
XBMLANGPATH
For both all, this variable specifies the location of icon files, such as
icons used for Shelf buttons. On IRIX and Linux, the syntax is slightly
different then other paths. For example:
XBMLANGPATH = "./icons/%B:$HOME/dev/icons/%B"
In this example, %B is acts as a placeholder that will be replaced by
Maya with the bitmap filename.
The following table lists the default paths, which will always follow
any path that you specify.
Default for Windows Default for IRIX and Default for Mac OS X
Linux
Rendering variables
AW_JPEG_Q_FACTOR
This variable can be used to specify the quality of JPEG files that Maya
renders out. The valid values are 1 through 100, with 100 being the
highest quality.
Basics
14
1 | Environment Variables
About > Rendering variables
MAYA_NO_JITTER_FINAL_COLOR
If you are quantizing to 8-bit color, we apply some randomness, or
jitter, to the color. To enable this option, set the value equal to 1. To
disable it, set the value to 0 (zero) or leave it undefined.
MAYA_RENDERER_RT_BACKGROUND_COLOR
If you set this variable to 1, Maya includes the camera background in
the calculation of reflection and refraction rays. If you set this variable
to 0 (zero) or leave it undefined, Maya ignores the background color
for these rays.
MAYA_USE_V1_CAMERA
Allows you to revert to the old (Maya 1.0/1.5) camera model
behavior. Starting with Maya 2.0, we have fixed how the camera
behaves when lens squeeze is not 1.0, or when the resolution’s aspect
ratio is not the same as the x-resolution divided by the y-resolution. If
you are in the middle of a job started with Maya 1.0/1.5, you may
need the old (incorrect) behavior for continuity.
To enable this option, set the value equal to 1. To disable it, set the
value to 0 (zero) or leave it undefined.
MAYA_USE_VERSION1_DISPLACEMENT
Allows you to revert to the old (Maya 1.0) displacement mapping
behavior. Starting with Maya 1.5/2.0, we significantly improved
displacement mapping. If you are in the middle of a job started using
Maya 1.0, you may need the old behavior for continuity.
To enable this option, set the value equal to 1. To disable it, set the
value to 0 (zero) or leave it undefined.
MAYA_USE_VERSION1_POLY_TANGENT
Allows you to revert to the old (Maya 1.0) polygon tangent calculation
behavior. For Maya 1.5/2.0 we significantly improved the way we
calculate tangents on polygon objects. This primarily affects bump-
mapping. If you are in the middle of a job started using Maya 1.0, you
may need the old behavior for continuity.
To enable this option, set the value equal to 1. To disable it, set the
value to 0 (zero) or leave it undefined.
MAYA_HW_FILE_TEXTURE_RESOLUTION_OVERRIDE
Enable this flag to force baked file textures to be the maximum of the
texture resolution attribute on the file texture or the actual file texture
dimensions.
Basics
15
1 | Environment Variables
About > Mac OS X specific variables
the left mouse button the left mouse button the left mouse button
the middle mouse button command + the left mouse command + the left mouse
button button
the right mouse button the right mouse button control + the left mouse
button
option + the right mouse option + the right mouse control + option + the left
button button mouse button
or
command + the right mouse
button
MAYA_MAC_MENUS_ARE_OPAQUE
This environment variable lets you change the opacity of pane menus.
If you set the variable to 1, then the pane menus appear opaque. If
you set the variable to 0 (zero) or leave it undefined, then the pane
menus appear with Mac OS X default transparency. This variable does
not affect the opacity of the main menus.
Basics
16
1 | Environment Variables
About > Linux and IRIX specific variables
MAYA_MAC_MENUS_ARE_OPAQUE MAYA_MAC_MENUS_ARE_OPAQUE
=0 =1
Basics
17
1 | Environment Variables
About > Linux and IRIX specific variables
Basics
18