Following lists the set of command line supported by
RealityServer. Command line options take precedence
over configuration file options. All are optional
unless otherwise marked.
copyright
| Description |
Outputs the copyright message |
| Syntax |
--copyright
|
version
| Description |
Outputs the RealityServer Web Services
version number
|
| Syntax |
--version
|
warm_up
| Description |
Performs a warm up render using Iray Photoreal and then
immediately exits. If rendering succeeds the return code
will be 0. If rendering fails the return code will be
non-zero.
|
| Syntax |
--warm_up
|
help
| Description |
Outputs the RealityServer command line
help
|
| Syntax |
--help
|
| Short Syntax |
-h
|
config_file
| Description |
Specifies the name of the configuration
file to read
|
| Syntax |
--config_file filename
|
| Compulsory |
yes |
override
| Description |
Override a config file entry |
| Syntax |
--override setting=value
|
| Short Syntax |
-o setting=value
|
Any simple directive may be overwritten on the command line.
content_root
| Description |
Overrides the content root directory
given in the config file
|
| Syntax |
--content_root directory
|
| Config file override |
content_root |
http_address
| Description |
Overrides the http address given in the
config file
|
| Syntax |
--http_address address
|
| Config file override |
http_address |
rtmp_address
| Description |
Overrides the rtmp address given in the
config file
|
| Syntax |
--rtmp_address address
|
| Config file override |
rtmp_address |
verbose
| Description |
Controls the verbosity of the
logging
|
| Syntax |
--verbosity int
|
| Short Syntax |
-v int
|
| Default |
3 |
In the range 0-4.
- 0
- Fatal
- 1
- Error
- 2
- Warning
- 3
- Info
- 4
- Verbose
coloring
| Description |
Create a colored log file |
| Syntax |
--coloring
|
If on then console control codes will be inserted into the log message to highlight info,
warning and error messages. Mainly only useful when not logging to file.
errtrace
| Description |
Increase # of error messages
shown
|
| Syntax |
--errtrace
|
gputrace
| Description |
Increase # of gpu messages shown |
| Syntax |
--gputrace
|
disktrace
| Description |
Increase # of disk messages shown |
| Syntax |
--disktrace
|
network
| Description |
Turn networking on or off |
| Syntax |
--network on|off
|
| Config file override |
network |
no_gpu
| Description |
Disables GPU usage on this host |
| Syntax |
--no_gpu
|
no_opengl
| Description |
Disables OpenGL usage on this host |
| Syntax |
--no_opengl
|
no_cuda
| Description |
Disables cuda on this host |
| Syntax |
--no_cuda
|
no_cuda_gl_techniques
| Description |
Do not use cuda techniques with the GPU renderer |
| Syntax |
--no_cuda_gl_techniques
|
no_gpu_job_delegation
| Description |
This host will not send GPU jobs to the
cluster
|
| Syntax |
--no_gpu_job_delegation
|
no_driver_check
| Description |
Disables graphics card driver version
check
|
| Syntax |
--no_driver_check
|
assign_renderer_gpus
| Description |
assigns specific GPUs to specific
renderers
|
| Syntax |
--assign_renderer_gpus
string
|
Specify the subset of GPUs for each renderer. This parameter
requires an argument in the form of "RENDERER_NAME:GPU_LIST;..."
where GPU_LIST is a list of comma separated integer enumerants
corresponding to GPUs. Enumerants can be obtained from the output of --gpu_info.
An example: --assign_renderer_gpus
"iray:1,2,3,4; gpu_gl:1" would assign GPUs 1, 2, 3 and 4 to the
iray renderer and GPU 1 to the OpenGL renderer. Multiple
arguments are also allowed, for example: --assign_renderer_gpus
"iray:1,2,3,4" --assign_renderer_gpus "gpu_gl:1" would have the
same effect. Absence of explicit GPU assignment defaults to all
renderers using all available GPUs
Note that the special renderer name "all" can be used to assign
GPUs to all renderers at once.
The special GPU id "cpu" can also be used to explicitly enable CPU rendering for
renderers that support it.
May be specified multiple times.
gpu_info
| Description |
Displays information about all detected GPUs. |
| Syntax |
--gpu_info
|
log_priority
| Description |
Priority of logging for this host |
| Syntax |
--log_priority int
|
| Config file override |
log_priority |
install_service
| Description |
Installs RealityServer as a Windows service. |
| Syntax |
--install_service
|
The service is installed using the service name 'RealityServer'. Use --service_name to
override this with a custom name.
Additional commandline options provided alongside this command are registered with the
service and will be used whenever the service process is run. Exceptions to this are
--override, --coloring, the licensing commands --activate, --revoke, reporting commands
--copyright, --version, and the --delete_service command. Arguments that accept file paths
are converted to absolute paths and the service will need to be reinstalled if they have changed.
The service is installed with the Automatic startup type, under the LocalSystem account, but
can be modified after installation if required. Start parameters provided when starting the
service manually will be processed in the same way as normal commandline options.
This commandline option requires administrator privileges.
delete_service
| Description |
Deletes the RealityServer Windows service. |
| Syntax |
--delete_service
|
Use --service_name if the name of the installed service differs from the default
'RealityServer'. This commandline option requires administrator privileges.
service_name
| Description |
Specify the name of the RealityServer Windows service. |
| Syntax |
--service_name string
|
Directs --install_service and --delete_service to use the supplied service name,
instead of the default 'RealityServer'.