The options package

[Tags: library, mit]

The options package lets library and application developers easily work with command-line options.

The following example is a full program that can accept two options, --message and --quiet:

{-# LANGUAGE TemplateHaskell #-}

import Options

defineOptions "MainOptions" $ do
    stringOption "optMessage" "message" "Hello world!"
        "A message to show the user."
    boolOption "optQuiet" "quiet" False
        "Whether to be quiet."
 
main :: IO ()
main = runCommand $ \opts args -> do
    if optQuiet opts
        then return ()
        else putStrLn (optMessage opts)
$ ./hello
Hello world!
$ ./hello --message='ciao mondo'
ciao mondo
$ ./hello --quiet
$

In addition, this library will automatically create documentation options such as --help and --help-all:

$ ./hello --help
Help Options:
  -h, --help                  Show option summary.
  --help-all                  Show all help options.

Application Options:
  --message                   A message to show the user.
  --quiet                     Whether to be quiet.

Properties

Versions0.1, 0.1.1, 1.0, 1.1, 1.2
Dependenciesbase (>=4.0 && <5.0), bytestring (==0.9.*), containers (>=0.1 && <0.5), monads-tf, system-filepath (==0.4.*), template-haskell, text (>=0.7 && <0.12), transformers (==0.2.*)
LicenseMIT
AuthorJohn Millikin <jmillikin@gmail.com>
MaintainerJohn Millikin <jmillikin@gmail.com>
Stabilityexperimental
CategoryConsole
Home pagehttps://john-millikin.com/software/haskell-options/
Bug trackermailto:jmillikin@gmail.com
Source repositoryhead: bzr branch https://john-millikin.com/branches/haskell-options/0.1/
this: bzr branch https://john-millikin.com/branches/haskell-options/0.1/ -r haskell-options_0.1
Upload dateSat Mar 24 19:07:23 UTC 2012
Uploaded byJohnMillikin
DistributionsDebian:1.2, NixOS:1.2, Stackage:1.2
Downloads1240 total (144 in last 30 days)

Modules

[Index]

Downloads

Maintainers' corner

For package maintainers and hackage trustees