cookutils view doc/cookopts.txt @ rev 1148

cook: typo
author Pascal Bellard <pascal.bellard@slitaz.org>
date Tue Nov 09 15:36:25 2021 +0000 (2021-11-09)
parents 5dcdc6015a2d
children
line source
1 You can use a variable COOKOPTS in the receipts to adjust certain aspects of the
2 preparation of a package. Multiple options are allowed, that can be written
3 together or separated by spaces, tabs or any other symbols.
4
5 Example of use:
6
7 COOKOPTS="!menus !pngz"
8
9
10 Currently, the following options are recognized:
11
12 !pixmaps
13 Default action is to copy icons from a /usr/share/pixmaps folder as well as
14 from the stuff folder (the same action that made obsolete option
15 `GENERIC_PIXMAPS="no"`).
16 The presence of this option overrides the default action (files will not be
17 automatically copied).
18
19 !menus
20 Default action is to copy desktop files from a /usr/share/applications
21 folder (the same action that made obsolete option `GENERIC_MENUS="no"`).
22 The presence of this option overrides the default action (files will not be
23 automatically copied).
24
25 !fixdesktops
26 Default action is to fix common errors and warnings in the .desktop files.
27 The presence of this option overrides the default action (.desktop files
28 will not be changed).
29
30 !i18nz
31 1. Default action is to delete locales that are not currently supported by
32 SliTaz while processing desktop files.
33 The presence of this option overrides the default action (.desktop files
34 will contain the original set of locales).
35 Please note, this option does not have any action if the `!fixdesktops`
36 option is provided (desktop files will not change in any way).
37 2. Default action is to keep only supported translations provided by the
38 *.mo files.
39 The presence of this option overrides the default action (all existing *.mo
40 files will remain).
41 Please note, you can add all the translations to the package, for example,
42 using the command: `copy *.mo` (then by default only the supported locales
43 will be left).
44
45 !extradesktops
46 Default action is to remove extra information from the desktop files:
47 entries such as 'GenericName', 'X-GNOME-FullName' (all X-* are exposed),
48 'Terminal=false', Keywords and other sections. This extra information just
49 isn't supported in the current (LXDE) environment.
50 The presence of this option overrides the default action (extra information
51 will not be removed from the .desktop files).
52
53 !strip
54 Default action is to strip executable files, shared and static libraries,
55 as well as remove Python (*.pyc and *.pyo) and Perl (perllocal.pod and
56 .packlist) files.
57 The presence of this option overrides the default action (executable files
58 and libraries will not be stripped, and Python and Perl files will all be
59 left).
60
61 !perlz
62 Default action is to strip POD (plain old documentation) from the Perl
63 modules (*.pm) and program (*.pl) files.
64 The presence of this option overrides the default action (Perl files will
65 not be stripped).
66 Note, if you disabled the cleaning by using the higher !strip option, Perl
67 files also will not be stripped.
68
69 !rmpod
70 Default action is to remove Perl's POD (plain old documentation) (*.pod)
71 files.
72 The presence of this option overrides the default action (*.pod files will
73 all be left).
74 Note, if you disabled the cleaning by using the higher !strip option, *.pod
75 files also will all be left.
76
77 !manz
78 Default action is to compress all man pages.
79 The presence of this option overrides the default action (all man pages will
80 be left "as is"). Please note that these files may be installed in a
81 compressed format.
82
83 !gz
84 Default action is to recompress all *.gz files (excluding man pages) with
85 the better compression ratio.
86 The presence of this option overrides the default action (all *.gz files
87 will be left "as is").
88
89 !zip
90 Default action is to recompress all *.zip files with the better compression
91 ratio.
92 The presence of this option overrides the default action (all *.zip files
93 will be left "as is").
94
95 !pngz
96 Default action is to compress all PNG images. Image compression allows you
97 to save some space, but it takes a lot of time.
98 The presence of this option overrides the default action (all PNG images
99 will be left "as is").
100
101 !pngquant
102 Default action is to use `pngquant` while compressing PNG images. Please
103 note, `pngquant` produces indexed images (max 256 colors) which can be
104 inappropriate in some cases, a few programs (such as SLiM) will not
105 recognize this PNG file format.
106 The presence of this option overrides the default action (`pngquant` will
107 not be used).
108
109 !optipng
110 Default action is to use `optipng` to compress PNG images. Please note,
111 `optipng` is a lossless PNG compressor. Using `pngquant` and `optipng` in
112 conjunction allows you to save more space.
113 The presence of this option overrides the default action (`optipng` will not
114 be used).
115
116 op0 to op8
117 Default action is to use optimization level 2 while processing PNG images by
118 `optipng`. Using this option you can set the desired `optipng` optimization
119 level. The higher the level, the slower the compression and the smaller the
120 file size. Please note that this option has no exclamation mark, because it
121 means "don't do", and here, on the contrary, "to do".
122
123 !svgz
124 Default action is to compress all SVG images.
125 The presence of this option overrides the default action (all SVG images
126 will be left "as is").
127
128 !svgextra
129 Default options assumed applying transformation to paths and reducing the
130 accuracy of the coordinates to the tenth.
131 The presence of this option overrides the default behaviour (transformations
132 will not be applied to paths and default numeric precision will be 6 digits
133 after the dot).
134
135 !gifz
136 Default action is to compress all GIF images.
137 The presence of this option overrides the default action (all GIF images
138 will be left "as is").
139
140 !uiz
141 Default action is to compress Glade UI files. Compression means the removal
142 of insignificant spaces and comments.
143 The presence of this option overrides the default action (all *.ui and
144 *.glade files will be left "as is").
145
146 !cssz
147 Default action is to compress CSS files. Compression means the removal
148 of insignificant spaces and comments.
149 The presence of this option overrides the default action (all *.css files
150 will be left "as is").
151
152 !monorm
153 Default action is to normalize *.mo files. Normalization means the
154 unconditional conversion to UTF-8, removal of accidental duplicates and
155 most of the header lines as well as catalog entries that are not added to
156 the translation (when string in msgid equals to string in msgstr).
157 The presence of this option overrides the default action (all *.mo files
158 will be left "as is").
159
160 skip-log-errors
161 Default behaviour is to end work with error message when certain words occur
162 in the log: "ERROR" or "undefined reference to". In some cases it may
163 produce false positives when no errors are produced during cooking, but these
164 words occur. For example, next line:
165 g_simple_async_result_set_error (simple, G_IO_ERROR, G_IO_ERROR_FAILED
166 The presence of this option overrides the default behaviour (word "ERROR" in
167 the log will not produce errors, etc.)
168
169 empty-pkg
170 Default behaviour is to end work with error message when package contains no
171 files (exception is made for packages belonging to the "meta" category).
172 Presence of this option allows the package not to contain files.
173
174 instant-pack
175 Usual behaviour is to make the sources (when sources in the $src became
176 files in the $install) and then pack the package (when files from $install
177 split to one or another $fs and then became the *.tazpkg archives).
178 When multiple SETs are used in the receipt, the default behaviour is to make
179 all the sources for all the sets and only then to pack all the packages.
180 Presence of this option will pack the SET packages instantly before
181 to switch to another SET. So, packages created in the first SET will be
182 immediately available to use in the second SET and so on.
183
184 force-arch
185 Architecture of the package determined by examining executable files on
186 a packing stage. System with "i486" architecture may produce packages with
187 architecture "i486" or "any" (if there's no architecture-dependent no files
188 like shared libraries or binaries are found, but only Shell, Python, Perl
189 scripts, fonts, icons, and so on). System with "x86_64" architecture may
190 produce packages with architecture "x86_64" or "any".
191 In rare cases architecture-independent packages built in "i486" and "x86_64"
192 environments may have architecture-dependent settings in configuration
193 files or package may provide architecture-dependent paths (Perl modules
194 packages) - this checking is not implemented yet or package may contain some
195 files for another architecture and you need to override default behavior.
196 In all these cases you can use this option and architecture of all packages
197 produced with this receipt will be the same as the build environment.