Fields

• programName :: String

  The simple name of the program, eg. ghc

• programFindLocation :: Verbosity -> ProgramSearchPath -> IO (Maybe (FilePath, [FilePath]))

  A function to search for the program if its location was not specified by the user. Usually this will just be a call to findProgramOnSearchPath.

  It is supplied with the prevailing search path which will typically just be used as-is, but can be extended or ignored as needed.

  For the purpose of change monitoring, in addition to the location where the program was found, it returns all the other places that were tried.

• programFindVersion :: Verbosity -> FilePath -> IO (Maybe Version)

  Try to find the version of the program. For many programs this is not possible or is not necessary so it's OK to return Nothing.

• programPostConf :: Verbosity -> ConfiguredProgram -> IO ConfiguredProgram

  A function to do any additional configuration after we have located the program (and perhaps identified its version). For example it could add args, or environment vars.

• programNormaliseArgs :: Maybe Version -> PackageDescription -> [String] -> [String]

  A function that filters any arguments that don't impact the output from a commandline. Used to limit the volatility of dependency hashes when using new-build.

Fields

• 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 ths 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).

Fields

• locationPath :: FilePath
   

Fields

• locationPath :: FilePath