Vorbereitung¶

Um alle wichtigen Programme zum Paketbau herunterzuladen, kann einfach das Paket packaging-dev installiert ^[1] werden.

Für diese Einführung werden folgende Pakete mit ihren Abhängigkeiten benötigt:

• build-essential

• debhelper

• dh-make

• quilt

• devscripts

Befehl zum Installieren der Pakete:

sudo apt-get install build-essential debhelper dh-make quilt devscripts 

Oder mit apturl installieren, Link: apt://build-essential,debhelper,dh-make,quilt,devscripts

Herstellen einer Arbeitsumgebung¶

Bevor der eigentliche Paketbau eines Programmes beginnt, sollte zuerst eine Arbeitsumgebung eingerichtet werden. Die Arbeitsumgebung stellt in diesem Fall ein leeres Verzeichnis dar, welches ausschließlich zum Bauen dieses einen Debian-Paketes genutzt wird. Dazu wird ein Ordner erstellt, der wie das zu erstellende Programmpaket bezeichnet wird. Anschließend wird in des Verzeichnis gewechselt:

mkdir gnu-hello
cd gnu-hello 

Nun wird das Quellarchiv des Programmes heruntergeladen und entpackt:

wget http://ftp.gnu.org/gnu/hello/hello-2.7.tar.gz
tar -xvzf hello-2.7.tar.gz 

Erstellen der Debian-Dateien¶

Die Debian-Dateien, welche zum Paketieren nötig sind, werden nun mit dem Programm dh_make erstellt.

export DEBFULLNAME="VORNAME NACHNAME"
export DEBEMAIL="EMAIL@ADRESSE" 

Es wird nun in das Verzeichnis des entpackten Quellarchivs, also des Quellcodes, gewechselt:

cd hello-2.7/ 

Dort werden nun mit dh_make die Vorlagedateien angelegt.

dh_make -f ../hello-2.7.tar.gz 

Nach dem Ausführen des Befehls werden nun einige Fragen gestellt:

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

Es wird also gefragt, ob ein einzelnes Binär-Paket, ein architekturunabhängiges Paket, mehrere Binär-Pakete, eine Bibliothek, ein Kernelmodul oder ein Kernelpatch paketiert werden soll. Da es sich bei GNU hello um ein einzelnes Programm mit nur einer Binär-Datei handelt, wird die Frage mit dem Drücken der S -Taste beantwortet.

Abschließend werden einige Informationen zum Ersteller und dem Paket angezeigt:

Maintainer name : VORNAME NACHNAME
Email-Address   : EMAIL@ADRESSE
Date            : DATUM UHRZEIT +/-UTC-DIFFERENZ
Package Name    : PAKETNAME
Version         : PAKETVERSION
License         : LIZENZ
Type of Package : PAKETTYP
Hit <enter> to confirm:

Nach einer Bestätigung mit ⏎ werden die Steuerungsdateivorlagen unter debian/ erstellt und das Quellarchiv an die für das Quellformat nötige Stelle ../hello_2.7.orig.tar.gz kopiert.

Bearbeiten der Debian-Dateien¶

Nachdem die Steuerungsdaten nun im Unterordner debian/ erstellt wurden, liegen diese auf die Gesamtstrukutur bezogen unter gnu-hello/hello-2.7/debian. In diesen Ordner wird nun gewechselt:

cd debian/ 

Dort befinden sich einige Dateien und ein Ordner source/:

gnu-hello/hello-2.7/debian$ ls
changelog           emacsen-startup.ex  manpage.sgml.ex  README.Debian
compat              hello.cron.d.ex     manpage.xml.ex   README.source
control             hello.default.ex    menu.ex          rules
copyright           hello.doc-base.EX   postinst.ex      source
docs                info                postrm.ex        watch.ex
emacsen-install.ex  init.d.ex           preinst.ex
emacsen-remove.ex   manpage.1.ex        prerm.ex
gnu-hello/hello-2.7/debian$ dir source/
format

Die Dateien werden in zwei Klassen unterteilt: Optionale Dateien, die nur unter bestimmten Umständen nötig sind, sie besitzen die Endung .ex bzw. .EX. Die übrigen Dateien sind idR. zwingend erforderlich, um ein Quellpaket erstellen zu können.

Bei den meisten Programmen wird ein Großteil der optionalen Dateien nicht benötigt. Eine kurze Übersicht erfolgt unter Weitere (optionale) Konfigurationsdateien. Eine ausführlichere Erklärung und Hinweise zur Benutzung finden sich unter Kapitel 5. Andere Dateien im Verzeichnis debian 🇩🇪 🇬🇧 des Leitfadens für neue Debian-Betreuer 🇩🇪 🇬🇧 oder auf der entsprechenden Manpage der debhelper-Skripte.

Für dieses Beispiel werden alle nicht benötigten Dateien gelöscht:

rm *.ex *.EX README.Debian README.source 

Danach sollten nur noch diese Dateien übrig bleiben:

gnu-hello/hello-2.7/debian$ dir
changelog  compat  control  copyright  docs  info  rules  source

Die wichtigen Dateien, die mit einem Texteditor ^[3] generell angepasst werden müssen, sind: changelog, compat, control, copyright, rules und source/format, wobei meist die Standardvorgabe von compat und source/format ausreicht. Des Weiteren ist bei vielen Programmen das Makefile im Quellcode ebenfalls ausreichend, sodass das Debian-Makefile in der Datei rules nicht weiter angepasst werden muss.

Eine umfangreiche Erklärung zu diesen Dateien findet sich in Kapitel 4. Benötigte Dateien im Verzeichnis debian 🇩🇪 🇬🇧 im Leitfaden für neue Debian-Betreuer 🇩🇪 🇬🇧.

1
2
3
4
5

hello (2.7-1) unstable; urgency=low

  * Initial release (Closes: #nnnn)  <nnnn is the bug number of your ITP>

 -- VORNAME NACHNAME <EMAIL@ADRESSE>  DATUM UHRZEIT +/-UTC-DIFFERENZ

1
2
3
4
5

hello (1:2.7-1~0ubuntu1) precise; urgency=low

  * Erster Paketbau.

 -- VORNAME NACHNAME <EMAIL@ADRESSE>  DATUM UHRZEIT +/-UTC-DIFFERENZ

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

Source: hello
Section: unknown
Priority: extra
Maintainer: VORNAME NACHNAME <EMAIL@ADRESSE>
Build-Depends: debhelper (>= 8.0.0), autotools-dev
Standards-Version: 3.9.5
Homepage: <insert the upstream URL, if relevant>
#Vcs-Git: git://git.debian.org/collab-maint/hello.git
#Vcs-Browser: http://git.debian.org/?p=collab-maint/hello.git;a=summary

Package: hello
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: <insert up to 60 chars description>
 <insert long description, indented with spaces>

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

Source: hello
Section: misc
Priority: optional
Maintainer: VORNAME NACHNAME <EMAIL@ADRESSE>
Build-Depends: debhelper (>= 8.0.0), autotools-dev
Standards-Version: 3.9.5

Package: hello
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: The classic greeting and a package build example
 The GNU hello program produces a familiar, friendly greeting.  It
 allows non-programmers to use a classic computer science tool which
 would otherwise be unavailable to them.
 .
 Seriously, though: this is an example of how to do a Debian package.
 It is the Debian version of the GNU Project's `hello world' program
 (which is itself an example for the GNU Project).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

Format: http://dep.debian.net/deps/dep5
Upstream-Name: hello
Source: <url://example.com>

Files: *
Copyright: <years> <put author's name and email here>
           <years> <likewise for another author>
License: <special license>
 <Put the license of the package here indented by 1 space>
 <This follows the format of Description: lines in control file>
 .
 <Including paragraphs>

# If you want to use GPL v2 or later for the /debian/* files use 
# the following clauses, or change it to suit. Delete these two lines
Files: debian/*
Copyright: JAHR VORNAME NACHNAME <EMAIL@ADRESSE>
License: GPL-2+
 This package is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.
 .
 This package is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 .
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>
 .
 On Debian systems, the complete text of the GNU General
 Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".

# Please also look if there are files or directories which have a
# different copyright/license attached and list them here.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: hello
Source: http://ftp.gnu.org/gnu/hello/hello-2.7.tar.gz

Files: *
Copyright: 1992-2011 Free Software Foundation, Inc.
License: GPL-3+

Files: debian/*
Copyright: JAHR VORNAME NACHNAME <EMAIL@ADRESSE>
License: GPL-3+

License: GPL-3+
 This package is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.
 .
 This package is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 .
 You should have received a copy of the GNU General Public License
 along with this program. If not, see <http://www.gnu.org/licenses/>
 .
 On Debian systems, the complete text of the GNU General
 Public License version 3 can be found in "/usr/share/common-licenses/GPL-3".

1
2
3

#!/usr/bin/make -f
%:
	dh $@

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

#!/usr/bin/make -f
# -*- makefile -*-
# Sample debian/rules that uses debhelper.
# This file was originally written by Joey Hess and Craig Small.
# As a special exception, when this file is copied by dh-make into a
# dh-make output file, you may use that output file without restriction.
# This special exception was added by Craig Small in version 0.37 of dh-make.

# Uncomment this to turn on verbose mode.
#export DH_VERBOSE=1

%:
	dh $@

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

#!/usr/bin/make -f

clean:
	dh_testdir
	dh_auto_clean
	dh_clean

build:
	dh_testdir
	dh_auto_configure
	dh_auto_build
	dh_auto_test

build-arch:
	dh_testdir -a
	dh_auto_configure -a
	dh_auto_build -a
	dh_auto_test -a

build-indep:
	dh_testdir -i
	dh_auto_configure -i
	dh_auto_build -i
	dh_auto_test -i

install: build
	dh_testroot
	dh_prep
	dh_installdirs
	dh_auto_install
	dh_install
	dh_installdocs
	dh_installchangelogs
	dh_installexamples
	dh_installman
	dh_installcatalogs
	dh_installcron
	dh_installdebconf
	dh_installemacsen
	dh_installifupdown
	dh_installinfo
	dh_installinit
	dh_installmenu
	dh_installmime
	dh_installmodules
	dh_installlogcheck
	dh_installlogrotate
	dh_installpam
	dh_installppp
	dh_installudev
	dh_installwm
	dh_installxfonts
	dh_installgsettings
	dh_bugfiles
	dh_ucf
	dh_lintian
	dh_gconf
	dh_icons
	dh_perl
	dh_usrlocal
	dh_link
	dh_compress
	dh_fixperms

install-arch: build-arch
	dh_testroot -a
	dh_prep -a
	dh_installdirs -a
	dh_auto_install -a
	dh_install -a
	dh_installdocs -a
	dh_installchangelogs -a
	dh_installexamples -a
	dh_installman -a
	dh_installcatalogs -a
	dh_installcron -a
	dh_installdebconf -a
	dh_installemacsen -a
	dh_installifupdown -a
	dh_installinfo -a
	dh_installinit -a
	dh_installmenu -a
	dh_installmime -a
	dh_installmodules -a
	dh_installlogcheck -a -a
	dh_installlogrotate -a
	dh_installpam -a
	dh_installppp -a
	dh_installudev -a
	dh_installwm -a
	dh_installxfonts -a
	dh_installgsettings -a
	dh_bugfiles -a
	dh_ucf -a
	dh_lintian -a
	dh_gconf -a
	dh_icons -a
	dh_perl -a
	dh_usrlocal -a
	dh_link -a
	dh_compress -a
	dh_fixperms -a

install-indep: build-indep
	dh_testroot -i
	dh_prep -i
	dh_installdirs -i
	dh_auto_install -i
	dh_install -i
	dh_installdocs -i
	dh_installchangelogs -i
	dh_installexamples -i
	dh_installman -i
	dh_installcatalogs -i
	dh_installcron -i
	dh_installdebconf -i
	dh_installemacsen -i
	dh_installifupdown -i
	dh_installinfo -i
	dh_installinit -i
	dh_installmenu -i
	dh_installmime -i
	dh_installmodules -i
	dh_installlogcheck -a -i
	dh_installlogrotate -i
	dh_installpam -i
	dh_installppp -i
	dh_installudev -i
	dh_installwm -i
	dh_installxfonts -i
	dh_installgsettings -i
	dh_bugfiles -i
	dh_ucf -i
	dh_lintian -i
	dh_gconf -i
	dh_icons -i
	dh_perl -i
	dh_usrlocal -i
	dh_link -i
	dh_compress -i
	dh_fixperms -i

binary: install
	dh_strip
	dh_makeshlibs
	dh_shlibdeps
	dh_installdeb
	dh_gencontrol
	dh_md5sums
	dh_builddeb

binary-arch: install-arch
	dh_strip -a
	dh_makeshlibs -a
	dh_shlibdeps -a
	dh_installdeb -a
	dh_gencontrol -a
	dh_md5sums -a
	dh_builddeb -a

binary-indep: install-indep
	dh_installdeb -i
	dh_gencontrol -i
	dh_md5sums -i
	dh_builddeb -i

.PHONY: binary binary-arch binary-indep install install-arch install-indep build build-arch build-indep clean

dh_auto_clean 

make distclean 

dh_auto_configure 

./configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var 

dh_auto_build 

make 

dh_auto_test 

make test 

dh_auto_install 

make install DESTDIR=/PFAD/ZU/PAKET_VERSION/debian/PAKET 

1
2
3
4
5
6
7

#!/usr/bin/make -f
%:
	dh $@

override_dh_auto_clean:
	dh_auto_clean
	rm -f junk

1
2
3

#!/usr/bin/make -f
%:
	dh $@ --buildsystem=qmake_qt4

dh_auto_build -l 

1

3.0 (quilt)

Erstellung eines Menüeintrages¶

Wie ein Icon im GNOME-, KDE-, Xfce-Menü für die Anwendung im erstellten Debian-Paket erscheint, ist im Artikel: Grundlagen der Paketerstellung/Menüeintrag beschrieben.

Für das Beispiel GNU hello ist dies nicht unbedingt notwendig, da es sich hierbei um ein reines Kommandozeilenprogramm handelt.

Patchen¶

Im Folgenden wird beschrieben, einen Patch mit quilt am Beispiel GNU hello zu erstellen.

Damit das Paket am Ende so "sauber" wie möglich ist, dh. keine Policy-Verletzungen oder Programmfehler aufweist, muss das Paket gepatcht werden, sofern diese Änderungen nicht vom Ursprung des Quellcodes (Upstream) geändert werden.

Wird folgender Patch von Santiago Vila nicht angewandt, tritt eine Richtlinenverletzung auf, da durch das Makefile relativ zur Quellcodewurzel unter doc/Makefile eine Datei /usr/share/info/dir.gz angelegt wird. Diese soll aber automatisch während der Installation angelegt werden.

Also ist das Makefile zu bearbeiten. Das Arbeitsverzeichnis sollte nun eine Ebene über dem debian/-Verzeichnis, also das Quellcodeverzeichnis selbst sein (der Prompt sieht in etwa wie gnu-hello/hello-2.7 $ aus).

Die aktuelle Version von quilt (Ubuntu 15.10) legt den Ordner Patches nicht unter debian/patches an sondern im Source-Verzeichnis. Da dies aber bei der Verwendung von dpkg-buildpackage (siehe unten) zusätzliche Konfigurationen nach sich ziehen würde, wird stattdessen eine Alias-Befehl mit zusätzlichen Optionen angelegt, die den Standard-Pfad wieder korrekt setzten. Da die Option vielleicht nicht dauerhaft das Verhalten von quilt beeinflussen soll, wird der alias "uquilt" gewählt.

1. Editieren der Datei ~/.bashrc mit einem Editor dabei sind die folgenden Zeile einzufügen:

alias uquilt="quilt --quiltrc=${HOME}/.quiltrc-dpkg"
complete -F _quilt_completion $_quilt_complete_opt uquilt 

Diese Option legt fest, dass uquilt die Konfigurationen aus ~/.quiltrc-dpkg verwendet.

2. Mit einem Editor die Datei ~/.quiltrc-dpkg anlegen und folgenden Inhalt einfügen:

d=. ; while [ ! -d $d/debian -a `readlink -e $d` != / ]; do d=$d/..; done
if [ -d $d/debian ] && [ -z $QUILT_PATCHES ]; then
    # falls in Debian-Paketbaum mit ungesetztem $QUILT_PATCHES
    QUILT_PATCHES="debian/patches"
    QUILT_PATCH_OPTS="--reject-format=unified"
    QUILT_DIFF_ARGS="-p ab --no-timestamps --no-index --color=auto"
    QUILT_REFRESH_ARGS="-p ab --no-timestamps --no-index"
    if ! [ -d $d/debian/patches ]; then mkdir $d/debian/patches; fi
fi

Nun wird, sofern der Ordner debian existiert, der Ordner patches dort angelegt.

Um quilt den Namen des neuen Patches mitzuteilen, wird folgender Befehl verwendet:

uquilt new 01-no-usr-share-info-dir-gz 

Anschließend wird die Datei doc/Makefile.in als Vorlagedatei des fehlerhaften Makefiles als zu bearbeitende Datei hinzugefügt:

uquilt add doc/Makefile.in 

Nun wurde eine Kopie der Datei unter .pc/01-no-usr-share-info-dir-gz/doc/Makefile.in angelegt (Sicherungskopie). Die Datei doc/Makefile.in kann nun bearbeitet werden ohne dass der Inhalt der ursprünglichen Datei verlorgen geht.

Nach den Änderungen an der Datei kann der Patch so gespeichert werden:

uquilt refresh 

Übernommen werden kann der Patch mit:

uquilt push -a 

Damit wird das Makefile auf den ursprünglichen Stand zurückversetzt und die Änderung nur im Patch gespeichert. Die Vorbereitung zur Paketierung wurde für das Beispiel GNU hello abgeschlossen und es kann nun ein Binärpaket erstellt werden.

quilt new PATCHNAME 

quilt add DATEI 

quilt refresh 

quilt applied 

quilt push 

quilt pop 

quilt unapplied 

quilt rename PATCHNAME 

quilt delete 

quilt header 

Erstellung des Quellpaketes¶

Im Quellcodeverzeichnis wird folgender Befehl zum Bau des Quellpakets angewandt:

dpkg-buildpackage -S -us -uc 

Dabei wird automatisch (sofern installiert) fakeroot verwendet, um Rootrechte vorzutäuschen. Die Optionen -us und -uc überspringen die Schritte des (automatischen) Signierens ^[4] der Quellkontrolldatei (Endung .dsc) und der Debian-Steuerdatei zum Hochladen (Endung .changes). Ist man im Besitz eines gnupg-Schlüssels, sollten diese beiden Optionen nicht genutzt werden, sodass eine Signierung erfolgt.

Im übergeordneten Verzeichnis wurden nun beide Quelldateien, sowie bei einem nicht-nativen Quellformat ein Archiv mit den Debian-Änderungen angelegt. Die Datei der Endung sources.changes kann nun lokal mit pbuilder-dist für den Bauprozess von Binär-Debian-Paketen verwendet werden. Alternativ kann diese, sofern sie signiert wurde, zum Hochladen in ein Launchpad/PPA genutzt werden.

Überprüfen des Paketes¶

Die verschiedenen Paketdateien sollten mit lintian überprüft werden. Dieses Programm dient dazu, bekannte Richtlinenverstöße und typische Rechtschreibfehler anzuzeigen. Damit kann das Paket vor seiner Veröffentlichung auf vermeidbare Fehler geprüft werden.

Folgender Befehl ruft lintian mit umfangreichsten Prüfungen auf:

lintian -EvI --pedantic --show-overrides --color=auto PAKET_VERSION_source.changes 

Sollen zusätzlich hilfreiche Informationen zu den bemängelten Fehlern angegeben werden, kann die Option -i genutzt werden. Die Optionen können auch in der systemweiten Konfigurationsdatei unter /etc/lintianrc, bzw. im Benutzerverzeichnis unter ~/.lintianrc gepspeichert werden.

Erstellung des Binärpaketes¶

Ähnlich wie beim Quellpaket wird dazu das Perlskript dpkg-buildpackage genutzt:

dpkg-buildpackage -us -uc 

Die Optionen -us und -uc sind analog wie beim Quellpaket ggfs. zu entfernen. Falls die Bauabhängigkeiten nicht installiert sind, kann mit der Option -d der Bau dennoch ermöglicht werden.

Dabei werden folgende Schritte nach dem Säubern von ungewollten Umgebungsvariablen, sowie dem Überprüfen nach denen in der control-Datei festgeleten Abhängigkeiten zum Paketbau durchgeführt (ohne Signieren der Quellkontroll- und Steuerungsdatei mittels gpg ^[4]):

debian/rules clean
cd .. && dpkg-source -b QUELLVERZEICHNIS/ && cd -
debian/rules build
fakeroot debian/rules binary
dpkg-genchanges >../PAKET_VERSION_ARCHITEKTUR.changes
cd .. && dpkg-source --after-build QUELLVERZEICHNIS/ && cd - 

fakeroot debian/rules binary 

export DEB_BUILD_OPTIONS="parallel=6" 

dpkg-buildpackage -j6 

Links¶

Intern¶

• Optionale Konfigurationsdateien

• Paketbau

• Versionsnummern von Ubuntu-Paketen

• dpkg-buildpackage

• Metapakete erstellen

• Open Build Service - Dienst zur Paketerstellung und -verwaltung

Extern¶

• Ubuntu Packaging Guide 🇬🇧

• Debian Packaging Guide 🇬🇧 🇩🇪

  • Änderungen am Quellcode durchführen (patchen) 🇩🇪

• Packaging Guide im deutschen Debiananwenderbuch 🇩🇪

• DebSrc3.0 🇬🇧 - Informationen zur Umstellung auf das Paketformat 3.0

• Machine-readable debian/copyright file 🇬🇧 - Deb5 copyright-Format-Spezifikationen

• GNU make manual 🇬🇧