package reason
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=bcf0081ecf3d05ce68e82876a1bc2a48497c78225b8b310f2cf24b33f3568416
sha512=388a0d8970b83423bb79978e4df3a558c27e043fc216a8d288ca7aab9babd8a3db45219ba53c9db09d791c07017f26ceba3a7d714c8ce9bf369d2e8b796d6d81
doc/reason.cmdliner/Vendored_cmdliner/Manpage/index.html
Module Vendored_cmdliner.ManpageSource
Man page specification.
Man page generation is automatically handled by Cmdliner. The block type is used to define a man page's content.
The print function can be useful if the client wants to define other man pages (e.g. to implement a help command).
Man pages
The type for a block of man page text.
`S sintroduces a new sections.`P tis a new paragraph with textt.`Pre tis a new preformatted paragraph with textt.`I (l,t)is an indented paragraph with labelland textt.`Noblanksuppresses the blank line introduced between two blocks.
Except in `Pre, whitespace and newlines are not significant and are all collapsed to a single space. In labels l and text strings t, the syntax "$(i,italic text)" and "$(b,bold text)" can be used to respectively produce italic and bold text.
The type for man page titles. Describes the man page title, section, center_footer, left_footer, center_header.
The type for a man page. A title and the page text as a list of blocks.
val print :
?subst:(string -> string) ->
[ `Pager | `Plain | `Groff ] ->
Format.formatter ->
t ->
unitprint ~subst fmt ppf page prints page on ppf in the format fmt. If fmt is `Pager the function tries to write the formatted result in a pager, if that fails the format `Plain is written on ppf. subst can be used to perform variable substitution, see Buffer.add_substitute (defaults to the identity).