Updated 15/February/2015 (build 3.2.07.2)

--------------------------------------------
Running Terragen 3 Linux From a Command Line
--------------------------------------------

Terragen 3 for Linux is a command line render node which doesn't have a GUI.

SETUP
-----

If Terragen is not in the current working directory, it will probably make lots of complaints when it starts. It's not enough just to pass the full path of the Terragen 3 command when you run it. Terragen needs to know where it can find other related files.

To fix this, you can set the TERRAGEN_PATH environment variable. For example you can set TERRAGEN_PATH to your user directory like this if you use bash :

    export TERRAGEN_PATH=~/

If you use tcsh:

    setenv TERRAGEN_PATH ~/

In other shells you would use the appropriate syntax.

IMPORTANT: If you set the TERRAGEN_PATH variable you modify the behaviour of all instances of Terragen within the scope of the variable, and this may cause problems if you have multiple versions installed. You can avoid using the TERRAGEN_PATH variable if you 'cd' to the directory before calling the executable.


EXECUTION
---------

Once you have changed into the executable folder, you can run Terragen 3. Here are some examples:


Run Terragen 3 as normal:

    ./terragen

Run Terragen 3 and load a project file:

    ./terragen -p project.tgd

Run Terragen 3 and load a project file, render to a file and then close:

    ./terragen -p project.tgd -exit -r -o test.tif

Run Terragen 3 and load a project file, render frame 42 and then close:

    ./terragen -p project.tgd -exit -r -f 42

Run Terragen 3 and load a project file, render frames 1,4,51,53,55,57,59 and then close:

    ./terragen -p project.tgd -exit -r -f 1,4,51-60/2


IMPORTANT: Currently (v2.4.20.0), Terragen automatically sets the -hide and -exit flags whenever -r is set, but you should always set -hide and -exit if you don't want this behaviour to change in future versions.


ALL COMMAND LINE OPTIONS
------------------------

-exit
Exit Terragen after rendering has finished.


-f <frameRange|commaSeparatedFrameRanges>
Set the frame range or list of frame ranges to render when -r is also used. If -r is not used, the current frame is set to the first in the range/list.
The list can contain any combination of frames or frame ranges separated by commas without any whitespace.

Example: -f 34
Set the frame to render to 34.

Example: -f 1-100
Set the frame range to render from 1 to 100 (inclusive).

Example: -f 1-100/5
Set the frame range to render from 1 to 100 with a step size of 5. This produces the sequence 1, 6, 11, 16, ... , 96.
Note that frame 100 is not rendered because 96 + 5 = 101 which is outside the specified range.

Example: -f 34,37,38
Set the list of frames to render to 34, 37, 38

Example: -f 1-50,66,71-100/10
Set the list of frames to render from 1 to 50 (inclusive) followed by 66 followed by 71, 81, 91.
Note that frame 100 is not rendered because 91 + 10 = 101 which is outside the specified range.


-hide
Hide the graphical user interface. Do not show any dialog boxes. This is not really relevant to the Linux render node as it doesn't have a GUI.


-no3dpreview
Do not open the 3D Preview automatically. This is not really relevant to the Linux render node as it doesn't have a GUI.


-nonetworkview
Do not open the Network View automatically (except in Node Network Layout). This is not really relevant to the Linux render node as it doesn't have a GUI.


-o <filename>
Set the renderer's output image filename to <filename> before rendering.
C-style format strings can be used to automatically insert the frame number,
eg. '~/frames/image.%04d.IMAGETYPE.exr'
Supported image extensions are .bmp, .rgb, .sgi, .exr, .tif, .tiff


-ox <filename>
Set the renderer's "extra output images" filename to <filename> before rendering.
Extra output images should contain the string "IMAGETYPE" (not including quotes).
When a render element is written, "IMAGETYPE" is automatically replaced by the name of the element.
By default the only element is "tgAlpha", but additional elements can be enabled using a Render Layer.

For example:

'~/frames/image.0023.IMAGETYPE.exr'

may result in:

'~/frames/image.0023.alpha.exr'
'~/frames/image.0023.surfrgb.exr'
'~/frames/image.0023.surfalpha.exr'
etc.

C-style format strings can be used to automatically insert the frame number. Example:

'~/frames/image.%04d.IMAGETYPE.exr'

Supported image extensions are .bmp, .rgb, .sgi, .exr, .tif, .tiff


-p <filename>
Open the project specified by <filename> before doing anything else.


-r
Render current frame (or frame range with -f) using the "master" renderer; save output image and extra output images (if enabled).
The -hide and -exit flags are set automatically in the current version.
The "master" renderer is the render node which has its "master" setting enabled,
or the first render node in the project if none are masters.
Another render node can be made the "master" by using the -rendernode command line option.


-rendernode <nodename>
Make <nodename> the "master" renderer after autoloading the project at startup.
<nodename> must be the name of a render node in the project.
Projects loaded subsequently are not affected.


-threads <numberOfThreads>
Override the number of threads used for rendering and other multithreaded tasks.
When used, this command line override takes priority over the min/max thread settings in the render node and the cores override in Preferences.


-tilex <minx> <maxx>
Limit the rendered region to a fraction of the image or crop region to be rendered.
minx and maxx should be numbers between 0 and 1, where minx < maxx.
For example, "-tilex 0 0.5" renders only the left half of the image or the left half of whatever crop region was already set.


-tiley <miny> <maxy>
Limit the rendered region to a fraction of the image or crop region to be rendered.
miny and maxy should be numbers between 0 and 1, where miny < maxy.
For example, "-tiley 0 0.5" renders only the bottom half of the image or the bottom half of whatever crop region was already set.


-cropoutput
Crop the output image(s) to the dimensions of the rendered region (defined by "crop region" and/or -tilex, -tiley), i.e. do not pad to the full image dimensions.


-w <filename>
The same as the -p option

