manual

This task will show the application manual. If no filters are used, i.e. no argument is provided, the text manual for the current print mode will be shown.

-h | --help        print help screen and exit

filters
-A | --all               all manual versions
     --adoc              ADOC manual
     --ansi              text manual with ansi colors andeffects
     --html              HTML manual
     --manp              manual page skb-framework(1)
     --pdf               PDF manual
     --text              plain text manual
     --text-anon         annotated text manual

The filters shown above can be used to show different versions of the manual. The filter all will show all manual versions (it overwrites all other filters). Otherwise, any number of filters can be used in any order. The task will always show the manual in the following order:

  • adoc - the ADOC (AsciiDoc) manual, filter adoc

  • anon - the annotated text version of the manual, filter text-anon

  • ansi - the ANSI formatted manual, filter ansi

  • text - the plain text manual, filter text

  • manp - the manual page, filter manp

  • html - the HTML version in a web browser, filter html

  • pdf - the PDF version in a PDF viewer, filter pdf

The text versions (adoc, anon, ansi, and text) are shown using the command less with the options -r -C -f -M -d. tput is used to safe (smcup) and restore (rmcup) the terminal context.

The manual page (manp) is shown using the command man.

Requirements

The task requires the manual being build in the application home directory. If a requested manual version is not found, an error will be thrown.

To show HTML and PDF versions, this task uses the tasks start-browser and start-pdf-viewer, respectively. Both tasks have their own configuration requirements, please see their documentation for details.