System.Console.ArgParser.Run

Functions used to build and run command line applications.

Running a parser

withParseResult :: ParserSpec a -> (a -> IO ()) -> IO ()

Runs an apllication with the user provided arguments. It is a shorter way of calling mkApp and runApp

runApp

Arguments

:: CmdLnInterface a

Command line spec

-> (a -> IO ())

Process to run if the parsing success

-> IO ()

Runs a command line application with the user provided arguments. If the parsing succeeds, run the application. Print the returned message otherwise

parseArgs

Arguments

:: Args

Arguments to parse

-> CmdLnInterface a

Command line spec

-> ParseResult a

Parse the arguments with the parser provided to the function.

parseNiceArgs

Arguments

:: NiceArgs

Arguments to parse

-> CmdLnInterface a

Command line spec

-> ParseResult a

Parse the arguments with the parser provided to the function.

Building a parser

mkApp :: ParserSpec a -> IO (CmdLnInterface a)

Build an application with no version/description and with a name equal to the file name.

mkDefaultApp :: ParserSpec a -> String -> CmdLnInterface a

Build an application with no version/description and with a name equal to the provided String.

defaultSpecialFlags :: [SpecialFlag a]

default version and help special actions

setAppDescr :: CmdLnInterface a -> String -> CmdLnInterface a

Set the description of an interface

setAppEpilog :: CmdLnInterface a -> String -> CmdLnInterface a

Set the bottom text of an interface

setAppName :: CmdLnInterface a -> String -> CmdLnInterface a

Set the name of an interface