Binary package guide/de

Neben der gewöhnlichen Unterstützung von ebuilds bietet Portage den Bau und die Installation von Binärpaketen. Dieser Leitfaden erklärt wie man diese erstellt, installiert und wie man einen Binärpaket-Server aufsetzt.

Es gibt viele Gründe, weshalb einige Systemadministratoren die Verwendung von Binärpaketen für Softwareinstallationen unter Gentoo mögen:


 * 1) Es erlaubt Administratoren ähnliche Systeme aktuell zu halten. Alles aus den Quellen kompilieren zu müssen, kann zeitaufwändig werden. Die Wartung einiger ähnlicher Systeme, möglicherweise einige von ihnen mit älterer Hardware, kann sehr viel einfacher sein, wenn nur ein System alles aus den Quellen kompilieren muss und die anderen Systeme die Binärpakete verwenden.
 * 2) Sichere Updates durchzuführen. Für missionskritische Systeme in Produktionsumgebungen ist es wichtig soweit wie möglich benutzbar zu bleiben. Dies kann durch Staging-Server erreicht werden, die alle Updates zuerst bei sich selbst durchführen. Sobald der Staging-Server (wieder) in einem guten Zustand ist, können die Updates auf das kritische System angewandt werden. Eine Variante dieses Ansatzes ist die Updates in einer chroot-Umgebung auf dem selben System durchzuführen und die hierbei erzeugten Binärdateien dann im richtigen System zu benutzen.
 * 3) Als ein Backup. Oft sind Binärpakete der einzige Weg ein kaputtes System wiederherzustellen (z.B. kaputter Kompiler). Vorkompilierte Binärpakete bei der Hand zu haben, entweder auf einem Binärpaket-Server oder lokal, kann im Falle einer defekten Toolchain eine große Hilfe sein.
 * 4) Und schließlich hilft es ebenfalls sehr alte Systeme upzudaten. Die Aufgabe sehr alte Systeme upzudaten kann durch die Verwendung von Binärpaketen stark vereinfacht werden. Es ist für gewöhnlich hilfreich Binärpakete auf alten Systemen zu installieren weil sie keine Build-Time Abhängigkeiten erfordern, die installiert/ upgedatet werden müssten. Binär-Pakete vermeiden ebenfalls Fehler in Build-Prozessen, weil sie vorkompiliert sind.

Dieser Leitfaden konzentriert sich auf die folgenden Themen:


 * Die Erstellung von Binärpaketen.
 * Die Verteilung der Pakete an die Nutzer.
 * Die Implementierung der Binärpakete.
 * Die Pflege der Binärpakete.

Nahe am Ende werden ein paar fortgeschrittenere Themen zum Umgang mit Binärpaketen behandelt.

Binary package formats
Starting with portage version 3.0.31, a new binary package format (GPKG) support has been added. The new format was completely redesigned to solve issues with the old design and to include new features, therefore no backward compatibility is provided. If users need to create binary packages for the system using older versions of Portage, please keep using the current XPAK format.

Motivation for the new GPKG format can be found in GLEP 78: Gentoo binary package container format. See also and.

To use new GPKG format, set the BINPKG_FORMAT value in. The default value is xpak.

This guide applies to both formats. See the Understanding the binary package format section for more information on the binary package formats.

Binärpakete erzeugen
Es gibt drei Hauptmethoden um Binärpakete zu erzeugen:


 * 1) Nach einer regulären Installation durch Nutzung der  Anwendung;
 * 2) Explizit währen einer -Operation durch den Gebrauch der   (  Werts in Portages FEATURES Variable.

Alle drei Methoden erzeugen ein Binärpaket im Verzeichnis auf das durch die PKGDIR -Variable gezeigt wird (deren Voreinstellung ist).

Benutzung von quickpkg
Die Applikation nimmt eine oder mehrere Abhängigkeits-atome (oder Paket-Sätze) und erstellt für alle installierten Pakete die mit diesem atom übereinstimmen Binärpakete.

Bei dieser Methode gibt es einen Vorbehalt: Sie ist auf die installierten Dateien angewiesen, was im Fall von Konfigurationsdateien ein Problem sein kann. Administratoren ändern Konfigurationsdateien nach der Softwareinstallation oft. Aus diesem Grund können (vielleicht sogar vertrauliche) Daten in die Pakete entweichen. schließt standardmäßig Konfigurationsdateien nicht ein, die mit der CONFIG_PROTECT Methode geschützt sind. Um die Erfassung von Konfigurationsdateien zu erzwingen nutzen Sie die  oder   Option.

Um beispielsweise von allen installierten GCC-Versionen Binärpakete zu erstellen:

To create binary packages for the system set:

Um Binärpakete von allen auf dem System installierten Paketen zu schaffen, verwenden Sie  glob:

--buildpkg als emerge Option nutzen
Bei der Installation von Software mit kann Portage mit der    Option verwendet werden, um Binärpakete zu erstellen:

Es ist ebenfalls möglich Portage dazu zu bringen nur Binärpakete zu erzeugen aber die Software nicht auf dem Live-System zu installieren. Dazu kann die   Option verwendet werden:

Die letztere Herangehensweise macht es erforderlich alle Build-Time Abhängigkeiten zuvor zu installieren.

buildpkg as a Portage Eigenschaft nutzen
Die gewöhnlichste Art um automatisch Binärpakete zu erzeugen wann immer ein Paket von Portage installiert wird, ist die Nutzung der  Eigenschaft. Sie kann auf die folgende Weise in gesetzt werden:

Falls diese Eigenschaft aktiviert ist, wird jedes mal wenn Portage Software installiert, ebenfalls ein Binärpaket erzeugt.

Erzeugung einiger Pakete ausschließen
Es ist möglich, Portage anzuweisen für einige ausgewählte Pakete oder Kategorien keine Binärpakete zu erstellen. Dies geschieht durch Übergabe der  Option zu emerge:

Dies könnte für Pakete verwendet werden, bei denen es wenig bis gar keinen Nutzen bring, ein Binärpaket zur Verfügung zu haben. Beispiele wären die Linux-Kernel-Quellpakete oder Upstream-Binärpakete (die mit "-bin" enden, wie ).

Binary package compression formats
It is possible to use a specific compression type on binary packages. Currently, the following formats are supported:,  ,  ,  ,  ,  , and. Defaults to. Review and search for BINPKG_COMPRESS for the most up-to-date information.

The compression format can be specified via.

Note that the compression type used might require extra dependencies to be installed, for example, in this case.

Binary package OpenGPG signing
GPG signature allows users to check the creator and integrity of a binary package, and to perform trust management based on keys. The binary package signing feature is disabled by default, to use it users need to enable the  feature. Note that whether this feature is enabled does not affect the signature verification feature.

Users also need to set the BINPKG_GPG_SIGNING_GPG_HOME and BINPKG_GPG_SIGNING_KEY variables for Portage to find the signing key.

Portage will only try to unlock the GPG private key at the beginning. If the user's key will expire over time, then consider enabling  to prevent signing failures.

Einrichtung eines Binärpaket-Hosts
Portage unterstützt eine Reihe von Protokollen für das Herunterladen von Binärpaketen: FTP, FTPS, HTTP, HTTPS und SSH/SFTP. Dies lässt Raum für viele mögliche Implementierungen von Binärpaket-Hosts.

Es gibt jedoch keine "out-of-the-box" Methode, die von Portage für die Verteilung von Binärpaketen angeboten wird. Je nach gewünschten Setup muss zusätzliche Software installiert werden.

Webbasierter Binärpaket-Hosts
Ein gängiger Ansatz für die Verteilung von Binärpaketen ist die Erstellung eines webbasierten Binärpaket-Hosts.

Verwenden Sie einen Webserver wie lighttpd und konfigurieren Sie in so, dass er Lesezugriff auf s PKGDIR Verzeichnis hat.

Auf den Client-Systemen konfigurieren Sie dann die Variable PORTAGE_BINHOST entsprechend:

SSH-Binärpaket-Host
Um einen authentifizierten Ansatz für Binärpakete zu liefern, kann man SSH verwenden.

Bei der Verwendung von SSH ist es möglich, den SSH-Schlüssel des Root-Linux-Benutzers zu verwenden (ohne Passphrase, da die Installationen im Hintergrund erfolgen müssen), um eine Verbindung zu einem entfernten Binärpaket-Host herzustellen.

Stellen Sie dazu sicher, dass der SSH-Schlüssel des Root-Benutzers auf dem Server zugelassen ist. Dies muss für jeden Rechner geschehen, der eine Verbindung mit dem SSH-fähigen Binärpaket-Host herstellen will:

Die PORTAGE_BINHOST Variable könnte dann wie folgt aussehen:

NFS exportiert
Bei der Verwendung von Binärpaketen in einem internen Netzwerk kann es einfacher sein, die Pakete über NFS zu exportieren und sie auf den Clients einzuhängen.

Die Datei könnte wie folgt aussehen:

Auf den Clients kann das Verzeichnis dann eingehängt werden. Ein Beispiel für einen -Eintrag würde so aussehen:

The NFS share is mounted on the local filesystem, so there is no need to set PORTAGE_BINHOST or use the  option. Instead, follow the normal procedures for installing binary packages, remembering to point PKGDIR to the NFS share so that portage knows where to find the packages:

Verwendung von Binärpaketen
Damit Binärpakete auf anderen Systemen verwendet werden können, müssen sie einige Anforderungen erfüllen:


 * Die Client- und Server-Prozessorarchitektur und CHOST müssen übereinstimmen.
 * Die CFLAGS und CXXFLAGS Variablen, die zum Bau der Pakete verwendet werden, müssen mit allen Clients kompatibel sein.
 * USE-Flags für prozessorspezifische Befehlssatzmerkmale (wie MMX, SSE usw.) müssen sorgfältig ausgewählt werden; alle Clients müssen sie unterstützen.

The utility can be used to find a subset of CFLAGS that is supported by both the server and client(s). For example, the host might return:

While the client might return:

In this example CFLAGS could be set to  since   is a full subset of. and  are not included as these are not supported but the client. However,  is included as the client does not support. To find which 's are subsets of others, check the [//gcc.gnu.org/onlinedocs/gcc/x86-Options.html gcc manual], if there is no suitable subset set e.g..

Optionally, it is also possible to set  or   to tell gcc to tune code to a specific arch. In contrast to, the   argument does not prevent code from being executed on other processors. For example, to compile code which is compatible with ivybridge and up but is tuned to run best on skylake set CFLAGS to. When  is not set it defaults to whatever   is set to.

When changing  to a lower subset for using binary packages on a client, a full recompilation is required to make sure that all binaries are compatible with the client's processor, to save time packages that are not compiled with e.g. gcc/clang can be excluded:

Similarly, can be used to find a suitable subset of processor specific instruction set USE flags. For example, the host might return:

While the client might return:

In this example CPU_FLAGS_X86 can be set to  in  because these flags are supported by both the client and the host

Next to these, Portage will check if the binary package is built using the same USE flags as expected on the client. If a package is built with a different USE flag combination, Portage will either ignore the binary package (and use source-based build) or fail, depending on the options passed to the command upon invocation (see Installing binary packages).

On clients, a few configuration changes are needed in order for the binary packages to be used.

Installation von Binärpaketen
There are a few options that can be passed on to the command that inform Portage about using binary packages:

In order to automatically use binary package installations, the appropriate option can be added to the EMERGE_DEFAULT_OPTS variable:

There is a Portage feature that automatically implements the equivalent of   without the need for updating the EMERGE_DEFAULT_OPTS variable with the   value:

Verify binary package's OpenGPG signature
This feature is only available in GPKG format.

Portage will try to verify the binary package's signature whenever possible, but users must first set up trusted local keys. A GPG key management tool for portage is in the plan, but for now, users have to manage it manually.

The GPG database of portage is stored in by default.

The following script will create a local trusted master key, import key  from keys.openpgp.org, and trust it. Please modify it to a key trusted by the user.

Make sure is global readable, portage will drop root privileges when verifying binary packages.

By default, Portage will only verify GPG signatures when a signature file is found in a package, which allows the user to mix signed and unsigned GPKG binary packages from different sources, and allows to use of old XPAK format binary packages.

If the user needs to force signature verification, the  feature needs to be enabled. This feature assumes that all packages should be signed and rejects any unsigned package. Note that this feature does not support per binhost configuration.

Pakete von einem Binärpaket-Host abrufen
When using a binary package host, clients need to have the PORTAGE_BINHOST variable set in or the sync-uri variable in. The latter option is preferred over setting the PORTAGE_BINHOST. Without this configuration, the client will not know where the binary packages are stored which results in Portage being unable to retrieve them.

The PORTAGE_BINHOST variable uses a space-separated list of URIs. This allows administrators to use several binary package servers simultaneously. The URI must always point to the directory in which the file resides.

For each binhost, a name can be configured in the brackets. sync-uri must point to the directory in which the file resides. Optionally, priority can be set. When a package exists in multiple binary package repositories, the package is pulled from the binary package host with the highest priority. This way, a preferred binary package host can be set up.

Neuinstallation von modifizierten Binärpaketen
Passing the  option to  will reinstall every binary that has been rebuilt since the package was installed. This is useful in case rebuilding tools like are run on the binary package server.

A related option is. It causes emerge not to consider binary packages for a re-install if those binary packages have been built before the given time stamp. This is useful to avoid re-installing all packages, if the binary package server had to be rebuild from scratch but  is used otherwise.

Zusätzliche Client-Einstellungen
Next to the  feature, Portage also listens to the   feature. This one controls if log files for successful binary package installations should be kept. It is only relevant if the PORT_LOGDIR variable has been set and is enabled by default.

Similar to excluding binary packages for a certain set of packages or categories, clients can be configured to exclude binary package installations for a certain set of packages or categories.

To accomplish this, use the  option:

To enable such additional settings for each emerge command, add the options to the EMERGE_DEFAULT_OPTS variable in the file:

Pflege von Binärpaketen
Exporting and distributing the binary packages will lead to useless storage consumption if the binary package list is not actively maintained.

Entfernen von veralteten Binärpaketen
In the package an application called  is provided. It allows for maintaining Portage-related variable files, such as downloaded source code files, but also binary packages.

The following command will remove all binary packages that have no corresponding ebuild in the installed ebuild repositories:

For more details please read the article.

Another tool that can be used is the tool from the  package. However, this tool is a bit less configurable.

To clean up unused binary packages (in the sense of used by the server on which the binary packages are stored):

Pflege der Packages-Datei
Inside the packages directory exists a manifest file called. This file acts as a cache for the metadata of all binary packages in the packages directory. The file is updated whenever Portage adds a binary package to the directory. Similarly, updates it when it removes binary packages.

If for some reason binary packages are simply deleted or copied into the packages directory, or the file gets corrupted or deleted, then it must be recreated. This is done using command:

Building for other architectures
is a tool that will easily build cross compile toolchains to allow setting up a binary host for a different architecture, for example for a device like a from a more powerful desktop PC.

An installation guide for this package can be found at the page.

Build a cross compiler
Using crossdev with the following command can build a toolchain for the desired system:

For the rest of this section, the example target will be for a Raspberry Pi 4:

After this has built, a toolchain will have been created in, and will look like a bare bones Gentoo install where it is possible to edit settings as normal.

Basic setup
Removing the  flag from the USE line in  is generally recommended in a setup like this:

Profiles
List available profiles for the device by running:

Next, select the profile that best suits:

Build a single package
To build a single binary package for use on the device, use the following:

Build world file
To build every package in the world file, then the following command is needed:

Binary location
By default, all binary packages will be stored in, so this is the location needed to be selected when setting up a binary package host.

Creating snapshots of the packages directory
When deploying binary packages for a large number of client systems it might become worthwhile to create snapshots of the packages directory. The client systems then do not use the packages directory directly but use binary packages from the snapshot.

Snapshots can be created using the or  tool. It takes four arguments:


 * 1) A source directory (the path to the packages directory).
 * 2) A target directory (that must not exist).
 * 3) A URI.
 * 4) A binary package server directory.

The files from the package directory are copied to the target directory. A file is then created inside the binary package server directory (fourth argument) with the provided URI.

Client systems need to use an URI that points to the binary package server directory. From there they will be redirected to the URI that was given to. This URI has to refer to the target directory.

XPAK format
XPAK format binary packages created by Portage have the file name ending with. These files consist of two parts:


 * 1) A  archive containing the files that will be installed on the system.
 * 2) A  archive containing package metadata, the ebuild, and the environment file.

See for a description of the format.

In some tools exists that are able to split or create  and  files.

The following command will split the into a  and an  file:

The file can be examined using the  utility.

To list the contents:

The next command will extract a file called which contains the enabled USE flags for this package:

GPKG format
GPKG format binary packages created by Portage have the file name ending with. These files consist of four parts at least:


 * 1) A  empty file that used to identify the format.
 * 2) A  archive containing package metadata, the ebuild, and the environment file.
 * 3) A  archive containing the files that will be installed on the system.
 * 4) A  file containing all files checksum that will be used to check for file corruption.
 * 5) Multiple optional  files containing OpenGPG signature are used for integrity checking and trust management.

The format can be extracted by tar without the need for additional tools.

Das PKGDIR-Layout
The currently used format version 2 has the following layout:

The file is the major improvement (and also the trigger for Portage to know that the binary package directory uses version 2) over the first binary package directory layout (version 1). In version 1, all binary packages were also hosted inside a single directory (called ) and the category directories only had symbolic links to the binary packages inside the directory.

In portage-3.0.15 and later, FEATURES=binpkg-multi-instance is enabled by default:

Entpacken mit quickunpkg
Zoobab wrote a simple shell tool named quickunpkg to quickly unpack files.

External resources
quickpkg man page.