SliTaz Repositories

     1.1 --- a/en/doc/cookbook/receipts.html	Sat Mar 28 01:15:01 2009 +0100
     1.2 +++ b/en/doc/cookbook/receipts.html	Mon Jun 22 20:51:07 2009 +0000
     1.3 @@ -64,6 +64,7 @@
     1.4  used by Tazpkg to manage dependencies or provide information about the package.
     1.5  </p>
     1.6  <p>
     1.7 +<a name="depends"></a>
     1.8  <code>$DEPENDS</code>: Set dependencies, there may be several dependencies 
     1.9  seperated by a space or on several lines. This variable is used mainly by 
    1.10  Tazpkg when installing the package and Tazwok to build large packages such 
    1.11 @@ -73,6 +74,7 @@
    1.12  DEPENDS="ncurses"
    1.13  </pre>
    1.14  <p>
    1.15 +<a name="build_depends"></a>
    1.16  <code>$BUILD_DEPENDS</code>: Set compilation dependencies, again seperated 
    1.17  by a space or several lines. This variable is used by Tazwok during the 
    1.18  cooking of a package. Example:
    1.19 @@ -81,6 +83,7 @@
    1.20  BUILD_DEPENDS="ncurses-dev"
    1.21  </pre>
    1.22  <p>
    1.23 +<a name="tarball"></a>
    1.24  <code>$TARBALL</code> : The archive is a source with the extension (tar.gz, 
    1.25  tgz or tar.bz2). In general, the variables $PACKAGE and $VERSION are used to 
    1.26  just change the extension, it helps to upgrade the package without changing 
    1.27 @@ -90,6 +93,7 @@
    1.28  TARBALL="$PACKAGE-$VERSION.tar.gz"
    1.29  </pre>
    1.30  <p>
    1.31 +<a name="web_site"></a>
    1.32  <code>$WEB_SITE</code> : The official website of the package. It may be that 
    1.33  some libraries have no website, in this case, there is no need to specify a 
    1.34  URL. Note Tazwok and Tazpkg both expect to find a URL with the complete HTTP:
    1.35 @@ -98,6 +102,7 @@
    1.36  WEB_SITE="http://www.clex.sk/"
    1.37  </pre>
    1.38  <p>
    1.39 +<a name="wget_url"></a>
    1.40  <code>$WGET_URL</code> : URL to download the source file. In general the 
    1.41  variable $TARBALL should be used to facilitate the updating of the package
    1.42  without changing the $VERSION. Using a configuration file, Tazwok also 
    1.43 @@ -109,6 +114,7 @@
    1.44  WGET_URL="http://www.clex.sk/download/$TARBALL"
    1.45  </pre>
    1.46  <p>
    1.47 +<a name="config_files"></a>
    1.48  <code>$CONFIG_FILES</code> : Some packages provide customized 
    1.49  configuration files. The $CONFIG_FILES variable provides a list of these 
    1.50  files that can be saved by the 'tazpkg repack-config' command. 
    1.51 @@ -119,16 +125,19 @@
    1.52  <pre class="script"> CONFIG_FILES="/etc/netatalk/AppleVolumes.* /etc/netatalk/*.conf"
    1.53  </pre>
    1.54  <p>
    1.55 +<a name="suggested"></a>
    1.56  <code>$SUGGESTED</code> : Lists useful packages without being essential. 
    1.57  Also used to activate optional features.
    1.58  </p>
    1.59  <p>
    1.60 +<a name="wanted"></a>
    1.61  <code>$WANTED</code> : SliTaz packages normally depend on the compilation of 
    1.62  a source package. Sometimes the receipt of a package requires no compilation 
    1.63  of rules, then $WANTED is used to copy files from the source of another 
    1.64  package by using the variable $ src.
    1.65  </p>
    1.66  <p>
    1.67 +<a name="source"></a>
    1.68  <code>$SOURCE</code> : It may be that the Tazpkg package name differs from 
    1.69  the name of the source package. Example for Xorg packages, the name of Tazpkg 
    1.70  library X11 is 'xorg-libX11' and the name of the package source is libX11. 
    1.71 @@ -137,6 +146,7 @@
    1.72  source archive becomes $SOURCE-$VERSION.tar.gz.
    1.73  </p>
    1.74  <p>
    1.75 +<a name="provide"></a>
    1.76  <code>$PROVIDE</code> : Some packages offer the same functionality, for 
    1.77  instance the web server was at first lighttpd, now apache is available. 
    1.78  All packages dependent on a web server refer to lighttpd. 
    1.79 @@ -167,13 +177,16 @@
    1.80  will add them to the receipt automatically.
    1.81  </p>
    1.82  <p>
    1.83 +<a name="packed_size"></a>
    1.84  <code>$PACKED_SIZE</code> : Tazpkg file size.
    1.85  </p>
    1.86  <p>
    1.87 +<a name="unpacked_size"></a>
    1.88  <code>$UNPACKED_SIZE</code> : Space taken up by the package after
    1.89  installation.
    1.90  </p>
    1.91  <p>
    1.92 +<a name="extraversion"></a>
    1.93  <code>$EXTRAVERSION</code> : Some packages have 2 different versions. 
    1.94  This is in case of modules added to the Linux kernel, such as squashfs, 
    1.95  because the module depends on the version of the kernel with which it was 
    1.96 @@ -190,20 +203,24 @@
    1.97  Functions.
    1.98  </p>
    1.99  <p>
   1.100 +<a name="src"></a>
   1.101  <code>$src</code> : Defines the path to the directory of unarchived sources.
   1.102  </p>
   1.103  <p>
   1.104 +<a name="pkg"></a>
   1.105  <code>$_pkg</code> : Defines the path to the compiled binaries installed via 
   1.106  'make DESTDIR=$PWD/_pkg install'. This variable is used to copy the generated 
   1.107  files and create Tazpkg packages.
   1.108  </p>
   1.109  <p>
   1.110 +<a name="fs"></a>
   1.111  <code>$fs</code> : Defines the path to the pseudo filesystem (fs) in each 
   1.112  package. The 'fs' of the package corresponds to the root of the system, a bit
   1.113  like Clex will for example be in $fs/usr/bin/clex. Note the need to create the 
   1.114  necessary directories via function genpkg_rules() before copying the files.
   1.115  </p>
   1.116  <p>
   1.117 +<a name="configure_args"></a>
   1.118  <code>$CONFIGURE_ARGS</code> : This variable is defined in the Tazwok 
   1.119  configuration file (tazwok.conf). It allows you to specify generic optimization
   1.120  arguments during construction of a package. Default is the i486 architecture.
   1.121 @@ -217,6 +234,7 @@
   1.122  standard commands, such as sed, awk, patch and variables automatically 
   1.123  configured.
   1.124  </p>
   1.125 +<a name="compile_rules"></a>
   1.126  <h4>compile_rules()</h4>
   1.127  <p>
   1.128  To compile a package you can use the variable $src to move (cd) in the 
   1.129 @@ -237,6 +255,7 @@
   1.130  	make DESTDIR=$PWD/_pkg install
   1.131  }
   1.132  </pre>
   1.133 +<a name="genpkg_rules"></a>
   1.134  <h4>genpkg_rules()</h4>
   1.135  <p>
   1.136  To generate a tazkg package we must specify commands in the function 
   1.137 @@ -253,6 +272,7 @@
   1.138  	strip -s $fs/usr/bin/*
   1.139  }
   1.140  </pre>
   1.141 +<a name="pre_install"></a>
   1.142  <h4>pre_install() and post_install()</h4>
   1.143  <p>
   1.144  These 2 functions are initiated by Tazpkg when installing the package. They 
   1.145 @@ -271,6 +291,7 @@
   1.146  	echo "Processing post-install commands..."
   1.147  }
   1.148  </pre>
   1.149 +<a name="clean_wok"></a>
   1.150  <h4>clean_wok()</h4>
   1.151  <p>
   1.152  This function helps to define additional commands to be run when cleaning the wok,