Safe Haskell	None
Language	Haskell98

System.Console.Args

Contents

Helpers

Synopsis

Documentation

data Args Source

Constructors

Args
Fields posArgs :: [String] namedArgs :: Opts String

Instances

Eq Args
Show Args
Monoid Args

newtype Opts a Source

Constructors

Opts
Fields getOpts :: Map String [a]

Instances

Functor Opts
Foldable Opts
Traversable Opts
Eq a => Eq (Opts a)
Show a => Show (Opts a)
ToJSON a => ToJSON (Opts a)
FromJSON a => FromJSON (Opts a)
Monoid (Opts a)

data Arg Source

Constructors

Flag
Required String
List String

Instances

Eq Arg
Ord Arg
Show Arg

data Opt Source

Constructors

Opt
Fields optName :: String optShort :: [Char] optLong :: [String] optDescription :: Maybe String optArg :: Arg

Instances

Eq Opt
Show Opt
Help Opt
Help [Opt]

withOpts :: (Opts String -> Opts String) -> Args -> Args Source

defOpts :: Opts String -> Opts String -> Opts String Source

Set default values, if option doesn't present

defArgs :: Opts String -> Args -> Args Source

selectOpts :: [Opt] -> Opts a -> Opts a Source

splitOpts :: [Opt] -> Opts a -> (Opts a, Opts a) Source

(%--) :: Format a => String -> a -> Opts String Source

(%-?) :: Format a => String -> Maybe a -> Opts String Source

hoist :: String -> Opts a Source

Make Opts with flag set

has :: String -> Opts a -> Bool Source

arg :: String -> Opts a -> Maybe a Source

Get argument value

narg :: (Read a, Num a) => String -> Opts String -> Maybe a Source

Get numeric value

iarg :: String -> Opts String -> Maybe Integer Source

Get integer value

listArg :: String -> Opts a -> [a] Source

Get list argument

flagSet :: String -> Opts a -> Bool Source

Is flag set

flag :: String -> Opt Source

Flag option

req :: String -> String -> Opt Source

Required option

list :: String -> String -> Opt Source

List option

manyReq :: Opt -> Opt Source

Convert req option to list

desc :: Opt -> String -> Opt Source

Set description

flag "quiet" `desc` "quiet mode"

alias :: Opt -> [String] -> Opt Source

Set aliases

fliag "quiet" `alias`

short :: Opt -> [Char] -> Opt Source

Shortcuts

parse :: [Opt] -> [String] -> Either String Args Source

parse_ :: [String] -> Args Source

Parse with no options declarations

tryParse :: [Opt] -> [String] -> Args Source

toArgs :: Args -> [String] Source

info :: [Opt] -> String Source

Helpers

splitArgs :: String -> [String] Source

unsplitArgs :: [String] -> String Source

verify :: [Opt] -> Args -> Either String Args Source

module Data.Help