You are here: User Guide > Nuke > Configuring Nuke > Nuke Environment Variables

Nuke Environment Variables

The following table lists the environment variables Nuke recognizes.

Environment Variable

Description

FC_DISK_CACHE

The location where Nuke saves all recent images flipbooked with FrameCycler.

If this variable is not set, the location is determined by NUKE_DISK_CACHE.

FC_HOME

This points to the directory that contains bin/framecycler.

FC_PATH

If you want to use a different version of FrameCycler than the one shipped with Nuke, you can use this to set the base directory of FrameCycler. This points to the FrameCycler binary.

FN_CRASH_DUMP_PATH

Allows you to specify where Issue Reporter dumps are saved by default.

FN_DISABLE_LICENSE_DIALOG

or

FN_NUKE_DISABLE_TMPLIC_NOTIFY_DIALOG

By default, if you have installed a temporary license, Nuke displays a dialog at start-up alerting you to the number of days remaining. If you want to disable this behavior, you can set either of these environment variables to 1 to suppress the warning message about imminent license expiration.

NOTE:  You still get a warning if no license is found, for example if you only have a Nuke license but you try to run NukeX.

FOUNDRY_LICENSE_FILE

The location of the Nuke license file (a plain text file called nuke.lic), if the following recommended location is not used:

On Mac OS X and Linux:

/usr/local/foundry/FLEXlm

On Windows XP:

drive letter:\Program Files\The Foundry\FLEXlm

On Windows Vista:

drive letter:\ProgramData\The Foundry\FLEXlm

NUKE_CRASH_HANDLING

Breakpad crash reporting allows you to submit crash dumps to The Foundry in the unlikely event of a crash. By default, crash reporting is enabled in GUI mode and disabled in terminal mode.

When NUKE_CRASH_HANDLING is set to 1, crash reporting is enabled in both GUI and terminal mode.

When NUKE_CRASH_HANDLING is set to 0, crash reporting is disabled in both GUI and terminal mode.

NUKE_DEBUG_MEMORY

When working on large images, Nuke may need to free up memory during rendering. When this happens and NUKE_DEBUG_MEMORY is set to 1, Nuke prints the following information to the console:

Memory: over maximum usage, trying to reduce usage from 1GB to 924MB.

If this variable is not set, you cannot see the debug memory messages.

Note that here, KB, MB, GB, and TB mean units of 1000. For example, 1MB means 1,000,000 bytes.

NUKE_DISK_CACHE

The location where Nuke saves all recent images displayed in the Viewer. Ideally, this should be a local disk with the fastest access time available. It should also have enough space for the maximum flipbook cache size.

If this variable is not set, the location is determined by the flipbook cache setting in the Preferences. By default, this setting points to NUKE_TEMP_DIR.

NUKE_DISK_CACHE_GB

The maximum size the flipbook cache can reach (in gigabytes).

If this variable is not set, the location is determined by the flipbook cache size setting in the Preferences.

NUKE_EXR_TEMP_DIR

On Linux, this is the location Nuke uses for temporary files while reading PIZ-compressed .exr files. This environment variable is only relevant on Linux.

If this variable is not set, the location is determined by NUKE_TEMP_DIR.

NUKE_FONT_PATH

The location that Nuke checks for available font files when the Text node properties panel is opened.

NUKE_INTERACTIVE

The import nuke function checks-out a nuke_r render license by default. If you want to use Nuke interactively, and you have a nuke_i license, set this environment variable to 1.

See Nuke as a Python Module for more information.

NUKE_NO_CRASH_PROMPT

When crash handling is enabled in GUI mode, this allows you to control whether reports are automatically submitted or not:

When NUKE_NO_CRASH_PROMPT is set to 1, crash reports are submitted automatically without displaying a crash reporter dialog.

When NUKE_NO_CRASH_PROMPT is set to 0, Nuke always displays a crash reporter dialog before submitting a crash report.

NUKE_PATH

The location where files related to Nuke customizations are stored. For more information, see Loading Gizmos, NDK Plug-ins, and Python and TCL Scripts.

NUKE_TEMP_DIR

The location where Nuke saves any temporary files that do not have a particular place defined for them.

This is also where the flipbook cache setting in the Preferences defaults to.

OFX_PLUGIN_PATH

The location where Nuke looks for OFX plug-ins. For more information, see Loading OFX Plug-ins.