cookutils annotate doc/cookopts.txt @ rev 1094

doc/cookopts.txt: explain force-arch option
author Aleksej Bobylev <al.bobylev@gmail.com>
date Mon Nov 26 12:13:01 2018 +0200 (2018-11-26)
parents 307bb45d96c2
children 8e94062e3045
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
paul@900 63 modules (*.pm) and program (*.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@954 86 The presence of this option overrides the default action (all *.gz files
al@954 87 will be left "as is").
al@954 88
al@954 89 !zip
al@954 90 Default action is to recompress all *.zip files with the better compression
al@954 91 ratio.
al@954 92 The presence of this option overrides the default action (all *.zip files
al@872 93 will be left "as is").
al@872 94
al@834 95 !pngz
al@838 96 Default action is to compress all PNG images. Image compression allows you
al@838 97 to save some space, but it takes a lot of time.
paul@839 98 The presence of this option overrides the default action (all PNG images
paul@839 99 will be left "as is").
al@834 100
al@834 101 !pngquant
al@838 102 Default action is to use `pngquant` while compressing PNG images. Please
al@838 103 note, `pngquant` produces indexed images (max 256 colors) which can be
paul@839 104 inappropriate in some cases, a few programs (such as SLiM) will not
al@838 105 recognize this PNG file format.
paul@839 106 The presence of this option overrides the default action (`pngquant` will
paul@839 107 not be used).
al@834 108
al@834 109 !optipng
al@838 110 Default action is to use `optipng` to compress PNG images. Please note,
paul@839 111 `optipng` is a lossless PNG compressor. Using `pngquant` and `optipng` in
paul@839 112 conjunction allows you to save more space.
paul@839 113 The presence of this option overrides the default action (`optipng` will not
paul@839 114 be used).
al@834 115
al@834 116 op0 to op8
paul@839 117 Default action is to use optimization level 2 while processing PNG images by
paul@839 118 `optipng`. Using this option you can set the desired `optipng` optimization
al@846 119 level. The higher the level, the slower the compression and the smaller the
al@846 120 file size. Please note that this option has no exclamation mark, because it
al@846 121 means "don't do", and here, on the contrary, "to do".
al@834 122
al@834 123 !svgz
al@838 124 Default action is to compress all SVG images.
paul@839 125 The presence of this option overrides the default action (all SVG images
paul@839 126 will be left "as is").
al@836 127
al@959 128 !svgextra
al@959 129 Default options assumed applying transformation to paths and reducing the
al@959 130 accuracy of the coordinates to the tenth.
al@959 131 The presence of this option overrides the default behaviour (transformations
al@959 132 will not be applied to paths and default numeric precision will be 6 digits
al@959 133 after the dot).
al@959 134
al@1064 135 !gifz
al@1064 136 Default action is to compress all GIF images.
al@1064 137 The presence of this option overrides the default action (all GIF images
al@1064 138 will be left "as is").
al@1064 139
al@836 140 !uiz
al@838 141 Default action is to compress Glade UI files. Compression means the removal
al@838 142 of insignificant spaces and comments.
paul@839 143 The presence of this option overrides the default action (all *.ui and
paul@839 144 *.glade files will be left "as is").
al@846 145
al@846 146 !monorm
al@846 147 Default action is to normalize *.mo files. Normalization means the
paul@847 148 unconditional conversion to UTF-8, removal of accidental duplicates and
paul@847 149 most of the header lines as well as catalog entries that are not added to
paul@847 150 the translation (when string in msgid equals to string in msgstr).
al@846 151 The presence of this option overrides the default action (all *.mo files
al@846 152 will be left "as is").
al@962 153
al@962 154 skip-log-errors
al@962 155 Default behaviour is to end work with error message when certain words occur
al@962 156 in the log: "ERROR" or "undefined reference to". In some cases it may
paul@965 157 produce false positives when no errors are produced during cooking, but these
al@962 158 words occur. For example, next line:
al@962 159 g_simple_async_result_set_error (simple, G_IO_ERROR, G_IO_ERROR_FAILED
al@962 160 The presence of this option overrides the default behaviour (word "ERROR" in
paul@965 161 the log will not produce errors, etc.)
al@969 162
al@969 163 empty-pkg
al@969 164 Default behaviour is to end work with error message when package contains no
paul@970 165 files (exception is made for packages belonging to the "meta" category).
al@969 166 Presence of this option allows the package not to contain files.
al@1079 167
al@1079 168 instant-pack
al@1079 169 Usual behaviour is to make the sources (when sources in the $src became
al@1079 170 files in the $install) and then pack the package (when files from $install
paul@1084 171 split to one or another $fs and then became the *.tazpkg archives).
paul@1084 172 When multiple SETs are used in the receipt, the default behaviour is to make
paul@1084 173 all the sources for all the sets and only then to pack all the packages.
al@1079 174 Presence of this option will pack the SET packages instantly before
al@1079 175 to switch to another SET. So, packages created in the first SET will be
paul@1084 176 immediately available to use in the second SET and so on.
al@1094 177
al@1094 178 force-arch
al@1094 179 Architecture of the package determined by examining executable files on
al@1094 180 a packing stage. System with "i486" architecture may produce packages with
al@1094 181 architecture "i486" or "any" (if there's no architecture-dependent files
al@1094 182 like shared libraries or binaries were found, but only Shell, Python, Perl
al@1094 183 scripts, fonts, icons, and so on). System with "x86_64" architecture may
al@1094 184 produce packages with architecture "x86_64" or "any".
al@1094 185 In rare cases architecture-independent packages built in "i486" and "x86_64"
al@1094 186 environments may have architecture-dependent settings in configuration
al@1094 187 files. Or package may provide architecture-dependent paths (Perl modules
al@1094 188 packages) - this checking not implemented yet. Or package may contain some
al@1094 189 files for other architecture and you need to override default behavior.
al@1094 190 In all these cases you can use this option and architecture of all packages
al@1094 191 produced with this receipt will be the same as build environment has.