00001 // Copyright (C) 2006-2007 Benedikt Böhm <hollow@gentoo.org> 00002 // 00003 // This program is free software; you can redistribute it and/or 00004 // modify it under the terms of the GNU General Public License 00005 // as published by the Free Software Foundation; either version 2 00006 // of the License, or (at your option) any later version. 00007 // 00008 // This program is distributed in the hope that it will be useful, 00009 // but WITHOUT ANY WARRANTY; without even the implied warranty of 00010 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 00011 // GNU General Public License for more details. 00012 // 00013 // You should have received a copy of the GNU General Public License 00014 // along with this program; if not, write to the Free Software 00015 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA 00016 00017 /*! 00018 * @mainpage lucid Documentation 00019 * 00020 * The lucid library combines a lot of useful functions i wrote for my 00021 * projects. There are a lot of custom functions for strings, 00022 * doubly-linked lists, bitmaps and flag lists, input/output, cryptogrpahic 00023 * digests, and tcp connections. 00024 * 00025 * Some of these functions, especially string and list functions, are 00026 * completely self-contained and do not rely on libc. This makes integration 00027 * in foreign projects as easy as possible. 00028 * 00029 * On the other hand, functions for input/output or chroot are just wrappers 00030 * around libc library functions, but may still be usefull to others as well. 00031 * 00032 * The size of functions range from a few hundred bytes to about 30K. 00033 * 00034 * @section why Why another library? 00035 * 00036 * This library was written for my own projects. As the number of foreign 00037 * libraries i included grew, i have collected all functions i needed - and 00038 * meanwhile most of them reimplemented - and made an own library. 00039 * 00040 * @section status Current Status 00041 * 00042 * Actually 4 projects (libvserver, vcd, vstatd, vwrappers) are using lucid now, 00043 * so an own shared library was necessary. The library contains a test suite for 00044 * the most important functions. Functions not explicitely tested are either 00045 * tested implicitely by other functions and a test may be written in the 00046 * future, or the function is so simple that you can just hope it works ;) 00047 * 00048 * @section doc Documentation 00049 * 00050 * All function are documented with an inline source browser for easy learning 00051 * and reference. To get an overview of function families please start at the 00052 * Modules page. Experienced users may look up information in the Globals, Data 00053 * Fields or File List. 00054 * 00055 * Also take a look at the \ref examples "Examples" and read the 00056 * \ref license "License". 00057 * 00058 * @section bugs Bugs, Patches, Wishes 00059 * 00060 * If you have found a bug in lucid that was not discovered by the test suite, 00061 * or if you have any suggestion, wishes or patches for the future of lucid, 00062 * please contact me at hollow[at]gentoo.org 00063 * 00064 * @{ 00065 */