tazlito diff man/flavor.5 @ rev 483
Russian dolls should update /cdrom/boot too
author | Pascal Bellard <pascal.bellard@slitaz.org> |
---|---|
date | Thu Feb 22 22:52:39 2018 +0100 (2018-02-22) |
parents | |
children |
line diff
1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/man/flavor.5 Thu Feb 22 22:52:39 2018 +0100 1.3 @@ -0,0 +1,202 @@ 1.4 +.TH "TazLiTo flavor" "1" "17.02.2016" 1.5 +.SH NAME 1.6 +Tazlito flavor file (\fB.flavor\fR). 1.7 +.SH SYNOPSIS 1.8 +\fIname\fB.flavor\fR 1.9 +.SH DESCRIPTION 1.10 +A \fB.flavor\fR is a small file contains information needed to (re)manufacture 1.11 +a custom LiveCD of SliTaz. 1.12 +.PP 1.13 +.IB flavor .flavor 1.14 +file is a cpio.gzip archive that contains next files inside: 1.15 +.TP 1.16 +.IB flavor .receipt 1.17 +File describing the flavor using the variables: 1.18 +.Bl -bullet 1.19 +.It 1.20 +FLAVOR: the flavor name 1.21 +.It 1.22 +SHORT_DESC: short description 1.23 +.It 1.24 +VERSION: free format 1.25 +.It 1.26 +MAINTAINER: e-mail address of the flavor maintainer 1.27 +.It 1.28 +FRUGAL_RAM: minimum RAM required (optional) 1.29 +.It 1.30 +ROOTFS_SIZE: size of rootfs.gz decompressed into RAM (optional) 1.31 +.It 1.32 +INITRAMFS_SIZE: size of rootfs.gz on the CD-ROM (optional) 1.33 +.It 1.34 +ISO_SIZE: size of CD-ROM (optional) 1.35 +.It 1.36 +ROOTFS_SELECTION: optional, see \fBMeta flavor below\fR. 1.37 +.El 1.38 +Receipt may contain function \fIcustom_rules()\fR executed after installing all 1.39 +packages, adding custom rootfs files, and executing \fIdistro.sh\fR script. 1.40 +.TP 1.41 +.IB flavor .desc 1.42 +File describing the flavor (the most of the information is taken from the 1.43 +receipt): flavor name, description, version, maintainer e-mail, Live CD RAM 1.44 +size, build date, number of the packages, rootFS size, initRAMFS size, ISO 1.45 +image size. 1.46 +.TP 1.47 +.IB flavor .pkglist 1.48 +List of packages without specifying the version (tazlito uses the latest 1.49 +available). This file is missing if ROOTFS_SELECTION exists in the receipt. 1.50 +.TP 1.51 +.IB flavor .nonfree 1.52 +Optional list of non-free packages. 1.53 +.TP 1.54 +.IB flavor -distro.sh 1.55 +Optional script executed after installing all packages and adding custom rootfs 1.56 +files to perform tasks in the rootfs before compression. Script executed with 1.57 +argument $DISTRO defined in the tazlito.conf(5). 1.58 +.TP 1.59 +.IB flavor .mirrors 1.60 +Optional file containing the list of undigest (unofficial) mirrors to be added 1.61 +to include personal packages. 1.62 +.TP 1.63 +.IB flavor .rootfs 1.64 +Optional cpio.gzip archive containing the root filesystem tree (so it should 1.65 +contain all the necessary top-level directories such as bin, etc, usr...). 1.66 +Files contained in this archive will be directly extracted to the root 1.67 +filesystem of the prepared flavor (configuration files usually). 1.68 +.TP 1.69 +.IB flavor .rootcd 1.70 +Optional cpio.gzip archive that files and folders will be directly extracted to 1.71 +the root of the CD-ROM. 1.72 +.SH WORKING WITH FLAVORS 1.73 +.SS Manufacture a flavor 1.74 +You can choose the flavor to (re)manufacture from among those available: 1.75 +.nf 1.76 +$ tazlito list-flavors 1.77 +.fi 1.78 +.B List of flavors 1.79 +.TS 1.80 +l r r l. 1.81 +\fBName\fR \fBISO\fR \fBRootfs\fR \fBDescription\fR 1.82 +_ 1.83 +base 12.0M 21.0M Minimal set of packages to boot 1.84 +core-4in1 42.0M 152.4M SliTaz core system with justX and base alternatives 1.85 +core 31.5M 104.6M SliTaz core system 1.86 +eeepc 31.2M 105.4M SliTaz eeepc system 1.87 +justX 16.1M 51.2M SliTaz with a minimal X environment 1.88 +.TE 1.89 +.PP 1.90 +We will start by remanufacturing the 1.91 +.I eeepc 1.92 +flavor which uses 105.4M of RAM and has a CD-ROM size of 31.2M: 1.93 +.nf 1.94 +# tazlito clean-distro 1.95 +# tazlito get-flavor \fIeeepc\fR 1.96 +# tazlito gen-distro 1.97 +.fi 1.98 +.SS Create a flavor 1.99 +To create a flavor, you must: 1.100 +.Bl -bullet 1.101 +.It 1.102 +Either create an ISO image with 1.103 +.B tazlito gen-distro 1.104 +and then create a flavor file with 1.105 +.B tazlito gen-flavor 1.106 +.It 1.107 +Either directly create the tree structure that defines the flavor (see 1.108 +.BR "tazlito extract-flavor" ) 1.109 +and then create the flavor with 1.110 +.B tazlito pack-flavor 1.111 +.It 1.112 +Either use the 1.113 +.B online builder 1.114 +http://pizza.slitaz.org/ 1.115 +.El 1.116 +.SS Post a flavor 1.117 +Because a 1.118 +.I .flavor 1.119 +file contains just a few KB, it can be easily sent via the 1.120 +mailing list 1.121 +.RI ( http://www.slitaz.org/en/mailing-list.php ). 1.122 +.PP 1.123 +The results of 1.124 +.B tazlito extract-flavor 1.125 +can also be put in mercurial 1.126 +.RI ( http://hg.slitaz.org/flavors ). 1.127 +This method is preferred because the tree will be directly visible with the 1.128 +mercurial web interface 1.129 +.RI ( http://hg.slitaz.org/flavors/file/tip ). 1.130 +.PP 1.131 +This tree includes: 1.132 +.Bl -bullet 1.133 +.It 1.134 +A \fBreceipt\fR file describing the flavor thanks to the variables: 1.135 +.Bl -bullet 1.136 +.It 1.137 +FLAVOR: The flavor name. 1.138 +.It 1.139 +SHORT_DESC: Short description. 1.140 +.It 1.141 +VERSION: Free format. 1.142 +.It 1.143 +MAINTAINER: Email address of maintainer. 1.144 +.It 1.145 +FRUGAL_RAM: Minimum RAM required (optional). 1.146 +.It 1.147 +ROOTFS_SIZE: Size of rootfs.gz decompressed into RAM (optional). 1.148 +.It 1.149 +INITRAMFS_SIZE: Size of rootfs.gz on the CD-ROM (optional). 1.150 +.It 1.151 +ISO_SIZE: Size of CD-ROM (optional). 1.152 +.It 1.153 +ROOTFS_SELECTION: Optional, see \fBMeta flavor\fR below. 1.154 +.El 1.155 +.It 1.156 +The file \fBpackages.list\fR containing the list of packages without specifying 1.157 +the version (tazlito uses the latest available). This file is missing if 1.158 +ROOTFS_SELECTION exists in the receipt. 1.159 +.It 1.160 +The optional \fBmirrors\fR file containing the list of unofficial mirrors 1.161 +(undigest) to be added to include personal packages. 1.162 +.It 1.163 +The optional directory \fBrootfs\fR containing the tree to add to the root 1.164 +filesystem rootfs.gz (configuration files usually). 1.165 +.It 1.166 +The optional directory \fBrootcd\fR containing the tree to add to the root of 1.167 +the CD-ROM. 1.168 +.El 1.169 +.SS Adapt a flavor 1.170 +It is often easier to modify an existing flavor than to create one from 1.171 +scratch. To adapt the eeepc flavor for example: 1.172 +.nf 1.173 +# tazpkg get-install mercurial 1.174 +# cd /home/slitaz 1.175 +# hg clone http://hg.slitaz.org/flavors 1.176 +# cd flavors 1.177 +# cp -a \fIeeepc myslitaz\fR 1.178 +.fi 1.179 +Files in \fImyslitaz\fR can then be changed, and: 1.180 +.nf 1.181 +# tazlito pack-flavor \fImyslitaz\fR 1.182 +.fi 1.183 +Will simply create the new flavor. 1.184 +.PP 1.185 +Tip: you can skip mercurial installation by extracting a flavor. Using the 1.186 +previous example: 1.187 +.nf 1.188 +# tazlito get-flavor \fIeeepc\fR 1.189 +# tazlito extract-flavor \fIeeepc.flavor\fR 1.190 +# cd /home/slitaz/flavors 1.191 +# cp -a \fIeeepc myslitaz\fR 1.192 +.fi 1.193 +.SS Meta flavor 1.194 +A meta flavor contains several flavors like nested Russian dolls. The flavor 1.195 +will be launched at startup according to the amount of RAM available. The 1.196 +ROOTFS_SELECTION variable defines the minimum RAM and corresponding flavor 1.197 +parameters, example 1.198 +.RI ( http://hg.slitaz.org/flavors/file/tip/core-4in1/receipt ): 1.199 +.nf 1.200 +ROOTFS_SELECTION="160M core 96M justX 32M base" 1.201 +.fi 1.202 +A meta flavor doesn't contain a list of packages (\fIpackages.list\fR). SliTaz 1.203 +kernels prior to 2.6.30 do not support meta flavors. 1.204 +.SH SEE ALSO 1.205 +tazlito(1), tazlito.conf(5).