RUSH RENDER QUEUE - ENVIRONMENT VARIABLES
(C) Copyright 1995,2000 Greg Ercolano. All rights reserved.
V 102.40g 05/06/03


Environment Variables

    These environment variables are used by the rush system. Some variables affect the behavior of the rush client program, and some are set by the rush daemon to pass information to the user's Render Script. Some fall into both categories.

    Render Scripts should at very least make use of $RUSH_FRAME or $RUSH_PADFRAME to determine the current frame being rendered.







   RUSH_DIR  

    This variable is the directory name of the rush directory. Normally, this is /usr/local/rush. Appending '/bin' gives a path to the rush(1) and rushd(8) binaries.

    This variable should be in the user's environment so all rush(1) commands can access it, and as well, should also be set in the boot scripts before rushd(8) is started. Both rush(1) and rushd(8) depend on this variable being set.

   RUSH_FRAME  

    This variable contains the frame number to be rendered, i.e., "1", "12", "104". No padded zeroes are used.

   RUSH_FU  

    If set to '1', implies the '-fu' flag for all commands. Not recommended for use in user's environment. This variable is meant only to be used by GUI interfaces that are layered on top of the rush command line tool.

   RUSH_HOSTNAME  

    The local hostname the render script is running on. This is the name that appears in 'rush -lah' reports.

   RUSH_JOBID  

    Contains the jobid of the current running job. i.e., "tahoe-37"

   RUSH_LOGFILE  

    Contains the absolute path to the output log for the currently running render script. The contents of this file grows as the render script generates output.

    The pathname in this variable always ends with the frame number being rendered [eg. 0001, 0002, 0003], so it will be a pathname specific to the current frame being rendered.

    This variable is dependent on the job's current LogDir value, which can be changed dynamically with the rush -logdir command line option.

    For example, the render script can use this variable to search the renderer's output for error messages, and act conditionally based on the error detected. See Detecting Render Problems with Grep for examples of this technique.

   RUSH_PADFRAME  

    This variable contains the frame number to be rendered, and includes 4 padding zeroes,
    I.e., "0001", "0012", "0104".

   RUSH_PRE102_20  

    If set, causes old rush command line options to be in effect:

      NEW BEHAVIOR
      'rush -laj' lists all jobs using fast UDP messaging
      'rush -lac' lists all cpus use
      'rush -lah' lists all hosts (old -lac report)

      OLD BEHAVIOR (PRE-102.20)
      'rush -lac' lists all hosts (new -lah report)
      'rush -laj' lists all jobs, TCP oriented polling

    Setting this variable to any value disables the new behavior in rush(1) 102.20 for commands like 'rush -lac', so as to be backwards compatible with previous versions.

    Use this *only* if you have old scripts or programs dependent on the old behavior of 'rush -lac'.

    Please convert old programs and scripts to use '-lah' instead of '-lac' for hosts reports.

   RUSH_RAM  

    This variable contains the job's current Ram value, which can be changed dynamically with the rush -ram command line option.

   RUSH_TMPDIR  

    Contains the path to a temp directory that is automatically created before the frame starts rendering, and is completely removed after the frame completes execution, deleting all files left behind.

    This variable is dependent on the current TmpDir setting in the rush.conf file.

    Use this variable when creating temporary files in your render script, so that the files are automatically removed even if your renders are bumped or dumped while in progress, e.g.,

      Using RUSH_TMPDIR
      
          ### YOUR RENDER COMMANDS HERE
          render -output $RUSH_TMPDIR/foo.rgb
          post_filter -in=$RUSH_TMPDIR/foo.rgb \
      		-out=/job/SHOW/img/$RUSH_PADFRAME.rgb             
      	
              

   RUSH_TRY  

    The number of times this frame has attempted to render this frame; the number in the 'TRY' column of a 'rush -lf' report. Can be changed with rush -try.