ucw/doc/index.txt

   1 The UCW library
   2 ===============
   3
   4 The UCW library aims to provide a set general purpose tools for programming
   5 in the C language. It contains generic data structures (lists, trees, hash
   6 tables etc.), fast memory allocators optimized for various usage patterns,
   7 abstract I/O streams and optimized implementations of some common algorithms
   8 (e.g., sorting of arrays and files).
   9
  10 Please note that this documentation is not yet complete. Many modules are
  11 not described, so you might need to look into the source code.
  12
  13 You can see the index of <<def_index:,documented definitions>>.
  14
  15 Modules
  16 -------
  17 - <<fastbuf:,Fastbufs>>
  18 - <<basecode:,Base64 and Base224 encoding>>
  19 - <<hash:,Hashing routines>>
  20 - <<conf:,Configuration and command line parser>>
  21 - <<mempool:,Memory pools>>
  22 - <<mainloop:,Mainloop>>
  23
  24 Other features
  25 --------------
  26 - <<docsys:,Documentation system>>
  27
  28 License
  29 -------
  30 The UCW library is copyrighted by its authors:
  31
  32 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
  33 - Martin Mareš <mailto:mj\@ucw.cz[]>
  34 - Robert Špalek <mailto:robert\@ucw.cz[]>
  35 - Michal Vaner <mailto:vorner\@ucw.cz[]>
  36
  37 It can be freely distributed and used according to the terms of
  38 the GNU Lesser General Public License.