15.2. Ihr erstes Paket erstellen

15.2.1. Meta-Pakete oder vorgetäuschte Pakete

Vorgetäuschte Pakete und Meta-Pakete sind insofern ähnlich, als sie leere Hüllen sind, die nur um des Effektes willen existieren, den ihre Meta-Daten auf den Paketverarbeitungsstapel haben.

Der Zweck eines vorgetäuschten Pakets ist es, dpkg und apt glauben zu machen, dass ein bestimmtes Paket installiert ist, obwohl es nur aus einer leeren Hülle besteht. So können Abhängigkeiten von einem Paket erfüllt werden, wenn das dazugehörige Programm außerhalb des Geltungsbereichs des Paketsystems installiert wurde. Obwohl diese Methode funktioniert, sollte sie möglichst vermieden werden, da sie keine Garantie bietet, dass sich das manuell installierte Programm genauso verhält wie das entsprechende Paket, und andere Pakete, die von ihm abhängen, würden nicht ordnungsgemäß funktionieren.

Ein Meta-Paket besteht dagegen vor allem aus einer Ansammlung von Abhängigkeiten, so dass das Installieren eines Meta-Pakets im Endeffekt in einem Schritt eine Reihe weiterer Pakete mit sich bringt.

Diese beiden Paketarten können mit den Befehlen equivs-control und equivs-build erstellt werden (in dem Paket equivs). Der Befehl equivs-control datei erstellt eine Debian-Header-Datei, die so editiert werden sollte, dass sie den Namen des erwarteten Pakets, seine Versionsnummer, den Namen des Betreuers, seine Abhängigkeiten und eine Beschreibung enthält. Andere Zeilen ohne einen vorgegebenen Wert sind optional und können gelöscht werden. Die Zeilen Copyright, Changelog, Readme und Extra-Files sind in Debian-Paketen keine Standardzeilen; sie machen nur bei equivs-build Sinn und bleiben nicht in den Kopfzeilen des erstellten Pakets erhalten.

Beispiel 15.2. Header-Datei des vorgetäuschten Pakets libxml-libxml-perl

Section: perl
Priority: optional
Standards-Version: 3.8.4

Package: libxml-libxml-perl
Version: 1.57-1
Maintainer: Raphael Hertzog <hertzog@debian.org>
Depends: libxml2 (>= 2.6.6)
Architecture: all
Description: Fake package - module manually installed in site_perl
 This is a fake package to let the packaging system
 believe that this Debian package is installed. 
 .
 In fact, the package is not installed since a newer version
 of the module has been manually compiled & installed in the
 site_perl directory.

Der nächste Schritt besteht darin, das Debian-Paket mit dem Befehl equivs-build datei zu erstellen. Voilà: das Paket wurde im aktuellen Verzeichnis erstellt und kann wie jedes andere Debian-Paket behandelt werden.

15.2.2. Einfaches Dateiarchiv

Die Falcot-Corp.-Administratoren müssen ein Debian-Paket erstellen, um die Bereitstellung einer Reihe von Dokumenten auf einer großen Anzahl von Rechnern zu erleichtern. Der für diese Aufgabe zuständige Administrator liest zunächst den „Leitfaden für neue Debian-Betreuer“ und beginnt dann, an seinem ersten Paket zu arbeiten.

→ http://www.debian.org/doc/maint-guide/

Der erste Schritt besteht darin, ein Verzeichnis namens falcot-data-1.0 zu erstellen, um das Ziel-Quellpaket aufzunehmen. Das Paket wird logischerweise falcot-data heißen und die Versionsnummer 1.0 tragen. Der Administrator legt die Dokumentdateien dann in einem Unterverzeichnis namens data ab. Anschließend ruft er den Befehl dh_make auf (aus dem Paket dh-make), um Dateien hinzuzufügen, die für den Paketerstellungsprozess benötigt werden, und die alle in einem Unterverzeichnis namens debian abgespeichert werden:

$ cd falcot-data-1.0
$ dh_make --native

Type of package: single binary, indep binary, multiple binary, library, kernel module, kernel patch or cdbs?
 [s/i/m/l/k/n/b] i

Maintainer name : Raphael Hertzog
Email-Address   : hertzog@debian.org
Date            : Mon, 11 Apr 2011 15:11:36 +0200
Package Name    : falcot-data
Version         : 1.0
License         : blank
Usind dpatch    : no
Type of Package : Independent
Hit <enter> to confirm:
Currently there is no top level Makefile. This may require additional tuning.
Done. Please edit the files in the debian/ subdirectory now. You should also
check that the falcot-data Makefiles install into $DESTDIR and not in / .
$

Der ausgewählte Paket-Typ (single binary) zeigt an, dass dieses Quellpaket ein einzelnes Binärpaket in Abhängigkeit von der Architektur (Architecture: any) erzeugen wird. indep binary fungiert als Pendant und führt zu einem einzelnen Binärpaket, das von der Zielarchitektur unabhängig ist (Architecture: all). In diesem Fall ist der zweite Punkt relevanter, da das Paket nur Dokumente und keine binären Programme enthält, so dass es in ähnlicher Weise auf Rechnern aller Architekturen verwendet werden kann.

Der Typ multiple binary bezieht sich auf ein Quellpaket, das zu mehreren Binärpaketen führen wird. library ist ein Sonderfall und für dynamische Bibliotheken nützlich, da diese strengen Erstellungsregeln folgen müssen. In ähnlicher Weise sollte kernel module auf Pakete beschränkt bleiben, die Kernel-Module enthalten. cdbs ist schließlich ein besonderes Paketerstellungssystem; es ist recht flexibel, erfordert jedoch einigen Lernaufwand.

TIPP Name und E-Mail-Adresse des Betreuers

Die meisten der an der Paketbetreuung beteiligten Programme werden in den Umgebungsvariablen DEBFULLNAME und DEBEMAIL oder EMAIL nach Ihrem Namen und Ihrer E-Mail-Adresse Ausschau halten. Sie können es vermeiden, sie viele Male einzugeben, indem Sie sie ein für alle Mal festlegen. Falls Ihre übliche Konsole bash ist, genügt es, die folgenden zwei Zeilen zu den Dateien ~/.bashrc und ~/.bash_profile hinzuzufügen (Sie werden selbstverständlich die angegebenen Werte durch die zutreffenden ersetzen!):

export EMAIL="hertzog@debian.org"
export DEBFULLNAME="Raphael Hertzog"

Der Befehl dh_make erzeugt ein Unterverzeichnis namens debian mit zahlreichen Dateien. Einige von ihnen sind zwingend notwendig, insbesondere rules, control, changelog und copyright. Dateien mit der Erweiterung .ex sind Beispieldateien, die verwendet werden können, indem man sie bei Bedarf abändert (und die Erweiterung entfernt). Wenn sie nicht benötigt werden, ist es empfehlenswert, sie zu entfernen. Die Datei compat sollte erhalten bleiben, da sie für das ordnungsgemäße Funktionieren der Programmgarnitur debhelper (alle Dateien, die mit dem Präfix dh_ beginnen) erforderlich ist, die in verschiedenen Stadien des Paketerstellungsprozesses verwendet wird.

Die Datei copyright muss Informationen zu den Verfassern der in dem Paket aufgenommenen Dokumente und zu der zugehörigen Lizenz enthalten. In unserem Fall handelt es sich um interne Dokumente, und ihr Gebrauch beschränkt sich auf das Unternehmen Falcot Corp. Die standardmäßige changelog-Datei passt weitgehend. Es genügt, das „Initial release“ durch eine ausführlichere Erläuterung zu ersetzen und die Distribution von unstable nach internal zu ändern. Die Datei control file wurde ebenfalls aktualisiert: der Abschnitt wurde in misc umbenannt und die Felder Homepage, Vcs-Git und Vcs-Browser wurden entfernt. Das Feld Depends wurde um iceweasel | www-browser ergänzt, um die Verfügbarkeit eines Web-Browsers, der die in dem Paket enthaltenen Dokumente darstellen kann, sicherzustellen.

Beispiel 15.3. The Datei control

Source: falcot-data
Section: misc
Priority: optional
Maintainer: Raphael Hertzog <hertzog@debian.org>
Build-Depends: debhelper (>= 7.0.50~)
Standards-Version: 3.8.4

Package: falcot-data
Architecture: all
Depends: iceweasel | www-browser, ${misc:Depends}
Description: Internal Falcot Corp Documentation
 This package provides several documents describing the internal
 structure at Falcot Corp.  This includes:
  - organization diagram
  - contacts for each department.
 .
 These documents MUST NOT leave the company.
 Their use is INTERNAL ONLY.

Beispiel 15.4. Die Datei changelog

falcot-data (1.0) internal; urgency=low

  * Initial Release.
  * Let's start with few documents:
    - internal company structure;
    - contacts for each department.

 -- Raphael Hertzog <hertzog@debian.org>  Mon, 11 Apr 2011 20:46:33 +0200

Beispiel 15.5. Die Datei copyright

This work was packaged for Debian by Raphael Hertzog <hertzog@debian.org>
on Mon, 11 Apr 2011 20:46:33 +0200

Copyright:

    Copyright (C) 2004-2011 Falcot Corp

License:

    All rights reserved.

ZURÜCK ZU DEN GRUNDLAGEN Die Datei Makefile

Eine Makefile-Datei ist ein Skript, das vom Programm make benutzt wird; es beschreibt Regeln, wie ein Satz von Dateien aufeinander aufbauend in einem Abhängigkeitsbaum zu erstellen ist (zum Beispiel kann ein Programm aus einem Satz von Quelldateien erstellt werden). Die Datei Makefile beschreibt diese Regeln in folgendem Format:

target: source1 source2
        command1
        command2

Eine derartige Regel ist folgendermaßen zu interpretieren: Falls eine der Dateien in source* jünger ist als die Datei target, dann muss das Ziel unter Verwendung von command1 und command2 erstellt werden.

Man beachte, dass die Befehlszeilen mit einem Tabulatorzeichen beginnen müssen; und beachten Sie auch, dass, wenn eine Zeile mit einem Gedankenstrich beginnt (-), ein Scheitern dieses Befehls den gesamten Prozess nicht unterbricht.

Die Datei rules enthält normalerweise einen Satz von Regeln, die verwendet werden, um das Programm zu konfigurieren, zu erstellen und in ein speziell dafür vorgesehenes Unterverzeichnis (das nach dem erstellten Binärpaket benannt ist) zu installieren. Der Inhalt dieses Unterverzeichnisses wird dann innerhalb des Debian-Pakets archiviert, als wäre es das Wurzelverzeichnis des Dateisystems. In unserem Fall werden die Dateien in dem Unterverzeichnis debian/falcot-data/usr/share/falcot-data/ installiert, so dass die Dateien beim Installieren des erstellten Pakets unter /usr/share/falcot-data/ eingerichtet werden. Die Datei rules wird als Makefile mit einigen Standardzielen benutzt (einschließlich clean und binary, die verwendet werden, um das Quellverzeichnis aufzuräumen beziehungsweise das Binärpaket zu erstellen).

Obwohl diese Datei im Zentrum des Prozesses steht, enthält sie in zunehmendem Maße nur das absolute Minimum zur Ausführung eines Standardbefehlssatzes, der vom Hilfsprogramm debhelper bereitgestellt wird. Dies ist für durch dh_make erzeugte Dateien der Fall. Um unsere Dateien zu installieren, konfigurieren wir einfach das Verhalten des Befehls dh_install, indem wir die folgende debian/falcot-data.install-Datei erstellen:

data/* usr/share/falcot-data/

Jetzt kann das Paket erstellt werden. Wir werden jedoch eine Spur Farbe hinzufügen. Da die Administratoren möchten, dass über die Hilfemenüs der grafischen Arbeitsumgebungen leicht auf die Dokumente zugegriffen werden kann, erstellen wir einen Eintrag im Debian-Menüsystem. Dies geschieht einfach dadurch, dass wir die Datei debian/menu.ex umbenennen, indem wir ihre Erweiterung entfernen, und sie dann wie folgt editieren:

Beispiel 15.6. Die Datei menu

?package(falcot-data):needs=X11|wm section=Help\
  title="Internal Falcot Corp Documentation" \
  command="/usr/bin/x-www-browser /usr/share/falcot-data/index.html"
?package(falcot-data):needs=text section=Help\
  title="Internal Falcot Corp Documentation" \
  command="/usr/bin/www-browser /usr/share/falcot-data/index.html"

Wenn das Feld needs auf X11|wm eingestellt ist, bedeutet dies, dass dieser Eintrag nur in einer grafischen Schnittstelle sinnvoll ist. Er wird daher nur in die Menüs der grafischen (X11-)Anwendungen und Fenstermanager (daher das wm) integriert werden. Das Feld section gibt an, an welcher Stelle des Menüs der Eintrag angezeigt werden soll. In unserem Fall wird der Eintrag sich im Hilfemenü befinden. Das Feld title enthält den Text, der im Menü angezeigt wird. Schließlich bezeichnet das Feld command den Befehl, der auszuführen ist, wenn der Benutzer den Menüeintrag auswählt.

Der zweite Eintrag entspricht dem ersten mit leichten Abwandlungen, die für den Textmodus der Linux-Konsole geeignet sind.

Um das Menü im Paket zu aktivieren, genügt es, einfach die Datei debian/menu zu erstellen, da der Befehl dh_installmenu während des Paketerstellungsprozesses von dh automatisch aufgerufen wird.

Unser Quellpaket ist nun fertig. Wir müssen nur noch mit derselben Methode, die wir zuvor für die Wiederherstellung von Paketen benutzt haben, das Binärpaket erzeugen: wir führen im Verzeichnis falcot-data-1.0 den Befehl dpkg-buildpackage -us -uc aus.