/*
 * $Id: dirstruc.txt 12843 2009-11-09 22:38:57Z vszakats $
 */

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.exe and other executable. (*)
|
+---config              - Configuration Files (.mk) for the GNU Make system.
|   |
|   +---bsd             - Configuration files specific to FreeBSD.
|   |
|   +---darwin          - Configuration files specific to BSD/Darwin.
|   |
|   +---dos             - Configuration files specific to DOS.
|   |
|   +---hpux            - Configuration files specific to HP-UX.
|   |
|   +---linux           - Configutation files specific to GNU/Linux.
|   |
|   +---os2             - Configutation files specific to OS/2.
|   |
|   +---sunos           - Configutation files specific to SunOS.
|   |
|   +---win             - Configutation files specific to MS Windows.
|
+---contrib             - Miscellaneous contribution files. Those are not
|   |                     part of the official Harbour project.
|   |
|   |---gtalleg         - GT subsystem based on Allegro with graphic
|   |                     extensions.
|   |
|   +---gtwvg           - GT subsystem for Windows GUI using GDI functions.
|   |   |
|   |   +---tests       - Demo program and sample images.
|   |
|   +---hbapollo        - Wrapper functions for VistaSoftware's Apollo
|   |   |                 database driver.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbbmcdx         - DBFCDX RDD with bitmap filters compatible with
|   |                     CA-Cl*pper 5.3
|   |
|   +---hbbtree         - BTree library.
|   |   |
|   |   +---doc         - HB_BTree C and Harbour API documentation.
|   |   |
|   |   +---tests       - HB_BTree api test programs.
|   |
|   +---hbclipsm        - Miscellaneous contribution files.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbct            - CA-T**ls Compatible Library for Harbour.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbcurl          - libcurl 'easy' API - Harbour interface.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbfbird         - Harbour Low Level api for Firebird and Interbase
|   |   |                 RDBMS.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbfimage        - Wrapper for FreeImage.
|   |   |
|   |   +---tests       - Test program and sample images.
|   |       |
|   |       +-imgs_out  - Output directory used by the test program.
|   |
|   +---hbgd            - HBGD wrapper for gdLibrary.
|   |   |
|   |   +---doc         - Help and license files.
|   |   |
|   |   +---tests       - Test programs and samples.
|   |       |
|   |       +-digits    - Digits images for counter test program.
|   |       |
|   |       +-imgs_in   - Sample images.
|   |       |
|   |       +-imgs_out  - Output directory.
|   |
|   +---hbgf            - Harbour GUI framework.
|   |   |
|   |   +---hbgfgtk     - Implementation for GTK+ environment.
|   |   |
|   |   +---hbgfos2     - Implementation for OS/2 Presentation Manager
|   |   |                 environment.
|   |   |
|   |   +---hbgfwin     - Implementation for Windowns environment.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbgt            - GT library port to Harbour.
|   |   |
|   |   +---doc         - Documents for the GT library.
|   |       |
|   |       +---en      - English documentation.
|   |
|   +---hbhpdf          - libHaru PDF library wrappers.
|   |   |
|   |   +---tests       - Test programs.
|   |       |
|   |       +---files   - Sample files for testing.
|   |
|   +---hbmisc          - Miscellaneous contribution.
|   |   |
|   |   +---doc         - Documents for above contribution.
|   |   |   |
|   |   |   +---en      - English documentation.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbmsql          - Harbour mSQL access classes.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbmysql         - Harbour MySQL access classes.
|   |   |
|   |   +---tests       - Test program.
|   |   |
|   |   +---utils       - Converts a .dbf file into a MySQL table.
|   |
|   +---hbmzip          - Wrapper functions for minizip library.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbnf            - Nanforum library port for Harbour.
|   |   |
|   |   +---tests       - Test program.
|   |
|   +---hbodbc          - ODBS Access Class Demonstration.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbpgsql         - Harbour Low Level API for Postgres RDBMS.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbsqlit3        - Interface for SQLite 3.x library.
|   |   |
|   |   +---sqlite3     - An amalgamation of SQLite core library.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbssl           - Harbour inteface for OpenSSL API.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbtip           - TIP Class oriented Internet Protocol library.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbtpathy        - Telepathy serial communication port for Harbour.
|   |   |
|   |   +---tests       - Test program.
|   |
|   +---hbvpdf          - PDF library written in PRG.
|   |   |
|   |   +---tests       - Test programs.
|   |       |
|   |       +---files   - Sample files for testing.
|   |
|   +---hbwhat          - What is a library for ccessing all of Windows API
|   |   |                 from PRG level.
|   |   |
|   |   +---tests       - Test program.
|   |
|   +---hbwin           - Collection of Windows specific utility functions.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---hbziparc        - Compatibility interface with ZipArchive general
|   |   |                 purpose compression library to work with ZIP files.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---rddads          - RDD for Advantage Database Server.
|   |   |
|   |   +---doc         - Documents for Advantage Database Server RDD.
|   |   |   |
|   |   |   +---en      - English documentation.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---rddsql          - RDD for general SQL database with plugins.
|   |   |
|   |   +---sddfb       - Firebird SQL database driver.
|   |   |
|   |   +---sddmy       - MySQL database driver.
|   |   |
|   |   +---sddpg       - Postgre SQL database driver.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---xhb             - xHarbour compatibility libarary. To allow programs
|       |                 which where written using some xHarcour extensions,
|       |                 to be complied by Harbour.
|       |
|       +---tests       - Test programs.
|
+---examples        - Sample files and small applications.
|   |
|   +---dbu         - Make files (without source) for CA-Cl*pper DBU.
|   |
|   +---guestbk     - Harbour Guests Book.
|   |
|   +---hbdoc           - Documentation generation tool.
|   |
|   +---hbdoc2          - Documentation generation tool.
|   |
|   +---hbextern        - hbextern.ch generator.
|   |
|   +---hbsqlit2    - Interface for SQLite 2.x library.
|   |   |
|   |   +---tests   - Test programs.
|   |
|   +---hscript     - Harbour Script.
|   |
|   +---misc        - A few humble demonstration.
|   |
|   +---pe          - Editor.
|   |
|   +---pp          - Harbour Preprocessor as a standalone module.
|   |
|   +---rddado          - ADORDD - RDD to automatically manage Microsoft ADO.
|   |   |
|   |   +---tests       - Test programs.
|   |
|   +---rl          - Make files (without source) for CA-Cl*pper RL.
|   |
|   +---terminal    - Harbour terminal server/client.
|   |
|   +---uhttpd      - uHTTPD micro web server.
|       |
|       +-home      - Root directory for the web server.
|       | |
|       | +-cgi-bin - (*)
|       | |
|       | +-css     -
|       | |
|       | +-images  -
|       | |
|       | +-js      -
|       | |
|       | +-xsl     -
|       |
|       +-logs      - Log files. (*)
|       |
|       +-modules   -
|       |
|       +-sessions  - (*)
|
+---debian              - Packaging information for Debian GNU/Linux.
|
+---doc                 - Documentation and white-paper.
|   |
|   +---en              - English documentation.
|   |
|   +---es              - Spanish documentation.
|   |
|   +---man             - Man pages.
|
+---include             - Include files for both Harbour and C.
|
+---lib                 - Run-Time libraries binaries for each platform. (*)
|
+---source              - 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
|   |
|   +---hbpcre          - Harbour implementation of the Perl Compatible
|   |                     Regular Expressions (PCRE) library.
|   |
|   +---hbzlib          - 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.
    |
    +---hbformat        - Harbour Source Formatter utility.
    |
    +---hbi18n          - Harbour i18n .pot/.hbl file manager.
    |
    +---hbmk2           - Harbour Make utility.
    |   |
    |   +---examples    - Usage examples.
    |
    +---hbrun           - Standalone Harbour Portable Object file runner,
    |                     and a "dot prompt" console for the Harbour language.
    |
    +---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>
