Skip to content

Client command-line arguments

See also: Server command-line arguments.

MultiTaction Canvus client accepts the command-line arguments below when you start the executable, mt-canvus-app. For the location of the executable, see Where is Canvus client application binary?. Run mt-canvus-app --help to print the list that your version accepts.

Usage:

mt-canvus-app [options] [canvas URL]

Canvus stops at start-up with the message "Unrecognized command line arguments" and exit code 1 if you give an argument it does not know. Arguments that start with --cef- are the exception; see Browser switches.

Note

Licenses are best activated with the license wizard; see licensing. Use the --activate option below only when the wizard is not available, for example on a headless computer or in a scripted deployment.

General options

Argument What it does
--help Print the list of arguments and exit.
--version Print the Canvus version and build identifiers and exit.
--mt-canvus-config <file> Read this configuration file instead of the per-user and system-wide mt-canvus.ini. The file must exist; otherwise Canvus exits with code 1. Canvus does not create or update a file named this way, and saves from the Settings page go to it. See Which file Canvus reads.
--merge-configs-only Update the system-wide configuration file (and on Windows also the per-user file of the account running the command) against the example file of this version, then exit without starting Canvus. The installers run it for you after an update; you normally do not need it. Exit code 0 means success. See What happens when you update.
--disable-dialogs Do not show native pop-up dialogs, such as error dialogs and the license wizard. Use it for unattended installations. Canvus also turns dialogs off by itself when any window in screen.xml stays on top or bypasses the window manager.
--connection-overlay Show a table over the workspace with one row per Canvus Server connection: ping time, current and total data in and out, and the number and size of downloads and uploads in progress. Use it to diagnose slow shared canvases.
--css <path> Load an additional CSS file to change the look of the Canvus user interface.
--scale <number> Scale the application content (graphics coordinates) by a fixed factor. 1 means no scaling. On Windows, if the application has only one window, by default this is set to match the desktop scaling.
--no-crash-reporter Turn off the built-in crash reporting and the automatic upload of crash dumps.

Display, input and audio files

Argument What it does
--screen <path> Use this screen configuration file (screen.xml) instead of the default one. See Where is screen.xml?.
--config <path> Use this touch configuration file (config.txt) instead of the default one. See Where is config.txt?.
--audio-config <path> Use this positional audio configuration file (audio-config.xml). See Positional audio.

License options

Argument What it does
--activate <activation key> Activate a Canvus license over the internet with this activation key, then exit. Exit code 0 means the license was activated; 1 means it was not. See Activate your license from the command line.
--product-type <slug> For an activation key that covers more than one product, choose which product the seat is taken from: canvus_meeting_room or canvus_desktop_laptop. Applies to --activate and --create-license-request. Not needed for keys that cover a single product. New in 26.07.7.
--create-license-request <activation key> Create an offline license request file, MT-Canvus-offline-request.html, then exit. On Windows the file is written to the user's Documents folder; on Ubuntu and macOS to the user's home folder. See Generate a license request while offline.
--activation-wizard Open the license wizard even if a valid license is installed. Canvus exits when you close the wizard.
--disable-license-wizard Do not open the license wizard, but keep other dialogs. Without a valid license Canvus exits instead. --disable-dialogs turns the wizard off as well.

Backup and restore

These options back up or restore local canvases and then exit. See Backup and restore.

Argument What it does
--backup Make a backup of local canvases and exit. Uses exit code 0 on success.
--restore Restore a local canvases backup from the folder given with --backup-path and exit. Any existing local canvases and assets will be deleted. Canvus must not be running.
--backup-path <path> Folder the backup is written to (with --backup) or restored from (with --restore). When creating a backup without this option, Canvus creates a new subfolder under the backup/root folder from the configuration file. Required with --restore.
--backup-skip <list> Leave parts of the data out of the backup. Only used with --backup. <list> is a comma-separated list of db, assets and canvus-folder.
--backup-delete Delete all files and folders in the --backup-path folder before writing the new backup there. Only used with --backup.

The backed up Canvus folder is always the built-in Canvus folder location inside the canvus-data folder, even if you have specified another folder in system/canvus-folder or don't have multi-user mode enabled and the Canvus folder in the application is your home folder. Back up a custom Canvus folder or the home folder separately.

Restoring a backup containing a Canvus folder will also always copy the files on top of the built-in Canvus folder location without deleting the existing files first.

Browser switches

Any argument that starts with --cef- is passed to the embedded web browser (Chromium) instead of to Canvus. For example --cef-ignore-gpu-blacklist reaches the browser as --ignore-gpu-blacklist. Use the form --cef-<switch>=<value> for a switch with a value. To set browser switches in the configuration file instead, use browser/cef-extra-switches; see Browser settings.

Argument What it does
--cef-shared-texture-disabled Turn off the shared-texture rendering pipeline of the web browser on Windows. This can make the browser more stable on some systems, but slows it down.
--cef-ignore-gpu-blacklist Let the browser use the GPU even on graphics drivers that Chromium blocks. The Ubuntu launcher mt-canvus.sh and the Windows mt-canvus.bat pass it.

Arguments the launchers pass

The normal ways of starting Canvus add some arguments for you. You do not need to add them yourself.

Launcher Arguments it adds
Ubuntu applications menu (/opt/mt-canvus-<version>/bin/mt-canvus.sh) --use-pulse-audio (play audio through PulseAudio), --minidump-upload-url <url> (the HTTPS address crash dumps are uploaded to), --cef-ignore-gpu-blacklist
Windows mt-canvus.bat, and the installer when it starts Canvus at the end of installation --cef-ignore-gpu-blacklist. The Windows desktop shortcut adds no arguments.
macOS application --cef-no-sandbox, --cef-use-mock-keychain (browser start-up on macOS)
MT Launcher (Windows) --disable-dialogs

Canvas URL

Give a canvas URL to open that canvas on the first workspace at start-up instead of the welcome screen. You can copy the URL from the Dashboard or write it manually. Examples:

canvus://example.com/0cb6639f-042b-42a3-9e97-74818d2fb09d (ssl)
canvus+ssl://example.com/0cb6639f-042b-42a3-9e97-74818d2fb09d (ssl)
canvus+tcp://example.com:1234/0cb6639f-042b-42a3-9e97-74818d2fb09d (tcp)
canvus://internal/0cb6639f-042b-42a3-9e97-74818d2fb09d (local canvas)
https://example.com/open/0cb6639f-042b-42a3-9e97-74818d2fb09d (from Dashboard)

If Canvus is already running, a second start with a canvas URL hands the URL to the running Canvus, which opens the canvas, and the second process exits with code 8. A second start without a URL reports that Canvus is already running. On Windows and Ubuntu the installer registers Canvus as the handler for canvus://, canvus+ssl:// and canvus+tcp:// links, so a link in a browser or email opens the same way.