package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Core_kernel.Command.Shape end
type t = Core_kernel.Command.Shape.t =
  1. | Basic of Base_info.t
  2. | Group of t Group_info.t
  3. | Exec of Exec_info.t * Base.Unit.t -> t
  4. | Lazy of t Core_kernel.Lazy.t

Fully forced shapes are comparable and serializable.

val help_text : t -> Path.t -> expand_dots:bool -> flags:bool -> recursive:bool -> string

Get the help text for a command shape.

The Path.t argument should be the path that identifies the shape argument.

expand_dots: expand subcommands in recursive help. (default: false) This is the same as the help subcommand's "-expand-dots" flag.

flags: show flags in recursive help. (default: false) This is the same as the help subcommand's "-flags" flag.

recursive: show subcommands of subcommands. (default: false) This is the same as the help subcommand's "-recursive" flag.