![](haskell_icon.gif) | Cabal-1.3.10: A framework for packaging Haskell software | Contents | Index |
|
Distribution.Simple.Setup | Portability | portable | Stability | alpha | Maintainer | Isaac Jones <ijones@syntaxpolice.org> |
|
|
|
Description |
Explanation: Data types and parser for the standard command-line
setup. Will also return commands it doesn't know about.
|
|
Synopsis |
|
|
|
Documentation |
|
data GlobalFlags |
Flags that apply at the top level, not to any sub-command.
| Constructors | | Instances | |
|
|
emptyGlobalFlags :: GlobalFlags |
|
defaultGlobalFlags :: GlobalFlags |
|
globalCommand :: CommandUI GlobalFlags |
|
data ConfigFlags |
Flags to configure command
| Constructors | ConfigFlags | | configPrograms :: ProgramConfiguration | All programs that cabal may run
| configProgramPaths :: [(String, FilePath)] | user specifed programs paths
| configProgramArgs :: [(String, [String])] | user specifed programs args
| configHcFlavor :: (Flag CompilerFlavor) | The "flavor" of the compiler, sugh as GHC or Hugs.
| configHcPath :: (Flag FilePath) | given compiler location
| configHcPkg :: (Flag FilePath) | given hc-pkg location
| configVanillaLib :: (Flag Bool) | Enable vanilla library
| configProfLib :: (Flag Bool) | Enable profiling in the library
| configSharedLib :: (Flag Bool) | Build shared library
| configProfExe :: (Flag Bool) | Enable profiling in the executables.
| configConfigureArgs :: [String] | Extra arguments to configure
| configOptimization :: (Flag OptimisationLevel) | Enable optimization.
| configProgPrefix :: (Flag PathTemplate) | Installed executable prefix.
| configProgSuffix :: (Flag PathTemplate) | Installed executable suffix.
| configInstallDirs :: (InstallDirs (Flag PathTemplate)) | Installation paths
| configScratchDir :: (Flag FilePath) | | configExtraLibDirs :: [FilePath] | path to search for extra libraries
| configExtraIncludeDirs :: [FilePath] | path to search for header files
| configVerbose :: Verbosity | verbosity level (deprecated)
| configVerbosity :: (Flag Verbosity) | verbosity level
| configUserInstall :: (Flag Bool) | The --user/--global flag
| configPackageDB :: (Flag PackageDB) | Which package DB to use
| configGHCiLib :: (Flag Bool) | Enable compiling library for GHCi
| configSplitObjs :: (Flag Bool) | Enable -split-objs with GHC
| configStripExes :: (Flag Bool) | Enable executable stripping
| configConfigurationsFlags :: [(String, Bool)] | |
|
| Instances | |
|
|
emptyConfigFlags :: ConfigFlags |
|
defaultConfigFlags :: ProgramConfiguration -> ConfigFlags |
|
configureCommand :: ProgramConfiguration -> CommandUI ConfigFlags |
|
data CopyFlags |
Flags to copy: (destdir, copy-prefix (backwards compat), verbosity)
| Constructors | | Instances | |
|
|
emptyCopyFlags :: CopyFlags |
|
defaultCopyFlags :: CopyFlags |
|
copyCommand :: CommandUI CopyFlags |
|
data InstallFlags |
Flags to install: (package db, verbosity)
| Constructors | | Instances | |
|
|
emptyInstallFlags :: InstallFlags |
|
defaultInstallFlags :: InstallFlags |
|
installCommand :: CommandUI InstallFlags |
|
data HaddockFlags |
Constructors | | Instances | |
|
|
emptyHaddockFlags :: HaddockFlags |
|
defaultHaddockFlags :: HaddockFlags |
|
haddockCommand :: CommandUI HaddockFlags |
|
data HscolourFlags |
Constructors | | Instances | |
|
|
emptyHscolourFlags :: HscolourFlags |
|
defaultHscolourFlags :: HscolourFlags |
|
hscolourCommand :: CommandUI HscolourFlags |
|
data BuildFlags |
Constructors | | Instances | |
|
|
emptyBuildFlags :: BuildFlags |
|
defaultBuildFlags :: BuildFlags |
|
buildCommand :: ProgramConfiguration -> CommandUI BuildFlags |
|
data CleanFlags |
Constructors | | Instances | |
|
|
emptyCleanFlags :: CleanFlags |
|
defaultCleanFlags :: CleanFlags |
|
cleanCommand :: CommandUI CleanFlags |
|
data MakefileFlags |
Constructors | | Instances | |
|
|
emptyMakefileFlags :: MakefileFlags |
|
defaultMakefileFlags :: MakefileFlags |
|
makefileCommand :: CommandUI MakefileFlags |
|
data RegisterFlags |
Flags to register and unregister: (user package, gen-script,
in-place, verbosity)
| Constructors | | Instances | |
|
|
emptyRegisterFlags :: RegisterFlags |
|
defaultRegisterFlags :: RegisterFlags |
|
registerCommand :: CommandUI RegisterFlags |
|
unregisterCommand :: CommandUI RegisterFlags |
|
data SDistFlags |
Flags to sdist: (snapshot, verbosity)
| Constructors | | Instances | |
|
|
emptySDistFlags :: SDistFlags |
|
defaultSDistFlags :: SDistFlags |
|
sdistCommand :: CommandUI SDistFlags |
|
testCommand :: CommandUI () |
|
data CopyDest |
The location prefix for the copy command.
| Constructors | | Instances | |
|
|
configureArgs :: Bool -> ConfigFlags -> [String] |
Arguments to pass to a configure script, e.g. generated by
autoconf.
|
|
configureOptions :: ShowOrParseArgs -> [OptionField ConfigFlags] |
|
data Flag a |
All flags are monoids, they come in two flavours:
1. list flags eg
--ghc-option=foo --ghc-option=bar
gives us all the values [foo, bar]
2. singular value flags, eg:
--enable-foo --disable-foo
gives us Just False
So this Flag type is for the latter singular kind of flag.
Its monoid instance gives us the behaviour where it starts out as
NoFlag and later flags override earlier ones.
| Constructors | | Instances | |
|
|
toFlag :: a -> Flag a |
|
fromFlag :: Flag a -> a |
|
fromFlagOrDefault :: a -> Flag a -> a |
|
flagToMaybe :: Flag a -> Maybe a |
|
flagToList :: Flag a -> [a] |
|
boolOpt :: SFlags -> SFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a |
|
boolOpt' :: OptFlags -> OptFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a |
|
trueArg :: SFlags -> LFlags -> Description -> (b -> Flag Bool) -> (Flag Bool -> b -> b) -> OptDescr b |
|
falseArg :: SFlags -> LFlags -> Description -> (b -> Flag Bool) -> (Flag Bool -> b -> b) -> OptDescr b |
|
optionVerbosity :: (flags -> Flag Verbosity) -> (Flag Verbosity -> flags -> flags) -> OptionField flags |
|
Produced by Haddock version 0.8 |