Help

Help

DISPLAX Service – Help

Overview

DISPLAX Service includes a built-in help command that displays all available command-line options and a short description of each one. This is useful for users working with advanced features, automation, scripting, or troubleshooting via the command line.

By using the help parameter, you can quickly view supported commands without referring to external documentation.

How to Display the DISPLAX Service Help Menu

To list all available DISPLAX Service commands and parameters, open a terminal or command prompt and run the service with the help option.

Supported Parameters

You can use either of the following:

-h

or

--help

Example Usage

displax-service -h

or

displax-service --help

After running the command, DISPLAX Service will output:

  • A list of available commands

  • Supported parameters

  • A brief description of what each command does


When to Use the Help Command

The help command is especially useful when:

  • Exploring DISPLAX Service capabilities for the first time

  • Building scripts or automation workflows

  • Verifying command syntax before execution

  • Troubleshooting advanced configurations

  • Working without access to online documentation

Best Practices

  • Always review the help output before running advanced or destructive commands.

  • Use the help command after software updates, as available parameters may change.

  • When contacting support, referencing exact command names from the help output can speed up troubleshooting.

    • Related Articles

    • Parameters that can be used

      DISPLAX Service – Available Device Parameters Overview DISPLAX Service allows you to retrieve a complete list of available parameters and command options supported by a specific connected device. This ensures you only use parameters that are valid ...

    • What is DISPLAX Service?

      DISPLAX Service Overview DISPLAX Service is a background process (agent/daemon) installed alongside DISPLAX Connect that enables low-level communication with your DISPLAX Touch Controllers. It acts as a command-line interface, allowing advanced ...

    • Parameter Syntax

      DISPLAX Service – Parameter Syntax Overview When using DISPLAX Service from the command line, the same syntax is used to view a parameter’s current value or change that parameter. This unified syntax makes it easy to manage device settings locally or ...

    • Version

      DISPLAX Service – Version and Status Command Overview DISPLAX Service provides a command-line parameter that allows you to quickly check the installed version and current running status of the service. This is useful for troubleshooting, verifying ...

    • Connect to a host

      DISPLAX Service – Connect to a Host Overview To view or modify settings on a touch device using DISPLAX Service, you must first connect to the host computer where the device is attached. This applies to both local devices (connected to the same ...