XTypes: Added support to configuration and option parser.

[libucw.git] / ucw / doc / index.txt

diff --git a/ucw/doc/index.txt b/ucw/doc/index.txt
index 9c46227df711b7438f6327b5adae81c7ca35202e..9d439184d90914a0e5afb40891a63f72e1d206ba 100644 (file)
--- a/ucw/doc/index.txt
+++ b/ucw/doc/index.txt
@@ -1,95 +1,113 @@
-UCW libraries
-=============
+The UCW library
+===============

 
 

-The UCW libraries aim to provide some general purpose tools for C
-programming language. It contains faster implementations of some
-algorithms found in libc (for example, sorting), few commonly used not
-available in libc (sha1 hash), several generic data structures (hash
-tables, binomial heap) and some less common tools (memory pools).
+The UCW library aims to provide a set general purpose tools for programming
+in the C language. It contains generic data structures (lists, trees, hash
+tables etc.), fast memory allocators optimized for various usage patterns,
+abstract I/O streams and optimized implementations of some common algorithms
+(e.g., sorting of arrays and files).

 
 

-It is probable you may save yourself some time by using this library.
+Please note that this documentation is not yet complete. Many modules are
+not described, so you might need to look into the source code.

 
 

-Please note this documentation is not yet complete. There are lot of
-modules not yet described, look into the source code.
+You can see the index of <<def_index:,documented definitions>>.

 
 

-You can see list of <<def_index:,definitions>>.
+For news and incompatible changes in this version, see the <<relnotes:,Release notes>>.

 
 Modules
 -------
 
 Modules
 -------

+- <<basics:,Basics>>
+- <<log:,Logging>>

 - <<fastbuf:,Fastbufs>>
 - <<basecode:,Base64 and Base224 encoding>>
 - <<hash:,Hashing routines>>
 - <<conf:,Configuration and command line parser>>
 - <<mempool:,Memory pools>>
 - <<fastbuf:,Fastbufs>>
 - <<basecode:,Base64 and Base224 encoding>>
 - <<hash:,Hashing routines>>
 - <<conf:,Configuration and command line parser>>
 - <<mempool:,Memory pools>>

+- <<eltpool:,Fixed-sized allocators>>
+- <<alloc:,Generic allocators>>

 - <<mainloop:,Mainloop>>
 - <<mainloop:,Mainloop>>

+- <<unaligned:,Unaligned data>>
+- <<lists:,Linked lists>>
+- <<gary:,Growing arrays>>
+- <<heap:,Binary heaps>>
+- <<binheap:,Binomial heaps>>
+- <<hashtable:,Hash tables>>
+- <<growbuf:,Growing buffers>> (obsolete)
+- <<chartype:,Single-byte characters>>
+- <<unicode:,Multi-byte characters>>
+- <<varint:,Encoding of integers>>
+- <<prime:,Prime numbers>>
+- <<sort:,Sorting>>
+- <<binsearch:,Binary search>>
+- <<compress:,Compression>>
+- <<trans:,Transactions and resource tracking>>
+- <<string:,String operations>>
+- <<time:,Time and timers>>
+- <<daemon:,Daemon helpers>>
+- <<signal:,Signal helpers>>
+- <<opt:,Command line parser>>
+- <<table:,Table printer>>
+
+Other features
+--------------
+- <<configure:,Compile time configuration>>
+- <<config:,Configuration file syntax>>
+- <<docsys:,Documentation system>>
+- <<generic:,Macro-generated generics>>

 
 Yet undocumented modules
 ------------------------
 
 Yet undocumented modules
 ------------------------

-- Sorting
-  * `arraysort.h`
-  * `sorter/`
-- Growing buffers
-  * `gbuf.h`
-  * `bbuf.h`
-- Heaps
-  * `binheap.h`
-  * `binheap-node.h`
-  * `heap.h`
-- Binary search
-  * `binsearch.h`
+- Trie
+  * `trie.h`
+- Red-black trees
+  * `redblack.h`

 - Bit manipulation
   * `bitarray.h`
 - Bit manipulation
   * `bitarray.h`

-  * `bitopts.h`
+  * `bitops.h`

   * `bitsig.h`
   * `bitsig.h`

-- Character manipulation
-  * `char-map.h`
-  * `chartype.h`
-  * `unicode.h`
-- Link lists
-  * `clists.h`
-  * `simple-lists.h`
-  * `slists.h`
-- Fixed-sized allocator
-  * `eltpool.h`
-- Hash tables
-  * `hashtable.h`
-- IP address access lists
-  * `ipaccess.h`

 - String manipulation
   * `kmp.h`
   * `kmp-search.h`
   * `regex.h`
   * `stkstring.h`
 - String manipulation
   * `kmp.h`
   * `kmp-search.h`
   * `regex.h`
   * `stkstring.h`

-  * `string.h`
-  * `str-match.h`
+  * `strtonum.h`

   * `wildmatch.h`
 - File manipulation
   * `asio.h`
   * `wildmatch.h`
 - File manipulation
   * `asio.h`

-  * `lfs.h`
+  * `io.h`

   * `partmap.h`
   * `partmap.h`

-- Compression
-  * `lizard.h`
-- Prefetching of memory
-  * `prefetch.h`
-- Primes
-  * `prime.h`
-- Profiling support
-  * `profile.h`
-- Caches
-  * `qache.h`
-- Red-black trees
-  * `redblack.h`
+- Address manipulation
+  * `url.h`
+  * `ipaccess.h`

 - Threads
   * `semaphore.h`
   * `threads.h`
   * `workqueue.h`
 - Threads
   * `semaphore.h`
   * `threads.h`
   * `workqueue.h`

-- Trie
-  * `trie.h`
-- Unaligned data
-  * `unaligned.h`
-- URL manipulation
-  * `url.h`
+- Miscellaneous
+  * `sighandler.h`
+  * `process.h`

 
 

-Other features
---------------
-- <<docsys:,Documentation system>>
+License
+-------
+The UCW library is copyrighted by its authors.
+
+It can be freely distributed and used according to the terms of
+the GNU Lesser General Public License, either version 2 or any later
+version.
+
+Authors
+-------
+Primary authors and maintainers are:
+
+- Pavel Charvát <mailto:pchar\@ucw.cz[]>
+- Martin Mareš <mailto:mj\@ucw.cz[]>
+- Robert Špalek <mailto:robert\@ucw.cz[]>
+
+Several modules have been contributed by:
+
+- Daniel Fiala <mailto:danfiala\@ucw.cz[]> (strtonum)
+- Tomáš Gavenčiak <mailto:gavento\@ucw.cz[]> (logging system)
+- Robert Kessl <mailto:robert.kessl\@economia.cz[]> (table printer)
+- Jan Moskyto Matějka <mailto:mq\@ucw.cz[]> (option parser, fb-multi)
+- Tomáš Valla <mailto:tom\@ucw.cz[]> (varint)
+- Michal Vaner <mailto:vorner\@ucw.cz[]> (documentation system)