cookutils annotate doc/cookopts.txt @ rev 838

cook: strip unsupported translations. Rewrite the doc in cookopts.txt.
author Aleksej Bobylev <al.bobylev@gmail.com>
date Thu Nov 17 01:28:30 2016 +0200 (2016-11-17)
parents 11a3c021e563
children ab44ce9b38bb
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
al@838 14 from stuff folder (the same action that made obsolete option
al@838 15 `GENERIC_PIXMAPS="no"`).
al@838 16 The presence of this option overrides the default action: files will not be
al@838 17 automatically copied.
al@834 18
al@834 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"`).
al@838 22 The presence of this option overrides the default action: files will not be
al@838 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.
al@838 27 The presence of this option overrides the default action: .desktop files
al@838 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
al@838 32 the SliTaz while processing desktop files.
al@838 33 The presence of this option overrides the default action: .desktop files
al@838 34 will contain the original set of locales.
al@838 35 Please note, this option does not have any action if the `!fixdesktops`
al@838 36 option provided: desktop files in any way not change.
al@838 37 2. Default action is to keep only supported translations provided by the
al@838 38 *.mo files.
al@838 39 The presence of this option overrides the default action: all existing *.mo
al@838 40 files will remain.
al@838 41 Please note, you can add all translations to the package, for example, using
al@838 42 command: `cook_copy_files *.mo`, and then by default only supported locales
al@838 43 will be left.
al@838 44
al@838 45 !extradesktops
al@838 46 Default action is to remove extra information from the desktop files: such
al@838 47 entries as 'GenericName', 'X-GNOME-FullName' (all X-* are exposed),
al@838 48 'Terminal=false', Keywords, other sections. This extra information just not
al@838 49 supported in the current (LXDE) environment.
al@838 50 The presence of this option overrides the default action: extra information
al@838 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.
al@838 57 The presence of this option overrides the default action: executable files
al@838 58 and libraries will not be stripped, and Python and Perl files all will be
al@838 59 left.
al@834 60
al@834 61 !manz
al@838 62 Default action is to compress all man pages.
al@838 63 The presence of this option overrides the default action: all man pages will
al@838 64 be left "as is". Please note that these files may be installed in compressed
al@838 65 form.
al@834 66
al@834 67 !pngz
al@838 68 Default action is to compress all PNG images. Image compression allows you
al@838 69 to save some space, but it takes a lot of time.
al@838 70 The presence of this option overrides the default action: all PNG images
al@838 71 will be left "as is".
al@834 72
al@834 73 !pngquant
al@838 74 Default action is to use `pngquant` while compressing PNG images. Please
al@838 75 note, `pngquant` produces indexed images (max 256 colors) which can be
al@838 76 inappropriate in some cases: a few programs (such as SLiM) will not
al@838 77 recognize this PNG file format.
al@838 78 The presence of this option overrides the default action: `pngquant` will
al@838 79 not be used.
al@834 80
al@834 81 !optipng
al@838 82 Default action is to use `optipng` to compress PNG images. Please note,
al@838 83 `optipng` is lossless PNG compressor. Using `pngquant` and `optipng` in
al@838 84 conjunction allows to save more space.
al@838 85 The presence of this option overrides the default action: `optipng` will not
al@838 86 be used.
al@834 87
al@834 88 op0 to op8
al@838 89 Default action is to use opimization level 2 while processing PNG images by
al@838 90 `optipng`. Using this option you can set desired `optipng` optimization
al@838 91 level. The higher the level, the slower compression and the smaller file
al@838 92 size. Please note that this option has no exclamation mark, because it means
al@838 93 "don't do", and here, on the contrary, "to do".
al@834 94
al@834 95 !svgz
al@838 96 Default action is to compress all SVG images.
al@838 97 The presence of this option overrides the default action: all SVG images
al@838 98 will be left "as is".
al@836 99
al@836 100 !uiz
al@838 101 Default action is to compress Glade UI files. Compression means the removal
al@838 102 of insignificant spaces and comments.
al@838 103 The presence of this option overrides the default action: all *.ui and
al@838 104 *.glade files will be left "as is".