/*
 * $Id$
 */

Harbour directory structure
===========================

Follow are the various directories that exist under the Harbour tree.
Under each directory exist in this list there is also a special directory
named .svn, which should normally ignored since it is used by the SVN to keep
track of all files (read the FAQ if you don't know what SVN is).


<harbour>               - Main Harbour directory. Contain all the various
|                         make file and Changelog (=changes history) files.
|
+---bin                 - Executable and build scripts.
|                         Should contain harbour and other executables. (*)
|
+---config              - Configuration Files (.mk) for the GNU Make system.
|   |
|   +---<platform>      - Configuration files specific to <platform>.
|
+---contrib             - Miscellaneous contribution projects.
|   |
|   |---gtalleg         - GT subsystem based on Allegro with graphic extensions.
|   |
|   +---gtwvg           - GT subsystem for Windows GUI using GDI functions.
|   |
|   +---rddbm           - DBFCDX RDD with bitmap filters.
|   |
|   +---hbct            - CA-T**ls Compatible Library for Harbour.
|   |
|   +---hbcurl          - libcurl 'easy' API - Harbour interface.
|   |
|   +---hbfbird         - Harbour Low Level api for Firebird and Interbase
|   |
|   +---hbfimage        - Wrapper for FreeImage.
|   |
|   +---hbformat        - Harbour Source Formatter utility.
|   |
|   +---hbgd            - HBGD wrapper for gdLibrary.
|   |
|   +---hbgt            - GT library port to Harbour.
|   |
|   +---hbhpdf          - libHaru PDF library wrappers.
|   |
|   +---hbmisc          - Miscellaneous contribution.
|   |
|   +---hbmysql         - Harbour MySQL access classes.
|   |   |
|   |   +---utils       - Converts a .dbf file into a MySQL table.
|   |
|   +---hbmzip          - Wrapper functions for minizip library.
|   |
|   +---hbnf            - Nanforum library port for Harbour.
|   |
|   +---hbodbc          - ODBS Access Class Demonstration.
|   |
|   +---hbpgsql         - Harbour Low Level API for Postgres RDBMS.
|   |
|   +---hbrun           - Standalone Harbour Portable Object file runner,
|   |                     and a "dot prompt" console for the Harbour language.
|   |
|   +---hbsqlit3        - Interface for SQLite 3.x library.
|   |
|   +---3rd/sqlite3     - An amalgamation of SQLite core library.
|   |
|   +---hbssl           - Harbour inteface for OpenSSL API.
|   |
|   +---hbtip           - TIP Class oriented Internet Protocol library.
|   |
|   +---hbtpathy        - Telepathy serial communication port for Harbour.
|   |
|   +---hbwin           - Collection of Windows specific utility functions.
|   |
|   +---hbziparc        - Compatibility interface with ZipArchive general
|   |                     purpose compression library to work with ZIP files.
|   |
|   +---rddads          - RDD for Advantage Database Server.
|   |
|   +---rddsql          - RDD for general SQL database with plugins.
|   |
|   +---sddfb           - RDDSQL Firebird SQL database driver.
|   |
|   +---sddmy           - RDDSQL MySQL database driver.
|   |
|   +---sddpg           - RDDSQL Postgre SQL database driver.
|   |
|   +---xhb             - xHarbour compatibility library. To allow programs
|                         which where written using some xHarcour extensions,
|                         to be complied by Harbour.
|
+---extras          - Sample files and small applications.
|   |
|   +---dbu         - Make files (without source) for CA-Cl*pper DBU.
|   |
|   +---guestbk     - Harbour Guests Book.
|   |
|   +---hbdoc       - Documentation generation tool.
|   |
|   +---misc        - A few humble demonstration.
|   |
|   +---rddado      - ADORDD - RDD to automatically manage Microsoft ADO.
|   |
|   +---rl          - Make files (without source) for CA-Cl*pper RL.
|   |
|   +---httpsrv     - uHTTPD micro web server.
|
+---debian              - Packaging information for Debian GNU/Linux.
|
+---doc                 - Documentation and white-paper.
|   |
|   +---en              - English documentation.
|
+---include             - Include files for both Harbour and C.
|
+---lib                 - Run-Time libraries binaries for each platform. (*)
|
+---src                 - All source files reside underneath.
|   |
|   +---codepage        - National codepage collection.
|   |
|   +---common          - Common function and Expression Optimizer.
|   |
|   +---compiler        - Harbour compiler module.
|   |
|   +---debug           - Debugger.
|   |
|   +---hbextern        - Library with all function binding available for
|   |                     .prg code
|   |
|   +---3rd/pcre        - Harbour implementation of the Perl Compatible
|   |                     Regular Expressions (PCRE) library.
|   |
|   +---3rd/zlib        - Harbour implementation of the ZLIB data
|   |                     compression library.
|   |
|   +---lang            - National language message support files.
|   |
|   +---macro           - Macro compiler.
|   |
|   +---main            - Harbour compiler main source.
|   |
|   +---pp              - Harbour Preprocessor.
|   |
|   +---rdd             - Replaceable Database Driver (RDD).
|   |   |
|   |   +---dbfcdx      - DBFCDX RDD.
|   |   |
|   |   +---dbffpt      - DBFFPT RDD.
|   |   |
|   |   +---dbfnsx      - DBFNSX RDD.
|   |   |
|   |   +---dbfntx      - DBFNTX RDD.
|   |   |
|   |   +---hbsix       - SIX compatible functions.
|   |   |
|   |   +---hsx         - HiPer-SEEK / CFTS compatible library.
|   |   |
|   |   +---nulsys      - NULL RDD.
|   |   |
|   |   +---usrrdd      - USRRDD which allows to create a new RDD at PRG level.
|   |       |
|   |       +---example - Usage examples.
|   |       |
|   |       +---rdds    - A set of simple RDD's all written in PRG.
|   |
|   +---rtl             - Run-Time libraries functions and various General
|   |   |                 Terminal (GT) implementation
|   |   |
|   |   +---gtcgi       - GT subsystem aimed at cgi-bin applications.
|   |   |
|   |   +---gtcrs       - GT subsystem based on ncurses.
|   |   |
|   |   +---gtdos       - GT subsystem for DOS compilers.
|   |   |
|   |   +---gtgui       - Minimal GT for Windows GUI programs.
|   |   |
|   |   +---gtos2       - GT subsystem for OS/2 compilers.
|   |   |
|   |   +---gtpca       - GT subsystem for ANSI terminals.
|   |   |
|   |   +---gtsln       - GT subsystem based on slang.
|   |   |
|   |   +---gtstd       - GT subsystem for plain ANSI C stream IO.
|   |   |
|   |   +---gttrm       - GT subsystem for terminal. It does not use
|   |   |                 termcap/terminfo for terminal escape sequences,
|   |   |                 but rather hard coded ones for basic capabilities.
|   |   |
|   |   +---gtwin       - GT subsystem for Windows compilers (Console).
|   |   |
|   |   +---gtwvt       - GT subsystem for Windows using GUI windows instead of
|   |   |                 Console.
|   |   |
|   |   +---gtxwc       - GT subsystem for XWindow Console.
|   |   |
|   |   +---gt_tpl      - GT subsystem template.
|   |
|   +---vm              - Harbour Virtual Machine and internal Run-Time
|       |                 library functions.
|       |
|       +---mainstd     - mainstd library for MinGW build.
|       |
|       +---mainwin     - mainwin library for MinGW build.
|       |
|       +---vmmt        - GNU Makefile for creating the multithreaded version
|                         of the VM library.
|
+---tests               - Test programs.
|   |
|   +---bldtest         - Simple C program to check if Harbour can be compiled
|   |                     on the current machine, system and C compiler.
|   |
|   +---hbpptest        - Regression tests for the preprocessor.
|   |
|   +---mt              - Various multithreading tests.
|   |
|   +---multifnc        - Overloading C functions test.
|   |
|   +---rddtest         - RDD tests.
|
+---utils               - Utilities and tools that are part of Harbour.
    |
    +---hbi18n          - Harbour i18n .pot/.hbl file manager.
    |
    +---hbmk2           - Harbour Make utility.
    |   |
    |   +---examples    - Usage examples.
    |
    +---hbtest          - Regression tests for the Run-Time library.


Legend:
=======
(*)      Should exist in a final build or if you build them yourself, in
         normal SVN distribution this directory is empty or does not contain
         all files.


Chen Kedem <niki@synel.co.il>
