Difference between revisions of "Creating packages (Italiano)"

From ArchWiki
Jump to: navigation, search
Line 14: Line 14:
 
Tutte le informazioni per creare un pacchetto sono situate in un file <code>PKGBUILD</code>. Quando si lancia <code>makepkg</code>, esso cercherà un file <code>PKGBUILD</code> nella directory in cui ci si trova e compilerà i sorgenti del software secondo le istruzioni contenute nel file <code>PKGBUILD</code>. Una volta terminata con successo la compilazione, i binari risultanti, insieme a tutti i meta-dati disponibili quali versione e dipendenze, sono immagazzinati nel pacchetto <code>nome.pkg.tar.gz</code> che può essere installato con il comando <code>pacman -Up <nome pacchetto></code>.
 
Tutte le informazioni per creare un pacchetto sono situate in un file <code>PKGBUILD</code>. Quando si lancia <code>makepkg</code>, esso cercherà un file <code>PKGBUILD</code> nella directory in cui ci si trova e compilerà i sorgenti del software secondo le istruzioni contenute nel file <code>PKGBUILD</code>. Una volta terminata con successo la compilazione, i binari risultanti, insieme a tutti i meta-dati disponibili quali versione e dipendenze, sono immagazzinati nel pacchetto <code>nome.pkg.tar.gz</code> che può essere installato con il comando <code>pacman -Up <nome pacchetto></code>.
  
Il file <code>PKGBUILD</code> contiene '''tutte''' le istruzioni per creare il pacchetto, in una forma direttamente interpretabile da bash "(don't worry if that little tidbit of clue doesn't help you)" (non c'è da preoccuparsi se questo non vi dice nulla). Le variabili qui usate sono descritte nell'articolo [[ABS_-_Il_Sistema_Di_Compilazione_di_Arch_(Italiano) | ABS]], ma le più importanti e quelle che creano più confusione sono comunque ricapitolate qui. Per iniziare con un nuovo pacchetto, si deve prima di tutto creare una directory vuota, preferibilmente di nome <code>/var/abs/local/<PKGNAME></code>. In questo modo è naturalmente integrata nell'ABS-tree, ma non toccata dal cvsup quando si sincronizzi l'albero. Si deve quindi entrare in questa directory e creare un file <code>PKGBUILD</code> su cui lavorare, copiando il prototipo d'esempio da <code>/usr/share/pacman/PKGBUILD.proto</code> alla directory di lavoro, o copiando il <code>PKGBUILD</code> da un altro pacchetto. Quest'ultima scelta è molto utile se si vuole soltanto modificare le opzioni di compilazione di un pacchetto invece di crearne uno completamente nuovo.
+
Il file <code>PKGBUILD</code> contiene '''tutte''' le istruzioni per creare il pacchetto, in una forma direttamente interpretabile da bash (non c'è da preoccuparsi se questa breve indicazione non è d'aiuto). Le variabili qui usate sono descritte nell'articolo [[ABS_-_Il_Sistema_Di_Compilazione_di_Arch_(Italiano) | ABS]], ma le più importanti e quelle che creano più confusione sono comunque ricapitolate qui. Per iniziare con un nuovo pacchetto, si deve prima di tutto creare una directory vuota, preferibilmente di nome <code>/var/abs/local/<PKGNAME></code>. In questo modo è naturalmente integrata nell'ABS-tree, ma non toccata dal cvsup quando si sincronizzi l'albero. Si deve quindi entrare in questa directory e creare un file <code>PKGBUILD</code> su cui lavorare, copiando il prototipo d'esempio da <code>/usr/share/pacman/PKGBUILD.proto</code> alla directory di lavoro, o copiando il <code>PKGBUILD</code> da un altro pacchetto. Quest'ultima scelta è molto utile se si vuole soltanto modificare le opzioni di compilazione di un pacchetto invece di crearne uno completamente nuovo.
  
 
Comunque si decida di procedere, si ha bisogno di un file <code>PKGBUILD</code> su cui lavorare.
 
Comunque si decida di procedere, si ha bisogno di un file <code>PKGBUILD</code> su cui lavorare.
Line 22: Line 22:
 
Ora bisogna aprirlo ed impostare i valori di ogni variabile secondo il pacchetto che si sta costruendo:
 
Ora bisogna aprirlo ed impostare i valori di ogni variabile secondo il pacchetto che si sta costruendo:
 
<br /><br />
 
<br /><br />
*'''pkgname:''' Impostarla con un nome per il pacchetto. La convenzione prevede che si usino tutte lettere minuscole per il nome del pacchetto. E' arbitrario, ma aiuta se il nome di un pacchetto è uguale al nome della directory in cui ci si trova ed anche al nome del file .tar.gz che contiene i sorgenti del programma che si vuole scaricare.
+
*'''pkgname:''' Impostarla con un nome per il pacchetto. Convenzione vuole che si usino tutte lettere minuscole per il nome del pacchetto. La scelta è arbitraria, ma è d'aiuto avere il nome di un pacchetto uguale al nome della directory in cui ci si trova ed anche al nome del file .tar.gz che contiene i sorgenti del programma che si vuole scaricare.
  
*'''pkgver:''' Set the version of the package. This can contain letters, numbers and periods, but CANNOT contain a hyphen. It depends on the versioning system (major.minor.bugfix, major.date, etc) that the program you are packaging uses. Again, in most cases you should stick to the version that's part of the sourcepackage filename to make later steps easier and more flexible. Also note: if the package writer uses a dash in their version numbering scheme, replace it with an underscore. ('0.99-10'  =>  '0.99_10')
+
*'''pkgver:''' Impostare la versione del pacchetto. Questa può contenere lettere, numeri e periodi, ma NON può contenere trattini. Dipende dal sistema di numerazione di versione (major.minor.bugfix, major.date, ecc..) che usa il programma che si sta impacchettando. Di nuovo, nella maggior parte dei casi bisognerebbe attenersi alla versione che è parte del file contenente i sorgenti, per rendere i passi successivi più facili e flessibili. N.B: se il creatore del pacchetto usa un trattino nello schema di numerazione delle versioni, rimpiazzarlo con un underscore. ('0.99-10'  =>  '0.99_10')
  
*'''pkgrel:''' This should be incremented each time you release a package, starting with 1. Its purpose is to differentiate consecutive builds of the same version of a package. Occasionally the first release of a package contains a problem or misfeature. When you make the second release, you increment the <code>pkgrel</code> variable so that pacman knows it needs to be reinstalled. When a new '''version''' of the package is released, you reset the <code>pkgrel</code> variable to 1.
+
*'''pkgrel:''' Questa variabile andrebbe incrementata ogni volta che si rilascia un pacchetto, a partire da 1. Il suo obiettivo è di differenziare compilazioni consecutive della stessa versione di un pacchetto. A volte il primo rilascio di un pacchetto contiene un problema o una "disfunzione". Quando si completa il secondo rilascio, si incrementa la variabile <code>pkgrel</code> di modo che pacman sappia che il pacchetto dev'essere reinstallato. Quando viene rilasciata una nuova '''versione''' del pacchetto, si reimposti la variabile <code>pkgrel</code> a 1.
  
*'''pkgdesc:''' This should contain a short, usually less than 76 characters, description of the package. Usually it is not necessary to use the program name. <code>OpenGL accelerated X server</code> is better than <code>xgl is an OpenGL...</code>.
+
*'''pkgdesc:''' Qui si dovrebbe inserire una breve (normalmente, meno di 76 caratteri) del pacchetto. Di solito non è necessario usare il nome del programma. <code>Server X accelerato con OpenGL</code> è meglio di <code>xgl è un server X...</code>.
  
*'''arch:''' This should contain an array of architectures, usually 'i686', that describes where the PKGBUILD file can be used. You can access this value with the variable <code>$arch</code> during the build.
+
*'''arch:''' Questa dovrebbe contenere un array delle architetture, normalmente 'i686', sulle quali il file PKGBUILD può essere usato. Si può accedere a questo valore con la variabile <code>$arch</code> durante la compilazione.
  
*'''url:''' This should contain the address of the official site of the program where who is interested can find more information.
+
*'''url:''' Qui dovrebbe essere inserito l'indirizzo del sito ufficiale del programma, dove chi è interessato possa trovare maggiori informazioni.
  
*'''license:''' The type of license, if you do not know it please write down 'unknown'.
+
*'''license:''' Il tipo di licenza, se non la si conosce scrivere 'unknown'.
  
*'''depends:''' This should contain an array of package names that need to be installed before this program can be run, separated by spaces. The names can optionally be enclosed in single quotes (apostrophes) to prevent possible shell quoting problems, and the array should be enclosed in round brackets. Sometimes a program requires a minimum version of a dependency; In that case, you might want to use the mathematical "larger or equal than" operator, and enclose the whole construct in quotes. Here's an example to add a dependency on the glibc package, and the slang library of at least version 1.8.0: '''<code>depends=('glibc' 'slang>=1.8.0')</code>'''
+
*'''depends:''' Questa dovrebbe contenere un array di nomi di pacchetti, separati da spazi, che devono essere installati prima che il programma possa essere eseguito. I nomi possono facoltativamente essere chiusi in singoli apici (apostrofi) per prevenire eventuali problemi di citazione della shell e l'array dev'essere chiuso tra parentesi. A volte un programma richiede una versione minima di una dipendenza: in tal caso, si può usare l'operatore matematico "maggiore o uguale di" ed racchiudere l'intero costrutto tra virgolette. Di seguito un esempio per aggiungere una dipendenza dal pacchetto glibc e dalla libreria slang, versione minima 1.8.0: '''<code>depends=('glibc' 'slang>=1.8.0')</code>'''
  
*'''makedepends:''' This should contain an array of package names that are needed only during the build, but that are unneeded for *using* the package after install. Example: <code>unarj</code> used in a build to unpack some patches.
+
*'''makedepends:''' Questa dovrebbe contenere un array di nomi di pacchetti necessari solo durante la compilazione, ma non necessarie per *usare* il pacchetto dopo l'installazione. Esempio: <code>unarj</code>, usato in una compilazione per decomprimere alcune patch.
  
*'''provides:''' This should contain an array of package names that this package provides the features of (or a virtual package such as 'cron' or 'sh'). If you use this variable, you should add the version (pkgver and perhaps the pkgrel) that this package will provide if dependencies may be affected by it. '''''NOTE:''''' This functionality is slightly broken in pacman 3.1.0 and will be fixed in 3.1.1. This documentation refers to the 3.1.1 syntax which will soon be in use. <br/>'''Example:''' If you are providing a modified qt package named qt-foo version 3.3.8 which provides qt, then provides should look like this: '''<code>provides=('qt=3.3.8')</code>'''. Putting '''<code>provides=('qt')</code>''' will cause dependencies that require a specific version of 'qt' to fail. However, if no packages required a specific version of qt, this would be enough. <br/>'''Example 2:''' If the package perl-5.10.0 also provides the perl modules perl-foo version 5.2.1 and perl-bar version 2.5, then provides looks like this: '''<code>provides=('perl-foo=5.2.1' 'perl-bar=2.5')</code>'''.
+
*'''provides:''' Questa dovrebbe contenere un array di nomi di pacchetti di cui questo pacchetto fornisce le caratteristiche (o un pacchetto virtuale come 'cron' o 'sh'). Se si usa questa variabile, bisognerebbe aggiungere la versione (pkgver e magari pkgrel) che questo pacchetto fornirà, se le dipendenze possono esserne influenzate. <br/>'''Esempio:''' Se si offre un pacchetto qt modificato, di nome qt-foo versione 3.3.8, che fornisce qt, allora provides dovrebbe somigliare a quanto segue: '''<code>provides=('qt=3.3.8')</code>'''. Scrivere '''<code>provides=('qt')</code>''' provocherà un fallimento delle dipendenze che richiedono una versione specifica di 'qt'. Ad ogni modo, se nessun pacchetto richiedeva una versione specifica di qt, sarebbe sufficiente. <br/>'''Esempio 2:''' Se il pacchetto perl-5.10.0 offre anche i moduli perl-foo versione 5.2.1 e perl-bar versione 2.5, allora provides è simile a: '''<code>provides=('perl-foo=5.2.1' 'perl-bar=2.5')</code>'''.
  
*'''conflicts:''' This should be an array of package names that if installed with the described one will give problems. You can also specify the "version properties" of the conflicting packages in the same format as depends.
+
*'''conflicts:''' Questa dovrebbe essere un array di nomi di pacchetti che se installati insieme a quello descritto creeranno problemi. Si può anche specificare le "proprietà di versione" del pacchetto in conflitto con lo stesso formato di depends.
  
*'''replaces:''' This should be an array of obsolete package names that are replaced by the described one.
+
*'''replaces:''' Questa dovrebbe essere un array di nomi di pacchetti obsoleti che sono rimpiazzati da quello descritto.
  
*'''source:''' This must be an array of files which are needed to build the package, containing at least the location of the program source, which is in most cases a full HTTP or FTP URL enclosed in double quotes. The prototype <code>PKGBUILD</code> shows how you can use the previously set variables for package name and version effectively here. If you find you need to supply files which are not downloadable on the fly, for example self-made patches, you simply put those into the same directory where your <code>PKGBUILD</code> is in, and add the filename to this source array. Any  paths you add here are resolved relative to the directory where the <code>PKGBUILD</code> lies. Before the actual build process is started, all of the files referenced here will be downloaded or checked for existence, and <code>makepkg</code> will not proceed if any are missing.
+
*'''source:''' Questo dev'essere un array di file necessari a compilare il pacchetto, contenenti perlomeno la locazione dei sorgenti del programma, che è nella maggioranza dei casi un URL HTTP o FTP completo racchiuso tra virgolette (doppi apici). Il prototipo di <code>PKGBUILD</code> mostra come si possono effettivamente usare le variabili precedentemente impostate per nome del pacchetto e versione in questa variabile. Se si scopre di aver bisogno di fornire file non scaricabili "al volo, ad esempio patch create personalmente, mettere semplicemente quei file nella stessa directory dove si trova il <code>PKGBUILD</code> e aggiungere il nome del file a questo array source. Any  paths you add here are resolved relative to the directory where the <code>PKGBUILD</code> lies. Before the actual build process is started, all of the files referenced here will be downloaded or checked for existence, and <code>makepkg</code> will not proceed if any are missing.
  
 
*'''md5sums:''' An array of md5 checksums for the source files, space seperated and enclosed in quotes. Once all files in the source array are available, an md5 hash of each file will be automatically generated and compared with the values of this array, '''in the same order they appear in the source array'''. Whilst the order of the source files itself does not matter, it's important that it's coherent with the order of the md5sums, as <code>makepkg</code> won't guess which md5sum belongs to what source file, and will happily start spewing errors if they don't match to prevent download errors or manipulations. You can generate the md5sums array quickly and easily using the command <code>makepkg -g</code> (after the source array has been properly set up) in the directory that contains the <code>PKGBUILD</code>. <code>makepkg -g >>PKGBUILD</code> will generate the sums and append them to the end of the <code>PKGBUILD</code>, from whence you can move the line(s) into the proper position of the file.
 
*'''md5sums:''' An array of md5 checksums for the source files, space seperated and enclosed in quotes. Once all files in the source array are available, an md5 hash of each file will be automatically generated and compared with the values of this array, '''in the same order they appear in the source array'''. Whilst the order of the source files itself does not matter, it's important that it's coherent with the order of the md5sums, as <code>makepkg</code> won't guess which md5sum belongs to what source file, and will happily start spewing errors if they don't match to prevent download errors or manipulations. You can generate the md5sums array quickly and easily using the command <code>makepkg -g</code> (after the source array has been properly set up) in the directory that contains the <code>PKGBUILD</code>. <code>makepkg -g >>PKGBUILD</code> will generate the sums and append them to the end of the <code>PKGBUILD</code>, from whence you can move the line(s) into the proper position of the file.

Revision as of 15:48, 18 May 2008

Tango-preferences-desktop-locale.pngThis article or section needs to be translated.Tango-preferences-desktop-locale.png

Notes: please use the first argument of the template to provide more detailed indications. (Discuss in Talk:Creating packages (Italiano)#)
Template:I18n links start

Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n entry Template:I18n links end

Il documento ABS - Il Sistema Di Compilazione di Arch fornisce una buona panoramica degli strumenti e dei file necessari a creare o modificare pacchetti per Arch Linux. Non è necessario sapere altro, se ciò che si vuole è solo personalizzare o ricompilare pacchetti esistenti. Comunque, se si ha bisogno di creare un pacchetto nuovo, ci sono alcune linee guida aggiuntive da conoscere. Questo documento presuppone la lettura e la comprensione della descrizione di ABS.

Preparazione dei file

Tutte le informazioni per creare un pacchetto sono situate in un file PKGBUILD. Quando si lancia makepkg, esso cercherà un file PKGBUILD nella directory in cui ci si trova e compilerà i sorgenti del software secondo le istruzioni contenute nel file PKGBUILD. Una volta terminata con successo la compilazione, i binari risultanti, insieme a tutti i meta-dati disponibili quali versione e dipendenze, sono immagazzinati nel pacchetto nome.pkg.tar.gz che può essere installato con il comando pacman -Up <nome pacchetto>.

Il file PKGBUILD contiene tutte le istruzioni per creare il pacchetto, in una forma direttamente interpretabile da bash (non c'è da preoccuparsi se questa breve indicazione non è d'aiuto). Le variabili qui usate sono descritte nell'articolo ABS, ma le più importanti e quelle che creano più confusione sono comunque ricapitolate qui. Per iniziare con un nuovo pacchetto, si deve prima di tutto creare una directory vuota, preferibilmente di nome /var/abs/local/<PKGNAME>. In questo modo è naturalmente integrata nell'ABS-tree, ma non toccata dal cvsup quando si sincronizzi l'albero. Si deve quindi entrare in questa directory e creare un file PKGBUILD su cui lavorare, copiando il prototipo d'esempio da /usr/share/pacman/PKGBUILD.proto alla directory di lavoro, o copiando il PKGBUILD da un altro pacchetto. Quest'ultima scelta è molto utile se si vuole soltanto modificare le opzioni di compilazione di un pacchetto invece di crearne uno completamente nuovo.

Comunque si decida di procedere, si ha bisogno di un file PKGBUILD su cui lavorare.

Modificare le variabili

Ora bisogna aprirlo ed impostare i valori di ogni variabile secondo il pacchetto che si sta costruendo:

  • pkgname: Impostarla con un nome per il pacchetto. Convenzione vuole che si usino tutte lettere minuscole per il nome del pacchetto. La scelta è arbitraria, ma è d'aiuto avere il nome di un pacchetto uguale al nome della directory in cui ci si trova ed anche al nome del file .tar.gz che contiene i sorgenti del programma che si vuole scaricare.
  • pkgver: Impostare la versione del pacchetto. Questa può contenere lettere, numeri e periodi, ma NON può contenere trattini. Dipende dal sistema di numerazione di versione (major.minor.bugfix, major.date, ecc..) che usa il programma che si sta impacchettando. Di nuovo, nella maggior parte dei casi bisognerebbe attenersi alla versione che è parte del file contenente i sorgenti, per rendere i passi successivi più facili e flessibili. N.B: se il creatore del pacchetto usa un trattino nello schema di numerazione delle versioni, rimpiazzarlo con un underscore. ('0.99-10' => '0.99_10')
  • pkgrel: Questa variabile andrebbe incrementata ogni volta che si rilascia un pacchetto, a partire da 1. Il suo obiettivo è di differenziare compilazioni consecutive della stessa versione di un pacchetto. A volte il primo rilascio di un pacchetto contiene un problema o una "disfunzione". Quando si completa il secondo rilascio, si incrementa la variabile pkgrel di modo che pacman sappia che il pacchetto dev'essere reinstallato. Quando viene rilasciata una nuova versione del pacchetto, si reimposti la variabile pkgrel a 1.
  • pkgdesc: Qui si dovrebbe inserire una breve (normalmente, meno di 76 caratteri) del pacchetto. Di solito non è necessario usare il nome del programma. Server X accelerato con OpenGL è meglio di xgl è un server X....
  • arch: Questa dovrebbe contenere un array delle architetture, normalmente 'i686', sulle quali il file PKGBUILD può essere usato. Si può accedere a questo valore con la variabile $arch durante la compilazione.
  • url: Qui dovrebbe essere inserito l'indirizzo del sito ufficiale del programma, dove chi è interessato possa trovare maggiori informazioni.
  • license: Il tipo di licenza, se non la si conosce scrivere 'unknown'.
  • depends: Questa dovrebbe contenere un array di nomi di pacchetti, separati da spazi, che devono essere installati prima che il programma possa essere eseguito. I nomi possono facoltativamente essere chiusi in singoli apici (apostrofi) per prevenire eventuali problemi di citazione della shell e l'array dev'essere chiuso tra parentesi. A volte un programma richiede una versione minima di una dipendenza: in tal caso, si può usare l'operatore matematico "maggiore o uguale di" ed racchiudere l'intero costrutto tra virgolette. Di seguito un esempio per aggiungere una dipendenza dal pacchetto glibc e dalla libreria slang, versione minima 1.8.0: depends=('glibc' 'slang>=1.8.0')
  • makedepends: Questa dovrebbe contenere un array di nomi di pacchetti necessari solo durante la compilazione, ma non necessarie per *usare* il pacchetto dopo l'installazione. Esempio: unarj, usato in una compilazione per decomprimere alcune patch.
  • provides: Questa dovrebbe contenere un array di nomi di pacchetti di cui questo pacchetto fornisce le caratteristiche (o un pacchetto virtuale come 'cron' o 'sh'). Se si usa questa variabile, bisognerebbe aggiungere la versione (pkgver e magari pkgrel) che questo pacchetto fornirà, se le dipendenze possono esserne influenzate.
    Esempio: Se si offre un pacchetto qt modificato, di nome qt-foo versione 3.3.8, che fornisce qt, allora provides dovrebbe somigliare a quanto segue: provides=('qt=3.3.8'). Scrivere provides=('qt') provocherà un fallimento delle dipendenze che richiedono una versione specifica di 'qt'. Ad ogni modo, se nessun pacchetto richiedeva una versione specifica di qt, sarebbe sufficiente.
    Esempio 2: Se il pacchetto perl-5.10.0 offre anche i moduli perl-foo versione 5.2.1 e perl-bar versione 2.5, allora provides è simile a: provides=('perl-foo=5.2.1' 'perl-bar=2.5').
  • conflicts: Questa dovrebbe essere un array di nomi di pacchetti che se installati insieme a quello descritto creeranno problemi. Si può anche specificare le "proprietà di versione" del pacchetto in conflitto con lo stesso formato di depends.
  • replaces: Questa dovrebbe essere un array di nomi di pacchetti obsoleti che sono rimpiazzati da quello descritto.
  • source: Questo dev'essere un array di file necessari a compilare il pacchetto, contenenti perlomeno la locazione dei sorgenti del programma, che è nella maggioranza dei casi un URL HTTP o FTP completo racchiuso tra virgolette (doppi apici). Il prototipo di PKGBUILD mostra come si possono effettivamente usare le variabili precedentemente impostate per nome del pacchetto e versione in questa variabile. Se si scopre di aver bisogno di fornire file non scaricabili "al volo, ad esempio patch create personalmente, mettere semplicemente quei file nella stessa directory dove si trova il PKGBUILD e aggiungere il nome del file a questo array source. Any paths you add here are resolved relative to the directory where the PKGBUILD lies. Before the actual build process is started, all of the files referenced here will be downloaded or checked for existence, and makepkg will not proceed if any are missing.
  • md5sums: An array of md5 checksums for the source files, space seperated and enclosed in quotes. Once all files in the source array are available, an md5 hash of each file will be automatically generated and compared with the values of this array, in the same order they appear in the source array. Whilst the order of the source files itself does not matter, it's important that it's coherent with the order of the md5sums, as makepkg won't guess which md5sum belongs to what source file, and will happily start spewing errors if they don't match to prevent download errors or manipulations. You can generate the md5sums array quickly and easily using the command makepkg -g (after the source array has been properly set up) in the directory that contains the PKGBUILD. makepkg -g >>PKGBUILD will generate the sums and append them to the end of the PKGBUILD, from whence you can move the line(s) into the proper position of the file.

So far you've only been setting up meta-information about the package; Where to get the sources, what the name of the package shall be, etc. The next step is supplying instructions on how to actually compile and install the program you're intending to pack up.

Using the source

Now you should download the source tarball, extract it, and note all commands needed to compile and install it. The contents of the build() function in your PKGBUILD will do nothing but run exactly these steps again, with a little glue to pack everything up once compilation is done.

Now you probably need to edit the contents of the build() function in the PKGBUILD. This function uses common shell commands in the bash syntax. The basic purpose of this function is to automatically compile the programs and create a pkg directory to install the program to, allowing makepkg to pack it all up easily without having to pick all interesting files from your "live" filesystem.

The build() function

Usually the first step in the build function is to change into one of the directories created by uncompressing the source files. You can use the $startdir variable to do this (it refers to the directory that contains the PKGBUILD). You may also use the $pkgname and $pkgver variables that you set earlier. For example, depending on the name of the directory that was uncompressed by makepkg, the first command in your build function might be cd $startdir/src/$pkgname-$pkgver, which happens to be a very common case unless the program's author is a very, very evil person.

Compiling the programs is the more difficult part. I will assume you managed to compile the program successfully "by hand" here, as all imaginable steps to do this cannot possibly be covered here. That's what the program's author is supposed to write README and INSTALL files for after all.

Now that you are in that directory, you need to issue whatever commands it takes to compile the files. In simple cases, you may simply use ./configure; make, although there are dozens of variations including ant build or issuing the actual gcc commands to compile the packages.

Good thing is, if you already managed to compile the package manually, you basically only need to list the commands you used here, and things should work out just fine. Since many packages like to install their files relative to the /usr/local directory, but Arch Linux prefers using just /usr, you probably want to supply a parameter to the configure script or the make command to take care of this. The prototype PKGBUILD serves as an example for that. It might work differently, though; Again, your mileage may vary.

  • It is good practice to use --prefix=/usr/local only when manually building from source, and to reserve /usr for pacman-handled packages, including those built with ABS/makepkg- this will save you headaches with conflicting packages.

The next step in the build() function is to put the compiled files in a place where makepkg can scoop them up to create a package. This directory is the pkg directory. It is supposed to imitate the root of your filesystem to the program's installation procedure. Any files that should be installed in a directory in the root of your filesystem should go in the pkg directory under the same directory structure (ie. if you want to install the file myprog in /usr/bin, it should be placed in $startdir/pkg/usr/bin). Fortunately, only a few programs require the user to copy dozens of files manually, but they supply some kind of installation procedure instead which is supposed to do that automatically, often invoked by running "make install". It's critical, however, that you find out how to tell this installation procedure that it's supposed to stuff all it's nifty files not into your /, but into $startdir/pkg/ instead! Otherwise you'll end up with an empty package file, and the binaries of the program you installed "correctly" added to your system already. Most of the time you'll have to supply the prefix parameter to the "make install" call as shown in the prototype, but it's very well possible that the program you're packaging expects an altogether different approach, but here are some hints:

  • Sometimes the configure script accepts a prefix property that tells where the files should be installed. You might use ./configure --prefix=$startdir/pkg/usr in such configuration, for example. Be certain that this is the right directory; sometimes the uncompressed directory might be named differently):
tar -xf foo-0.99.tar.gz

and a ls might return:

  .
  ..
  foo-0.99.tar.gz
  foo/

and not:

  .
  ..
  foo-0.99.tar.gz
  foo-0.99/
  • Sometimes there is a PREFIX option to append to a make install command. This is sometimes set as a variable, and sometimes set in the command. In worse cases you have to edit the Makefile(s) (or ant build/properties files if the project uses ant) with sed or a patch you'd have to create yourself.
  • There might be other sorts of install scripts that allow you to specify where the program should be installed.
  • In some cases, the program expects to be run from a single directory. Often it is wise to simply copy these to $startdir/pkg/opt.

As you might have guessed already, that's the part where actual knowledge and experience becomes a necessity. It helps a lot if you browse over the PKGBUILD files in the ABS tree, as those are tested and contain a few tricks that might prove valuable.

More often that not, the installation routine of the program will take care to create any subdirectories below the pkg/ directory. If it does not, however, you'll get a lot of errors during the install stage as files are copied to nonexistent subdirectories. In that case you'll have to create the needed subdirectories by adding the appropriate mkdir commands in the build() function before running the installation procedure. The actual directory structure is package dependent, of course; some programs need to place files in /etc or /usr while others might need to use /bin or /opt. Most will need to create several directories. You can do all of this with the mkdir -p $startdir/pkg/OTHER/DIRS/AS/NEEDED command, where OTHER/DIRS/AS/NEEDED represent directories at the root of the filesystem.

Testing the PKGBUILD

As you are writing the PKGBUILD's build() function, you will want to test your changes frequently to ensure there are no bugs. You can do this using the makepkg command in the directory containing the PKGBUILD. With a properly formatted PKGBUILD, this will create a package, but with a broken or unfinished one it will throw an error. Hopefully it will be a descriptive error!

If running makepkg finished successfully, it will place a shiny new file called $pkgname-$pkgver.pkg.tar.gz in your working directory. This is a pacman package and can be installed with the pacman -U and pacman -A options, or added to a local or web based repository. Note that just because a package file was built it doesn't mean it works! It might conceivably contain only the directory structure and no files whatsoever if, for example, you specified a prefix improperly. You can use pacman's query functions to display a list of files contained in the package and the dependencies it requires, and compare those with what you consider as correct. "pacman -Qlp <package file>" and "pacman -Qip <package file>" do the trick.

If the package looks sane, that's all you need to do. However, if you plan on releasing the package or PKGBUILD, it is imperative that you check and double check and re-double-check the contents of the depends array. This should contain a list of all packages that need to be installed in order for your package to work. You only need to list first level depends in the depends array. That is, you do not need to list packages that your program depends on if other packages that your program depends on are already listed.

For example, gtk2 depends on glib2. Like most open source C programs, it also requires glibc to be installed. However, glibc does not need to be listed as a dependency for gtk2 because it is a dependency for glib2, and glib2 is already listed in gtk2.

There are some tools you can use to check dependencies, including Jason Chu's famous namcap program (pacman -Sy namcap), and the more arcane ldd program. Check the man pages for these programs and the links at the end of this document for more information. You should also scour the program's documentation and website (some nice developers have a page called "dependencies" that helps a lot).

Testing the package

Also make sure that the package binaries actually run flawlessly! It's really annoying to release a package that contains all necessary files, but dumps core because of some obscure configuration option that doesn't quite work well with the rest of the system. If you're only going to compile packages for your own system, though, you don't need to worry too much about this quality assurance step, as you're the only person suffering from mistakes after all.

To sum it all up

  • Download the source tarball of the program you want to package up
  • Try compiling the package and installing it into an arbitrary directory
  • Copy over the prototype /usr/share/pacman/PKGBUILD.proto and rename it to PKGBUILD in a temporary working directory
  • Edit the PKGBUILD according to the needs of your package
  • Run makepkg and see whether the resulting package is built correctly
  • If not, repeat the last two steps

Useful links

Warnings

  • Before you can automate the package building process, you should have done it manually at least once unless you know exactly what you're doing in advance, in which case you would not be reading this in the first place. Unfortunately, although a good bunch of program authors stick to the 3-step build cycle of "./configure; make; make install", this is not always the case, and things can get real ugly if you have to apply patches to make everything work at all. Rule of thumb: If you can't get the program to compile from the source tarball, and make it install itself to a defined, temporary subdirectory, you don't even need to try packaging it. There isn't any magic pixie dust in makepkg that makes source problems go away.
  • In a few cases, the packages are not even available as source and you have to use something like sh installer.run to get it to work. You will have to do quite a bit of research (read READMEs, INSTALL instructions, man pages, perhaps ebuilds from gentoo or other package installers, possibly even the MAKEFILEs or source code) to get it working. In some really bad cases, you have to edit the source files to get it to work at all. However, makepkg needs to be completely autonomous, with no user input. Therefore if you need to edit the Makefiles, you may have to bundle a custom patch with the PKGBUILD and install it from inside the build() function, or you might have to issue some sed commands from inside the build() function.
  • Note that just because a package file was built it doesn't mean it works! It might conceivably contain only the directory structure and no files whatsoever if, for example, you specified a prefix improperly. You can use pacman's query functions to display a list of files contained in the package and the dependencies it requires, and compare those with what you consider as correct. "pacman -Qlp <package file>" and "pacman -Qip <package file>" do the trick.