website rev 362

Add anchors in receipts.html
author Pascal Bellard <pascal.bellard@slitaz.org>
date Fri Apr 10 20:01:55 2009 +0000 (2009-04-10)
parents 53b544e3454b
children e8ceba26f899
files doc/cookbook/receipts.html en/doc/cookbook/receipts.html
line diff
     1.1 --- a/doc/cookbook/receipts.html	Fri Apr 10 16:47:56 2009 +0000
     1.2 +++ b/doc/cookbook/receipts.html	Fri Apr 10 20:01:55 2009 +0000
     1.3 @@ -65,6 +65,7 @@
     1.4  des informations sur le paquet.
     1.5  </p>
     1.6  <p>
     1.7 +<a name="depends"></a>
     1.8  <code>$DEPENDS</code>: Specifie les dépendances, il peut y avoir plusieurs
     1.9  paquets séparés par un espace ou sur plusieurs lignes. Cette variable est
    1.10  principalement utilisée par Tazpkg lors de l'installation du paquet et Tazwok
    1.11 @@ -74,6 +75,7 @@
    1.12  <pre class="script">
    1.13   DEPENDS="ncurses"
    1.14  </pre>
    1.15 +<a name="build_depends"></a>
    1.16  <code>$BUILD_DEPENDS</code>: Specifie les dépendances de compilation, séparées 
    1.17  par un espace ou sur plusieurs lignes. Cette variable est utilisée par Tazwok
    1.18  lors de la cuisson d'un paquet et Tazwok. Exemple :
    1.19 @@ -82,11 +84,13 @@
    1.20   BUILD_DEPENDS="ncurses-dev"
    1.21  </pre>
    1.22  <p>
    1.23 +<a name="suggested"></a>
    1.24  <code>$SUGGESTED</code> : Liste les paquets pouvant être utiles sans pour
    1.25  autant être indispensables. Ils serviront à activer des fonctionnalités
    1.26  optionnelles.
    1.27  </p>
    1.28  <p>
    1.29 +<a name="tarball"></a>
    1.30  <code>$TARBALL</code> : L'archive source avec sont extension (tar.gz, tgz ou
    1.31  tar.bz2). En générale, les variables $PACAKAGE et $VERSION sont utilisées et
    1.32  il suffit de modifier l'extension, cela permet de mettre à jour le paquet en
    1.33 @@ -97,6 +101,7 @@
    1.34   TARBALL="$PACKAGE-$VERSION.tar.gz"
    1.35  </pre>
    1.36  <p>
    1.37 +<a name="web_site"></a>
    1.38  <code>$WEB_SITE</code> : Le site web officiel du paquet. Il se peut que
    1.39  certaines bibliothèques n'aient pas de site Web, dans ce cas il n'y a pas
    1.40  besoin de spécifier d'URL. Tazwok et Tazpkg s'attendent a trouver l'URL
    1.41 @@ -106,6 +111,7 @@
    1.42   WEB_SITE="http://www.clex.sk/"
    1.43  </pre>
    1.44  <p>
    1.45 +<a name="wget_url"></a>
    1.46  <code>$WGET_URL</code> : L'url de téléchargement des l'archive source. En
    1.47  générale la variable $TARBALL devraient être utilisée pour faciliter la mise
    1.48  à jour du paquet en ne modifiant que $VERSION. Le fichier de configuration de
    1.49 @@ -117,6 +123,7 @@
    1.50   WGET_URL="http://www.clex.sk/download/$TARBALL"
    1.51  </pre>
    1.52  <p>
    1.53 +<a name="config_files"></a>
    1.54  <code>$CONFIG_FILES</code> : Certains paquets fournissent des fichiers de
    1.55  configuration à adapter. La variable $CONFIG_FILES donne la liste de ces
    1.56  fichiers qui pourront être sauvegardés par la commande 'tazpkg repack-config'.
    1.57 @@ -128,12 +135,14 @@
    1.58   CONFIG_FILES="/etc/netatalk/AppleVolumes.* /etc/netatalk/*.conf"
    1.59  </pre>
    1.60  <p>
    1.61 +<a name="wanted"></a>
    1.62  <code>$WANTED</code> : Il y a des paquets SliTaz qui sont dépendants de la
    1.63  compilation d'un paquet source. La recette de ces paquets ne nécessite pas de
    1.64  règles de compilation, une variable $WANTED peut être utilisée pour copier des
    1.65  fichiers depuis les sources du paquet voulu en utilisant la variable $src.
    1.66  </p>
    1.67  <p>
    1.68 +<a name="source"></a>
    1.69  <code>$SOURCE</code> : Il se peut que le nom du paquet Tazpkg diffère du nom
    1.70  du paquet source. C'est le cas par exemple pour les paquets d'Xorg, le nom
    1.71  Tazpkg des bibliothèque X11 est 'xorg-libX11' et le nom du paquet source est
    1.72 @@ -142,6 +151,7 @@
    1.73  le nom de l'archive source devient $SOURCE-$VERSION.tar.gz.
    1.74  </p>
    1.75  <p>
    1.76 +<a name="provide"></a>
    1.77  <code>$PROVIDE</code> : Certains paquets offrent la même fonctionalité. Par
    1.78  exemple, le serveur web de Slitaz fût dans un premier temps lighttpd.
    1.79  Maintenant apache est aussi disponible. Tous les paquets dépendants d'un
    1.80 @@ -174,13 +184,16 @@
    1.81  automatiquement.
    1.82  </p>
    1.83  <p>
    1.84 +<a name="packed_size"></a>
    1.85  <code>$PACKED_SIZE</code> : Taille du ficher tazpkg.
    1.86  </p>
    1.87  <p>
    1.88 +<a name="unpacked_size"></a>
    1.89  <code>$UNPACKED_SIZE</code> : Taille utilisée par le paquet après son 
    1.90  installation.
    1.91  </p>
    1.92  <p>
    1.93 +<a name="extraversion"></a>
    1.94  <code>$EXTRAVERSION</code> : Certains packages ont besion de 2 numéros de
    1.95  version distincts. C'est le cas des modules ajoutés au noyau linux comme
    1.96  squashfs car le module produit dépend aussi de la version du noyau avec 
    1.97 @@ -197,14 +210,17 @@
    1.98  toutes deux dans le chapitre : Fonctions.
    1.99  </p>
   1.100  <p>
   1.101 +<a name="src"></a>
   1.102  <code>$src</code> : Définit le chemin vers le répertoire des sources désarchivée.
   1.103  </p>
   1.104  <p>
   1.105 +<a name="pkg"></a>
   1.106  <code>$_pkg</code> : Définit le chemin vers les binaires compliés et installés
   1.107  via la commande 'make DESTDIR=$PWD/_pkg install'. Cette variable est utilisée
   1.108  pour copier les fichiers générés et créer des paquets tazpkg.
   1.109  </p>
   1.110  <p>
   1.111 +<a name="fs"></a>
   1.112  <code>$fs</code> : Définit le chemin vers le pseudo système de fichier (fs)
   1.113  propre à chaque paquet. Le 'fs' d'un paquet correspond à la racine du système
   1.114  cible, un binaire tel que Clex sera par exemple dans $fs/usr/bin/clex, à noter
   1.115 @@ -212,6 +228,7 @@
   1.116  avant de copier des fichiers.
   1.117  </p>
   1.118  <p>
   1.119 +<a name="configure_args"></a>
   1.120  <code>$CONFIGURE_ARGS</code> : Cette variables est définie dans le fichier de
   1.121  configuration de Tazwok (tazwok.conf), elle permet de spécifier des
   1.122  arguments d'optimisation générique lors de la configuration d'un paquet.
   1.123 @@ -227,6 +244,7 @@
   1.124  configurées automatiquements. A noter que ces deux fonctions utilisent les
   1.125  commandes du Cookbook de SliTaz : http://www.slitaz.org/doc/cookbook/
   1.126  </p>
   1.127 +<a name="compile_rules"></a>
   1.128  <h4>compile_rules()</h4>
   1.129  <p>
   1.130  Pour compiler un paquet vous pouvez utiliser la variable $src pour vous
   1.131 @@ -247,6 +265,7 @@
   1.132  	make DESTDIR=$PWD/_pkg install
   1.133  }
   1.134  </pre>
   1.135 +<a name="genpkg_rules"></a>
   1.136  <h4>genpkg_rules()</h4>
   1.137  <p>
   1.138  Pour générer un paquet Tazpkg il faut mettre les commandes à lancer dans la
   1.139 @@ -263,6 +282,7 @@
   1.140  	strip -s $fs/usr/bin/*
   1.141  }
   1.142  </pre>
   1.143 +<a name="pre_install"></a>
   1.144  <h4>pre_install() et post_install()</h4>
   1.145  <p>
   1.146  Ces deux fonctions sont lancées par Tazpkg lors de l'installation du paquet.
   1.147 @@ -282,6 +302,7 @@
   1.148  	echo "Processing post-install commands..."
   1.149  }
   1.150  </pre>
   1.151 +<a name="clean_wok"></a>
   1.152  <h4>clean_wok()</h4>
   1.153  <p>
   1.154  Cette fonction est lancée par Tazwok avec la commande clean.
     2.1 --- a/en/doc/cookbook/receipts.html	Fri Apr 10 16:47:56 2009 +0000
     2.2 +++ b/en/doc/cookbook/receipts.html	Fri Apr 10 20:01:55 2009 +0000
     2.3 @@ -64,6 +64,7 @@
     2.4  used by Tazpkg to manage dependencies or provide information about the package.
     2.5  </p>
     2.6  <p>
     2.7 +<a name="depends"></a>
     2.8  <code>$DEPENDS</code>: Set dependencies, there may be several dependencies 
     2.9  seperated by a space or on several lines. This variable is used mainly by 
    2.10  Tazpkg when installing the package and Tazwok to build large packages such 
    2.11 @@ -73,6 +74,7 @@
    2.12  DEPENDS="ncurses"
    2.13  </pre>
    2.14  <p>
    2.15 +<a name="build_depends"></a>
    2.16  <code>$BUILD_DEPENDS</code>: Set compilation dependencies, again seperated 
    2.17  by a space or several lines. This variable is used by Tazwok during the 
    2.18  cooking of a package. Example:
    2.19 @@ -81,6 +83,7 @@
    2.20  BUILD_DEPENDS="ncurses-dev"
    2.21  </pre>
    2.22  <p>
    2.23 +<a name="tarball"></a>
    2.24  <code>$TARBALL</code> : The archive is a source with the extension (tar.gz, 
    2.25  tgz or tar.bz2). In general, the variables $PACKAGE and $VERSION are used to 
    2.26  just change the extension, it helps to upgrade the package without changing 
    2.27 @@ -90,6 +93,7 @@
    2.28  TARBALL="$PACKAGE-$VERSION.tar.gz"
    2.29  </pre>
    2.30  <p>
    2.31 +<a name="web_site"></a>
    2.32  <code>$WEB_SITE</code> : The official website of the package. It may be that 
    2.33  some libraries have no website, in this case, there is no need to specify a 
    2.34  URL. Note Tazwok and Tazpkg both expect to find a URL with the complete HTTP:
    2.35 @@ -98,6 +102,7 @@
    2.36  WEB_SITE="http://www.clex.sk/"
    2.37  </pre>
    2.38  <p>
    2.39 +<a name="wget_url"></a>
    2.40  <code>$WGET_URL</code> : URL to download the source file. In general the 
    2.41  variable $TARBALL should be used to facilitate the updating of the package
    2.42  without changing the $VERSION. Using a configuration file, Tazwok also 
    2.43 @@ -109,6 +114,7 @@
    2.44  WGET_URL="http://www.clex.sk/download/$TARBALL"
    2.45  </pre>
    2.46  <p>
    2.47 +<a name="config_files"></a>
    2.48  <code>$CONFIG_FILES</code> : Some packages provide customized 
    2.49  configuration files. The $CONFIG_FILES variable provides a list of these 
    2.50  files that can be saved by the 'tazpkg repack-config' command. 
    2.51 @@ -119,16 +125,19 @@
    2.52  <pre class="script"> CONFIG_FILES="/etc/netatalk/AppleVolumes.* /etc/netatalk/*.conf"
    2.53  </pre>
    2.54  <p>
    2.55 +<a name="suggested"></a>
    2.56  <code>$SUGGESTED</code> : Lists useful packages without being essential. 
    2.57  Also used to activate optional features.
    2.58  </p>
    2.59  <p>
    2.60 +<a name="wanted"></a>
    2.61  <code>$WANTED</code> : SliTaz packages normally depend on the compilation of 
    2.62  a source package. Sometimes the receipt of a package requires no compilation 
    2.63  of rules, then $WANTED is used to copy files from the source of another 
    2.64  package by using the variable $ src.
    2.65  </p>
    2.66  <p>
    2.67 +<a name="source"></a>
    2.68  <code>$SOURCE</code> : It may be that the Tazpkg package name differs from 
    2.69  the name of the source package. Example for Xorg packages, the name of Tazpkg 
    2.70  library X11 is 'xorg-libX11' and the name of the package source is libX11. 
    2.71 @@ -137,6 +146,7 @@
    2.72  source archive becomes $SOURCE-$VERSION.tar.gz.
    2.73  </p>
    2.74  <p>
    2.75 +<a name="provide"></a>
    2.76  <code>$PROVIDE</code> : Some packages offer the same functionality, for 
    2.77  instance the web server was at first lighttpd, now apache is available. 
    2.78  All packages dependent on a web server refer to lighttpd. 
    2.79 @@ -167,13 +177,16 @@
    2.80  will add them to the receipt automatically.
    2.81  </p>
    2.82  <p>
    2.83 +<a name="packed_size"></a>
    2.84  <code>$PACKED_SIZE</code> : Tazpkg file size.
    2.85  </p>
    2.86  <p>
    2.87 +<a name="unpacked_size"></a>
    2.88  <code>$UNPACKED_SIZE</code> : Space taken up by the package after
    2.89  installation.
    2.90  </p>
    2.91  <p>
    2.92 +<a name="extraversion"></a>
    2.93  <code>$EXTRAVERSION</code> : Some packages have 2 different versions. 
    2.94  This is in case of modules added to the Linux kernel, such as squashfs, 
    2.95  because the module depends on the version of the kernel with which it was 
    2.96 @@ -190,20 +203,24 @@
    2.97  Functions.
    2.98  </p>
    2.99  <p>
   2.100 +<a name="src"></a>
   2.101  <code>$src</code> : Defines the path to the directory of unarchived sources.
   2.102  </p>
   2.103  <p>
   2.104 +<a name="pkg"></a>
   2.105  <code>$_pkg</code> : Defines the path to the compiled binaries installed via 
   2.106  'make DESTDIR=$PWD/_pkg install'. This variable is used to copy the generated 
   2.107  files and create Tazpkg packages.
   2.108  </p>
   2.109  <p>
   2.110 +<a name="fs"></a>
   2.111  <code>$fs</code> : Defines the path to the pseudo filesystem (fs) in each 
   2.112  package. The 'fs' of the package corresponds to the root of the system, a bit
   2.113  like Clex will for example be in $fs/usr/bin/clex. Note the need to create the 
   2.114  necessary directories via function genpkg_rules() before copying the files.
   2.115  </p>
   2.116  <p>
   2.117 +<a name="configure_args"></a>
   2.118  <code>$CONFIGURE_ARGS</code> : This variable is defined in the Tazwok 
   2.119  configuration file (tazwok.conf). It allows you to specify generic optimization
   2.120  arguments during construction of a package. Default is the i486 architecture.
   2.121 @@ -217,6 +234,7 @@
   2.122  standard commands, such as sed, awk, patch and variables automatically 
   2.123  configured.
   2.124  </p>
   2.125 +<a name="compile_rules"></a>
   2.126  <h4>compile_rules()</h4>
   2.127  <p>
   2.128  To compile a package you can use the variable $src to move (cd) in the 
   2.129 @@ -237,6 +255,7 @@
   2.130  	make DESTDIR=$PWD/_pkg install
   2.131  }
   2.132  </pre>
   2.133 +<a name="genpkg_rules"></a>
   2.134  <h4>genpkg_rules()</h4>
   2.135  <p>
   2.136  To generate a tazkg package we must specify commands in the function 
   2.137 @@ -253,6 +272,7 @@
   2.138  	strip -s $fs/usr/bin/*
   2.139  }
   2.140  </pre>
   2.141 +<a name="pre_install"></a>
   2.142  <h4>pre_install() and post_install()</h4>
   2.143  <p>
   2.144  These 2 functions are initiated by Tazpkg when installing the package. They 
   2.145 @@ -271,6 +291,7 @@
   2.146  	echo "Processing post-install commands..."
   2.147  }
   2.148  </pre>
   2.149 +<a name="clean_wok"></a>
   2.150  <h4>clean_wok()</h4>
   2.151  <p>
   2.152  This function helps to define additional commands to be run when cleaning the wok,