Global

The global settings object is a singleton stored at $HOME/.config/qtermy/qtermy.conf. Global settings can be edited from the View menu or by calling the EditGlobalSettings action. The file can also be edited directly in a text editor, but note that qtermy does not monitor for external changes to settings files.

General

LogThreshold (enumeration)

Specifies which severity level of log message will automatically show the Event Log.

LogToSystem (boolean)

If enabled, log messages will be sent to the default Qt logging handler in addition to the Event Log.

RestoreGeometry (boolean)

If enabled, the information described in SaveGeometry is restored when an application window is opened to the value it had when the window was last closed with SaveGeometry enabled or the SaveGeometryNow button was pressed.

SaveGeometry (boolean)

If enabled, the following information is saved when an application window is closed. It will be restored when the same number of windows are reopened if RestoreGeometry is enabled. The saved information is stored in the State settings in an opaque format.

• The size and position of the window and dockable widgets within it.
• The layout of split view panes within the window.
• For each pane, the ID and profile name of the terminal within the pane.
• For each pane, the scrollback position, Timing widget origin, and selected job of each viewport that has been created in that pane.

When restoring the saved settings, the application will try to match viewports and terminals as closely as possible. For example, if the saved terminal for a pane cannot be found by its ID, but an unassigned terminal with the same profile name exists, it will be substituted.

SaveGeometryNow (none)

A button that causes the information described in SaveGeometry to be saved immediately for all application windows.

RestoreOrder (boolean)

If enabled, the ordering and shown/hidden status of terminals within the Terminals tool will be restored to the values they had when the window was last closed with SaveOrder enabled or the SaveOrderNow button was pressed.

SaveOrder (boolean)

If enabled, the ordering and shown/hidden status of terminals within the Terminals tool is saved when an application window is closed. It will be restored when the same number of windows are reopened if RestoreOrder is enabled. The saved information is stored in the State settings in an opaque format.

SaveOrderNow (none)

A button that causes the information described in SaveOrder to be saved immediately for all application windows.

ProfileMenuSize (integer)

The number of items to show in dynamic item chooser menus such as the Switch Profile menu, in which settings objects or icons are displayed for the user to select from.

DocumentationRoot (string)

The root URL used by the application to access this documentation. Setting an empty string and restarting the application will restore the default value.

Tip

Save a copy of this documentation to your hard drive, then set this setting to its file:// URL to get instant page loads and offline availability.

Note

This setting requires an application restart to take effect.

IconTheme (string)

The name of an icon theme directory located under prefix/share/qtermy/icons, or none to disable icons. Icons are shown within menu entries and in windows and dialog boxes. This setting does not affect images loaded from prefix/share/qtermy/images which are shown in terminal thumbnails.

Note

This setting requires an application restart to take effect.

Server

LaunchTransient (boolean)

If enabled, a transient local server is launched by the application on startup.

LaunchPersistent (boolean)

If enabled, a connection to the persistent user server is made by the application on startup, launching it if it's not already running.

PreferTransient (boolean)

If enabled, the transient local server is preferred over the persistent user server for creating new local terminals and running local tasks. Note that if only one of the two servers is connected, it will be used as the local server regardless of the value of this setting.

CloseConnectionsWindowOnLaunch (boolean)

If enabled, the Manage Connections window will close when a connection is launched from within it.

AutoQuit (boolean)

If enabled, the application will exit when the last terminal is closed.

PopulateTime (integer)

The number of milliseconds that the application should wait after a server connection has been made for all of the server's existing terminals to be reported. At connection time, the server reports how many terminals it has, followed the by information for each terminal. The information on existing terminals is used in the Global/RestoreGeometry logic to restore the previous appearance of the application. Normally the terminal information arrives immediately, but a very slow connection might cause it to arrive late. A race condition also exists where a terminal might be closed between the time that the server reports the number of existing terminals and the time that the server sends the terminal information. This setting puts a limit on the amount of time the application will wait for the information to arrive.

ScrollbackFetchSpeed (enumeration)

Controls how quickly the application downloads scrollback contents in the background. Enable the ShowFetchPosition profile setting to view the progress of scrollback downloads in the Minimap widget.

LocalDownloads (boolean)

If enabled, file downloads and uploads are permitted to local servers. Note that file mounts of files on local servers are never permitted.

Appearance / Terminals Tool

ShowMenuBar (boolean)

If disabled, the menu bar in new application windows will be hidden. It can be shown via the View menu or the ToggleStatusBar action.

ShowStatusBar (boolean)

If disabled, the status bar in new application windows will be hidden. It can be shown via the View menu or the ToggleMenuBar action.

AutoRaiseTerminals (boolean)

If enabled, the Terminals tool will autoraise whenever the active terminal is changed.

ShowTerminalsPopup (boolean)

If enabled, a popup will appear for a brief period over the active viewport whenever the active terminal is changed. The popup displays a list of servers and terminals with the active server and terminal highlighted.

TerminalsPopupTime (integer)

The number of milliseconds to display the terminals popup, if it's enabled.

TerminalThumbnailCaption (string)

The format of the caption shown below terminal thumbnails in the Terminals tool. The value of a terminal attribute named varname may be substituted using the notation \(varname). The value of a server attribute named varname may be substituted using the notation \(server.varname). Multiple lines are supported; use \n to insert a newline.

TerminalThumbnailTooltip (string)

The format of the tooltip on terminal thumbnails in the Terminals tool. The value of a terminal attribute named varname may be substituted using the notation \(varname). The value of a server attribute named varname may be substituted using the notation \(server.varname). Multiple lines are supported; use \n to insert a newline.

ServerThumbnailCaption (string)

The format of the caption shown below server thumbnails in the Terminals tool. The value of a server attribute named varname may be substituted using the notation \(server.varname). Multiple lines are supported; use \n to insert a newline.

ServerThumbnailTooltip (string)

The format of the tooltip on server thumbnails in the Terminals tool. The value of a server attribute named varname may be substituted using the notation \(server.varname). Multiple lines are supported; use \n to insert a newline.

WindowTitle (string)

The format of the window title. The value of a terminal attribute named varname may be substituted using the notation \(varname). The value of a server attribute named varname may be substituted using the notation \(server.varname). Multiple lines are not supported.

ShowMainIndex (boolean)

If enabled, the index of each pane is shown in the associated viewport.

ShowThumbnailIndex (boolean)

If enabled, the index of the pane where a terminal is active is shown in its thumbnail in the Terminals tool. If a terminal is active in more than one pane, the lowest numbered pane will be shown followed by a plus sign (+).

DenseThumbnails (boolean)

If enabled, less space will be allocated for the TerminalThumbnailCaption, and thumbnails will be packed closer together in the Terminals tool. This setting has no effect if thumbnail caption is empty.

TerminalAction0 (string)

The action to invoke when a terminal thumbnail is double-clicked. The strings <terminalId> and <serverId> within the action string will be replaced as appropriate. Any other action parameters must be hard-coded.

TerminalAction1 (string)

The action to invoke when a terminal thumbnail is Control-clicked. The strings <terminalId> and <serverId> within the action string will be replaced as appropriate. Any other action parameters must be hard-coded.

TerminalAction2 (string)

The action to invoke when a terminal thumbnail is Shift-clicked. The strings <terminalId> and <serverId> within the action string will be replaced as appropriate. Any other action parameters must be hard-coded.

TerminalAction3 (string)

The action to invoke when a terminal thumbnail is middle-clicked. The strings <terminalId> and <serverId> within the action string will be replaced as appropriate. Any other action parameters must be hard-coded.

ServerAction0 (string)

The action to invoke when a server thumbnail is double-clicked. The string <serverId> within the action string will be replaced as appropriate. Any other action parameters must be hard-coded.

ServerAction1 (string)

The action to invoke when a server thumbnail is Control-clicked. The string <serverId> within the action string will be replaced as appropriate. Any other action parameters must be hard-coded.

ServerAction2 (string)

The action to invoke when a server thumbnail is Shift-clicked. The string <serverId> within the action string will be replaced as appropriate. Any other action parameters must be hard-coded.

ServerAction3 (string)

The action to invoke when a server thumbnail is middle-clicked. The string <serverId> within the action string will be replaced as appropriate. Any other action parameters must be hard-coded.

Effects

MainBell (enumeration)

How to display a bell event in the terminal.

ThumbnailBell (enumeration)

How to display a bell event in the terminal thumbnail.

EnableCursorBlink (boolean)

If disabled, the cursor will not blink.

EnableTextBlink (boolean)

If disabled, text decorated with the blink property in the terminal will not blink.

CursorBlinkCount (integer)

Number of times the cursor will blink after terminal activity occurs.

TextBlinkCount (integer)

Number of times text decorated with the blink property will blink after terminal activity occurs.

SkipBlinkCount (integer)

Number of cursor blinks to skip after keyboard input occurs. This prevents the cursor from blinking off while text is being entered.

BlinkTime (integer)

Duration of each half-blink in milliseconds.

EnableResizeEffect (boolean)

If enabled, a popup will appear for a brief period in viewports and terminal thumbnails when a terminal or viewport is resized. The popup displays the new size of the terminal and/or viewport.

EnableFocusEffect (enumeration)

Controls the display of a brief animation in the border of the newly focused pane whenever the focus changes.

EnableBadgeScrolling (boolean)

If enabled, the badge string will scroll down and back up if the string exceeds the height of the viewport.

BadgeScrollingRate (integer)

The rate at which the badge string will scroll, measured in milliseconds per character, if badge scrolling is enabled.

Command Mode / Selection Mode

StartInCommandMode (boolean)

If enabled, the application will start with command mode enabled.

RaiseKeymapInCommandMode (boolean)

If enabled, the Keymap tool will autoraise and autohide when command mode is entered and exited. Note that the Keymap tool will not autohide when command mode is toggled from within the tool itself.

RaiseKeymapInSelectMode (boolean)

If enabled, the Keymap tool will autoraise and autohide when selection mode is entered and exited. Note that the Keymap tool will not autohide when selection mode is toggled from within the tool itself.

AutoSelectMode (boolean)

If enabled, selection mode will be automatically entered whenever a selection is made.

ExitSelectModeOnCopy (boolean)

If enabled, the selection will be cleared after a Copy action.

ExitSelectModeOnWrite (boolean)

If enabled, the selection will be cleared after a WriteSelection or WriteSelectionNewline action.

SelectModeInputDisabled (boolean)

If enabled, input to the terminal is disabled while in selection mode. Only keymap bindings to actions will be run.

Presentation Mode

EnterFullScreen (boolean)

If enabled, enter full screen mode on entering presentation mode.

HideMenuBar (boolean)

If enabled, hide the menu bar in the application window on entering presentation mode. See also Appearance/ShowMenuBar.

HideStatusBar (boolean)

If enabled, hide the status bar in the application window on entering presentation mode. See also Appearance/ShowStatusBar.

HideTools (boolean)

If enabled, hide any visible Tools on entering presentation mode.

HideIndex (boolean)

If enabled, hide the pane index in the viewport on entering presentation mode. See also Appearance/ShowMainIndex.

HideIndicators (boolean)

If enabled, hide the status indicator graphics in the viewport on entering presentation mode. See also Appearance/ShowMainIndicators (profile setting).

HideBadge (boolean)

If enabled, hide the badge string in the viewport on entering presentation mode. See also Appearance/Badge (profile setting).

FontSizeIncrement (integer)

Add the specified number of points to the font size on entering presentation mode, reverting to normal when exiting presentation mode.

Inline Content

InlineAction0 (enumeration)

What to do when a hyperlink, inline image, or other semantic region is double-clicked.

InlineAction1 (enumeration)

What to do when a hyperlink, inline image, or other semantic region is Control-clicked.

InlineAction2 (enumeration)

What to do when a hyperlink, inline image, or other semantic region is Shift-clicked.

DragStartMultiplier (integer)

A multiplier applied to the normal distance that the mouse pointer must move to begin a drag operation. Use this option to make it more difficult to accidentally start a drag operation on a semantic region when clicking in the terminal viewport.

RenderInlineImages (boolean)

If enabled, inline images uploaded using termy-imgcat and termy-imgls are parsed using Qt's QImage and QMovie classes and displayed inline as semantic regions. If disabled, inline images must be individually shown using the region's context menu. This setting can be overridden on a per-server basis.

AllowSmartHyperlinks (boolean)

If enabled, smart hyperlinks created by terminal programs are honored. This setting can be overridden on a per-server basis.

RenderAvatars (boolean)

If enabled, custom avatar images uploaded to the server by remote users are displayed on their terminals.

Avatar (none)

Displays your custom avatar image. To change the custom avatar image, place an SVG image at $HOME/.config/qtermy/avatar.svg and restart the application.

Files / Files Tool

DownloadLocation (string)

The default folder in which to store downloaded files. This setting can be overridden on a per-server basis.

DownloadFileConfirmation (enumeration)

What to do when an existing local file would be overwritten by a DownloadFile task. This setting can be overridden on a per-server basis.

UploadFileConfirmation (enumeration)

What to do when an existing remote file would be overwritten by an UploadFile task. This setting can be overridden on a per-server basis.

DeleteFileConfirmation (enumeration)

Whether to confirm removal of a remote file or folder during a DeleteFile task. This setting can be overridden on a per-server basis.

RenameFileConfirmation (enumeration)

What to do when an existing remote file would be overwritten by a RenameFile task. This setting can be overridden on a per-server basis.

TerminalLocalFileDrop (enumeration)

What to do when a file:// URL is dropped onto a terminal that is running on a local server.

TerminalRemoteFileDrop (enumeration)

What to do when a file:// URL is dropped onto a terminal that is not running on a local server.

ThumbnailLocalFileDrop (enumeration)

What to do when a file:// URL is dropped onto the thumbnail of a terminal that is running on a local server in the Terminals tool.

ThumbnailRemoteFileDrop (enumeration)

What to do when a file:// URL is dropped onto the thumbnail of a terminal that is not running on a local server in the Terminals tool.

ServerFileDrop (enumeration)

What to do when a file:// URL is dropped onto the thumbnail of a server in the Terminals tool.

AutoRaiseFiles (boolean)

If enabled, the Files tool will autoraise whenever its selected file changes. This can occur outside the tool itself as a result of certain actions or by clicking on a semantic region that has an associated file:// URL.

FilesAction0 (enumeration)

What to do when a file or folder is double-clicked in the Files tool.

FilesAction1 (enumeration)

What to do when a file or folder is Control-clicked in the Files tool.

FilesAction2 (enumeration)

What to do when a file or folder is Shift-clicked in the Files tool.

FilesAction3 (enumeration)

What to do when a file or folder is middle-clicked in the Files tool.

Tasks / Tasks Tool

AutoRaiseTasks (boolean)

If enabled, the Tasks tool will autoraise whenever a task starts or finishes. The tool will autohide after a brief period once there are no outstanding active tasks.

AutoShowTaskStatus (boolean)

If enabled, a task status dialog will be shown whenever most types of task are started. Some tasks are considered background tasks and will ignore this setting. Task status dialogs can be manually launched using the Tasks tool context menu or the InspectTask action.

AutoHideTaskStatus (boolean)

If enabled, tasks status dialogs will automatically close after a brief period when their task finishes.

TasksDelayTime (integer)

The number of milliseconds to hold the Tasks tool and task status dialogs open before autoclosing them. Task status dialogs are held open for only half of the configured time.

DownloadAction (enumeration)

What to do when a download task finishes. The "preferred launcher" for files refers to the PreferredFileLauncher. The "new terminal" option uses the PreferredProfile as the profile to create new terminals.

MountAction (enumeration)

What to do when a the file mounted via a mount task is ready. The "preferred launchers" for files and directories refer to the PreferredFileLauncher and PreferredDirectoryLauncher respectively. The "new terminal" option uses the PreferredProfile as the profile to create new terminals.

PreferredFileLauncher (string)

The preferred launcher for opening task result files. See OpenTaskFile.

PreferredDirectoryLauncher (string)

The preferred launcher for opening task result directories. See OpenTaskDirectory.

PreferredProfile (string)

The preferred profile for creating new terminals to handle task result files and directories. See OpenTaskTerminal.

TasksAction0 (enumeration)

What to do when a task is double-clicked in the Tasks tool.

TasksAction1 (enumeration)

What to do when a task is Control-clicked in the Tasks tool.

TasksAction2 (enumeration)

What to do when a task is Shift-clicked in the Tasks tool.

TasksAction3 (enumeration)

What to do when a task is middle-clicked in the Tasks tool.

TaskSizeLimit (integer)

The maximum number of tasks to show in the Tasks tool. Completed tasks can be removed from the list using the context menu or the RemoveTasks action.

Suggestions Tool

AutoRaiseSuggestions (boolean)

If enabled, the Suggestions tool will autoraise after a brief idle period when a certain number of characters have been typed at a prompt with shell integration enabled.

The tool will autohide when command entry is finished.

SuggestionsDelayTime (integer)

The idle time required before the Suggestions tool will autoraise. This prevents the tool from popping up and flickering rapidly while a command is still being typed out.

SuggestionsAction0 (enumeration)

What to do when a suggestion is double-clicked in the Suggestions tool.

SuggestionsAction1 (enumeration)

What to do when a suggestion is Control-clicked in the Suggestions tool.

SuggestionsAction2 (enumeration)

What to do when a suggestion is Shift-clicked in the Suggestions tool.

SuggestionsAction3 (enumeration)

What to do when a suggestion is middle-clicked in the Suggestions tool.

History and Notes Tools

HistoryAction0 (enumeration)

What to do when a job is double-clicked in the History tool.

HistoryAction1 (enumeration)

What to do when a job is Control-clicked in the History tool.

HistoryAction2 (enumeration)

What to do when a job is Shift-clicked in the History tool.

HistoryAction3 (enumeration)

What to do when a job is middle-clicked in the History tool.

NotesAction0 (enumeration)

What to do when an annotation is double-clicked in the Annotations tool.

NotesAction1 (enumeration)

What to do when an annotation is Control-clicked in the Annotations tool.

NotesAction2 (enumeration)

What to do when an annotation is Shift-clicked in the Annotations tool.

NotesAction3 (enumeration)

What to do when an annotation is middle-clicked in the Annotations tool.

HistoryFont (string)

The font to use in the History and Annotations tools.

HistorySizeLimit (integer)

The maximum number of items to show in the History and Annotations tools. Items associated with closed terminals can be removed from the lists using the context menu or the ToolFilterRemoveClosed action.