Copyright	(c) Maciek Makowski 2015
License	BSD-like
Maintainer	cabal-devel@haskell.org
Stability	provisional
Portability	portable
Safe Haskell	Safe-Inferred
Language	Haskell2010

Distribution.Client.Manpage

Contents

Manual page generation

Description

Functions for building the manual page.

Synopsis

manpage :: String -> [CommandSpec a] -> String
manpageCmd :: String -> [CommandSpec a] -> ManpageFlags -> IO ()
data ManpageFlags
defaultManpageFlags :: ManpageFlags
manpageOptions :: ShowOrParseArgs -> [OptionField ManpageFlags]

Manual page generation

manpage :: String -> [CommandSpec a] -> String Source #

Produces a manual page with troff markup.

manpageCmd :: String -> [CommandSpec a] -> ManpageFlags -> IO () Source #

data ManpageFlags Source #

Instances

Instances details

Monoid ManpageFlags Source #
Instance details Defined in Distribution.Client.ManpageFlags Methods mempty :: ManpageFlags # mappend :: ManpageFlags -> ManpageFlags -> ManpageFlags # mconcat :: [ManpageFlags] -> ManpageFlags #
Semigroup ManpageFlags Source #
Instance details Defined in Distribution.Client.ManpageFlags Methods (<>) :: ManpageFlags -> ManpageFlags -> ManpageFlags # sconcat :: NonEmpty ManpageFlags -> ManpageFlags # stimes :: Integral b => b -> ManpageFlags -> ManpageFlags #
Generic ManpageFlags Source #
Instance details Defined in Distribution.Client.ManpageFlags Associated Types type Rep ManpageFlags :: Type -> Type # Methods from :: ManpageFlags -> Rep ManpageFlags x # to :: Rep ManpageFlags x -> ManpageFlags #
Show ManpageFlags Source #
Instance details Defined in Distribution.Client.ManpageFlags Methods showsPrec :: Int -> ManpageFlags -> ShowS # show :: ManpageFlags -> String # showList :: [ManpageFlags] -> ShowS #
Eq ManpageFlags Source #
Instance details Defined in Distribution.Client.ManpageFlags Methods (==) :: ManpageFlags -> ManpageFlags -> Bool # (/=) :: ManpageFlags -> ManpageFlags -> Bool #
type Rep ManpageFlags Source #
Instance details Defined in Distribution.Client.ManpageFlags type Rep ManpageFlags = D1 ('MetaData "ManpageFlags" "Distribution.Client.ManpageFlags" "cabal-install-3.10.1.0-FbhGUvZ0l0XIx7QbOQfSVh" 'False) (C1 ('MetaCons "ManpageFlags" 'PrefixI 'True) (S1 ('MetaSel ('Just "manpageVerbosity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Verbosity)) :*: S1 ('MetaSel ('Just "manpageRaw") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Flag Bool))))

defaultManpageFlags :: ManpageFlags Source #

manpageOptions :: ShowOrParseArgs -> [OptionField ManpageFlags] Source #