Cmdliner_manpage
Manpages.
See Cmdliner.Manpage
.
type block = [
| `S of section_name
| `P of string
| `Pre of string
| `I of string * string
| `Noblank
| `Blocks of block list
]
val s_name : section_name
val s_synopsis : section_name
val s_description : section_name
val s_commands : section_name
val s_arguments : section_name
val s_options : section_name
val s_common_options : section_name
val s_exit_status : section_name
val s_environment : section_name
val s_files : section_name
val s_bugs : section_name
val s_examples : section_name
val s_authors : section_name
val s_see_also : section_name
val s_none : section_name
Used for handling the merging of metadata doc strings.
val smap_has_section : smap -> sec:section_name -> bool
val smap_append_block : smap -> sec:section_name -> block -> smap
smap_append_block smap sec b
appends b
at the end of section sec
creating it at the right place if needed.
val s_exit_status_intro : block
val s_environment_intro : block
val subst_vars :
errs:Stdlib.Format.formatter ->
subst:subst ->
Stdlib.Buffer.t ->
string ->
string
subst b ~subst s
, using b
, substitutes in s
variables of the form "$(doc)" by their subst
definition. This leaves escapes and markup directives $(markup,…) intact.
val doc_to_plain :
errs:Stdlib.Format.formatter ->
subst:subst ->
Stdlib.Buffer.t ->
string ->
string
doc_to_plain b ~subst s
using b
, substitutes in s
variables by their subst
definition and renders cmdliner directives to plain text.
Raises Invalid_argument in case of illegal syntax.
val doc_to_styled :
?buffer:Stdlib.Buffer.t ->
errs:Stdlib.Format.formatter ->
subst:subst ->
string ->
string
doc_to_styled
is like doc_to_plain
but uses ANSI escapes.