% HSlackBuilder
% Andrea Rossato
About
-----
[HSlackBuilder] is a simple application, at the present time only
`cabal2slackBuild`, that will generate all needed scripts to build
from the source a [Hackage] package released in the [Cabal] format and
create a [Slackware] package to be install with [Slackware] `pkgtools`.
Download
--------
[HSlackBuilder] can be downloaded from [Hackage]:
        http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hslackbuilder
The darcs code can be retrieved from here:
        darcs get http://code.haskell.org/~arossato/hslackbuilder
Installation
------------
To install simply run:
        tar xvfz hslackbuilder-0.0.1.tar.gz
        cd hslackbuilder-0.0.1
        runhaskell Setup.lhs configure --prefix=/usr/local
        runhaskell Setup.lhs build
        runhaskell Setup.lhs install # possibly to be run as root
Running
-------
Given a [Cabal] package named `example-0.1.tar.gz`, run:
        cabal2slackBuild example-0.1.tar.gz
This will generate:
        doinst.sh
        example.SlackBuild
        slack-desc
If `cabal2slackBuild` is run with the `-r` option also a
`slack-required` will be generated. This file will contain *only* the
[Haskell] packages needed for compiling `example`. If one of these
packages is missing, instead of producing the slackBuild scripts,
`cabal2slackBuild` will produce a warning.
This is the output of `cabal2slackBuild -h`
        Usage: cabal2slackBuild [OPTION...] FILE
        The file must be a .tar.gz of a cabal package.
        Options:
          -h, -?           --help                       This help
          -V               --version                    Show version information
          -b build number  --build-number=build number  The build number
          -a architecture  --arch=architecture          The architecture
          -p               --hs-prefix                  Use a 'hs-' prefix in package name to
                                                        avoid conflicts with slackware package
                                                        names
          -r               --required                   Generate a slack-required from the
                                                        dependency field
Known Bugs and Issues
---------------------
1. At the present time no [Haddock] documentation is generated for
executables. See:
        http://hackage.haskell.org/trac/hackage/ticket/250
2. [Haddock]-2.0.0.0 doesn't support the `--hoogle` option anymore.
3. The [Cabal] `haddock --hyperlink-source` option seems to be broken:
         http://hackage.haskell.org/trac/hackage/ticket/248
Please report bugs to:
         andrea.rossato AT unibz . it
Author
------
Andrea Rossato
`andrea.rossato AT unibz . it`
Legal
-----
This software is released under a BSD-style license. See LICENSE for
more details.
Copyright © 2007 Andrea Rossato
[Cabal]: http://www.haskell.org/cabal
[Hackage]: http://hackage.haskell.org
[Haskell]: http://www.haskell.org
[Haddock]: http:www.haskell.org/haddock
[HSlackBuilder]: http://hackage.haskell.org/cgi-bin/hackage-scripts/package/hslackbuilder
[Slackware]: http://www.slackware.com