helm/DEVEL/pxp/pxp/doc/ABOUT-FINDLIB

   1 ******************************************************************************
   2 ABOUT-FINDLIB - Package manager for O'Caml
   3 ******************************************************************************
   4
   5
   6 ==============================================================================
   7 Abstract
   8 ==============================================================================
   9
  10 The findlib library provides a scheme to manage reusable software components
  11 (packages), and includes tools that support this scheme. Packages are
  12 collections of OCaml modules for which metainformation can be stored. The
  13 packages are kept in the filesystem hierarchy, but with strict directory
  14 structure. The library contains functions to look the directory up that stores
  15 a package, to query metainformation about a package, and to retrieve dependency
  16 information about multiple packages. There is also a tool that allows the user
  17 to enter queries on the command-line. In order to simplify compilation and
  18 linkage, there are new frontends of the various OCaml compilers that can
  19 directly deal with packages.
  20
  21 Together with the packages metainformation is stored. This includes a version
  22 string, the archives the package consists of, and additional linker options.
  23 Packages can also be dependent on other packages. There is a query which finds
  24 out all predecessors of a list of packages and sorts them topologically. The
  25 new compiler frontends do this implicitly.
  26
  27 Metainformation can be conditional, i.e. depend on a set of predicates. This is
  28 mainly used to be able to react on certain properties of the environment, such
  29 as if the bytecode or the native compiler is invoked, if the application is
  30 multi-threaded, and a few more. If the new compiler frontends are used, most
  31 predicates are found out automatically.
  32
  33 There is special support for scripts. A new directive, "#require", loads
  34 packages into scripts. Of course, this works only with newly created toploops
  35 which include the findlib library.
  36
  37 ==============================================================================
  38 Where to get findlib
  39 ==============================================================================
  40
  41 The manual of findlib is available online [1]. You can download findlib here
  42 [2].
  43
  44
  45 --------------------------
  46
  47 [1]   see http://www.ocaml-programming.de/packages/documentation/findlib/
  48
  49 [2]   see http://www.ocaml-programming.de/packages/findlib-0.3.1.tar.gz
  50
  51
  52