Hledger.Cli.DocFiles

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

|

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 the "man" executable in $PATH. Note when a topic is provided we force man to use the "less" executable in $PATH, 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.

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

Display plain text help for this tool, scrolled to the given topic if provided, using the given pager executable. Note when a topic is provided we ignore the provided pager and use the "less" executable in $PATH.