package reason

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Man pages
Standard section names and content
Output

package reason

reason
- Library reason
- Library reason.cmdliner
  - Vendored_cmdliner
    
    Manpage
    
    Term
    
    Cmd
    
    Exit
    
    Env
    
    Arg
- Library reason.easy_format
  - Vendored_easy_format
    
    Pretty
    
    Compact
- Library reason.ocaml-migrate-parsetree
  - Reason_omp
    
    Def
    
    Ast_402
    
    Location
    
    Longident
    
    Asttypes
    
    Outcometree
    
    Ast_403
    
    Location
    
    Longident
    
    Asttypes
    
    Outcometree
    
    Ast_404
    
    Location
    
    Longident
    
    Asttypes
    
    Outcometree
    
    Ast_405
    
    Location
    
    Longident
    
    Asttypes
    
    Outcometree
    
    Ast_406
    
    Location
    
    Longident
    
    Asttypes
    
    Outcometree
    
    Ast_407
    
    Location
    
    Longident
    
    Asttypes
    
    Outcometree
    
    Ast_408
    
    Location
    
    Longident
    
    Asttypes
    
    Outcometree
    
    Ast_409
    
    Location
    
    Longident
    
    Asttypes
    
    Outcometree
    
    Ast_410
    
    Location
    
    Longident
    
    Asttypes
    
    Type_immediacy
    
    Outcometree
    
    Ast_411
    
    Location
    
    Longident
    
    Asttypes
    
    Type_immediacy
    
    Outcometree
    
    Ast_412
    
    Asttypes
    
    Type_immediacy
    
    Outcometree
    
    Ast_413
    
    Asttypes
    
    Type_immediacy
    
    Outcometree
    
    Ast_414
    
    Asttypes
    
    Type_immediacy
    
    Outcometree
    
    Ast_500
    
    Asttypes
    
    Type_immediacy
    
    Outcometree
    
    Ast_51
    
    Asttypes
    
    Type_immediacy
    
    Outcometree
    
    Ast_52
    
    Asttypes
    
    Type_immediacy
    
    Outcometree
    
    Migrate_402_403
    
    From
    
    To
    
    Migrate_403_402
    
    From
    
    To
    
    Migrate_403_404
    
    From
    
    To
    
    Migrate_404_403
    
    From
    
    To
    
    Migrate_404_405
    
    From
    
    To
    
    Migrate_405_404
    
    From
    
    To
    
    Migrate_405_406
    
    From
    
    To
    
    Migrate_406_405
    
    From
    
    To
    
    Migrate_406_407
    
    From
    
    To
    
    Migrate_407_406
    
    From
    
    To
    
    Migrate_407_408
    
    From
    
    To
    
    Migrate_408_407
    
    Def
    
    From
    
    To
    
    Migrate_408_409
    
    From
    
    To
    
    Migrate_409_408
    
    From
    
    To
    
    Migrate_409_410
    
    From
    
    To
    
    Migrate_410_409
    
    From
    
    To
    
    Def
    
    Migrate_410_411
    
    From
    
    To
    
    Migrate_411_410
    
    From
    
    To
    
    Migrate_411_412
    
    From
    
    To
    
    Migrate_412_411
    
    From
    
    To
    
    Migrate_412_413
    
    From
    
    To
    
    Migrate_413_412
    
    From
    
    To
    
    Migrate_413_414
    
    From
    
    To
    
    Migrate_414_413
    
    From
    
    To
    
    Migrate_414_500
    
    From
    
    To
    
    Migrate_500_414
    
    From
    
    To
    
    Migrate_500_51
    
    From
    
    To
    
    Migrate_51_500
    
    From
    
    To
    
    Migrate_51_52
    
    From
    
    To
    
    Migrate_52_51
    
    From
    
    To
    
    Versions
    
    Ast
    
    Outcometree
    
    OCaml_version
    
    Ast
    
    Outcometree
    
    OCaml_402
    
    Ast
    
    OCaml_403
    
    Ast
    
    OCaml_404
    
    Ast
    
    OCaml_405
    
    Ast
    
    OCaml_406
    
    Ast
    
    OCaml_407
    
    Ast
    
    OCaml_408
    
    Ast
    
    OCaml_409
    
    Ast
    
    OCaml_410
    
    Ast
    
    OCaml_411
    
    Ast
    
    OCaml_412
    
    Ast
    
    OCaml_413
    
    Ast
    
    OCaml_414
    
    Ast
    
    OCaml_500
    
    Ast
    
    OCaml_51
    
    Ast
    
    OCaml_52
    
    Ast
    
    OCaml_53
    
    Ast
    
    Asttypes
    
    Type_immediacy
    
    Outcometree
    
    OCaml_current
    
    Convert
    
    OCaml_version
    
    OCaml_402
    
    OCaml_403
    
    OCaml_404
    
    OCaml_405
    
    OCaml_406
    
    OCaml_407
    
    OCaml_408
    
    OCaml_409
    
    OCaml_410
    
    OCaml_411
    
    OCaml_412
    
    OCaml_413
    
    OCaml_414
    
    OCaml_500
    
    OCaml_51
    
    OCaml_current
    
    Convert
    
    Compiler_libs
    
    Location
    
    Longident
    
    Asttypes
    
    Asttypes
    
    Parsetree
    
    Parsetree
    
    Docstrings
    
    Ast_helper
    
    Ast_mapper
- Library reason.refmt-lib
  - Refmt_lib
    
    Eol_convert
    
    Eol_detect
    
    Git_commit
    
    Package
    
    Printer_maker
    
    PRINTER
    
    Reason_implementation_printer
    
    Reason_interface_printer
    
    Refmt_args
- Sources

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Vendored_cmdliner.Manpage`Source

Man page specification.

Man page generation is automatically handled by Cmdliner, consult the details.

The Manpage.block type is used to define a man page's content. It's a good idea to follow the standard manual page structure.

References.

man-pages(7), Conventions for writing Linux man pages.

Man pages

Sourcetype 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 section s, see the standard section names.
`P t is a new paragraph with text t.
`Pre t is a new preformatted paragraph with text t.
`I (l,t) is an indented paragraph with label l and text t.
`Noblank suppresses the blank line introduced between two blocks.
`Blocks bs splices the blocks bs.

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.

Sourceval escape : string -> string

escape s escapes s so that it doesn't get interpreted by the documentation markup language.

Sourcetype title = string * int * string * string * string

The type for man page titles. Describes the man page title, section, center_footer, left_footer, center_header.

Sourcetype t = title * block list

The type for a man page. A title and the page text as a list of blocks.

Sourcetype xref = [

| `Main
| `Cmd of string
| `Tool of string
| `Page of string * int

]

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's cmd command (which must exist).
`Tool bin refers to the command line tool named bin.
`Page (name, sec) refers to the man page name(sec).

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.

Sourceval s_name : string

The NAME section. This section is automatically created by Cmdliner for your.

Sourceval s_synopsis : string

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.

Sourceval s_description : string

The DESCRIPTION section. This should be a description of what the tool does and provide a little bit of usage and documentation guidance.

Sourceval s_commands : string

The COMMANDS section. By default subcommands get listed here.

Sourceval s_arguments : string

The ARGUMENTS section. By default positional arguments get listed here.

Sourceval s_options : string

The OPTIONS section. By default optional arguments get listed here.

Sourceval s_common_options : string

The COMMON OPTIONS section. By default help and version options get listed here. For programs with multiple commands, optional arguments common to all commands can be added here.

Sourceval s_exit_status : string

The EXIT STATUS section. By default term status exit codes get listed here.

Sourceval s_environment : string

The ENVIRONMENT section. By default environment variables get listed here.

Sourceval s_environment_intro : block

s_environment_intro is the introduction content used by cmdliner when it creates the s_environment section.

Sourceval s_files : string

The FILES section.

Sourceval s_bugs : string

The BUGS section.

Sourceval s_examples : string

The EXAMPLES section.

Sourceval s_authors : string

The AUTHORS section.

Sourceval s_see_also : string

The SEE ALSO section.

Sourceval s_none : string

s_none is a special section named "cmdliner-none" that can be used whenever you do not want something to be listed.

Output

The print function can be useful if the client wants to define other man pages (e.g. to implement a help command).

Sourcetype format = [

| `Auto
| `Pager
| `Plain
| `Groff

]

The type for man page output specification.

`Auto, formats like `Pager or `Plain whenever the TERM environment variable is dumb 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.

Source

val print : 
  ?errs:Format.formatter ->
  ?subst:(string -> string option) ->
  format ->
  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.

package reason

Module Vendored_cmdliner.ManpageSource

Man pages

Standard section names and content

Output

Module `Vendored_cmdliner.Manpage`Source