How to use the command 'kscreen-console' (with examples)

The command ‘kscreen-console’ is a command-line tool that allows users to query KScreen’s status. KScreen is a KDE Plasma component that manages screen configuration and provides features such as screen rotation, screen scaling, and multi-monitor management. Using ‘kscreen-console’, users can gather information about KScreen’s outputs, configuration files, and monitor for changes.

Use case 1: Show all outputs and configuration files to attach to a bug report

Code:

kscreen-console bug

Motivation: When encountering a bug related to KScreen’s outputs or configuration files, it is helpful to include this information when reporting the bug. By using the ‘kscreen-console bug’ command, all outputs and configuration files are displayed, making it easy to gather and attach them to the bug report.

Explanation:

• kscreen-console: Invokes the ‘kscreen-console’ command-line tool.
• bug: The ‘bug’ argument is used to specify the bug mode, which displays all outputs and configuration files related to KScreen.

Example output:

Outputs:
 - Output 1: Resolution 1920x1080, Position (0,0), Scale factor 1.0
 - Output 2: Resolution 1280x1024, Position (1920,0), Scale factor 1.0

Configuration files:
 - /etc/kscreenrc
 - /home/user/.config/kscreenrc

Use case 2: Show paths to KScreen configuration files

Code:

kscreen-console config

Motivation: Knowing the paths to KScreen’s configuration files can be useful when troubleshooting or making modifications to the configuration manually. By using the ‘kscreen-console config’ command, the paths to KScreen configuration files are displayed.

Explanation:

• kscreen-console: Invokes the ‘kscreen-console’ command-line tool.
• config: The ‘config’ argument is used to specify the config mode, which displays the paths to KScreen configuration files.

Example output:

Configuration files:
 - /etc/kscreenrc
 - /home/user/.config/kscreenrc

Use case 3: Show KScreen output information and configuration

Code:

kscreen-console outputs

Motivation: Understanding the current KScreen output information and configuration can help in managing and troubleshooting multiple monitors or display settings. By using the ‘kscreen-console outputs’ command, users can view detailed information about each output and its configuration.

Explanation:

• kscreen-console: Invokes the ‘kscreen-console’ command-line tool.
• outputs: The ‘outputs’ argument is used to specify the outputs mode, which displays information and configuration related to KScreen’s outputs.

Example output:

Outputs:
 - Output 1: Resolution 1920x1080, Position (0,0), Scale factor 1.0
 - Output 2: Resolution 1280x1024, Position (1920,0), Scale factor 1.0

Use case 4: Monitor for changes

Code:

kscreen-console monitor

Motivation: Monitoring for changes in KScreen’s status can be useful for applications or scripts that need to respond to display configuration modifications. By using the ‘kscreen-console monitor’ command, users can monitor and receive notifications whenever changes occur in KScreen’s status.

Explanation:

• kscreen-console: Invokes the ‘kscreen-console’ command-line tool.
• monitor: The ‘monitor’ argument is used to specify the monitor mode, which enables continuous monitoring for changes in KScreen’s status.

Example output:

Output changed: Output 1, Resolution 1920x1080, Position (0,0), Scale factor 1.0

Use case 5: Show the current KScreen configuration as JSON

Code:

kscreen-console json

Motivation: Obtaining the current KScreen configuration in JSON format allows for easier parsing and integration with other tools or scripts. By using the ‘kscreen-console json’ command, users can retrieve the current KScreen configuration in JSON format.

Explanation:

• kscreen-console: Invokes the ‘kscreen-console’ command-line tool.
• json: The ‘json’ argument is used to specify the JSON mode, which outputs the current KScreen configuration in JSON format.

Example output:

{
    "outputs": [
        {
            "name": "Output 1",
            "resolution": "1920x1080",
            "position": "(0,0)",
            "scaleFactor": 1.0
        },
        {
            "name": "Output 2",
            "resolution": "1280x1024",
            "position": "(1920,0)",
            "scaleFactor": 1.0
        }
    ]
}

Use case 6: Display help

Code:

kscreen-console --help

Motivation: When unsure about the available options or how to use the ‘kscreen-console’ command, displaying the help information can provide guidance. By using the ‘kscreen-console –help’ command, the command’s help message is displayed.

Explanation:

• kscreen-console: Invokes the ‘kscreen-console’ command-line tool.
• --help: The ‘–help’ option displays the help message for the ‘kscreen-console’ command.

Example output:

Usage: kscreen-console [options] [bug | config | outputs | monitor | json]
...

Use case 7: Display help including Qt specific command-line options

Code:

kscreen-console --help-all

Motivation: In addition to the basic help information, displaying Qt specific command-line options can be useful when working with the ‘kscreen-console’ command in a Qt-based environment. By using the ‘kscreen-console –help-all’ command, the help message including Qt specific command-line options is displayed.

Explanation:

• kscreen-console: Invokes the ‘kscreen-console’ command-line tool.
• --help-all: The ‘–help-all’ option displays the help message for the ‘kscreen-console’ command, including Qt specific command-line options.

Example output:

Usage: kscreen-console [options] [bug | config | outputs | monitor | json]
...
Qt options:
  --platform <plugin>        Set platform plugin <plugin>
  --style <style>            Set style <style>
...

Conclusion:

The ‘kscreen-console’ command-line tool provides a convenient and efficient way to gather information about KScreen’s status, outputs, and configuration. By using the various modes and options provided by ‘kscreen-console’, users can troubleshoot display issues, monitor for changes in KScreen’s status, and obtain the current configuration in different formats. Whether for personal use or bug reporting, ‘kscreen-console’ offers valuable insights and control over screen configuration in KDE Plasma.