Linux Command Line Reference (TG4) - Revision history

Matt: Added link to command line references for all versions, all platforms

2025-07-30T00:14:17Z

Added link to command line references for all versions, all platforms

← Older revision		Revision as of 00:14, 30 July 2025
Line 1:		Line 1:
	This document is a mirror of the file 'linux_command_line.txt' in the Terragen 4 for Linux distribution.		This document is a mirror of the file 'linux_command_line.txt' in the Terragen 4 for Linux distribution.


			See Also: [[Command_Line_Reference\|Command Line References for All Versions, All Platforms]]


	Updated 10/June/2024 (build 4.8.12)		Updated 10/June/2024 (build 4.8.12)

Matt: Updated for build 4.8.12: -renderlayer option

2025-07-29T23:54:33Z

Updated for build 4.8.12: -renderlayer option

← Older revision		Revision as of 23:54, 29 July 2025
Line 1:		Line 1:
	This document is a mirror of the file 'linux_command_line.txt' in the Terragen 4 for Linux distribution.		This document is a mirror of the file 'linux_command_line.txt' in the Terragen 4 for Linux distribution.

	Updated 1/~~July~~/~~2022~~ (build 4.6.11)		Updated 10/June/2024 (build 4.8.12)


Line 221:		Line 221:
	The "master" renderer is the render node which has its "master" setting enabled,		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.		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.		Another render node can be made the master by using the -rendernode command line option.


Line 227:		Line 227:

	Make <nodename> the "master" renderer after autoloading the project at startup.		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.		Projects loaded subsequently are not affected.
			<nodename> must be the name or full path of a render node in the project,
			and it must be surrounded by quotes if it contains any spaces (quotes are optional if there are no spaces).


			-renderlayer <renderLayer>

			Connect <renderLayer> to the "master" renderer after autoloading the project at startup.
			Projects loaded subsequently are not affected.
			<renderLayer> must be the name or full node path of a Render Layer node in the project,
			and it must be surrounded by quotes if it contains any spaces (quotes are optional if there are no spaces).
			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 is applied before -renderlayer regardless of their order in the command line).

Matt: Minor corrections, consistency with Windows command line docs (4.6.11)

2022-07-01T11:38:36Z

Minor corrections, consistency with Windows command line docs (4.6.11)

← Older revision		Revision as of 11:38, 1 July 2022
Line 1:		Line 1:
	This document is a mirror of the file 'linux_command_line.txt' in the Terragen 4 for Linux distribution.		This document is a mirror of the file 'linux_command_line.txt' in the Terragen 4 for Linux distribution.

	Updated 4/~~January~~/~~2021~~ (build 4.5.56)		Updated 1/July/2022 (build 4.6.11)


Line 57:		Line 57:


	~~IMPORTANT~~: Currently 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.		Note: Currently Terragen automatically sets the -hide and -exit flags whenever -r or -exportvdb is set, but you should always set -hide and -exit if you don't want this behaviour to change in future versions.


Line 66:		Line 66:
	-exit		-exit

	Exit Terragen after rendering ~~has~~ finished.		Exit Terragen after all rendering and other commands have finished.


Line 150:		Line 150:
	'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'<br/>		'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'<br/>
	etc.		etc.


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

	Example:		Example:
			./terragen -p project.tgd -exportvdb "Easy cloud 01" cloud.vdb -threads 8
	./terragen -p project.tgd -exportvdb "Easy ~~Cloud~~ 01" cloud.vdb -threads 8

	The cloud name needs to be in quotes if there are spaces in its name (usually there are). Similarly for filenames. The use of the -threads command line option is optional, and can be inserted anywhere in the command line as long as it is followed by an integer number and doesn't break apart any other argument groups.		The cloud name needs to be in quotes if there are spaces in its name (usually there are). Similarly for filenames. The use of the -threads command line option is optional, and can be inserted anywhere in the command line as long as it is followed by an integer number and doesn't break apart any other argument groups.

Matt: OCIO arguments, 4.5.56

2021-01-04T18:06:11Z

OCIO arguments, 4.5.56

← Older revision		Revision as of 18:06, 4 January 2021
Line 1:		Line 1:
	This document is a mirror of the file 'linux_command_line.txt' in the Terragen 4 for Linux distribution.		This document is a mirror of the file 'linux_command_line.txt' in the Terragen 4 for Linux distribution.

	Updated 13/~~November~~/~~2018~~ (build 4.3.16)		Updated 4/January/2021 (build 4.5.56)


Line 193:		Line 193:
	This overrides the "create subfolders" option in the project's render node, which is usually enabled.		This overrides the "create subfolders" option in the project's render node, which is usually enabled.
	If the command line contains both -oxsubfolders and -oxsubfolders=no then the behaviour is undefined.		If the command line contains both -oxsubfolders and -oxsubfolders=no then the behaviour is undefined.


			-ocio

			Enable "Use OCIO" in Project Settings at startup and after loading a project.
			For this to be useful there must be an environment variable named OCIO pointing to a valid OCIO config file.
			Terragen will default to roles which work well with ACES 1.0.3 but might not be compatible with your OCIO configuration.
			We recommend testing this feature in the GUI first to see if the default settings are suitable.
			Please send us feedback if you think our defaults could be better or you need more controls.


			-ocio=no

			Disable "Use OCIO" in Project Settings at startup and after loading a project.

Matt at 22:11, 13 March 2019

2019-03-13T22:11:37Z

← Older revision		Revision as of 22:11, 13 March 2019
Line 7:		Line 7:
	Running Terragen 4 Linux From a Command Line		Running Terragen 4 Linux From a Command Line
	--------------------------------------------		--------------------------------------------


	Terragen 4 for Linux is a command line render node which doesn't have a GUI. Apart from rendering frames, it also supports additional commands such as exporting VDB files.		Terragen 4 for Linux is a command line render node which doesn't have a GUI. Apart from rendering frames, it also supports additional commands such as exporting VDB files.

Matt at 21:19, 13 March 2019

2019-03-13T21:19:15Z

← Older revision		Revision as of 21:19, 13 March 2019
Line 167:		Line 167:

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


	may result in:		may result in:

Matt at 21:18, 13 March 2019

2019-03-13T21:18:06Z

Matt at 21:09, 13 March 2019

2019-03-13T21:09:19Z

← Older revision		Revision as of 21:09, 13 March 2019
Line 132:		Line 132:


	For example:		For example:<br/>

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

	may result in:		may result in:<br/>
			'~/frames/image.0023.tgAlpha.exr'<br/>
	'~/frames/image.0023.tgAlpha.exr'		'~/frames/image.0023.tgSurfRgb.exr'<br/>
	'~/frames/image.0023.tgSurfRgb.exr'		'~/frames/image.0023.tgSurfAlpha.exr'<br/>
	'~/frames/image.0023.tgSurfAlpha.exr'
	etc.		etc.

	or, if "create subfolders" option is enabled (in project or command line), may result in:		or, if "create subfolders" option is enabled (in project or command line), may result in:<br/>
			'~/frames/tgAlpha/image.0023.tgAlpha.exr'<br/>
	'~/frames/tgAlpha/image.0023.tgAlpha.exr'		'~/frames/tgSurfRgb/image.0023.tgSurfRgb.exr'<br/>
	'~/frames/tgSurfRgb/image.0023.tgSurfRgb.exr'		'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'<br/>
	'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'

	etc.		etc.

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

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

Matt at 21:07, 13 March 2019

2019-03-13T21:07:35Z

← Older revision		Revision as of 21:07, 13 March 2019
Line 135:		Line 135:

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


	may result in:		may result in:
Line 143:		Line 142:
	'~/frames/image.0023.tgSurfAlpha.exr'		'~/frames/image.0023.tgSurfAlpha.exr'
	etc.		etc.


	or, if "create subfolders" option is enabled (in project or command line), may result in:		or, if "create subfolders" option is enabled (in project or command line), may result in:
Line 150:		Line 148:
	'~/frames/tgSurfRgb/image.0023.tgSurfRgb.exr'		'~/frames/tgSurfRgb/image.0023.tgSurfRgb.exr'
	'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'		'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'

	etc.		etc.


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

Matt at 21:04, 13 March 2019

2019-03-13T21:04:32Z

← Older revision		Revision as of 21:04, 13 March 2019
Line 72:		Line 72:
	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.		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.		The list can contain any combination of frames or frame ranges separated by commas without any whitespace.


	Example: -f 34		Example: -f 34

	Set the frame to render to 34.		Set the frame to render to 34.


	Example: -f 1-100		Example: -f 1-100

	Set the frame range to render from 1 to 100 (inclusive).		Set the frame range to render from 1 to 100 (inclusive).


	Example: -f 1-100/5		Example: -f 1-100/5
Line 85:		Line 88:
	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.		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.		Note that frame 100 is not rendered because 96 + 5 = 101 which is outside the specified range.


	Example: -f 34,37,38		Example: -f 34,37,38

	Set the list of frames to render to 34, 37, 38		Set the list of frames to render to 34, 37, 38


	Example: -f 1-50,66,71-100/10		Example: -f 1-50,66,71-100/10
Line 125:		Line 130:
	When a render element is written, "IMAGETYPE" is automatically replaced by the name of the element.		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.		By default the only element is "tgAlpha", but additional elements can be enabled using a Render Layer.


	For example:		For example:

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


	may result in:		may result in:
Line 136:		Line 143:
	'~/frames/image.0023.tgSurfAlpha.exr'		'~/frames/image.0023.tgSurfAlpha.exr'
	etc.		etc.


	or, if "create subfolders" option is enabled (in project or command line), may result in:		or, if "create subfolders" option is enabled (in project or command line), may result in:
Line 143:		Line 151:
	'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'		'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'
	etc.		etc.


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

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


	Supported image extensions are .bmp, .rgb, .sgi, .exr, .tif, .tiff		Supported image extensions are .bmp, .rgb, .sgi, .exr, .tif, .tiff
Line 155:		Line 165:
	Create and use subfolders when outputting render elements (extra output images).		Create and use subfolders when outputting render elements (extra output images).
	This overrides the "create subfolders" option in the project's render node.		This overrides the "create subfolders" option in the project's render node.


	For example:		For example:

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


	may result in:		may result in:
Line 166:		Line 178:
	'~/frames/tgSurfAlpha/image.0023.exr'		'~/frames/tgSurfAlpha/image.0023.exr'
	etc.		etc.


	It can be combined with the use of "IMAGETYPE" in the filename, so the following is possible:		It can be combined with the use of "IMAGETYPE" in the filename, so the following is possible:
Line 173:		Line 186:
	'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'		'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'
	etc.		etc.


	If the command line contains both -oxsubfolders and -oxsubfolders=no then the behaviour is undefined.		If the command line contains both -oxsubfolders and -oxsubfolders=no then the behaviour is undefined.
Line 236:		Line 250:
	Generate a voxel buffer from the density of the specified cloud layer and export it to an OpenVDB file.		Generate a voxel buffer from the density of the specified cloud layer and export it to an OpenVDB file.

	Example: ./terragen -p project.tgd -exportvdb "Easy Cloud 01" cloud.vdb -threads 8		Example:

			./terragen -p project.tgd -exportvdb "Easy Cloud 01" cloud.vdb -threads 8

	The cloud name needs to be in quotes if there are spaces in its name (usually there are). Similarly for filenames. The use of the -threads command line option is optional, and can be inserted anywhere in the command line as long as it is followed by an integer number and doesn't break apart any other argument groups.		The cloud name needs to be in quotes if there are spaces in its name (usually there are). Similarly for filenames. The use of the -threads command line option is optional, and can be inserted anywhere in the command line as long as it is followed by an integer number and doesn't break apart any other argument groups.

← Older revision		Revision as of 21:18, 13 March 2019
Line 132:		Line 132:


	For example:~~<br/>~~		For example:

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

	may result in:~~<br/>~~		may result in:

	'~/frames/image.0023.tgAlpha.exr'<br/>		'~/frames/image.0023.tgAlpha.exr'<br/>
	'~/frames/image.0023.tgSurfRgb.exr'<br/>		'~/frames/image.0023.tgSurfRgb.exr'<br/>
Line 141:		Line 143:
	etc.		etc.

	or, if "create subfolders" option is enabled (in project or command line), may result in:~~<br/>~~		or, if "create subfolders" option is enabled (in project or command line), may result in:

	'~/frames/tgAlpha/image.0023.tgAlpha.exr'<br/>		'~/frames/tgAlpha/image.0023.tgAlpha.exr'<br/>
	'~/frames/tgSurfRgb/image.0023.tgSurfRgb.exr'<br/>		'~/frames/tgSurfRgb/image.0023.tgSurfRgb.exr'<br/>
Line 147:		Line 150:
	etc.		etc.

	C-style format strings can be used to automatically insert the frame number. Example:~~<br/>~~		C-style format strings can be used to automatically insert the frame number. Example:

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

Line 167:		Line 171:
	may result in:		may result in:

	'~/frames/tgAlpha/image.0023.exr'		'~/frames/tgAlpha/image.0023.exr'<br/>
	'~/frames/tgSurfRgb/image.0023.exr'		'~/frames/tgSurfRgb/image.0023.exr'<br/>
	'~/frames/tgSurfAlpha/image.0023.exr'		'~/frames/tgSurfAlpha/image.0023.exr'<br/>
	etc.		etc.

Line 175:		Line 179:
	It can be combined with the use of "IMAGETYPE" in the filename, so the following is possible:		It can be combined with the use of "IMAGETYPE" in the filename, so the following is possible:

	'~/frames/tgAlpha/image.0023.tgAlpha.exr'		'~/frames/tgAlpha/image.0023.tgAlpha.exr'<br/>
	'~/frames/tgSurfRgb/image.0023.tgSurfRgb.exr'		'~/frames/tgSurfRgb/image.0023.tgSurfRgb.exr'<br/>
	'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'		'~/frames/tgSurfAlpha/image.0023.tgSurfAlpha.exr'<br/>
	etc.		etc.