rev |
line source |
al@412
|
1 .TH "TazLiTo flavor" "1" "17.02.2016"
|
al@412
|
2 .SH NAME
|
al@412
|
3 Tazlito flavor file (\fB.flavor\fR).
|
al@412
|
4 .SH SYNOPSIS
|
al@412
|
5 \fIname\fB.flavor\fR
|
al@412
|
6 .SH DESCRIPTION
|
al@412
|
7 A \fB.flavor\fR is a small file contains information needed to (re)manufacture
|
al@412
|
8 a custom LiveCD of SliTaz.
|
al@412
|
9 .PP
|
al@412
|
10 .IB flavor .flavor
|
al@412
|
11 file is a cpio.gzip archive that contains next files inside:
|
al@412
|
12 .TP
|
al@412
|
13 .IB flavor .receipt
|
al@412
|
14 File describing the flavor using the variables:
|
al@412
|
15 .Bl -bullet
|
al@412
|
16 .It
|
al@412
|
17 FLAVOR: the flavor name
|
al@412
|
18 .It
|
al@412
|
19 SHORT_DESC: short description
|
al@412
|
20 .It
|
al@412
|
21 VERSION: free format
|
al@412
|
22 .It
|
al@412
|
23 MAINTAINER: e-mail address of the flavor maintainer
|
al@412
|
24 .It
|
al@412
|
25 FRUGAL_RAM: minimum RAM required (optional)
|
al@412
|
26 .It
|
al@412
|
27 ROOTFS_SIZE: size of rootfs.gz decompressed into RAM (optional)
|
al@412
|
28 .It
|
al@412
|
29 INITRAMFS_SIZE: size of rootfs.gz on the CD-ROM (optional)
|
al@412
|
30 .It
|
al@412
|
31 ISO_SIZE: size of CD-ROM (optional)
|
al@412
|
32 .It
|
al@412
|
33 ROOTFS_SELECTION: optional, see \fBMeta flavor below\fR.
|
al@412
|
34 .El
|
al@412
|
35 Receipt may contain function \fIcustom_rules()\fR executed after installing all
|
al@412
|
36 packages, adding custom rootfs files, and executing \fIdistro.sh\fR script.
|
al@412
|
37 .TP
|
al@412
|
38 .IB flavor .desc
|
al@412
|
39 File describing the flavor (the most of the information is taken from the
|
al@412
|
40 receipt): flavor name, description, version, maintainer e-mail, Live CD RAM
|
al@412
|
41 size, build date, number of the packages, rootFS size, initRAMFS size, ISO
|
al@412
|
42 image size.
|
al@412
|
43 .TP
|
al@412
|
44 .IB flavor .pkglist
|
al@412
|
45 List of packages without specifying the version (tazlito uses the latest
|
al@412
|
46 available). This file is missing if ROOTFS_SELECTION exists in the receipt.
|
al@412
|
47 .TP
|
al@412
|
48 .IB flavor .nonfree
|
al@412
|
49 Optional list of non-free packages.
|
al@412
|
50 .TP
|
al@412
|
51 .IB flavor -distro.sh
|
al@412
|
52 Optional script executed after installing all packages and adding custom rootfs
|
al@412
|
53 files to perform tasks in the rootfs before compression. Script executed with
|
al@412
|
54 argument $DISTRO defined in the tazlito.conf(5).
|
al@412
|
55 .TP
|
al@412
|
56 .IB flavor .mirrors
|
al@412
|
57 Optional file containing the list of undigest (unofficial) mirrors to be added
|
al@412
|
58 to include personal packages.
|
al@412
|
59 .TP
|
al@412
|
60 .IB flavor .rootfs
|
al@412
|
61 Optional cpio.gzip archive containing the root filesystem tree (so it should
|
al@412
|
62 contain all the necessary top-level directories such as bin, etc, usr...).
|
al@412
|
63 Files contained in this archive will be directly extracted to the root
|
al@412
|
64 filesystem of the prepared flavor (configuration files usually).
|
al@412
|
65 .TP
|
al@412
|
66 .IB flavor .rootcd
|
al@412
|
67 Optional cpio.gzip archive that files and folders will be directly extracted to
|
al@412
|
68 the root of the CD-ROM.
|
al@412
|
69 .SH WORKING WITH FLAVORS
|
al@412
|
70 .SS Manufacture a flavor
|
al@412
|
71 You can choose the flavor to (re)manufacture from among those available:
|
al@412
|
72 .nf
|
al@412
|
73 $ tazlito list-flavors
|
al@412
|
74 .fi
|
al@412
|
75 .B List of flavors
|
al@412
|
76 .TS
|
al@412
|
77 l r r l.
|
al@412
|
78 \fBName\fR \fBISO\fR \fBRootfs\fR \fBDescription\fR
|
al@412
|
79 _
|
al@412
|
80 base 12.0M 21.0M Minimal set of packages to boot
|
al@412
|
81 core-4in1 42.0M 152.4M SliTaz core system with justX and base alternatives
|
al@412
|
82 core 31.5M 104.6M SliTaz core system
|
al@412
|
83 eeepc 31.2M 105.4M SliTaz eeepc system
|
al@412
|
84 justX 16.1M 51.2M SliTaz with a minimal X environment
|
al@412
|
85 .TE
|
al@412
|
86 .PP
|
al@412
|
87 We will start by remanufacturing the
|
al@412
|
88 .I eeepc
|
al@412
|
89 flavor which uses 105.4M of RAM and has a CD-ROM size of 31.2M:
|
al@412
|
90 .nf
|
al@412
|
91 # tazlito clean-distro
|
al@412
|
92 # tazlito get-flavor \fIeeepc\fR
|
al@412
|
93 # tazlito gen-distro
|
al@412
|
94 .fi
|
al@412
|
95 .SS Create a flavor
|
al@412
|
96 To create a flavor, you must:
|
al@412
|
97 .Bl -bullet
|
al@412
|
98 .It
|
al@412
|
99 Either create an ISO image with
|
al@412
|
100 .B tazlito gen-distro
|
al@412
|
101 and then create a flavor file with
|
al@412
|
102 .B tazlito gen-flavor
|
al@412
|
103 .It
|
al@412
|
104 Either directly create the tree structure that defines the flavor (see
|
al@412
|
105 .BR "tazlito extract-flavor" )
|
al@412
|
106 and then create the flavor with
|
al@412
|
107 .B tazlito pack-flavor
|
al@412
|
108 .It
|
al@412
|
109 Either use the
|
al@412
|
110 .B online builder
|
al@412
|
111 http://pizza.slitaz.org/
|
al@412
|
112 .El
|
al@412
|
113 .SS Post a flavor
|
al@412
|
114 Because a
|
al@412
|
115 .I .flavor
|
al@412
|
116 file contains just a few KB, it can be easily sent via the
|
al@412
|
117 mailing list
|
al@412
|
118 .RI ( http://www.slitaz.org/en/mailing-list.php ).
|
al@412
|
119 .PP
|
al@412
|
120 The results of
|
al@412
|
121 .B tazlito extract-flavor
|
al@412
|
122 can also be put in mercurial
|
al@412
|
123 .RI ( http://hg.slitaz.org/flavors ).
|
al@412
|
124 This method is preferred because the tree will be directly visible with the
|
al@412
|
125 mercurial web interface
|
al@412
|
126 .RI ( http://hg.slitaz.org/flavors/file/tip ).
|
al@412
|
127 .PP
|
al@412
|
128 This tree includes:
|
al@412
|
129 .Bl -bullet
|
al@412
|
130 .It
|
al@412
|
131 A \fBreceipt\fR file describing the flavor thanks to the variables:
|
al@412
|
132 .Bl -bullet
|
al@412
|
133 .It
|
al@412
|
134 FLAVOR: The flavor name.
|
al@412
|
135 .It
|
al@412
|
136 SHORT_DESC: Short description.
|
al@412
|
137 .It
|
al@412
|
138 VERSION: Free format.
|
al@412
|
139 .It
|
al@412
|
140 MAINTAINER: Email address of maintainer.
|
al@412
|
141 .It
|
al@412
|
142 FRUGAL_RAM: Minimum RAM required (optional).
|
al@412
|
143 .It
|
al@412
|
144 ROOTFS_SIZE: Size of rootfs.gz decompressed into RAM (optional).
|
al@412
|
145 .It
|
al@412
|
146 INITRAMFS_SIZE: Size of rootfs.gz on the CD-ROM (optional).
|
al@412
|
147 .It
|
al@412
|
148 ISO_SIZE: Size of CD-ROM (optional).
|
al@412
|
149 .It
|
al@412
|
150 ROOTFS_SELECTION: Optional, see \fBMeta flavor\fR below.
|
al@412
|
151 .El
|
al@412
|
152 .It
|
al@412
|
153 The file \fBpackages.list\fR containing the list of packages without specifying
|
al@412
|
154 the version (tazlito uses the latest available). This file is missing if
|
al@412
|
155 ROOTFS_SELECTION exists in the receipt.
|
al@412
|
156 .It
|
al@412
|
157 The optional \fBmirrors\fR file containing the list of unofficial mirrors
|
al@412
|
158 (undigest) to be added to include personal packages.
|
al@412
|
159 .It
|
al@412
|
160 The optional directory \fBrootfs\fR containing the tree to add to the root
|
al@412
|
161 filesystem rootfs.gz (configuration files usually).
|
al@412
|
162 .It
|
al@412
|
163 The optional directory \fBrootcd\fR containing the tree to add to the root of
|
al@412
|
164 the CD-ROM.
|
al@412
|
165 .El
|
al@412
|
166 .SS Adapt a flavor
|
al@412
|
167 It is often easier to modify an existing flavor than to create one from
|
al@412
|
168 scratch. To adapt the eeepc flavor for example:
|
al@412
|
169 .nf
|
al@412
|
170 # tazpkg get-install mercurial
|
al@412
|
171 # cd /home/slitaz
|
al@412
|
172 # hg clone http://hg.slitaz.org/flavors
|
al@412
|
173 # cd flavors
|
al@412
|
174 # cp -a \fIeeepc myslitaz\fR
|
al@412
|
175 .fi
|
al@412
|
176 Files in \fImyslitaz\fR can then be changed, and:
|
al@412
|
177 .nf
|
al@412
|
178 # tazlito pack-flavor \fImyslitaz\fR
|
al@412
|
179 .fi
|
al@412
|
180 Will simply create the new flavor.
|
al@412
|
181 .PP
|
al@412
|
182 Tip: you can skip mercurial installation by extracting a flavor. Using the
|
al@412
|
183 previous example:
|
al@412
|
184 .nf
|
al@412
|
185 # tazlito get-flavor \fIeeepc\fR
|
al@412
|
186 # tazlito extract-flavor \fIeeepc.flavor\fR
|
al@412
|
187 # cd /home/slitaz/flavors
|
al@412
|
188 # cp -a \fIeeepc myslitaz\fR
|
al@412
|
189 .fi
|
al@412
|
190 .SS Meta flavor
|
al@412
|
191 A meta flavor contains several flavors like nested Russian dolls. The flavor
|
al@412
|
192 will be launched at startup according to the amount of RAM available. The
|
al@412
|
193 ROOTFS_SELECTION variable defines the minimum RAM and corresponding flavor
|
al@412
|
194 parameters, example
|
al@412
|
195 .RI ( http://hg.slitaz.org/flavors/file/tip/core-4in1/receipt ):
|
al@412
|
196 .nf
|
al@412
|
197 ROOTFS_SELECTION="160M core 96M justX 32M base"
|
al@412
|
198 .fi
|
al@412
|
199 A meta flavor doesn't contain a list of packages (\fIpackages.list\fR). SliTaz
|
al@412
|
200 kernels prior to 2.6.30 do not support meta flavors.
|
al@412
|
201 .SH SEE ALSO
|
al@412
|
202 tazlito(1), tazlito.conf(5).
|