System.Console.Command

Documentation

type Commands setting = Tree (Command setting)

Commands s is a tree of commands. It represents the whole set of possible commands of a program.

data Command s

A Command s is an action, together with some descriptive information: name (this is the textual command that invokes the action), description, and lists of applicable options and non-options. s is the type of setting.

Constructors

Command

Fields

name :: String

applicableNonOptions :: [String]

applicableOptions :: [OptDescr (Either String s)]

description :: String

action :: Action (Options s)

single :: Setting s => Options s -> Commands s -> IO ()

Load the configuration file (if present), and run the action given on the command line.

showUsage :: Commands o -> IO ()

Show usage info for the program.