Env.Internal.Help · envparse-0.6.0

valuehelpInfo :: Info e -> Parser e b -> [(String, e)] -> String

valuehelpDoc :: Int -> Parser e a -> String

A pretty-printed list of recognized environment variables suitable for usage messages

datadata Info e

Parser's metadata

typetype ErrorHandler e = String -> e -> Maybe String

Given a variable name and an error value, try to produce a useful error message

valuedefaultInfo :: Info Error

valuedefaultErrorHandler :: (AsUnset e, AsEmpty e, AsUnread e) => ErrorHandler e

The default error handler

valueheader :: String -> Info e -> Info e

Set the help text header (it usually includes the application's name and version)

valuedesc :: String -> Info e -> Info e

Set the short description

valuefooter :: String -> Info e -> Info e

Set the help text footer (it usually includes examples)

valuewidthMax :: Int -> Info e -> Info e

Set the max info width.

Note: It will be set to 26 columns if a smaller value is passed.

valuehandleError :: ErrorHandler e -> Info x -> Info e

An error handler