optparse-applicative-0.16.0.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)] Source #

Generate descriptions for commands.

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

Generate a brief help text for a parser.

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

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

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

Generate a full help text for a parser

globalDesc :: ParserPrefs -> Parser a -> Chunk Doc Source #

Generate a help text for the parser, showing only what is relevant in the "Global options: section"

data ParserHelp Source #

Constructors

ParserHelp 

Fields

Instances
Show ParserHelp Source # 
Instance details

Defined in Options.Applicative.Help.Types

Methods

showsPrec :: Int -> ParserHelp -> ShowS #

show :: ParserHelp -> String #

showList :: [ParserHelp] -> ShowS #

Semigroup ParserHelp Source # 
Instance details

Defined in Options.Applicative.Help.Types

Methods

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

sconcat :: NonEmpty ParserHelp -> ParserHelp #

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

Monoid ParserHelp Source # 
Instance details

Defined in Options.Applicative.Help.Types

Methods

mempty :: ParserHelp #

mappend :: ParserHelp -> ParserHelp -> ParserHelp #

mconcat :: [ParserHelp] -> ParserHelp #

errorHelp :: Chunk Doc -> ParserHelp Source #

headerHelp :: Chunk Doc -> ParserHelp Source #

suggestionsHelp :: Chunk Doc -> ParserHelp Source #

usageHelp :: Chunk Doc -> ParserHelp Source #

bodyHelp :: Chunk Doc -> ParserHelp Source #

footerHelp :: Chunk Doc -> ParserHelp Source #

globalsHelp :: Chunk Doc -> ParserHelp Source #

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

Generate the help text for a program.

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

Generate option summary.

parserGlobals :: ParserPrefs -> Parser a -> ParserHelp Source #