cookutils annotate doc/cookopts.txt @ rev 899
Some important changes:
* cook: better die handling; cook can now mark packages as broken by itself; less chatty zip extracting; rename internal function copy() to scopy(); new copy() is the main tool to copy files from $install to $fs (docs to come); automatic patching (if patches are in $stuff/patches and patch list is $stuff/patches/series); better local packages handling; update packages.info database after each successful build, virtual packages are accessible immediately after build.
* doc/cookopts.txt: added "!perlz" and "!rmpod" options description.
* modules/compressor: strip Perl files.
* modules/pkgdb: calculate estimated time for cook:pkgdb too (as well as for cook:package).
* cook: better die handling; cook can now mark packages as broken by itself; less chatty zip extracting; rename internal function copy() to scopy(); new copy() is the main tool to copy files from $install to $fs (docs to come); automatic patching (if patches are in $stuff/patches and patch list is $stuff/patches/series); better local packages handling; update packages.info database after each successful build, virtual packages are accessible immediately after build.
* doc/cookopts.txt: added "!perlz" and "!rmpod" options description.
* modules/compressor: strip Perl files.
* modules/pkgdb: calculate estimated time for cook:pkgdb too (as well as for cook:package).
author | Aleksej Bobylev <al.bobylev@gmail.com> |
---|---|
date | Thu May 11 00:36:43 2017 +0300 (2017-05-11) |
parents | 111b6212516c |
children | e6e0957f3a48 |
rev | line source |
---|---|
al@834 | 1 You can use a variable COOKOPTS in the receipts to adjust certain aspects of the |
al@834 | 2 preparation of a package. Multiple options are allowed, that can be written |
al@834 | 3 together or separated by spaces, tabs or any other symbols. |
al@834 | 4 |
al@834 | 5 Example of use: |
al@834 | 6 |
al@834 | 7 COOKOPTS="!menus !pngz" |
al@834 | 8 |
al@834 | 9 |
al@834 | 10 Currently, the following options are recognized: |
al@834 | 11 |
al@834 | 12 !pixmaps |
al@838 | 13 Default action is to copy icons from a /usr/share/pixmaps folder as well as |
paul@839 | 14 from the stuff folder (the same action that made obsolete option |
al@838 | 15 `GENERIC_PIXMAPS="no"`). |
paul@839 | 16 The presence of this option overrides the default action (files will not be |
paul@839 | 17 automatically copied). |
al@834 | 18 |
al@848 | 19 !menus |
al@838 | 20 Default action is to copy desktop files from a /usr/share/applications |
al@838 | 21 folder (the same action that made obsolete option `GENERIC_MENUS="no"`). |
paul@839 | 22 The presence of this option overrides the default action (files will not be |
paul@839 | 23 automatically copied). |
al@834 | 24 |
al@834 | 25 !fixdesktops |
al@838 | 26 Default action is to fix common errors and warnings in the .desktop files. |
paul@839 | 27 The presence of this option overrides the default action (.desktop files |
paul@839 | 28 will not be changed). |
al@838 | 29 |
al@838 | 30 !i18nz |
al@838 | 31 1. Default action is to delete locales that are not currently supported by |
paul@839 | 32 SliTaz while processing desktop files. |
paul@839 | 33 The presence of this option overrides the default action (.desktop files |
paul@839 | 34 will contain the original set of locales). |
al@838 | 35 Please note, this option does not have any action if the `!fixdesktops` |
paul@839 | 36 option is provided (desktop files will not change in any way). |
al@838 | 37 2. Default action is to keep only supported translations provided by the |
al@838 | 38 *.mo files. |
paul@839 | 39 The presence of this option overrides the default action (all existing *.mo |
paul@839 | 40 files will remain). |
al@846 | 41 Please note, you can add all the translations to the package, for example, |
al@846 | 42 using the command: `cook_copy_files *.mo` (then by default only the |
al@846 | 43 supported locales will be left). |
al@838 | 44 |
al@838 | 45 !extradesktops |
al@846 | 46 Default action is to remove extra information from the desktop files: |
al@846 | 47 entries such as 'GenericName', 'X-GNOME-FullName' (all X-* are exposed), |
al@846 | 48 'Terminal=false', Keywords and other sections. This extra information just |
al@846 | 49 isn't supported in the current (LXDE) environment. |
paul@839 | 50 The presence of this option overrides the default action (extra information |
paul@839 | 51 will not be removed from the .desktop files). |
al@834 | 52 |
al@834 | 53 !strip |
al@838 | 54 Default action is to strip executable files, shared and static libraries, |
al@838 | 55 as well as remove Python (*.pyc and *.pyo) and Perl (perllocal.pod and |
al@838 | 56 .packlist) files. |
paul@839 | 57 The presence of this option overrides the default action (executable files |
paul@839 | 58 and libraries will not be stripped, and Python and Perl files will all be |
paul@839 | 59 left). |
al@834 | 60 |
al@899 | 61 !perlz |
al@899 | 62 Default action is to strip POD (plain old documentation) from the Perl |
al@899 | 63 modules (*.pm) and programs (*.pl) files. |
al@899 | 64 The presence of this option overrides the default action (Perl files will |
al@899 | 65 not be stripped). |
al@899 | 66 Note, if you disabled the cleaning by using the higher !strip option, Perl |
al@899 | 67 files also will not be stripped. |
al@899 | 68 |
al@899 | 69 !rmpod |
al@899 | 70 Default action is to remove Perl's POD (plain old documentation) (*.pod) |
al@899 | 71 files. |
al@899 | 72 The presence of this option overrides the default action (*.pod files will |
al@899 | 73 all be left). |
al@899 | 74 Note, if you disabled the cleaning by using the higher !strip option, *.pod |
al@899 | 75 files also will all be left. |
al@899 | 76 |
al@834 | 77 !manz |
al@838 | 78 Default action is to compress all man pages. |
paul@839 | 79 The presence of this option overrides the default action (all man pages will |
al@846 | 80 be left "as is"). Please note that these files may be installed in a |
al@846 | 81 compressed format. |
al@834 | 82 |
al@872 | 83 !gz |
al@872 | 84 Default action is to recompress all *.gz files (excluding man pages) with |
al@872 | 85 the better compression ratio. |
al@872 | 86 The presence of this option overrides the default action (all *.gzip files |
al@872 | 87 will be left "as is"). |
al@872 | 88 |
al@834 | 89 !pngz |
al@838 | 90 Default action is to compress all PNG images. Image compression allows you |
al@838 | 91 to save some space, but it takes a lot of time. |
paul@839 | 92 The presence of this option overrides the default action (all PNG images |
paul@839 | 93 will be left "as is"). |
al@834 | 94 |
al@834 | 95 !pngquant |
al@838 | 96 Default action is to use `pngquant` while compressing PNG images. Please |
al@838 | 97 note, `pngquant` produces indexed images (max 256 colors) which can be |
paul@839 | 98 inappropriate in some cases, a few programs (such as SLiM) will not |
al@838 | 99 recognize this PNG file format. |
paul@839 | 100 The presence of this option overrides the default action (`pngquant` will |
paul@839 | 101 not be used). |
al@834 | 102 |
al@834 | 103 !optipng |
al@838 | 104 Default action is to use `optipng` to compress PNG images. Please note, |
paul@839 | 105 `optipng` is a lossless PNG compressor. Using `pngquant` and `optipng` in |
paul@839 | 106 conjunction allows you to save more space. |
paul@839 | 107 The presence of this option overrides the default action (`optipng` will not |
paul@839 | 108 be used). |
al@834 | 109 |
al@834 | 110 op0 to op8 |
paul@839 | 111 Default action is to use optimization level 2 while processing PNG images by |
paul@839 | 112 `optipng`. Using this option you can set the desired `optipng` optimization |
al@846 | 113 level. The higher the level, the slower the compression and the smaller the |
al@846 | 114 file size. Please note that this option has no exclamation mark, because it |
al@846 | 115 means "don't do", and here, on the contrary, "to do". |
al@834 | 116 |
al@834 | 117 !svgz |
al@838 | 118 Default action is to compress all SVG images. |
paul@839 | 119 The presence of this option overrides the default action (all SVG images |
paul@839 | 120 will be left "as is"). |
al@836 | 121 |
al@836 | 122 !uiz |
al@838 | 123 Default action is to compress Glade UI files. Compression means the removal |
al@838 | 124 of insignificant spaces and comments. |
paul@839 | 125 The presence of this option overrides the default action (all *.ui and |
paul@839 | 126 *.glade files will be left "as is"). |
al@846 | 127 |
al@846 | 128 !monorm |
al@846 | 129 Default action is to normalize *.mo files. Normalization means the |
paul@847 | 130 unconditional conversion to UTF-8, removal of accidental duplicates and |
paul@847 | 131 most of the header lines as well as catalog entries that are not added to |
paul@847 | 132 the translation (when string in msgid equals to string in msgstr). |
al@846 | 133 The presence of this option overrides the default action (all *.mo files |
al@846 | 134 will be left "as is"). |