hledger-1.19.1: Command-line interface for the hledger accounting system

Safe Haskell | None
Language | Haskell2010

Hledger.Cli.DocFiles

Description

Embedded documentation files in various formats, and helpers for viewing them.

|

Synopsis

- type Topic = String
- docFiles :: [(Topic, (ByteString, ByteString, ByteString))]
- docTopics :: [Topic]
- lookupDocNroff :: Topic -> ByteString
- lookupDocTxt :: Topic -> ByteString
- lookupDocInfo :: Topic -> ByteString
- printHelpForTopic :: Topic -> IO ()
- runManForTopic :: Topic -> IO ()
- runInfoForTopic :: Topic -> IO ()
- runPagerForTopic :: FilePath -> Topic -> IO ()

# Documentation

type Topic = String Source #

docFiles :: [(Topic, (ByteString, ByteString, ByteString))] Source #

These are all the main hledger manuals, in man, txt, and info formats. Only files under the current package directory can be embedded, so most of these are symlinked here from the other package directories.

docTopics :: [Topic] Source #

lookupDocNroff :: Topic -> ByteString Source #

lookupDocTxt :: Topic -> ByteString Source #

lookupDocInfo :: Topic -> ByteString Source #

printHelpForTopic :: Topic -> IO () Source #

runManForTopic :: Topic -> IO () Source #

runInfoForTopic :: Topic -> IO () Source #

runPagerForTopic :: FilePath -> Topic -> IO () Source #