[ zurück ] [ Copyright Hinweis ] [ Inhalt ] [ weiter ]

Anleitung für zukünftige Debian-Maintainer
Kapitel 6 Andere Dateien unter debian/


Wie Sie sehen gibt es noch verschiedene weitere Dateien im "debian/"-Unterverzeichniss, von den die meisten mit der `.ex'-Endung versehen sind, was bedeutet, dass es sich um Beispiele handelt. Wenn Sie eines dieser Features unbedingt brauchen oder einfach so verwenden möchten, lesen Sie die entsprechende Dokumentation (Tip: Policy Manual), bennen Sie die Datei um (`.ex' entfernen) und passen Sie die rules-Datei an, soweit notwendig.. Einige dieser Dateien, die am meisten benutzten, werden in den follgenden Abschnitten beschrieben.


6.1 README.Debian

Alle zusätzlichen Details und nennenswerte Unterschiede zw. dem Original und ihrer "debianisierten" Version sollten hier dokumentiert werden. Dh_make erstellt uns eine Standardvorlage, die etwa so aussieht:

       gentoo for Debian
       ----------------------
     
       <possible notes regarding this package - if none, delete this file>
     
       Josip Rodin <jrodin@jagor.srce.hr>, Wed, 11 Nov 1998 21:02:14 +0100

Da wir nichts einzutragen haben, kann die Datei ruhig gelöscht werden.


6.2 conffiles

Eine der ärgerlichsten Sachen bei der Software ist es, wenn Sie richtig viel Zeit und Mühe in die Konfiguration eines Programms investieren, und schon das nächste Update ihre Konfigurationsdateien platt macht. Debian löst dieses Problem, in dem die Konfigurationsdateien markiert werden und der Administrator beim nächsten Paketupgrde gefragt wird, ob er seine Konfiguration behalten will oder nicht.

Zu markierende Konfigurationsdateien können Sie in die Datei "conffiles" eintragen, pro Zeile ein Dateiname mit dem vollständigen Pfad der Konfigurationsdatei (normallerweise in /etc/...)

Gentoo hat eine Konfigurationsdatei, "/etc/gentoorc", also werden wir diesen String in die `conffiles'-Datei eintragen. Wenn ihr Programm keine Konfigurationsdateien braucht, kann diese Datei natürlich verschwinden.


6.3 dirs

In dieser Datei werden Verzeichnisse festgelegt, die wir brauchen, die von der Installationsprozedur (hier: "make install") aber nicht automatisch erstellt werden. Die Vorlage sieht so aus:

       usr/bin
       usr/sbin

Beachten Sie, dass kein einleitender Schrägstrich dabei ist. Normallerweise würden wir das jetzt ins Folgende ändern:

       usr/X11R6/bin
       usr/X11R6/man/man1

Allerdings werden diese Verzeichnisse bereits durch das Makefile erstellt, wir brauchen die "dirs"-Datei also nicht und können sie ruhig löschen.


6.4 manpage.1.ex

Die Dateien mit der ".ex"-Erweiterung sind Beispiele dafür, wie man bestimmte Features in das Paket einbaut. Um diese zu verwenden, bearbeiten Sie die entsprechende Dateien und entfernen die " .ex"-Erweiterung. Wenn Sir die Funktion nicht brauchen, löschen Sie die Datei.

Ihr Programm sollte eine Manpage haben. Hat es keine, dann können Sie die erstellte Vorlage umbennen und mit dem eigenen Text füllen. In den Manpages von man(7) finden Sie weitere Hinweise zur Erstellung von Man-Seiten. Geben Sie der fertigen Datei auf jeden Fall den Namen des Programms mit der Endung der Zielkategorie dieser Manpage. Hier ist eine kurze Liste der Kategorien:

       Sektion |     Beschreibung     |     Anmerkungen
          1     Benutzerkomandos       Ausführbare Programme oder Skripte
          2     Systemaufrufe          Kernelfunktionen
          3     Bibliotheksaufrufe     Funktionen in System-Bibliotheken
          4     Spezielle Dateien      gewöhnlich in /dev
          5     Dateiformate und 
                Konventionen           z.B. das Format von /etc/passwd
          6     Spiele                 und ähnliche Programme
          7     Makropakete und 
                Konventionen           z.B. man(7), groff(7)
          8     Systemadministrations-
                befehle                in der Regel nur für root
          9     Kernelroutinen         [Nicht Standard]

Also bekommt unsere Manpage den Dateinamen gentoo.1, oder besser gentoo.1x, weil es ein X11-Programm ist. Im gentoo-Archiv gab es keine gentoo.1-Manpage, also habe ich eine geschrieben, mit Hilfe der Informationen aus dem Beispiel und aus der Doku des Upstream's.


6.5 menu.ex

Benutzer von "X Window System" haben normallerweise einen Fenstermanager mit konfigurierbaren Menüs, aus den die Programme gestartet werden. Wenn Sie Debian's "menu"-Paket installiert haben, wird eine Reihe Menüeinträge für die installierten Programme automatisch hinzugefügt. Dies ist von der Policy nicht vorgeschrieben, wird aber sicherlich von vielen Benutzern erwünscht. Wir können Gentoo in das Menüsystem eintragen, in dem wir die "menu"-Datei erstellen. Das Beispiel von dh_make sieht so aus:

       ?package(gentoo):needs=X11|text|vc|wm section=Apps/see-menu-manual\
         title="gentoo" command="/usr/bin/gentoo"

Das erste Feld (needs) bestimmt, welche Art der Benutzerschnittstelle das Programm braucht (z.B. Text oder X11). Das nächste ist das Menü/Untermenü (section), in dem der Eintrag später erscheinen soll. Die aktuelle Liste der Sektionen ist in: /usr/share/doc/debian-policy/menu-policy.html/ch2.html#s2.1 zu finden. Das dritte Feld (title) enthält die Bezeichnung des Programms. Das "icon"-Feld gibt die Icondatei an oder keinen Icon mit dem Eintrag "none". Und das letzte Feld ist das Kommando, das das Programm ausführt.

Die Menü-Datei verändern wir also zum folgenden:

       ?package(gentoo):needs=X11 section=Apps/Misc \
         title="Gentoo" command="/usr/X11R6/bin/gentoo"

Siehe menufile(5), update-menus(1) und /usr/share/doc/debian-policy/menu-policy.html/ für mehr Info über das Menüsystem.


6.6 watch.ex

Sie können diese Datei mit Programmen uscan(1) und uupdate(1) (aus dem devscripts-Paket) benutzen, um die Seite zu überwachen, von der Sie die Original-Quellen bezogen haben. Folgendes habe ich da eingetragen:

       # watch control file for uscan
       # Site		Directory	Pattern			Version	Script
       ftp.obsession.se	/gentoo		gentoo-(.*)\.tar\.gz	debian	uupdate

Hinweiss: wechseln Sie, wenn Sie die Datei mal erstellt haben, mit einer stehenden Internetverbindung in das Arbeitsverzeichniss und probieren Sie "uscan" auszuführen. Und RTFM.


6.7 ex.doc-base

Hat ihr Programm Dokumentation in HTML oder einem anderen Format (ausser Man- und Info-Seiten), so sollten die Datei `doc-base' benutzen, um diese zu registrieren, damit der Benutzer sie mit Programmen wie dhelp(1) oder dwww(1) einfacher finden kann.

So könnte Gentoo's doc-base-Datei dann aussehen.

       Document: gentoo
       Title: Gentoo Manual
       Author: Emil Brink
       Abstract: This manual describes what Gentoo is, and how it can be used.
       Section: Apps/Tools
     
       Format: HTML
       Index: /usr/share/doc/gentoo/html/index.html
       Files: /usr/share/doc/gentoo/html/*.html

Informationen über das Format dieser Datei finden Sie in install-docs(8) und der Anleitung von doc-base in /usr/doc/doc-base/doc-base.html/index.html.


6.8 postinst.ex, preinst.ex, postrm.ex, prerm.ex

Diese Dateien werden Maintainer-Skripte gennant, Skripte die im Kontrol-Bereich des Pakets ligen und von dpkg ausgeführt werden, und zwar wenn ihr Paket installiert, aktualisiert oder entfernt wird.

Vorerst sollten Sie aber von den Maintainer-Skripten die Finger lassen, weil die manuelle Bearbeitung schnell kompliziert werden kann. Mehr Informationen finden Sie im Packaging Manual, Sektion 6, und werfen Sie einen Blick auf die Beispiele von dh_make.

Nun sollten wir soweit sein, das Paket zu "bauen".


[ zurück ] [ Copyright Hinweis ] [ Inhalt ] [ weiter ]
Anleitung für zukünftige Debian-Maintainer
Version 1.0.2, 10. Juni 2001.
Josip Rodin jrodin@jagor.srce.hr
Übersetzer: Eduard Bloch edi@ka.linux.de