OSDN Git Service

Yet more trivial doc updates
[uclinux-h8/uclibc-ng.git] / README
1
2   uClibc - a Small C Library for Linux
3   Erik Andersen <andersen@codepoet.org>
4
5 uClibc (aka µClibc/pronounced yew-see-lib-see) is a C library for
6 developing embedded Linux systems. It is much smaller than the
7 GNU C Library, but nearly all applications supported by glibc
8 also work perfectly with uClibc. Porting applications from glibc
9 to uClibc typically involves just recompiling the source code.
10 uClibc even supports shared libraries and threading. It currently
11 runs on standard Linux and MMU-less (also known as µClinux)
12 systems with support for alpha, ARM, cris, h8300, i386, i960,
13 m68k, mips/mipsel, PowerPC, SH, SPARC, and v850 processors.
14
15 If you are building an embedded Linux system and you find that
16 glibc is eating up too much space, you should consider using
17 uClibc.  If you are building a huge fileserver with 12 Terabytes
18 of storage, then using glibc may make more sense.  Unless, for
19 example, that 12 Terabytes will be Network Attached Storage and
20 you plan to burn Linux into the system's firmware...
21
22 uClibc is maintained by Erik Andersen and is licensed under the
23 GNU LIBRARY GENERAL PUBLIC LICENSE . This license allows you to
24 make closed source commercial applications using an unmodified
25 version of uClibc (Please consider sharing some of the money you
26 make ;-). You do not need to give away all your source code just
27 because you use uClibc and/or run on Linux. 
28
29
30 For installation instructions, see the file INSTALL.
31
32 This distribution contains a wrapper for gcc and ld that allows
33 you to use existing toolchains that were targetted for glibc.
34 There are limits as to what this wrapper can do, so it is
35 recommended that you instead build a full binutils/gcc toolchain.
36
37 uClibc strives to be standards compliant, which means that most
38 documentation written for SuSv3, or for glibc also applies to
39 uClibc functions.  However, many GNU extensions are not supported
40 because they have not been ported, or more importantly, would
41 increase the size of uClibc disproportional to the added
42 functionality.
43
44 Additional information (recent releases, FAQ, mailing list, bugs,
45 etc.) can be found at http://www.uclibc.org/.
46
47 uClibc may be freely modified distributed under the terms of the
48 GNU Library General Public License, which can be found in the
49 file COPYING.LIB.
50
51 Please Note:
52
53         There is an unwholesomely huge amount of code out there
54         that depends on the presence of GNU libc header files.
55         We have GNU libc compatible header files.  So we have
56         committed a horrible sin in uClibc.  We _lie_ and claim
57         to be GNU libc in order to force these applications to
58         work as their developers intended.  This is IMHO,
59         pardonable, since these defines are not really intended
60         to check for the presence of a particular library, but
61         rather are used to define an _interface_.  Some programs
62         are especially chummy with glibc, and may need this
63         behavior disabled by adding CFLAGS+=-D__FORCE_NOGLIBC
64