HORIZON HASKELLDocslts/ghc-10.0.x8174fa42026-10-11Search names, modules, packages, or :: a typeCtrl K

GHC 10.0.0.20260917 · lts/ghc-10.0.x · 8174fa4 · 2026-10-11

ModuleCabal-3.18.1.0Haskell2010

Distribution.Simple.Program.HcPkg

This module provides an library interface to the hc-pkg program. Currently only GHC and GHCJS have hc-pkg programs.

  • 2 types
  • 20 values
  • PackageCabal-3.18.1.0
  • Exports22
  • LanguageHaskell2010
  • LicenceBSD-3-Clause
  • SourceHcPkg.hs

Types

3 declarations
datadata ConfiguredProgram
#

Represents a program which has been configured and is thus ready to be run.

These are usually made by configuring a Program, but if you have to construct one directly then start with simpleConfiguredProgram and override any extra fields.

Constructors

  • ConfiguredProgram
    • programId :: String

      Just the name again

    • programVersion :: Maybe Version

      The version of this program, if it is known.

    • programDefaultArgs :: [String]

      Default command-line args for this program. These flags will appear first on the command line, so they can be overridden by subsequent flags.

    • programOverrideArgs :: [String]

      Override command-line args for this program. These flags will appear last on the command line, so they override all earlier flags.

    • programOverrideEnv :: [(String, Maybe String)]

      Override environment variables for this program. These env vars will extend/override the prevailing environment of the current to form the environment for the new process.

    • programProperties :: Map String String

      A key-value map listing various properties of the program, useful for feature detection. Populated during the configuration step, key names depend on the specific program.

    • programLocation :: ProgramLocation

      Location of the program. eg. /usr/bin/ghc-6.4

    • programMonitorFiles :: [FilePath]

      In addition to the programLocation where the program was found, these are additional locations that were looked at. The combination of this found location and these not-found locations can be used to monitor to detect when the re-configuring the program might give a different result (e.g. found in a different location).

Instances7Eq, Read, Show, Generic, Binary, Structured, …
datadata RegisterOptions
#

Additional variations in the behaviour for register.

Constructors

  • RegisterOptions
    • registerAllowOverwrite :: Bool

      Allows re-registering / overwriting an existing package

    • registerMultiInstance :: Bool

      Insist on the ability to register multiple instances of a single version of a single package.

    • registerSuppressFilesCheck :: Bool

      Require that no checks are performed on the existence of package files mentioned in the registration info. This must be used if registering prior to putting the files in their final place. This will fail if the hc-pkg does not support it, see suppressFilesCheck.

Actions

10 declarations

Program invocations

9 declarations