Skip to content

Command-line options ​

QtEDM can be executed from the command line in the general form:

text
qtedm [options] [display-files]

Options are:

OptionDescription
-help, -h, -?Display usage information and exit
-versionDisplay version information and exit
-xStart in EXECUTE mode (default is EDIT mode)
--read-onlyStart in EXECUTE mode with global observe-only write inhibition. A persistent red indicator is shown and all CA, PVA, and soft-PV puts are blocked and audit logged.
--session nameExplicitly restore a named version-1 session. Session restore defaults to EXECUTE mode, validates every display, reports omissions, and clamps windows to connected screens.
-localRun in local mode (default)
-attachOn X11, send requested displays to an existing compatible QtEDM instance
-cleanupOn X11, replace stale single-instance request state and become the receiving instance
-macro "xxx=aaa,yyy=bbb,..."Define macro substitutions for PV names in EXECUTE mode
-dg geometrySpecify display geometry (WxH+X+Y format)
-displayGeometry geometryLong-form alias for -dg
-displayFont alias|scalableSelect font mode: alias (MEDM-compatible) or scalable
-noMsgDo not raise the message window on startup
-nologDisable audit logging of control widget value changes
-bigMousePointerUse a larger mouse pointer for accessibility
-cmapUse a private colormap (compatibility option)

Examples ​

Start QtEDM with a display in execute mode:

text
qtedm -x main.adl

Start with macro substitutions:

text
qtedm -x -macro "P=ioc1:,R=motor1" motor.adl

Open multiple displays:

text
qtedm -x display1.adl display2.adl display3.adl

Remote Display via SSH ​

When running QtEDM over an SSH connection with X11 forwarding, it is highly recommended to use the -C option to enable compression. This significantly improves display update performance and provides a smoother experience, especially when monitoring rapidly changing process variables.

text
ssh -C -X user@host
qtedm -x display.adl

The -C option compresses all data sent over the SSH connection, which reduces the bandwidth required for X11 protocol traffic. Without compression, high-frequency widget updates can overwhelm the connection and cause sluggish or jerky display behavior.

-attach and -cleanup use an X11 root-window request protocol and fall back to local mode on Wayland, macOS, and Windows.