Command line usage¶
Styrene creates distributable installers and portable zipfiles by bundling together MSYS2 packages.
Usage¶
Styrene must be be run from one of the MINGW32 or MINGW64 shells installed by an MSYS2 environment.
styrene --help
styrene [options] spec1.cfg ...
The first form shows the usage message, and gives a terse explanation of what the options do. Normally you run Styrene with a configuration file which tells it what packages to install into your bundle.
Options¶
| -h, --help | Show the help message, and exit immediately with a return code of zero. |
| -q, --quiet | Log errors and warnings only. |
| --debug | Debug mode (noisy operation, pause after postinst). |
| -o DIR, --output-dir=DIR | |
Where to store output.
The folder DIR will be created if needed. | |
| -p DIR, --pkg-dir=DIR | |
Preferentially use package files from DIR. | |
| --no-exe | Do not write the installer .exe output file. |
| --no-zip | Do not write the standalone .zip output file. |
| --colour=COLSPEC, --color=COLSPEC | |
| Colourize output: yes/no/auto. | |
Normally a temp directory is used for building,
and the output distributables are then copied into the current directory.
The temp dir is normally deleted after processing.
Specifying --output-dir changes this behaviour:
no temp directory will be made.
The output dir will be created if it doesn’t exist, and all output will be retained there, not copied out. The temporary bundle tree is kept too, for inspection and testing.
If you specify both --no-exe and --no-zip
without also specififying a --output-dir to keep the bundle tree in,
styrene will take no action.
Not counting any retained bundle trees, styrene generates two kinds of bundle files for distribution: installer executables, amd standalone zipfiles. See Supported output formats for details.
Required parameters¶
Styrene requires at least one config file to process. Each config file defines the list of packages to install into the bundle, and what launchers to create in it. It also allows you to delete unused files from your bundle in order to keep its file size down.
See Bundle configuration language for details of the format.
Examples¶
styrene gtk3-examples.cfg
This processes the standard test file in the normal way.
It’ll eventually write two output files
into the current working directory,
with names like gtk3-examples-w64-3.22.1-1-standalone.zip
or gtk3-examples-w64-3.22.1-1-installer.exe.
styrene --debug gtk3-examples.cfg
This enables debug mode: highly detailed explanations of each step. It’s normally too verbose to be useful except when trying to diagnose a fault.
Debug mode should not be used for regular builds. It append a “Press return to continue…” line to the post-install script, so that you can check that everything in it works.
styrene --output-dir=/tmp/test1 gtk3-examples.cfg
This makes Styrene write all its output into a folder of your choice. If you do this, the temporary bundle trees it uses to build the installers and zipfiles are retained. This allows you to examine the contents and run the launchers from inside the working tree. This is a good way to test some aspects of your bundle without installing it.
styrene --pkg-dir=path/to/my/builds my-package.cfg
If you routinely build your own packages, you can tell Styrene to look in specific folders for packages you explicitly name in the config file. Note that you must explicitly name the packages, or they won’t be installed. They won’t be pulled in as dependencies, but they can be used to _satisfy_ dependencies of other packages if you list them explicitly.
Styrene will only install the most recent version of the packages you name.