Man page specification.
Man page generation is automatically handled by
Cmdliner, consult the details.
block type is used to define a man page's content. It's a good idea to follow the standard manual page structure.
man-pages(7), Conventions for writing Linux man pages.
type block = [
`S of string
`P of string
`Pre of string
`I of string * string
`Blocks of block list
The type for a block of man page text.
`S sintroduces a new section
s, see the standard section names.
`P tis a new paragraph with text
`Pre tis a new preformatted paragraph with text
`I (l,t)is an indented paragraph with label
`Noblanksuppresses the blank line introduced between two blocks.
`Blocks bssplices the blocks
`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
The type for man page cross-references.
`Mainrefers to the man page of the program itself.
`Cmd cmdrefers to the man page of the program's
cmdcommand (which must exist).
`Tool binrefers to the command line tool named
`Page (name, sec)refers to the man page
Standard section names and content
The following are standard man page section names, roughly ordered in the order they conventionally appear. See also
man man-pages for more elaborations about what sections should contain.
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.
DESCRIPTION section. This should be a description of what the tool does and provide a little bit of usage and documentation guidance.
COMMON OPTIONS section. For programs with multiple commands a section that can be used to gather options common to all commands.
EXIT STATUS section. By default term status exit codes get listed here.
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
The type for man page output specification.
`Auto, formats like
TERMenvironment variable is
`Pager, tries to write to a discovered pager, if that fails uses the
`Plain, formats to plain text.
`Groff, formats to groff commands.
val print : ?errs:Format.formatter -> ?subst:(string -> string option) -> format -> Format.formatter -> t -> unit
print ~errs ~subst fmt ppf page prints
ppf in the format
subst can be used to perform variable substitution,(defaults to the identity).
errs is used to print formatting errors, it defaults to