Next: , Up: API   [Contents][Index]

3.1 (documenta cli)

This module defines the command-line interface of the documenta program. See the CLI section for additional information.

This module provides the following interface.

3.1.1 Procedures

Procedure: call command spec

Call an appropriate procedure for the given command.

command (list): A list of strings that represent a command-line instruction passed to the program (see Guile’s command-line procedure).

spec (Configuration): A <configuration> record as defined by the guile-config library, which specifies the command-line interface of the program.

Result: The command is followed. If the command is not recognized, display help information.

3.1.2 Variables

Variable: spec

This is a record of the type <configuration>, which has the following fields:

  • name
  • synopsis
  • description
  • wanted
  • keywords
  • arguments
  • subcommands
  • directory
  • version
  • license
  • copyright
  • author
  • parser
  • alias
  • generate-help?
  • generate-usage?
  • generate-version?
  • generate-cmdtree?