X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fdocs%2Fusers_guide%2Fpackages.xml;h=3bd65c66ce8c2c19ae837a20a5acf3fb59e7e309;hb=51ab82d2c77dbb12fb6d92cfcf6ee30c5a543997;hp=6d64e792b0d4ea5ab2cee9cabcc58d5027a1ca5d;hpb=305c762e994fff4c47f22e8e2cc4940ee430d682;p=ghc-hetmet.git diff --git a/ghc/docs/users_guide/packages.xml b/ghc/docs/users_guide/packages.xml index 6d64e79..3bd65c6 100644 --- a/ghc/docs/users_guide/packages.xml +++ b/ghc/docs/users_guide/packages.xml @@ -1,147 +1,328 @@ - Packages - packages - - Packages are collections of libraries, conveniently grouped - together as a single entity. The package system is flexible: a - package may consist of Haskell code, foreign language code (eg. C - libraries), or a mixture of the two. A package is a good way to - group together related Haskell modules, and is essential if you - intend to make the modules into a Windows DLL (see below). - - Because packages can contain both Haskell and C libraries, they - are also a good way to provide convenient access to a Haskell - layer over a C library. - - GHC comes with several packages (see the accompanying - library documentation), and packages can be added to or removed - from an existing GHC installation, using the supplied - ghc-pkgghc-pkg - tool, described in . - - - Using a package - packages - using - - Some packages, called auto packages, - are automatically available: you don't need - to specify any extra flags to use them (except in certain - circumstances; see below). All the packages which contain - hierarchical libraries fall into this category. - - Some other packages are not - automatically available: those are normally the packages - containing old non-hierarchical libraries. To gain access to a - non-auto package, use the command-line - flag: - - - - - - -package lib option - - - This option brings into scope all the modules from - package lib (they still have to - be imported in your Haskell source, however). It also - causes the relevant libraries to be linked when linking is - being done. - Some packages depend on other packages, for example the - text package makes use of some of the modules - in the lang package. The package system - takes care of all these dependencies, so that when you say - -package text on the command line, you - automatically get -package lang too. - - - + +Packages + + packages + + A package is a library of Haskell modules known to the compiler. GHC + comes with several packages: see the accompanying + library documentation. + + Using a package couldn't be simpler: if you're using + or GHCi, then most of the installed packages will be + automatically available to your program without any further options. The + exceptions to this rule are covered below in . + + Building your own packages is also quite straightforward: we provide + the Cabal infrastructure which + automates the process of configuring, building, installing and distributing + a package. All you need to do is write a simple configuration file, put a + few files in the right places, and you have a package. See the + Cabal documentation + for details, and also the Cabal libraries (Distribution.Simple, + for example). + + + Using Packages + + packages + using + + To see which packages are installed, use the + ghc-pkg command: - There's one case where you need to use the - option even for auto packages: when - linking a program in batch mode mode () - This is because - GHC can't figure out from the object files which packages are - required; in mode and in - GHCi the compiler has more information available to figure out - the package dependencies. We might try to lift this restriction - in the future.. For example, to link a - program consisting of objects Foo.o and - Main.o, where we made use of the - network package, we need to give GHC the -package flag thus: + +$ ghc-pkg list +/usr/lib/ghc-6.4/package.conf: + base-1.0, haskell98-1.0, template-haskell-1.0, mtl-1.0, unix-1.0, + Cabal-1.0, haskell-src-1.0, parsec-1.0, network-1.0, + QuickCheck-1.0, HUnit-1.1, fgl-1.0, X11-1.1, HGL-3.1, OpenGL-2.0, + GLUT-2.0, stm-1.0, readline-1.0, (lang-1.0), (concurrent-1.0), + (posix-1.0), (util-1.0), (data-1.0), (text-1.0), (net-1.0), + (hssource-1.0), rts-1.0 + + + Packages are either exposed or hidden. Only + modules from exposed packages may be imported by your Haskell code; if + you try to import a module from a hidden package, GHC will emit an error + message. + + Each package has an exposed flag, which says whether it is exposed by + default or not. Packages hidden by default are listed in + parentheses (eg. (lang-1.0)) in the output from + ghc-pkg list. To expose a package which is hidden by + default, use the + flag (see below). + + To see which modules are exposed by a package: + + +$ ghc-pkg field network exposed-modules +exposed-modules: Network.BSD, + Network.CGI, + Network.Socket, + Network.URI, + Network + -$ ghc -o myprog Foo.o Main.o -package network + In general, packages containing hierarchical modules are usually + exposed by default. However, it is possible for two packages to contain + the same module: in this case, only one of the packages should be + exposed. It is an error to import a module that belongs to more than one + exposed package. - The same flag is necessary even if we compiled the modules from source, because GHC still - reckons it's in batch mode: -$ ghc -o myprog Foo.hs Main.hs -package network -In --make and --interactive modes (), however, GHC figures out -the auto packages required for linking without further assistance. - + The GHC command line options that control packages are: - + + + + + + + + This option causes package P to be + exposed. The package P can be specified + in full with its version number + (e.g. network-1.0) or the version number can be + omitted if there is only one version of the package + installed. + If there are multiple versions of P + installed, then all other versions will become hidden. - - Maintaining a local set of packages - - When GHC starts up, it automatically reads the default set - of packages from a configuration file, normally named - package.conf in your GHC installation - directory. + The + option also causes package P to be + linked into the resulting executable. In + mode and GHCi, the compiler + normally determines which packages are required by the current + Haskell modules, and links only those. In batch mode however, the + dependency information isn't available, and explicit + options must be given when linking. - You can load in additional package configuration files - using the option: + For example, to link a program consisting of objects + Foo.o and Main.o, where + we made use of the network package, we need to + give GHC the -package flag thus: - - - - - - - - Read in the package configuration file - file in addition to the system - default file. This allows the user to have a local set of - packages in addition to the system-wide ones. - - - +$ ghc -o myprog Foo.o Main.o -package network - To create your own package configuration file, just create - a new file and put the string - [] in it. Packages can be - added to the new configuration file using the - ghc-pkg tool, described in . - + The same flag is necessary even if we compiled the modules from + source, because GHC still reckons it's in batch mode: - - Building a package from Haskell source - packages - building +$ ghc -o myprog Foo.hs Main.hs -package network - It takes some special considerations to build a new - package: + In --make and --interactive + modes (), however, GHC figures out the + packages required for linking without further assistance. - + The one other time you might need to use + to force linking a package is when the + package does not contain any Haskell modules (it might contain a C + library only, for example). In that case, GHC + will never discover a dependency on it, so it has to be mentioned + explicitly. + + + + + + + - A package may contain several Haskell modules. A - package may span many directories, or many packages may - exist in a single directory. Packages may not be mutually - recursive. + Ignore the exposed flag on installed packages, and hide them + all by default. If you use + this flag, then any packages you require (including + base) need to be explicitly exposed using + options. + + This is a good way to insulate your program from differences + in the globally exposed packages, and being explicit about package + dependencies is a Good Thing. + + + P + + - A package has a name - (e.g. base) + This option does the opposite of : it + causes the specified package to be hidden, + which means that none of its modules will be available for import + by Haskell import directives. + + Note that the package might still end up being linked into the + final program, if it is a dependency (direct or indirect) of + another exposed package. + + + P + + + + Causes the compiler to behave as if package + P, and any packages that depend on + P, are not installed at all. + + Saying -ignore-package P is the same as + giving -hide-package flags for + P and all the packages that depend on + P. Sometimes we don't know ahead of time which + packages will be installed that depend on P, + which is when the -ignore-package flag can be + useful. + + + + + + + The module overlap restriction + + The module names in a Haskell program must be distinct. + This doesn't sound like a severe restriction, but in a Haskell program + using multiple packages with interdependencies, difficulties can start to + arise. You should be aware of what the module overlap + restriction means, and how to avoid it. + + GHC knows which packages are in use by your + program: a package is in use if you imported something from it, or if it + is a dependency of some other package in use. There must be no conflicts + between the packages in use; a conflict is when two packages contain + a module with the same name. If + GHC detects a conflict, it will issue a message stating which packages + are in conflict, and which modules are overlapping. + + For example, a conflict might arise if you use two packages, say P + and Q, which respectively depend on two different versions of another + package, say R-1.0 and R-2.0. The + two versions of R are likely to contain at least some + of the same modules, so this situation would be a conflict. + + + + Package Databases + + A package database is a file, normally called + package.conf which contains descriptions of installed + packages. GHC usually knows about two package databases: + + + + The global package database, which comes with your GHC + installation. + + + A package database private to each user. On Unix + systems this will be + $HOME/.ghc/arch-os-version/package.conf, and on + Windows it will be something like + C:\Documents And Settings\user\ghc. + The ghc-pkg tool knows where this file should be + located, and will create it if it doesn't exist (see ). + + + + When GHC starts up, it reads the contents of these two package + databases, and builds up a list of the packages it knows about. You can + see GHC's package table by running GHC with the + flag. + + Package databases may overlap: for example, packages in the user + database will override those of the same name in the global + database. + + You can control the loading of package databses using the following + GHC options: + + + + + + + - The Haskell code in a package may be built into one or + Read in the package configuration file + file in addition to the system + default file and the user's local file. Packages in additional + files read this way will override those in the global and user + databases. + + + + + + + + + + Prevent loading of the user's local package database. + + + + + To create a new package database, just create + a new file and put the string + [] in it. Packages can be + added to the file using the + ghc-pkg tool, described in . + + + The <literal>GHC_PACKAGE_PATH</literal> environment variable + Environment variableGHC_PACKAGE_PATH + + GHC_PACKAGE_PATH + The GHC_PACKAGE_PATH environment variable may be + set to a :-separated (;-separated + on Windows) list of files containing package databases. This list of + package databases is used by GHC and ghc-pkg, with earlier databases in + the list overriding later ones. This order was chosen to match the + behaviour of the PATH environment variable; think of + it as a list of package databases that are searched left-to-right for + packages. + + If GHC_PACKAGE_PATH ends in a separator, then + the default user and system package databases are appended, in that + order. e.g. to augment the usual set of packages with a database of + your own, you could say (on Unix): + +$ export GHC_PACKAGE_PATH=$HOME/.my-ghc-packages.conf: + (use ; instead of : on + Windows). + + To check whether your GHC_PACKAGE_PATH setting + is doing the right thing, ghc-pkg list will list all + the databases in use, in the reverse order they are searched. + + + + + + Building a package from Haskell source + packages + building + + We don't recommend building packages the hard way. Instead, use the + Cabal infrastructure + if possible. If your package is particularly complicated or requires a + lot of configuration, then you might have to fall back to the low-level + mechanisms, so a few hints for those brave souls follow. + + + + You need to build an "installed package info" file for + passing to ghc-pkg when installing your + package. The contents of this file are described in . + + + + The Haskell code in a package may be built into one or more archive libraries (e.g. libHSfoo.a), or a single DLL on Windows (e.g. HSfoo.dll). The @@ -154,19 +335,19 @@ the auto packages required for linking without further assistance. for the gory details. - Building a static library is done by using the + Building a static library is done by using the ar tool, like so: ar cqs libHSfoo.a A.o B.o C.o ... - where A.o, + where A.o, B.o and so on are the compiled Haskell modules, and libHSfoo.a is the library you wish to create. The syntax may differ slightly on your system, so check the documentation if you run into difficulties. - Versions of the Haskell libraries for use with GHCi + Versions of the Haskell libraries for use with GHCi may also be included: GHCi cannot load .a files directly, instead it will look for an object file called HSfoo.o and load that. On some @@ -178,113 +359,182 @@ the auto packages required for linking without further assistance. follows: ld -r ––whole-archive -o HSfoo.o libHSfoo.a - - - (replace + (replace ––--whole-archive with –all_load on MacOS X) - + GHC does not maintain detailed cross-package dependency information. It does remember which modules in other packages the current module depends on, but not which things within those imported things. - - - - To compile a module which is to be part of a new package, - use the -package-name option: - - - - - - -package-nameoption - - - This option is added to the command line when - compiling a module that is destined to be part of package - foo. If this flag is omitted then the - default package Main is assumed. - - - - - Failure to use the -package-name option - when compiling a package will result in disaster on Windows, but - is relatively harmless on Unix at the moment (it will just cause - a few extra dependencies in some interface files). However, - bear in mind that we might add support for Unix shared libraries - at some point in the future. - - It is worth noting that on Windows, when each package + + + + It is worth noting that on Windows, when each package is built as a DLL, since a reference to a DLL costs an extra indirection, intra-package references are cheaper than inter-package references. Of course, this applies to the Main package as well. - - Package management - packages - management - - The ghc-pkg tool allows packages to be - added or removed from a package configuration file. By default, - the system-wide configuration file is used, but alternatively - packages can be added, updated or removed from a user-specified - configuration file using the - option. An empty package configuration file consists of the - string []. - - The ghc-pkg program accepts the - following options: - - - - - - - - - - - - Reads package specification from the input (see below), - and adds it to the database of installed packages. The - package specification must be a package that isn't already + + Package management (the <literal>ghc-pkg</literal> command) + packages + management + + The ghc-pkg tool allows packages to be + added or removed from a package database. By default, + the system-wide package database is modified, but alternatively + the user's local package database or another specified + file can be used. + + To see what package databases are in use, say + ghc-pkg list. The stack of databases that + ghc-pkg knows about can be modified using the + GHC_PACKAGE_PATH environment variable (see , and using + --package-conf options on the + ghc-pkg command line. + + When asked to modify a database, ghc-pkg modifies + the global database by default. Specifying + causes it to act on the user database, or + can be used to act on another database entirely. When multiple of these + options are given, the rightmost one is used as the database to act + upon. + + If the environment variable GHC_PACKAGE_PATH is + set, and its value does not end in a separator (: on + Unix, ; on Windows), then the last database is + considered to be the global database, and will be modified by default by + ghc-pkg. The intention here is that + GHC_PACKAGE_PATH can be used to create a virtual + package environment into which Cabal packages can be installed without + setting anything other than GHC_PACKAGE_PATH. + + The ghc-pkg program may be run in the ways listed + below. Where a package name is required, the package can be named in + full including the version number + (e.g. network-1.0), or without the version number. + Naming a package without the version number matches all versions of the + package; the specified action will be applied to all the matching + packages. A package specifier that matches all version of the package + can also be written pkg-*, + to make it clearer that multiple packages are being matched. + + + + ghc-pkg register file + + Reads a package specification from + file (which may be “-” + to indicate standard input), + and adds it to the database of installed packages. The syntax of + file is given in . + + The package specification must be a package that isn't already installed. - - + + - - - - - - - - - - Read new package specifications from file - file. If a value of - "-" is given, standard input is used. - If no is present on the command-line, - an input file of "-" is assumed. - - - + + ghc-pkg update file + + The same as register, except that if a + package of the same name is already installed, it is + replaced by the new one. + + - - - - - - - - - - Automatically generate the GHCi + + ghc-pkg unregister P + + Remove the specified package from the database. + + + + + ghc-pkg expose P + + Sets the exposed flag for package + P to True. + + + + + ghc-pkg hide P + + Sets the exposed flag for package + P to False. + + + + + ghc-pkg list [P] [] + + This option displays the currently installed + packages, for each of the databases known to + ghc-pkg. That includes the global database, the + user's local database, and any further files specified using the + option on the command line. + + Hidden packages (those for which the exposed + flag is False) are shown in parentheses in the + list of packages. + + If an optional package identifier P + is given, then only packages matching that identifier are + shown. + + If the option is given, then + the packages are listed on a single line separated by spaces, and + the database names are not included. This is intended to make it + easier to parse the output of ghc-pkg list using + a script. + + + + + ghc-pkg latest P + + Prints the latest available version of package + P. + + + + + ghc-pkg describe P + + Emit the full description of the specified package. The + description is in the form of an + InstalledPackageInfo, the same as the input file + format for ghc-pkg register. See for details. + + + + + ghc-pkg field P field + + Show just a single field of the installed package description + for P. + + + + + Additionally, the following flags are accepted by + ghc-pkg: + + + + + + + + + Automatically generate the GHCi .o version of each .a Haskell library, using GNU ld (if that is available). Without this option, @@ -297,198 +547,379 @@ the auto packages required for linking without further assistance. this option will cause the GHCi library to be created in the same directory as the .a library. - - + + + + + + file + + + + + file + + + + + Adds file to the stack of package + databases. Additionally, file will + also be the database modified by a register, + unregister, expose or + hide command, unless it is overriden by a later + , or + option. + + + + + + + + + + + + Causes ghc-pkg to ignore missing + dependencies, directories and libraries when registering a package, + and just go ahead and add it anyway. This might be useful if your + package installation system needs to add the package to + GHC before building and installing the files. + + + + + + + + + + Operate on the global package database (this is the default). + This flag affects the register, + update, unregister, + expose, and hide + commands. + + + + + + + + + + + + + + Outputs the command-line syntax. + + + + + + + + + + Operate on the current user's local package database. + This flag affects the register, + update, unregister, + expose, and hide + commands. + + + + + + + + + + + + + + Output the ghc-pkg version number. + + + + + When modifying the package database + file, a copy of the original file is + saved in file.old, + so in an emergency you can always restore the old settings by + copying the old file back again. + + + + + + <literal>InstalledPackageInfo</literal>: a package specification + + + A package specification is a Haskell record; in particular, it is the + record InstalledPackageInfo in the module Distribution.InstalledPackageInfo, which is part of the Cabal package distributed with GHC. + + An InstalledPackageInfo has a human + readable/writable syntax. The functions + parseInstalledPackageInfo and + showInstalledPackageInfo read and write this syntax + respectively. Here's an example of the + InstalledPackageInfo for the unix package: + + +$ ghc-pkg describe unix +name: unix +version: 1.0 +license: BSD3 +copyright: +maintainer: libraries@haskell.org +stability: +homepage: +package-url: +description: +category: +author: +exposed: True +exposed-modules: System.Posix, + System.Posix.DynamicLinker.Module, + System.Posix.DynamicLinker.Prim, + System.Posix.Directory, + System.Posix.DynamicLinker, + System.Posix.Env, + System.Posix.Error, + System.Posix.Files, + System.Posix.IO, + System.Posix.Process, + System.Posix.Resource, + System.Posix.Temp, + System.Posix.Terminal, + System.Posix.Time, + System.Posix.Unistd, + System.Posix.User, + System.Posix.Signals.Exts +import-dirs: /usr/lib/ghc-6.4/libraries/unix +library-dirs: /usr/lib/ghc-6.4/libraries/unix +hs-libraries: HSunix +extra-libraries: HSunix_cbits, dl +include-dirs: /usr/lib/ghc-6.4/libraries/unix/include +includes: HsUnix.h +depends: base-1.0 + + + The full Cabal documentation + is still in preparation (at time of writing), so in the meantime + here is a brief description of the syntax of this file: + + A package description consists of a number of field/value pairs. A + field starts with the field name in the left-hand column followed by a + “:”, and the value continues until the next line that begins in the + left-hand column, or the end of file. + + The syntax of the value depends on the field. The various field + types are: + + + + freeform + + Any arbitrary string, no interpretation or parsing is + done. + + + + string + + A sequence of non-space characters, or a sequence of arbitrary + characters surrounded by quotes "....". + + + + string list + + A sequence of strings, separated by commas. The sequence may + be empty. + + + + + In addition, there are some fields with special syntax (e.g. package + names, version, dependencies). + + The allowed fields, with their types, are: + + + + + name + namepackage specification + + + The package's name (without the version). + + + + + + version + versionpackage specification + + + The package's version, usually in the form + A.B (any number of components are allowed). + + + + + + license + autopackage specification + + + (string) The type of license under which this package is distributed. + This field is a value of the License type. + + - - + license-file + license-filepackage specification + + (optional string) The name of a file giving detailed license + information for this package. + + + + - + copyright + copyrightpackage specification - Use file as an additional - package configuration file. This is used to modify - configuration files for use with GHC's - option. - - There may be any number of configuration files named - on the command line; files mentioned later on the - command-line override those mentioned earlier. The - last configuration file mentioned on - the command-line is the only one that is actually modified - by ghc-pkg. - + (optional freeform) The copyright string. - - + maintainer + maintainerpackage specification + + (optinoal freeform) The email address of the package's maintainer. + + + + - + stability + stabilitypackage specification - This option displays the list of currently installed - packages, including those in extra configuration files - specified with the - option. - - - $ ghc-pkg ––list-packages - /usr/local/lib/ghc-5.05/package.conf: - hdirect, readline, lang, concurrent, posix, util, data, text, net, - hssource, rts, haskell98, network, haskell-src, unix, base - - - Note that your GHC installation might have a - slightly different set of packages installed. - - The rts package is always - present, and represents the runtime system library. The - base package contains the Haskell - prelude and basic hierarchical libraries, and the - haskell98 package contains the Haskell - 98 standard libraries. The rest of the packages are - optional libraries. + (optional freeform) A string describing the stability of the package + (eg. stable, provisional or experimental). - - + homepage + homepagepackage specification - - + + (optional freeform) URL of the package's home page. + + + + + + package-url + package-urlpackage specification - Displays the list of packages installed in the - topmost configuration file only: that will be the - configuration file specified using on - the command line, or the system configuration file - otherwise. - - This option may be more convenient than - when the output needs to be parsed by - a script. + (optional freeform) URL of a downloadable distribution for this + package. The distribution should be a Cabal package. - - + description + descriptionpackage specification + + (optional freeform) Description of the package. + + + + - + category + categorypackage specification - Removes the specified package from the installed - configuration. + (optinoal freeform) Which category the package belongs to. This field + is for use in conjunction with a future centralised package + distribution framework, tentatively titled Hackage. + - - - - - + author + authorpackage specification - Reads package specification from the input, and - adds it to the database of installed packages. If a package - with the same name is already installed, its configuration - data is replaced with the new information. If the package - doesn't already exist, it's added. - + (optional freeform) Author of the package. + - - + exposed + exposedpackage specification - Causes ghc-pkg to ignore missing - directories and libraries when adding a package, and just - go ahead and add it anyway. This might be useful if your - package installation system needs to add the package to - GHC before building and installing the files. + (bool) Whether the package is exposed or not. - - - When modifying the configuration file - file, a copy of the original file is - saved in file.old, - so in an emergency you can always restore the old settings by - copying the old file back again. - - A package specification looks like this: - - - Package { - name = "mypkg", - auto = True, - import_dirs = ["${installdir}/imports/mypkg"], - source_dirs = [], - library_dirs = ["${installdir}"], - hs_libraries = ["HSmypkg" ], - extra_libraries = ["HSmypkg_cbits"], - include_dirs = [], - c_includes = ["HsMyPkg.h"], - package_deps = ["text", "data"], - extra_ghc_opts = [], - extra_cc_opts = [], - extra_ld_opts = ["-lmy_clib"] - } - - Components of a package specification may be specified in - any order, and are: - - - name - namepackage specification + exposed-modules + exposed-modulespackage specification - The package's name, for use with - the -package flag and as listed in the - ––list-packages list. - + (string list) modules exposed by this package. - auto - autopackage specification + hidden-modules + hidden-modulespackage specification - Set to True if the package should - be automatically available (see ). This is normally set to - True for packages which contain - hierarchical libraries, because in that case there is no - danger of polluting the module namespace. - + (string list) modules provided by this package, + but not exposed to the programmer. These modules cannot be + imported, but they are still subject to the overlapping constraint: + no other package in the same program may provide a module of the + same name. + - import_dirs - import_dirspackage specification + import-dirs + import-dirspackage specification - A list of directories containing interface files + (string list) A list of directories containing interface files (.hi files) for this package. If the package contains profiling libraries, then @@ -502,35 +933,22 @@ the auto packages required for linking without further assistance. - source_dirs - source_dirspackage specification + library-dirs + library-dirspackage specification - A list of directories containing Haskell source - files for this package. This field isn't used by GHC, but - could potentially be used by an all-interpreted system - like Hugs. - - - - - - library_dirs - library_dirspackage specification - - - A list of directories containing libraries for this + (string list) A list of directories containing libraries for this package. - hs_libraries - hs_librariespackage specification + hs-libraries + hs-librariespackage specification - A list of libraries containing Haskell code for this + (string list) A list of libraries containing Haskell code for this package, with the .a or .dll suffix omitted. When packages are built as libraries, the @@ -572,43 +990,42 @@ the auto packages required for linking without further assistance. - - extra_libraries - extra_librariespackage specification + extra-libraries + extra-librariespackage specification - A list of extra libraries for this package. The - difference between hs_libraries and - extra_libraries is that - hs_libraries normally have several + (string list) A list of extra libraries for this package. The + difference between hs-libraries and + extra-libraries is that + hs-libraries normally have several versions, to support profiling, parallel and other build options. The various versions are given different suffixes to distinguish them, for example the profiling version of the standard prelude library is named - libHSstd_p.a, with the + libHSbase_p.a, with the _p indicating that this is a profiling version. The suffix is added automatically by GHC for - hs_libraries only, no suffix is added + hs-libraries only, no suffix is added for libraries in - extra_libraries. + extra-libraries. The libraries listed in - extra_libraries may be any libraries + extra-libraries may be any libraries supported by your system's linker, including dynamic libraries (.so on Unix, .DLL on Windows). - Also, extra_libraries are placed + Also, extra-libraries are placed on the linker command line after the - hs_libraries for the same package. If + hs-libraries for the same package. If your package has dependencies in the other direction (i.e. - extra_libraries depends on - hs_libraries), and the libraries are + extra-libraries depends on + hs-libraries), and the libraries are static, you might need to make two separate packages. @@ -616,23 +1033,23 @@ the auto packages required for linking without further assistance. - include_dirs - include_dirspackage specification + include-dirs + include-dirspackage specification - A list of directories containing C includes for this - package (maybe the empty list). + (string list) A list of directories containing C includes for this + package. - c_includes - c_includespackage specification + includes + includespackage specification - A list of files to include for via-C compilations - using this package. Typically this include file will + (string list) A list of files to include for via-C compilations + using this package. Typically the include file(s) will contain function prototypes for any C functions used in the package, in case they end up being called as a result of Haskell functions from the package being @@ -642,33 +1059,34 @@ the auto packages required for linking without further assistance. - package_deps - package_depspackage specification + depends + dependspackage specification - A list of packages which this package depends - on. + (package name list) Packages on which this package depends. This field contains + packages with explicit versions are required, except that when + submitting a package to ghc-pkg register, the + versions will be filled in if they are unambiguous. - extra_ghc_opts - extra_ghc_optspackage specification + hugs-options + hugs-optionspackage specification - Extra arguments to be added to the GHC command line - when this package is being used. + (string list) Options to pass to Hugs for this package. - extra_cc_opts - extra_cc_optspackage specification + cc-options + cc-optionspackage specification - Extra arguments to be added to the gcc command line + (string list) Extra arguments to be added to the gcc command line when this package is being used (only for via-C compilations). @@ -676,11 +1094,11 @@ the auto packages required for linking without further assistance. - extra_ld_opts - extra_ld_optspackage specification + ld-options + ld-optionspackage specification - Extra arguments to be added to the + (string list) Extra arguments to be added to the gcc command line (for linking) when this package is being used. @@ -688,29 +1106,55 @@ the auto packages required for linking without further assistance. - framework_dirs - framework_dirspackage specification + framework-dirs + framework-dirspackage specification + + + (string list) On Darwin/MacOS X, a list of directories containing + frameworks for this package. This corresponds to the + option. It is ignored on all other + platforms. + + + + + + frameworks + frameworkspackage specification - On Darwin/MacOS X, a list of directories containing frameworks for this - package. This corresponds to the option. - It is ignored on all other platforms. + (string list) On Darwin/MacOS X, a list of frameworks to link to. This + corresponds to the option. Take a look + at Apple's developer documentation to find out what frameworks + actually are. This entry is ignored on all other platforms. - extra_frameworks - extra_frameworkspackage specification + haddock-interfaces + haddock-interfacespackage specification - On Darwin/MacOS X, a list of frameworks to link to. This corresponds to the - option. Take a look at Apple's developer documentation - to find out what frameworks actually are. This entry is ignored on all other platforms. + (string list) A list of filenames containing Haddock interface + files (.haddock files) for this package. + + + + + + haddock-html + haddock-htmlpackage specification + + + (optional string) The directory containing the Haddock-generated HTML + for this package. + +