readme

TTYLINUX迷你代码 TTYLINUX迷你代码

ttylinux source and build script
(C) 2005 Pascal Schmidt <[e-mail]>

INTRODUCTION
============

This package contains the source code and build script used to
build the ttylinux GNU/Linux distribution. You can use it to
build your own binary ttylinux package.


LICENSES
========

The makedist.sh script, the contents of the docs directory, and
the basesystem package are all licensed under the GNU General
Public License (GPL), a copy of which you can find in the file
docs/COPYING.

The other packages are licensed under a number of different
licenses. A quick overview can be found in the file
docs/user_guide.html, in the "License" section. For more
details, please look inside the source packages.


REQUIREMENTS
============

To build ttylinux, you need the build system (which contains
this README file, so you already have it) and the individual
source packages that need to be stored in the packages/src/
directory.

The basesystem package which contains the basic directory
structure and configuration files for ttylinux is included
with the build script package. The others can be downloaded
seperately from the ttylinux homepage.

	http://www.minimalinux.org/ttylinux/

Since the build process needs to be able to create device nodes
and mount loopback filesystem images, you need to be logged in
as root when running the build. To start the build, go to the
directory with makedist.sh in it and run:

	./makedist.sh

When the build completes without errors, the last message
on the screen will be "BUILD COMPLETED". This will leave you with
a couple of files: "filesys", which is a 4M ext2 filesystem image
with ttylinux installed on it, and "ttylinux-<version>.tar.gz",
a binary distribution tarball as can be downloaded from the
ttylinux website. The directory packages/bin/ will contain binary
packages created from all the source packages. These can be used
to later reinstall packages on a ttylinux system where packages
were removed by use of the "pacman -e" command.

You will need about 400 MB of free disk space to complete
the build. This is because the build process builds a full
glibc.

On a 3.2 GHz Pentium 4 with 2 GB of RAM, the build takes about
18 minutes.


REQUIREMENTS -- SOFTWARE
========================

The build script is meant to run under Slackware 10.0. It may
or may not work under other distributions. On Slackware, you
need the following packages to be installed (at least). The
versions given here are the versions with which the script
was tested. Basic system packages are not listed.

	bin86		0.16.15
	binutils	2.15.90.0.3
	bison		1.35
	flex		2.5.4a
	gawk		3.1.3
	gcc		3.3.4
	gettext-tools	0.14.1
	gzip		1.3.3
	make		3.80
	nasm		0.98.38
	perl		5.8.4
	sed		4.0.9
	tar		1.14
	texinfo		4.7

If you have the above packages with roughly the same versions
installed on a distribution different from Slackware, the build
script should work for you. YMMV.

What version of glibc is installed on your system should not
matter, unless it is a newer version than glibc-2.3.6.


PACKAGES
========

Source packages are stored in the packages/src/ directory. Each
package is a bzip2 compressed tar archive. Each archive contains
two directories -- one is the source code for the package and
the other is called "control" and contains additional files
needed to build a package. When a package is being build, the
archive file is unpacked into the build/ directory. The build
system then changes into that directory and includes the file
"control/build". This file must be a bash script defining the
shell functions "name()" and "build()". The "name" function
must just echo the package name when called, while the "build"
function is expected to compile the package and install the
resulting binary files under the directory $DISTDIR.

There must be a file called "control/files" that lists all
the files that the "build()" shell function will install
into $DISTDIR. The file listing is used to create the binary
version of the package and must use relative pathnames.

The "control" directory may also contain files named like
"patch-*" which contain source patches that need to be applied
before calling the "build()" shell function. The build system
will apply those automatically, by using a "patch -p0" command.

You can store an executable (most likely you want this to be
a shell script) in the file "control/install" that will be
copied into the binary package and run whenever the package
is installed on a ttylinux system.

Any other files inside the "control" directory are ignored
by the build system, but can be used from within the "build()"
shell function defined by the package.

Take a look at the existing packages that are part of ttylinux
for examples of how a "control/build" shell script should look
like. The following shell variables are available to the script:

	TTYVERSION  version of ttylinux being built
	TOPDIR	    directory that contains "makedist.sh"
	DISTDIR	    directory root for binary distribution
	CFLAGS	    flags for C compiler
	INSTALL     default install command and flags
	PACKAGES    space-delimited list of packages to build

If you want to add your own package to the build or remove a
standard package, all you need to do is change the PACKAGES
variable in the top section of the "makedist.sh" script.


BUG REPORTS
===========

Should the build script not work on a Slackware 10.0 system,
a bug report to

	Pascal Schmidt <[e-mail]>
	
is appreciated. It should include a log of the failed build.
A report is also welcome if you spot an error in the above
instructions or required software list.

If the build script fails on a non-Slackware system, then
sorry, but I cannot support such use (for now).