Modulehledger-1.52.4GHC2021

Hledger.Cli.DocFiles

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

1 type
5 values

Packagehledger-1.52.4
Exports6
LanguageGHC2021
LicenceGPL-3.0-or-later
SourceDocFiles.hs

typetype Topic = String

valueprintHelpForTopic :: Tool -> Maybe Topic -> IO ()

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

valuerunManForTopic :: 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.

valuerunInfoForTopic :: 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.

valuerunPagerForTopic :: 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.

valuerunTldrForPage :: TldrPage -> IO ()

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