optparse-applicative-0.15.1.0: Utilities and combinators for parsing command line options

Safe HaskellSafe
LanguageHaskell98

Options.Applicative.Help.Core

Synopsis

Documentation

cmdDesc :: Parser a -> [(Maybe String, Chunk Doc)] #

Generate descriptions for commands.

briefDesc :: ParserPrefs -> Parser a -> Chunk Doc #

Generate a brief help text for a parser.

missingDesc :: ParserPrefs -> Parser a -> Chunk Doc #

Generate a brief help text for a parser, only including mandatory options and arguments.

fullDesc :: ParserPrefs -> Parser a -> Chunk Doc #

Generate a full help text for a parser.

data ParserHelp #

Instances
Show ParserHelp # 
Instance details

Defined in Options.Applicative.Help.Types

Methods

showsPrec :: Int -> ParserHelp -> ShowS

show :: ParserHelp -> String

showList :: [ParserHelp] -> ShowS

Semigroup ParserHelp # 
Instance details

Defined in Options.Applicative.Help.Types

Methods

(<>) :: ParserHelp -> ParserHelp -> ParserHelp #

sconcat :: NonEmpty ParserHelp -> ParserHelp

stimes :: Integral b => b -> ParserHelp -> ParserHelp

Monoid ParserHelp # 
Instance details

Defined in Options.Applicative.Help.Types

parserHelp :: ParserPrefs -> Parser a -> ParserHelp #

Generate the help text for a program.

parserUsage :: ParserPrefs -> Parser a -> String -> Doc #

Generate option summary.