Befehlszeilenbefehle

Es gibt zwei verschiedene Arten, Meson aufzurufen. Erstens können Sie es direkt aus dem Quellcodeverzeichnis mit dem Befehl /path/to/source/meson.py ausführen. Meson kann auch installiert werden, in diesem Fall ist der Befehl einfach meson. In diesem Handbuch verwenden wir aus Gründen der Einfachheit nur das letztere Format.

Meson wird mit folgender Syntax aufgerufen: meson [BEFEHL] [BEFEHLSOPTIONEN]

Dieser Abschnitt beschreibt alle verfügbaren Befehle und einige ihrer optionalen Argumente. Der gebräuchlichste Arbeitsablauf ist das Ausführen von setup, gefolgt von compile und dann install.

Für die vollständige Liste aller verfügbaren Optionen für einen bestimmten Befehl verwenden Sie die folgende Syntax: meson BEFEHL --help

configure

$ meson configure [-h] [--prefix PREFIX] [--bindir BINDIR]
                  [--datadir DATADIR] [--includedir INCLUDEDIR]
                  [--infodir INFODIR] [--libdir LIBDIR]
                  [--licensedir LICENSEDIR] [--libexecdir LIBEXECDIR]
                  [--localedir LOCALEDIR] [--localstatedir LOCALSTATEDIR]
                  [--mandir MANDIR] [--sbindir SBINDIR]
                  [--sharedstatedir SHAREDSTATEDIR]
                  [--sysconfdir SYSCONFDIR]
                  [--auto-features {enabled,disabled,auto}]
                  [--backend {ninja,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode,none}]
                  [--genvslite {vs2022}]
                  [--buildtype {plain,debug,debugoptimized,release,minsize,custom}]
                  [--debug] [--default-library {shared,static,both}]
                  [--default-both-libraries {shared,static,auto}]
                  [--errorlogs] [--install-umask INSTALL_UMASK]
                  [--layout {mirror,flat}]
                  [--optimization {plain,0,g,1,2,3,s}] [--prefer-static]
                  [--stdsplit] [--strip] [--unity {on,off,subprojects}]
                  [--unity-size UNITY_SIZE]
                  [--warnlevel {0,1,2,3,everything}] [--werror]
                  [--wrap-mode {default,nofallback,nodownload,forcefallback,nopromote}]
                  [--force-fallback-for FORCE_FALLBACK_FOR] [--vsenv]
                  [--pkgconfig.relocatable]
                  [--python.bytecompile PYTHON.BYTECOMPILE]
                  [--python.install-env {auto,prefix,system,venv}]
                  [--python.platlibdir PYTHON.PLATLIBDIR]
                  [--python.purelibdir PYTHON.PURELIBDIR]
                  [--python.allow-limited-api]
                  [--pkg-config-path PKG_CONFIG_PATH]
                  [--build.pkg-config-path BUILD.PKG_CONFIG_PATH]
                  [--cmake-prefix-path CMAKE_PREFIX_PATH]
                  [--build.cmake-prefix-path BUILD.CMAKE_PREFIX_PATH]
                  [-D option] [--clearcache] [--no-pager]
                  [builddir]

Ändert Optionen eines konfigurierten Meson-Projekts.

positional arguments:
  builddir

options:
  -h, --help                            show this help message and exit
  --prefix PREFIX                       Installation prefix.
  --bindir BINDIR                       Executable directory.
  --datadir DATADIR                     Data file directory.
  --includedir INCLUDEDIR               Header file directory.
  --infodir INFODIR                     Info page directory.
  --libdir LIBDIR                       Library directory.
  --licensedir LICENSEDIR               Licenses directory (default: ).
  --libexecdir LIBEXECDIR               Library executable directory.
  --localedir LOCALEDIR                 Locale data directory.
  --localstatedir LOCALSTATEDIR         Localstate data directory.
  --mandir MANDIR                       Manual page directory.
  --sbindir SBINDIR                     System executable directory.
  --sharedstatedir SHAREDSTATEDIR       Architecture-independent data directory.
  --sysconfdir SYSCONFDIR               Sysconf data directory.
  --auto-features {enabled,disabled,auto}
                                        Override value of all 'auto' features
                                        (default: auto).
  --backend {ninja,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode,none}
                                        Backend to use (default: ninja).
  --genvslite {vs2022}                  Setup multiple buildtype-suffixed ninja-
                                        backend build directories, and a
                                        [builddir]_vs containing a Visual Studio
                                        meta-backend with multiple
                                        configurations that calls into them
                                        (default: vs2022).
  --buildtype {plain,debug,debugoptimized,release,minsize,custom}
                                        Build type to use (default: debug).
  --debug                               Enable debug symbols and other
                                        information
  --default-library {shared,static,both}
                                        Default library type (default: shared).
  --default-both-libraries {shared,static,auto}
                                        Default library type for both_libraries
                                        (default: shared).
  --errorlogs                           Whether to print the logs from failing
                                        tests
  --install-umask INSTALL_UMASK         Default umask to apply on permissions of
                                        installed files (default: 022).
  --layout {mirror,flat}                Build directory layout (default:
                                        mirror).
  --optimization {plain,0,g,1,2,3,s}    Optimization level (default: 0).
  --prefer-static                       Whether to try static linking before
                                        shared linking
  --stdsplit                            Split stdout and stderr in test logs
  --strip                               Strip targets on install
  --unity {on,off,subprojects}          Unity build (default: off).
  --unity-size UNITY_SIZE               Unity block size (default: (2, None,
                                        4)).
  --warnlevel {0,1,2,3,everything}      Compiler warning level to use (default:
                                        1).
  --werror                              Treat warnings as errors
  --wrap-mode {default,nofallback,nodownload,forcefallback,nopromote}
                                        Wrap mode (default: default).
  --force-fallback-for FORCE_FALLBACK_FOR
                                        Force fallback for those subprojects
                                        (default: []).
  --vsenv                               Activate Visual Studio environment
  --pkgconfig.relocatable               Generate pkgconfig files as relocatable
  --python.bytecompile PYTHON.BYTECOMPILE
                                        Whether to compile bytecode (default:
                                        (-1, 2, 0)).
  --python.install-env {auto,prefix,system,venv}
                                        Which python environment to install to
                                        (default: prefix).
  --python.platlibdir PYTHON.PLATLIBDIR
                                        Directory for site-specific, platform-
                                        specific files (default: ).
  --python.purelibdir PYTHON.PURELIBDIR
                                        Directory for site-specific, non-
                                        platform-specific files (default: ).
  --python.allow-limited-api            Whether to allow use of the Python
                                        Limited API
  --pkg-config-path PKG_CONFIG_PATH     List of additional paths for pkg-config
                                        to search (default: []). (just for host
                                        machine)
  --build.pkg-config-path BUILD.PKG_CONFIG_PATH
                                        List of additional paths for pkg-config
                                        to search (default: []). (just for build
                                        machine)
  --cmake-prefix-path CMAKE_PREFIX_PATH
                                        List of additional prefixes for cmake to
                                        search (default: []). (just for host
                                        machine)
  --build.cmake-prefix-path BUILD.CMAKE_PREFIX_PATH
                                        List of additional prefixes for cmake to
                                        search (default: []). (just for build
                                        machine)
  -D option                             Set the value of an option, can be used
                                        several times to set multiple options.
  --clearcache                          Clear cached state (e.g. found
                                        dependencies)
  --no-pager                            Do not redirect output to a pager

Die meisten Argumente sind die gleichen wie bei setup.

Hinweis: Das erneute Konfigurieren eines Projekts setzt die Optionen nicht auf ihre Standardwerte zurück (auch wenn sie in meson.build geändert wurden).

Beispiele

Alle verfügbaren Optionen auflisten

meson configure builddir

Wert einer einzelnen Option ändern

meson configure builddir -Doption=new_value

compile

(seit 0.54.0)

$ meson compile [-h] [--clean] [-C WD] [-j JOBS] [-l LOAD_AVERAGE] [-v]
                [--ninja-args NINJA_ARGS] [--vs-args VS_ARGS]
                [--xcode-args XCODE_ARGS]
                [TARGET ...]

Erstellt ein Standard- oder ein angegebenes Ziel eines konfigurierten Meson-Projekts.

positional arguments:
  TARGET                                Targets to build. Target has the
                                        following format: [PATH_TO_TARGET/]TARGE
                                        T_NAME.TARGET_SUFFIX[:TARGET_TYPE].

options:
  -h, --help                            show this help message and exit
  --clean                               Clean the build directory.
  -C WD                                 directory to cd into before running
  -j JOBS, --jobs JOBS                  The number of worker jobs to run (if
                                        supported). If the value is less than 1
                                        the build program will guess.
  -l LOAD_AVERAGE, --load-average LOAD_AVERAGE
                                        The system load average to try to
                                        maintain (if supported).
  -v, --verbose                         Show more verbose output.
  --ninja-args NINJA_ARGS               Arguments to pass to `ninja` (applied
                                        only on `ninja` backend).
  --vs-args VS_ARGS                     Arguments to pass to `msbuild` (applied
                                        only on `vs` backend).
  --xcode-args XCODE_ARGS               Arguments to pass to `xcodebuild`
                                        (applied only on `xcode` backend).

Das Argument --verbose ist seit 0.55.0 verfügbar.

Ziele

(seit 0.55.0)

ZIEL hat die folgende Syntax [PFAD/]NAME.SUFIX[:TYP], wobei

  • NAME: Name des Ziels aus meson.build (z.B. foo aus executable('foo', ...)).
  • SUFIX: Name des Suffixes des Ziels aus meson.build (z.B. exe aus executable('foo', suffix: 'exe', ...)).
  • PFAD: Pfad zum Ziel relativ zur Stammdatei meson.build. Hinweis: Der relative Pfad für ein Ziel, das in der Stammdatei meson.build angegeben ist, ist ./.
  • TYP: Typ des Ziels. Kann einer der folgenden sein: 'executable', 'static_library', 'shared_library', 'shared_module', 'custom', 'alias', 'run', 'jar'.

PFAD, SUFIX und TYP können alle weggelassen werden, wenn das resultierende ZIEL verwendet werden kann, um das Ziel in meson.build eindeutig zu identifizieren.

Beachten Sie, dass SUFIX vor 1.3.0 nicht existierte.

Backend-spezifische Argumente

(seit 0.55.0)

BACKEND-args verwenden die folgende Syntax

Wenn Sie nur einen einzigen String übergeben, wird angenommen, dass er alle durch Kommas getrennten Werte enthält. Somit würde die Ausführung des folgenden Befehls

$ meson compile --ninja-args=-n,-d,explain

die Argumente -n, -d und explain zur Ninja-Ausführung hinzufügen.

Wenn Sie Kommas oder Leerzeichen in Ihren String-Werten benötigen, müssen Sie den Wert mit der entsprechenden Shell-Anführungszeichen wie folgt übergeben

$ meson compile "--ninja-args=['a,b', 'c d']"

Beispiele

Bauen Sie das Projekt

meson compile -C builddir

Führen Sie eine Trockenlauf auf dem Ninja-Backend mit zusätzlichen Debug-Informationen aus

meson compile --ninja-args=-n,-d,explain

Bauen Sie drei Ziele: zwei Ziele mit demselben Namen foo, aber unterschiedlichem Typ, und ein Ziel bar

meson compile foo:shared_library foo:static_library bar

Erzeugen Sie einen HTML-Bericht über die Abdeckung (falls verfügbar)

ninja coverage-html

dist

(seit 0.52.0)

$ meson dist [-h] [-C WD] [--allow-dirty] [--formats FORMATS]
             [--include-subprojects] [--no-tests]

Erzeugt ein Release-Archiv aus dem aktuellen Quellcodeverzeichnis.

options:
  -h, --help             show this help message and exit
  -C WD                  directory to cd into before running
  --allow-dirty          Allow even when repository contains uncommitted
                         changes.
  --formats FORMATS      Comma separated list of archive types to create.
                         Supports xztar (default), bztar, gztar, and zip.
  --include-subprojects  Include source code of subprojects that have been used
                         for the build.
  --no-tests             Do not build and test generated packages.

Weitere Informationen finden Sie in den Hinweisen zur Erstellung von Releases.

Beispiele

Erstellen Sie ein Release-Archiv

meson dist -C builddir

init

(seit 0.45.0)

$ meson init [-h] [-C WD] [-n NAME] [-e EXECUTABLE] [-d DEPS]
             [-l {c,cpp,cs,cuda,d,fortran,java,objc,objcpp,rust,vala}] [-b]
             [--builddir BUILDDIR] [-f] [--type {executable,library}]
             [--version VERSION]
             [sourcefile ...]

Erstellt einen grundlegenden Satz von Build-Dateien basierend auf einer Vorlage.

positional arguments:
  sourcefile                            source files. default: all recognized
                                        files in current directory

options:
  -h, --help                            show this help message and exit
  -C WD                                 directory to cd into before running
  -n NAME, --name NAME                  project name. default: name of current
                                        directory
  -e EXECUTABLE, --executable EXECUTABLE
                                        executable name. default: project name
  -d DEPS, --deps DEPS                  dependencies, comma-separated
  -l {c,cpp,cs,cuda,d,fortran,java,objc,objcpp,rust,vala}, --language {c,cpp,cs,cuda,d,fortran,java,objc,objcpp,rust,vala}
                                        project language. default: autodetected
                                        based on source files
  -b, --build                           build after generation
  --builddir BUILDDIR                   directory for build
  -f, --force                           force overwrite of existing files and
                                        directories.
  --type {executable,library}           project type. default: executable based
                                        project
  --version VERSION                     project version. default: 0.1

Beispiele

Erstellen Sie ein Projekt in sourcedir

meson init -C sourcedir

env2mfile

Dieser Befehl ist experimentell und kann sich ändern.

{Seit 0.62.0}

$ meson env2mfile [-h] [--debarch DEBARCH] [--gccsuffix GCCSUFFIX] -o
                  OUTFILE [--cross] [--native] [--system SYSTEM]
                  [--subsystem SUBSYSTEM] [--kernel KERNEL] [--cpu CPU]
                  [--cpu-family CPU_FAMILY] [--endian {big,little}]

Erstellt native und Cross-Dateien aus der aktuellen Umgebung, typischerweise durch Abtasten von Umgebungsvariablen wie CC und CFLAGS.

options:
  -h, --help               show this help message and exit
  --debarch DEBARCH        The dpkg architecture to generate.
  --gccsuffix GCCSUFFIX    A particular gcc version suffix if necessary.
  -o OUTFILE               The output file.
  --cross                  Generate a cross compilation file.
  --native                 Generate a native compilation file.
  --system SYSTEM          Define system for cross compilation.
  --subsystem SUBSYSTEM    Define subsystem for cross compilation.
  --kernel KERNEL          Define kernel for cross compilation.
  --cpu CPU                Define cpu for cross compilation.
  --cpu-family CPU_FAMILY  Define cpu family for cross compilation.
  --endian {big,little}    Define endianness for cross compilation.

Beispiele

Autodetect der aktuellen Cross-Build-Umgebung

meson env2mfile --cross -o current_cross.txt --cpu=arm7a --cpu-family=arm --system=linux

Generieren Sie einen Cross-Build unter Verwendung von Debian-Systeminformationen

meson env2mfile --cross --debarch=armhf -o deb_arm_cross.txt

introspect

$ meson introspect [-h] [--ast] [--benchmarks] [--buildoptions]
                   [--buildsystem-files] [--compilers] [--dependencies]
                   [--scan-dependencies] [--installed] [--install-plan]
                   [--machines] [--projectinfo] [--targets] [--tests]
                   [--backend {ninja,none,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode}]
                   [-a] [-i] [-f]
                   [builddir]

Zeigt Informationen über ein konfiguriertes Meson-Projekt an.

positional arguments:
  builddir                              The build directory

options:
  -h, --help                            show this help message and exit
  --ast                                 Dump the AST of the meson file.
  --benchmarks                          List all benchmarks.
  --buildoptions                        List all build options.
  --buildsystem-files                   List files that make up the build
                                        system.
  --compilers                           List used compilers.
  --dependencies                        List external dependencies.
  --scan-dependencies                   Scan for dependencies used in the
                                        meson.build file.
  --installed                           List all installed files and
                                        directories.
  --install-plan                        List all installed files and directories
                                        with their details.
  --machines                            Information about host, build, and
                                        target machines.
  --projectinfo                         Information about projects.
  --targets                             List top level targets.
  --tests                               List all unit tests.
  --backend {ninja,none,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode}
                                        The backend to use for the
                                        --buildoptions introspection.
  -a, --all                             Print all available information.
  -i, --indent                          Enable pretty printed JSON.
  -f, --force-object-output             Always use the new JSON format for
                                        multiple entries (even for 0 and 1
                                        introspection commands)

Beispiele

Grundlegende Informationen über ein konfiguriertes Projekt in builddir anzeigen

meson introspect builddir --projectinfo

install

(seit 0.47.0)

$ meson install [-h] [-C WD] [--no-rebuild] [--only-changed] [--quiet]
                [--destdir DESTDIR] [--dry-run]
                [--skip-subprojects [SKIP_SUBPROJECTS]] [--tags TAGS]
                [--strip]

Installiert das Projekt in das unter setup angegebene Präfix.

options:
  -h, --help                            show this help message and exit
  -C WD                                 directory to cd into before running
  --no-rebuild                          Do not rebuild before installing.
  --only-changed                        Only overwrite files that are older than
                                        the copied file.
  --quiet                               Do not print every file that was
                                        installed.
  --destdir DESTDIR                     Sets or overrides DESTDIR environment.
                                        (Since 0.57.0)
  --dry-run, -n                         Doesn't actually install, but print
                                        logs. (Since 0.57.0)
  --skip-subprojects [SKIP_SUBPROJECTS]
                                        Do not install files from given
                                        subprojects. (Since 0.58.0)
  --tags TAGS                           Install only targets having one of the
                                        given tags. (Since 0.60.0)
  --strip                               Strip targets even if strip option was
                                        not set during configure. (Since 0.62.0)

Weitere Informationen finden Sie in der Installationsdokumentation.

Beispiele

Projekt in prefix installieren

meson install -C builddir

Projekt in $DESTDIR/prefix installieren

DESTDIR=/path/to/staging/area meson install -C builddir

Seit 0.60.0 kann DESTDIR und --destdir ein Pfad sein, der relativ zum Build-Verzeichnis ist. Ein absoluter Pfad wird in die Umgebung gesetzt, wenn Skripte ausgeführt werden.

reprotest

(seit 1.6.0)

$ meson reprotest [-h] [--intermediaries] [mesonargs ...]

Einfacher reproduzierbarer Build-Tester, der das Projekt zweimal kompiliert und prüft, ob die Endergebnisse identisch sind.

Dieser Befehl muss im Quell-Root des zu testenden Projekts ausgeführt werden.

positional arguments:
  mesonargs         Arguments to pass to "meson setup".

options:
  -h, --help        show this help message and exit
  --intermediaries  Check intermediate files.

Beispiele

meson reprotest

Baut das aktuelle Projekt mit seinen Standardeinstellungen.

meson reprotest --intermediaries -- --buildtype=debugoptimized

Baut das Ziel und prüft auch, ob alle Zwischenanlagen wie Objektdateien ebenfalls identisch sind. Alle Kommandozeilenargumente nach -- werden direkt an die zugrunde liegende meson-Aufrufung übergeben. Verwenden Sie nur Optionsargumente, d.h. solche, die mit einem Bindestrich beginnen. Meson setzt Verzeichnisargumente automatisch.

rewrite

(seit 0.50.0)

$ meson rewrite [-h] [-s SRCDIR] [-V] [-S]
                {target,tgt,kwargs,default-options,def,command,cmd} ...

Modifiziert das Meson-Projekt.

options:
  -h, --help                            show this help message and exit
  -s SRCDIR, --sourcedir SRCDIR         Path to source directory.
  -V, --verbose                         Enable verbose output
  -S, --skip-errors                     Skip errors instead of aborting

Rewriter commands:
  Rewrite command to execute

  {target,tgt,kwargs,default-options,def,command,cmd}
    target (tgt)                        Modify a target
    kwargs                              Modify keyword arguments
    default-options (def)               Modify the project default options
    command (cmd)                       Execute a JSON array of commands

Weitere Informationen finden Sie in der Dokumentation zum Meson-Datei-Rewriter.

setup

$ meson setup [-h] [--prefix PREFIX] [--bindir BINDIR] [--datadir DATADIR]
              [--includedir INCLUDEDIR] [--infodir INFODIR]
              [--libdir LIBDIR] [--licensedir LICENSEDIR]
              [--libexecdir LIBEXECDIR] [--localedir LOCALEDIR]
              [--localstatedir LOCALSTATEDIR] [--mandir MANDIR]
              [--sbindir SBINDIR] [--sharedstatedir SHAREDSTATEDIR]
              [--sysconfdir SYSCONFDIR]
              [--auto-features {enabled,disabled,auto}]
              [--backend {ninja,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode,none}]
              [--genvslite {vs2022}]
              [--buildtype {plain,debug,debugoptimized,release,minsize,custom}]
              [--debug] [--default-library {shared,static,both}]
              [--default-both-libraries {shared,static,auto}] [--errorlogs]
              [--install-umask INSTALL_UMASK] [--layout {mirror,flat}]
              [--optimization {plain,0,g,1,2,3,s}] [--prefer-static]
              [--stdsplit] [--strip] [--unity {on,off,subprojects}]
              [--unity-size UNITY_SIZE] [--warnlevel {0,1,2,3,everything}]
              [--werror]
              [--wrap-mode {default,nofallback,nodownload,forcefallback,nopromote}]
              [--force-fallback-for FORCE_FALLBACK_FOR] [--vsenv]
              [--pkgconfig.relocatable]
              [--python.bytecompile PYTHON.BYTECOMPILE]
              [--python.install-env {auto,prefix,system,venv}]
              [--python.platlibdir PYTHON.PLATLIBDIR]
              [--python.purelibdir PYTHON.PURELIBDIR]
              [--python.allow-limited-api]
              [--pkg-config-path PKG_CONFIG_PATH]
              [--build.pkg-config-path BUILD.PKG_CONFIG_PATH]
              [--cmake-prefix-path CMAKE_PREFIX_PATH]
              [--build.cmake-prefix-path BUILD.CMAKE_PREFIX_PATH]
              [-D option] [--native-file NATIVE_FILE]
              [--cross-file CROSS_FILE] [-v] [--fatal-meson-warnings]
              [--reconfigure] [--wipe] [--clearcache]
              [builddir] [sourcedir]

Konfiguriert ein Build-Verzeichnis für das Meson-Projekt.

Veraltet seit 0.64.0: Dies ist der Standardbefehl von Meson (aufgerufen, wenn kein BEFEHL angegeben wurde). Das explizite Angeben des Befehls ist jedoch notwendig, um Kollisionen mit zukünftig hinzugefügten Befehlen zu vermeiden, daher sollte "setup" explizit verwendet werden.

Seit 1.1.0 ist --reconfigure auch dann erlaubt, wenn das Build-Verzeichnis noch nicht existiert; dieses Argument wird in diesem Fall ignoriert.

Seit 1.3.0 Wenn das Build-Verzeichnis bereits existiert, werden Optionen mit ihrem neuen Wert aktualisiert, der auf der Kommandozeile angegeben wurde (-Dopt=value). Sofern --reconfigure nicht ebenfalls angegeben ist, wird dies nicht sofort neu konfiguriert. Dies hat dasselbe Verhalten wie meson configure <builddir> -Dopt=value.

Seit 1.3.0 Es ist möglich, den Cache zu löschen und mit einem einzigen Befehl neu zu konfigurieren: meson setup --clearcache --reconfigure <builddir>.

positional arguments:
  builddir
  sourcedir

options:
  -h, --help                            show this help message and exit
  --prefix PREFIX                       Installation prefix.
  --bindir BINDIR                       Executable directory.
  --datadir DATADIR                     Data file directory.
  --includedir INCLUDEDIR               Header file directory.
  --infodir INFODIR                     Info page directory.
  --libdir LIBDIR                       Library directory.
  --licensedir LICENSEDIR               Licenses directory (default: ).
  --libexecdir LIBEXECDIR               Library executable directory.
  --localedir LOCALEDIR                 Locale data directory.
  --localstatedir LOCALSTATEDIR         Localstate data directory.
  --mandir MANDIR                       Manual page directory.
  --sbindir SBINDIR                     System executable directory.
  --sharedstatedir SHAREDSTATEDIR       Architecture-independent data directory.
  --sysconfdir SYSCONFDIR               Sysconf data directory.
  --auto-features {enabled,disabled,auto}
                                        Override value of all 'auto' features
                                        (default: auto).
  --backend {ninja,vs,vs2010,vs2012,vs2013,vs2015,vs2017,vs2019,vs2022,xcode,none}
                                        Backend to use (default: ninja).
  --genvslite {vs2022}                  Setup multiple buildtype-suffixed ninja-
                                        backend build directories, and a
                                        [builddir]_vs containing a Visual Studio
                                        meta-backend with multiple
                                        configurations that calls into them
                                        (default: vs2022).
  --buildtype {plain,debug,debugoptimized,release,minsize,custom}
                                        Build type to use (default: debug).
  --debug                               Enable debug symbols and other
                                        information
  --default-library {shared,static,both}
                                        Default library type (default: shared).
  --default-both-libraries {shared,static,auto}
                                        Default library type for both_libraries
                                        (default: shared).
  --errorlogs                           Whether to print the logs from failing
                                        tests
  --install-umask INSTALL_UMASK         Default umask to apply on permissions of
                                        installed files (default: 022).
  --layout {mirror,flat}                Build directory layout (default:
                                        mirror).
  --optimization {plain,0,g,1,2,3,s}    Optimization level (default: 0).
  --prefer-static                       Whether to try static linking before
                                        shared linking
  --stdsplit                            Split stdout and stderr in test logs
  --strip                               Strip targets on install
  --unity {on,off,subprojects}          Unity build (default: off).
  --unity-size UNITY_SIZE               Unity block size (default: (2, None,
                                        4)).
  --warnlevel {0,1,2,3,everything}      Compiler warning level to use (default:
                                        1).
  --werror                              Treat warnings as errors
  --wrap-mode {default,nofallback,nodownload,forcefallback,nopromote}
                                        Wrap mode (default: default).
  --force-fallback-for FORCE_FALLBACK_FOR
                                        Force fallback for those subprojects
                                        (default: []).
  --vsenv                               Activate Visual Studio environment
  --pkgconfig.relocatable               Generate pkgconfig files as relocatable
  --python.bytecompile PYTHON.BYTECOMPILE
                                        Whether to compile bytecode (default:
                                        (-1, 2, 0)).
  --python.install-env {auto,prefix,system,venv}
                                        Which python environment to install to
                                        (default: prefix).
  --python.platlibdir PYTHON.PLATLIBDIR
                                        Directory for site-specific, platform-
                                        specific files (default: ).
  --python.purelibdir PYTHON.PURELIBDIR
                                        Directory for site-specific, non-
                                        platform-specific files (default: ).
  --python.allow-limited-api            Whether to allow use of the Python
                                        Limited API
  --pkg-config-path PKG_CONFIG_PATH     List of additional paths for pkg-config
                                        to search (default: []). (just for host
                                        machine)
  --build.pkg-config-path BUILD.PKG_CONFIG_PATH
                                        List of additional paths for pkg-config
                                        to search (default: []). (just for build
                                        machine)
  --cmake-prefix-path CMAKE_PREFIX_PATH
                                        List of additional prefixes for cmake to
                                        search (default: []). (just for host
                                        machine)
  --build.cmake-prefix-path BUILD.CMAKE_PREFIX_PATH
                                        List of additional prefixes for cmake to
                                        search (default: []). (just for build
                                        machine)
  -D option                             Set the value of an option, can be used
                                        several times to set multiple options.
  --native-file NATIVE_FILE             File containing overrides for native
                                        compilation environment.
  --cross-file CROSS_FILE               File describing cross compilation
                                        environment.
  -v, --version                         show program's version number and exit
  --fatal-meson-warnings                Make all Meson warnings fatal
  --reconfigure                         Set options and reconfigure the project.
                                        Useful when new options have been added
                                        to the project and the default value is
                                        not working.
  --wipe                                Wipe build directory and reconfigure
                                        using previous command line options.
                                        Useful when build directory got
                                        corrupted, or when rebuilding with a
                                        newer version of meson.
  --clearcache                          Clear cached state (e.g. found
                                        dependencies). Since 1.3.0.

Weitere Informationen finden Sie auf der Meson-Einführungsseite.

Beispiele

Konfiguriert builddir mit Standardwerten

meson setup builddir

subprojects

(seit 0.49.0)

$ meson subprojects [-h]
                    {update,checkout,download,foreach,purge,packagefiles}
                    ...

Verwaltet Unterprojekte des Meson-Projekts. Seit 0.59.0 werden Befehle standardmäßig parallel auf mehreren Unterprojekten ausgeführt. Verwenden Sie --num-processes=1, wenn dies nicht gewünscht ist.

Seit 0.64.0 wird der Unterbefehl update keine neuen Wrap-Dateien mehr von WrapDB herunterladen. Verwenden Sie stattdessen den Befehl meson wrap update.

options:
  -h, --help                            show this help message and exit

Commands:
  {update,checkout,download,foreach,purge,packagefiles}
    update                              Update all subprojects from wrap files
    checkout                            Checkout a branch (git only)
    download                            Ensure subprojects are fetched, even if
                                        not in use. Already downloaded
                                        subprojects are not modified. This can
                                        be used to pre-fetch all subprojects and
                                        avoid downloads during configure.
    foreach                             Execute a command in each subproject
                                        directory.
    purge                               Remove all wrap-based subproject
                                        artifacts
    packagefiles                        Manage the packagefiles overlay

test

$ meson test [-h] [--maxfail MAXFAIL] [--repeat REPEAT] [--no-rebuild]
             [--gdb] [--gdb-path GDB_PATH] [-i] [--list]
             [--wrapper WRAPPER] [-C WD] [--suite SUITE] [--no-suite SUITE]
             [--no-stdsplit] [--print-errorlogs] [--benchmark]
             [--logbase LOGBASE] [-j NUM_PROCESSES] [-v] [-q]
             [-t TIMEOUT_MULTIPLIER] [--setup SETUP]
             [--test-args TEST_ARGS] [--max-lines MAX_LINES]
             [args ...]

Führt Tests für das konfigurierte Meson-Projekt aus.

positional arguments:
  args                                  Optional list of test names to run.
                                        "testname" to run all tests with that
                                        name, "subprojname:testname" to
                                        specifically run "testname" from
                                        "subprojname", "subprojname:" to run all
                                        tests defined by "subprojname".

options:
  -h, --help                            show this help message and exit
  --maxfail MAXFAIL                     Number of failing tests before aborting
                                        the test run. (default: 0, to disable
                                        aborting on failure)
  --repeat REPEAT                       Number of times to run the tests.
  --no-rebuild                          Do not rebuild before running tests.
  --gdb                                 Run test under gdb.
  --gdb-path GDB_PATH                   Path to the gdb binary (default: gdb).
  -i, --interactive                     Run tests with interactive input/output.
  --list                                List available tests.
  --wrapper WRAPPER                     wrapper to run tests with (e.g.
                                        Valgrind)
  -C WD                                 directory to cd into before running
  --suite SUITE                         Only run tests belonging to the given
                                        suite.
  --no-suite SUITE                      Do not run tests belonging to the given
                                        suite.
  --no-stdsplit                         Do not split stderr and stdout in test
                                        logs.
  --print-errorlogs                     Whether to print failing tests' logs.
  --benchmark                           Run benchmarks instead of tests.
  --logbase LOGBASE                     Base name for log file.
  -j NUM_PROCESSES, --num-processes NUM_PROCESSES
                                        How many parallel processes to use.
  -v, --verbose                         Do not redirect stdout and stderr
  -q, --quiet                           Produce less output to the terminal.
  -t TIMEOUT_MULTIPLIER, --timeout-multiplier TIMEOUT_MULTIPLIER
                                        Define a multiplier for test timeout,
                                        for example when running tests in
                                        particular conditions they might take
                                        more time to execute. (<= 0 to disable
                                        timeout)
  --setup SETUP                         Which test setup to use.
  --test-args TEST_ARGS                 Arguments to pass to the specified
                                        test(s) or all tests
  --max-lines MAX_LINES                 Maximum number of lines to show from a
                                        long test log. Since 1.5.0.

Weitere Informationen finden Sie in der Dokumentation zu Unit-Tests.

Seit 1.2.0 können Sie Wildcards in args für Testnamen verwenden. Zum Beispiel passt "bas*" zu allen Tests, deren Namen mit "bas" beginnen.

Seit 1.2.0 ist es ein Fehler, einen Testnamen oder ein Wildcard anzugeben, das keinem Test entspricht.

Beispiele

Führen Sie Tests für das Projekt aus

meson test -C builddir

Führen Sie nur specific_test_1 und specific_test_2 aus

meson test -C builddir specific_test_1 specific_test_2

wrap

$ meson wrap [-h]
             {list,search,install,update,info,status,promote,update-db} ...

Ein Hilfsprogramm zur Verwaltung von WrapDB-Abhängigkeiten.

options:
  -h, --help                            show this help message and exit

Commands:
  {list,search,install,update,info,status,promote,update-db}
    list                                show all available projects
    search                              search the db by name
    install                             install the specified project
    update                              Update wrap files from WrapDB (Since
                                        0.63.0)
    info                                show available versions of a project
    status                              show installed and available versions of
                                        your projects
    promote                             bring a subsubproject up to the master
                                        project
    update-db                           Update list of projects available in
                                        WrapDB (Since 0.61.0)

Weitere Informationen finden Sie in der Dokumentation zum WrapDB-Tool.

devenv

(seit 0.58.0)

$ meson devenv [-h] [-C BUILDDIR] [--workdir WORKDIR] [--dump [DUMP]]
               [--dump-format {sh,export,vscode}]
               ...

Führt einen Befehl aus oder öffnet eine interaktive Shell, wenn kein Befehl angegeben ist, mit einer Umgebung, die so eingerichtet ist, dass das Projekt aus dem Build-Verzeichnis heraus ausgeführt werden kann, ohne Installation.

Wir behandeln bash automatisch und setzen $PS1 entsprechend. Wenn die automatische Überschreibung von $PS1 nicht gewünscht ist (vielleicht haben Sie eine ausgefallene benutzerdefinierte Eingabeaufforderung), setzen Sie die Umgebungsvariable $MESON_DISABLE_PS1_OVERRIDE und verwenden Sie $MESON_PROJECT_NAME beim Festlegen der benutzerdefinierten Eingabeaufforderung, zum Beispiel mit einem Snippet wie dem folgenden

...
if [[ -n "${MESON_PROJECT_NAME-}" ]];
then
  PS1+="[ ${MESON_PROJECT_NAME} ]"
fi
...

Diese Variablen werden zusätzlich zu den mit meson.add_devenv() gesetzten Variablen in die Umgebung gesetzt.

  • MESON_DEVENV ist auf '1' gesetzt.
  • MESON_PROJECT_NAME ist auf den Namen des Hauptprojekts gesetzt.
  • PKG_CONFIG_PATH beinhaltet das Verzeichnis, in dem Meson -uninstalled.pc-Dateien generiert.
  • PATH beinhaltet jedes Verzeichnis, in dem sich eine ausführbare Datei befindet, die in bindir installiert werden würde. Unter Windows beinhaltet es auch jedes Verzeichnis, in dem sich eine DLL befindet, die zum Ausführen dieser ausführbaren Dateien benötigt wird.
  • LD_LIBRARY_PATH beinhaltet jedes Verzeichnis, in dem sich eine gemeinsam genutzte Bibliothek befindet, die in libdir installiert werden würde. Dies ermöglicht die Ausführung von Systemanwendungen, die benutzerdefinierte Builds einiger Bibliotheken verwenden. Zum Beispiel die Ausführung von systemeigenem GEdit beim Erstellen von GTK aus dem Git-Repository. Auf OSX ist die Umgebungsvariable DYLD_LIBRARY_PATH und unter Windows PATH.
  • GI_TYPELIB_PATH beinhaltet jedes Verzeichnis, in dem ein GObject Introspection Typelib erstellt wird. Dies wird automatisch gesetzt, wenn gnome.generate_gir() verwendet wird.
  • GSETTINGS_SCHEMA_DIR Seit 0.59.0 beinhaltet jedes Verzeichnis, in dem GSettings-Schemata kompiliert werden. Dies wird automatisch gesetzt, wenn gnome.compile_schemas() verwendet wird. Beachten Sie, dass dies GLib >= 2.64 erfordert, wenn gnome.compile_schemas() in mehr als einem Verzeichnis verwendet wird.
  • QEMU_LD_PREFIX Seit 1.0.0 wird auf den sys_root-Wert aus der Cross-Datei gesetzt, wenn Cross-Compilierung stattfindet und diese Eigenschaft definiert ist.

Seit 0.62.0 werden Bash-Completion-Skripte, falls sie installiert werden und die Shell Bash ist, automatisch gesourced.

Seit 0.62.0 werden GDB-Hilfsskripte (*-gdb.py, *-gdb.gdb und *-gdb.csm), die mit einem Bibliotheksnamen installiert werden, der mit einem gerade erstellten übereinstimmt, von Meson in die Datei <builddir>/.gdbinit aufgenommen. Wenn GDB vom Top-Build-Verzeichnis aus gestartet wird, wird diese Datei automatisch von GDB geladen. Im Fall von Python-Skripten, die andere Python-Module laden müssen, muss PYTHONPATH möglicherweise mit meson.add_devenv() modifiziert werden.

Seit 0.63.0 wird beim Cross-Compilieren für Windows WINEPATH anstelle von PATH verwendet, was das Ausführen von Windows-Executables mit Wine ermöglicht. Beachten Sie, dass die Größe von WINEPATH derzeit auf 1024 Zeichen begrenzt ist, daher werden Pfade relativ zum Root des Build-Verzeichnisses verwendet. Das bedeutet, dass das aktuelle Arbeitsverzeichnis das Root des Build-Verzeichnisses sein muss, wenn Wine ausgeführt wird.

Seit 1.1.0 nimmt der Befehl meson devenv --dump [<filename>] ein optionales Dateinamenargument entgegen, um die Umgebung in eine Datei zu schreiben, anstatt sie auf stdout auszugeben.

Seit 1.1.0 wurde das Argument --dump-format hinzugefügt, um auszuwählen, welches Shell-Format verwendet werden soll. Derzeit werden 3 Formate unterstützt

  • sh: Zeilen sind im Format VAR=/prepend:$VAR:/append.
  • export: Gleicht sh, aber mit zusätzlichen export VAR Zeilen.
  • vscode: Gleicht sh, aber ohne $VAR-Substitution, da diese in VS Code anscheinend nicht richtig unterstützt werden.
positional arguments:
  command                           Command to run in developer environment
                                    (default: interactive shell)

options:
  -h, --help                        show this help message and exit
  -C BUILDDIR                       Path to build directory
  --workdir WORKDIR, -w WORKDIR     Directory to cd into before running
                                    (default: builddir, Since 1.0.0)
  --dump [DUMP]                     Only print required environment (Since
                                    0.62.0) Takes an optional file path (Since
                                    1.1.0)
  --dump-format {sh,export,vscode}  Format used with --dump (Since 1.1.0)

format

(seit 1.5.0)

$ meson format [-h] [-q | -i] [-r] [-c meson.format] [-e] [-o OUTPUT]
               [sources ...]

Formatiert die Dokumentation von meson.build. Zur Kompatibilität mit muon ist fmt ein Alias für format.

positional arguments:
  sources                               meson source files

options:
  -h, --help                            show this help message and exit
  -q, --check-only                      exit with 1 if files would be modified
                                        by meson format
  -i, --inplace                         format files in-place
  -r, --recursive                       recurse subdirs (requires --check-only
                                        or --inplace option)
  -c meson.format, --configuration meson.format
                                        read configuration from meson.format
  -e, --editor-config                   try to read configuration from
                                        .editorconfig
  -o OUTPUT, --output OUTPUT            output file (implies having exactly one
                                        input)

Die Konfigurationsdatei ist eine .ini-Datei. Wenn eine meson.format-Datei neben der zu analysierenden Build-Datei existiert und keine Konfigurationsdatei auf der Kommandozeile angegeben wird, wird die Datei meson.format automatisch verwendet.

Wenn auf der Kommandozeile keine Build-Datei angegeben wird, wird die Datei meson.build im aktuellen Verzeichnis analysiert.

Folgende Optionen werden erkannt

  • max_line_length (int): Wenn ein Array, ein Dictionary, eine Funktion oder eine Methode länger als dieser Wert wird, wird es mit einem Argument pro Zeile formatiert (Standard ist 80).
  • indent_by (str): Einrückung, die verwendet werden soll (Standard sind vier Leerzeichen ' ').
  • space_array (bool): Ob Leerzeichen zwischen [] und Array-Argumenten hinzugefügt werden sollen (Standard ist false).
  • kwargs_force_multiline (bool): Wenn true, werden Argumente so schnell wie ein Keyword-Argument vorhanden ist, eine pro Zeile formatiert (Standard ist false).
  • wide_colon (bool): Wenn true, wird vor Doppelpunkten in Dictionaries und Keyword-Argumenten ein Leerzeichen gesetzt (Standard ist false).
  • no_single_comma_function (bool): Wenn true, wird niemals ein Komma an Funktionsargumente angehängt, wenn nur ein Argument vorhanden ist, auch wenn mehrzeilige Argumente verwendet werden (Standard ist false).
  • end_of_line ('cr', 'lf', 'crlf', 'native'): Zeilenende, das verwendet werden soll (angewendet, wenn das Argument --output oder --inline verwendet wird) (Standard ist 'native).
  • indent_before_comments (str): Einrückung, die vor Inline-Kommentaren verwendet werden soll (Standard sind zwei Leerzeichen ' ').
  • simplify_string_literals (bool): Wenn true, werden mehrzeilige Strings in einzeilige Strings umgewandelt, wenn sie keine Zeilenumbrüche enthalten. Formatierte Strings werden in normale Strings umgewandelt, wenn sie keine Substitutionen enthalten (Standard ist true).
  • insert_final_newline (bool): Wenn true, erzwingt die Datei meson.build, mit einem Zeilenumbruchzeichen zu enden (Standard ist true).
  • tab_width (int): Breite der Tabulatorstopps, die zur Berechnung der Zeilenlänge verwendet wird, wenn indent_by Tabulatoren verwendet (Standard ist 4).
  • sort_files (bool): Wenn true, werden die Argumente der Funktion files() alphabetisch sortiert (Standard ist false).
  • group_arg_value (bool): Wenn true, werden String-Argumente mit dem Präfix --, gefolgt von String-Argumenten ohne Präfix --, in mehrzeiligen Argumenten in derselben Zeile gruppiert (Standard ist false).
  • use_editor_config (bool): Wenn true, wird auch die Konfiguration aus .editorconfig verwendet.

Die ersten sechs Optionen sind die gleichen wie für den Befehl muon fmt.

Es ist auch möglich, eine .editorconfig-Datei zu verwenden, indem die Option --editor-config auf der Kommandozeile angegeben wird, oder mit der Option use_editor_config in der Konfigurationsdatei.

Wenn die Option --recursive angegeben ist, werden auch meson.build-Dateien aus subdir analysiert (muss zusammen mit der Option --inplace oder --check-only verwendet werden).

Unterschiede zu muon fmt

Der Befehl meson format sollte mit dem Befehl muon fmt kompatibel sein. Er verfügt jedoch über mehr Funktionen und einige Unterschiede

  • Standardmäßig fügt meson format zwei Leerzeichen vor Inline-Kommentaren ein, während muon fmt nur eines einfügt.
  • muon fmt kann potenziell CRLF- und LF-Zeilenenden mischen, da es sich dessen nicht bewusst ist. meson format wird bei der Ausgabe immer konsistent sein.
  • muon fmt erkennt nur die Option indent_by aus .editorconfig-Dateien. meson format erkennt auch die Optionen max_line_length, end_of_line, insert_final_newline und tab_width.
  • meson format hat viele zusätzliche Formatierungsregeln (siehe obige Optionsliste).

Die Ergebnisse der Suche sind