Hledger.Cli.DocFiles

hledger-1.41: 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
- printHelpForTopic :: Tool -> Maybe Topic -> IO ()
- runManForTopic :: Tool -> Maybe Topic -> IO ()
- runInfoForTopic :: Tool -> Maybe Topic -> IO ()
- runPagerForTopic :: Tool -> Maybe Topic -> IO ()
- runTldrForPage :: TldrPage -> IO ()

# Documentation

type Topic = String #

printHelpForTopic :: Tool -> Maybe Topic -> IO () #

Print plain text help for this tool. Takes an optional topic argument for convenience but it is currently ignored.

runManForTopic :: Tool -> Maybe Topic -> IO () #

Display a man page for this tool, scrolled to the given topic if provided, using "man". When a topic is provided we force man to use "less", ignoring $MANPAGER and $PAGER.

runInfoForTopic :: Tool -> Maybe Topic -> IO () #

Display an info manual for this topic, opened at the given topic if provided, using the "info" executable in $PATH. Topic can be an exact heading or a heading prefix; info will favour an exact match.

runPagerForTopic :: Tool -> Maybe Topic -> IO () #

Display plain text help for this tool, scrolled to the given topic if any, using the users $PAGER or "less". When a topic is provided we always use less, ignoring $PAGER.

This is less robust than the newer Hledger.Utils.IO.runPager, but that one doesn't yet support scrolling to a topic.

runTldrForPage :: TldrPage -> IO () #

Display one of the hledger tldr pages, using "tldr".