hub.darcs.net :: dunrix -> hslackbuilder -> files

% HSlackBuilder
% Andrea Rossato, Damon Unrix

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://hub.darcs.net/dunrix/hslackbuilder

The darcs code can be retrieved from here:

        darcs get http://hub.darcs.net/dunrix/hslackbuilder

Installation
------------

To install simply run:

        tar xvfz hslackbuilder-0.0.4.tar.gz
        cd hslackbuilder-0.0.4
        runhaskell Setup.lhs configure --user
        runhaskell Setup.lhs build
        runhaskell Setup.lhs install --user

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
      -t tag name      --tag-name=tag name          The name of the builder
      -l               --link                       The Haddock documentation will link the source code
      -p               --profile                    Build libraries with profiling information
      -n               --no-shared                  Do not build with shared libraries
      -w               --without-prefix             Do not use a 'haskell-' prefix in package name
      -r               --required                   Generate a slack-required from the dependency field
      -c path to css   --hs-colour=path to css      The source code will be colorize with hs-colour

Default tag name is `hsb', for script published at http://slackbuilds.org use
"-t _SBo" option please.


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:

         dunrix29a AT gmail . com


Authors
------

Andrea Rossato

`andrea.rossato AT unibz . it`

Damon Unrix

`dunrix29a AT gmail . com`


Legal
-----

This software is released under a BSD-style license. See LICENSE for
more details.

Copyright © 2007 Andrea Rossato
Copyright © 2015 Damon Unrix


[Cabal]: http://www.haskell.org/cabal
[Hackage]: http://hackage.haskell.org
[Haskell]: http://www.haskell.org
[Haddock]: http:www.haskell.org/haddock
[HSlackBuilder]: http://hub.darcs.net/dunrix/hslackbuilder
[Slackware]: http://www.slackware.com