All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Standard Command Line Arguments

Cornerstone applications have a set of common command line arguments.

The arguments are available for all GUI applications, but some of them do not work with the command-line applications, such as MTWin7, PrintHands, etc.

--audio-config <filename> Sets the audio panning configuration file name.

--audio-devices <filename> Sets the audio device configuration file name.

--background <filename/directory/plugin> Sets the application background.

--clear-image-cache Clear all temporary images from mipmap cache.

--config <filename> Sets the computer vision configuration file to be used. Typical filenames are config.txt, config-network.txt.

--console [hostname:]<port> Enable experimental remote v8 telnet terminal.

--css <filename.css>[;another_filename.css;...] Sets the CSS style sheet files for the application. The style sheets are automatically loaded by the application. If the style sheets are updated while the application is running, then they are reloaded automatically and applied to the running application.

--disable-watch-dog This option disables the watchdog that kills applications if they get stuck.

--dummy Starts the application without any touch tracking. This argument is useful for operating applications using only mouse and keyboard.

--enable-site-manager Allows SiteManager to connect to this application.

--fonts-dir <param> Path to directory containing fonts. All .otf- and .ttf-files found here are automatically loaded at the application start.

--fps <param> Background ItemMovieWidget fps, used with --background.

--input-timeout <ms> How long to wait (in milliseconds) for new input sample each frame.

--license <filename> Specify custom license file.

--maximum-update-frequency <frames-per-second> Limit application update to given fps. In really fast applications this removes extra CPU time and makes sure that frame delta time doesn't get too small.

--minidump-path <path> Specify the path where to store crash minidumps. Minidumps are supported only on Linux.

--minidump-upload-url <url> URL where to upload the minidump on crash using Breakpad minidump_upload -command.

--minimize Minimize application windows on startup. Doesn't work with frameless windows.

--minimum-update-frequency <frames-per-second> Limit MultiWidgets::FrameInfo::dt to 1/minimum-update-frequency.

--rotation <degrees> Sets the rotation for the root widget of the scene. The rotation is expressed in degrees.

--scale <number> Sets the scale for the root widget of the scene. With this option you can easily scale the whole scene so that (physically) large applications can be run in a small window. For example "--scale 0.5" makes everything half the size, compared to the nominal size.

--screen <filename> Sets the screen setup description file to be used. The screen file defines how the application open different windows. Typical filenames are screen-1024x768.xml and screen-1920x1080.xml

--simultaneous-virtual-input Enable simultaneous virtual and real input.

--site-manager-port <port> Specify TCP port that SiteManager listens. Used with --enable-site-manager.

--stop-on-event-mismatches

--trace-file <filename> This option can be used to give a file name for storing the application output. Once the trace file is specified, all terminal output will go into the trace file. This include all debug output, error messages and so on. Using the --trace-file option is useful there is so much output that it is difficult to copy-paste the output from the terminal.

--translation "X Y" Sets the translation for the root widget of the scene.

--use-pulse-audio Enabled experimental PulseAudio backend for all audio processing instead of PortAudio. Try this if you are having any issues with audio.

--verbose This option enables verbose output to the terminal, or a file. Turning this option on gives you plenty of information about what is happening in the application. Using verbose output will slow down the application, as there is a lot of text that is written to the output. To reduce this effect, you can use the --trace-file option.

--verbose-modules <ModuleName1>[,ModuleName2,...] This option enables verbose output from given Cornerstone modules to the terminal, or a file. This option is similar to the --verbose option, but more granular since you can specify which modules should produce output. The modules are specified as a comma-separated list, for example: "--verbose-modules MultiWidgets,Luminous".

--virtual-marker-code <code> Specify the marker code used with virtual markers.

--with-input-visualizer Enable input visualizer widget overlay.

--with-ripple This option creates a ripple effect on top of all the application widgets. Ripple is commonly used to make the applications more lively.

V8 command line arguments

In addition you can give command line arguments to v8 JavaScript engine by prefixing the arguments with --v8. For example, there is a v8 command line argument use_strict that can be enabled by giving --v8-use_strict to any Cornerstone application.

All v8 command line arguments can be listed with --v8-help.

Node.js command line arguments

By prefixing the arguments with --node you can also give arguments to embedded Node.js. For example --node-debug.

CEF and Chromium command line arguments

Any command line arguments given to Cornerstone application using form --cef-ARG will be forwarded to CEF as --ARG. For example --cef-enable-media-stream.