☰ pyILPER

pyILPER command line parameters

Introduction

pyILPER supports command line parameters to perform special actions.

Note: You must start pyILPER from the command line as a module to specify command line parameters.

Use the -help parameter to see the available arguments:

python -m pyilper2 --help
Usage: python -m pyilper2 [options]

Start pyILPER version 2 with command line parameters

options:
  -h, --help            show this help message and exit
  --instance, -instance INSTANCE
                        Start a pyILPER instance INSTANCE. This instance has an
                        own set of configuration files.
  --cc, -cc             Copy configuration from development to production
                        version and vice versa
  --clean, -clean       Start pyILPER with a config file which is reset to
                        defaults
  --use-system-browser, -use-system-browser
                        Use default system browser for help system
  --scale, -scale SCALE
                        Force scaling for high-DPI displays. 1.0<=SCALE<=4.0
  --migrate, -migrate   Migrate pyILPER configuration from version 1.9
  --v, -v               Show pyILPER version


Starting another instance of pyILPER

The parameter -instance INSTANCE-NAME allows to start multiple independent instances of pyILPER. Each instance has its own set of configuration files and is identified by INSTANCE-NAME. Only letters or digits are allowed in an INSTANCE-NAME.

Reset the pyILPER configuration to default

If a pyILPER configuration has been corrupted, which can result in a crashing or misbehaving program, then the configuration can be reset to default with the -clean parameter.

Copy configuration data between beta/development and production versions

The beta and production versions of pyILPER use different configuration files. In this way a beta or production version can be tested without affecting the configuration of an installed production version. But sometimes it is required to copy the configuration data between production and beta or development versions. With the -cc option:

  • The production version pulls the configuration data of a development or beta version
  • A beta or development version pulls the configuration data of the production version

Note: You have to confirm the copy action. After completion, you must restart pyILPER without the -cc option.

Scaling on High DPI displays

pyILPER usually uses the desktop's display scaling factor. However, you can set this factor individually using the -scale option for pyILPER.

Use the system default browser for the help system

The parameter --use-system-browser disables the loading of the PySide6 web extension, which could cause compatibility problems with display drivers. The system default browser is used instead for the help system.

Migrate configuration from version 1.9

Migrate the configuraton of a pyILPER production version 1.9.x to version 2.0.0. Note: this will overwrite the current configuration of the 2.0 version. If you use an elder Version than pyILPER then upgrade to 1.9 first and run the program at least once to migrate the 1.x configuration to the pyILPER 1.9 level