Man pages
type block = [
| `S of string |
| `P of string |
| `Pre of string |
| `I of string * string |
| `Noblank |
| `Blocks of block list |
]
The type for a block of man page text.
`S s
introduces a new sections
, see the standard section names.`P t
is a new paragraph with textt
.`Pre t
is a new preformatted paragraph with textt
.`I (l,t)
is an indented paragraph with labell
and textt
.`Noblank
suppresses the blank line introduced between two blocks.`Blocks bs
splices the blocksbs
.
Except in `Pre
, whitespace and newlines are not significant and are all collapsed to a single space. All block strings support the documentation markup language.
escape s
escapes s
so that it doesn't get interpreted by the documentation markup language.
The type for man page titles. Describes the man page title
, section
, center_footer
, left_footer
, center_header
.
The type for man page cross-references.
`Main
refers to the man page of the program itself.`Cmd cmd
refers to the man page of the program'scmd
command (which must exist).`Tool bin
refers to the command line tool namedbin
.`Page (name, sec)
refers to the man pagename(sec)
.
Standard section names and content
The SYNOPSIS
section. By default this section is automatically created by Cmdliner
for you, unless it is the first section of your term's man page, in which case it will replace it with yours.
The DESCRIPTION
section. This should be a description of what the tool does and provide a little bit of usage and documentation guidance.
The COMMON OPTIONS
section. For programs with multiple commands a section that can be used to gather options common to all commands.
The EXIT STATUS
section. By default term status exit codes get listed here.
The ENVIRONMENT
section. By default environment variables get listed here.
val s_environment_intro : block
s_environment_intro
is the introduction content used by cmdliner when it creates the s_environment
section.
Output
The type for man page output specification.
`Auto
, formats like`Pager
or`Plain
whenever theTERM
environment variable isdumb
or unset.`Pager
, tries to write to a discovered pager, if that fails uses the`Plain
format.`Plain
, formats to plain text.`Groff
, formats to groff commands.
val print : ?errs:Stdlib.Format.formatter -> ?subst:(string -> string option) -> format -> Stdlib.Format.formatter -> t -> unit
print ~errs ~subst fmt ppf page
prints page
on ppf
in the format fmt
. subst
can be used to perform variable substitution,(defaults to the identity). errs
is used to print formatting errors, it defaults to Format
.err_formatter.