Command -package:hedgehog package:Cabal

module Distribution.Simple.Command
Cabal
This is to do with command line handling. The Cabal command line is organised into a number of named sub-commands (much like darcs). The CommandUI abstraction represents one of these sub-commands, with a name, description, a set of flags. Commands can be associated with actions and run. It handles some common stuff automatically, like the --help and command line completion flags. It is designed to allow other tools make derived commands. This feature is used heavily in cabal-install.
data Command action
Cabal Distribution.Simple.Command
CommandErrors :: [String] -> CommandParse flags
Cabal Distribution.Simple.Command
CommandHelp :: (String -> String) -> CommandParse flags
Cabal Distribution.Simple.Command
CommandList :: [String] -> CommandParse flags
Cabal Distribution.Simple.Command
data CommandParse flags
Cabal Distribution.Simple.Command
CommandReadyToGo :: flags -> CommandParse flags
Cabal Distribution.Simple.Command
data CommandSpec action
Cabal Distribution.Simple.Command
wraps a CommandUI together with a function that turns it into a Command. By hiding the type of flags for the UI allows construction of a list of all UIs at the top level of the program. That list can then be used for generation of manual page as well as for executing the selected command.
CommandSpec :: CommandUI flags -> (CommandUI flags -> Command action) -> CommandType -> CommandSpec action
Cabal Distribution.Simple.Command
data CommandType
Cabal Distribution.Simple.Command
data CommandUI flags
Cabal Distribution.Simple.Command
CommandUI :: String -> String -> (String -> String) -> Maybe (String -> String) -> Maybe (String -> String) -> flags -> (ShowOrParseArgs -> [OptionField flags]) -> CommandUI flags
Cabal Distribution.Simple.Command
commandAddAction :: CommandUI flags -> (flags -> [String] -> action) -> Command action
Cabal Distribution.Simple.Command
commandDefaultFlags :: CommandUI flags -> flags
Cabal Distribution.Simple.Command
Initial / empty flags
commandDescription :: CommandUI flags -> Maybe (String -> String)
Cabal Distribution.Simple.Command
Additional explanation of the command to use in help texts.
commandFromSpec :: CommandSpec a -> Command a
Cabal Distribution.Simple.Command
commandName :: CommandUI flags -> String
Cabal Distribution.Simple.Command
The name of the command as it would be entered on the command line. For example "build".
commandNotes :: CommandUI flags -> Maybe (String -> String)
Cabal Distribution.Simple.Command
Post-Usage notes and examples in help texts
commandOptions :: CommandUI flags -> ShowOrParseArgs -> [OptionField flags]
Cabal Distribution.Simple.Command
All the Option fields for this command
commandParseArgs :: CommandUI flags -> Bool -> [String] -> CommandParse (flags -> flags, [String])
Cabal Distribution.Simple.Command
Parse a bunch of command line arguments
commandShowOptions :: CommandUI flags -> flags -> [String]
Cabal Distribution.Simple.Command
Show flags in the standard long option command line format
commandSynopsis :: CommandUI flags -> String
Cabal Distribution.Simple.Command
A short, one line description of the command to use in help texts.
commandUsage :: CommandUI flags -> String -> String
Cabal Distribution.Simple.Command
A function that maps a program name to a usage summary for this command.
commandsRun :: CommandUI a -> [Command action] -> [String] -> CommandParse (a, CommandParse action)
Cabal Distribution.Simple.Command
HiddenCommand :: CommandType
Cabal Distribution.Simple.Command