cookutils view doc/cookopts.txt @ rev 1064

modules/compressor: compress (optimize) GIF images using gifsicle
author Aleksej Bobylev <al.bobylev@gmail.com>
date Wed Jun 06 00:00:22 2018 +0300 (2018-06-06)
parents 68c17954b51b
children 64c16be1dda4
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: `cook_copy_files *.mo` (then by default only the
43 supported locales 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 !monorm
147 Default action is to normalize *.mo files. Normalization means the
148 unconditional conversion to UTF-8, removal of accidental duplicates and
149 most of the header lines as well as catalog entries that are not added to
150 the translation (when string in msgid equals to string in msgstr).
151 The presence of this option overrides the default action (all *.mo files
152 will be left "as is").
153
154 skip-log-errors
155 Default behaviour is to end work with error message when certain words occur
156 in the log: "ERROR" or "undefined reference to". In some cases it may
157 produce false positives when no errors are produced during cooking, but these
158 words occur. For example, next line:
159 g_simple_async_result_set_error (simple, G_IO_ERROR, G_IO_ERROR_FAILED
160 The presence of this option overrides the default behaviour (word "ERROR" in
161 the log will not produce errors, etc.)
162
163 empty-pkg
164 Default behaviour is to end work with error message when package contains no
165 files (exception is made for packages belonging to the "meta" category).
166 Presence of this option allows the package not to contain files.