command_line_options — Logtalk 3.100.1

object

# `command_line_options`

Command line options parsing predicates. Uses object-based option specifications with the `command_line_option` category.

Availability:
`logtalk_load(command_line_options(loader))`
Author: Marcus Uneson and Paulo Moura
Version: 1:0:0
Date: 2026-02-20
Compilation flags:
`static, context_switching_calls`
Imports:
`public` options
Uses:
atom
list
meta
numberlist
term_io
type
user
Remarks:
(none)
Inherited public predicates:
check_option/1 check_options/1 default_option/1 default_options/1 option/2 option/3 valid_option/1 valid_options/1

## Public predicates

### `parse/4`

Parses the arguments `ApplArguments` according to the option objects `OptionObjects` using default parsing options.

Compilation flags:
`static`
Template:
`parse(OptionObjects,ApplArguments,Options,PositionalArguments)`
Mode and number of proofs:
`parse(+list(object),+list(atom),-list,-list(atom))` - `one_or_error`

### `parse/5`

Parses the arguments `ApplArguments` according to the option objects `OptionObjects` and the parsing options `ParseOptions`. `Options` is a list of parsed options as `Name(Value)` terms by default (or `Func(Name,Value)` when the `output_functor(Func)` parse option is used). `PositionalArguments` are the remaining non-dashed arguments. `ParseOptions` include `output_functor(Func)`, `duplicated_flags(Keep)` (one of `keepfirst`, `keeplast`, `keepall`; default `keeplast`), and `allow_empty_flag_spec(Bool)` (default `true`).

Compilation flags:
`static`
Template:
`parse(OptionObjects,ApplArguments,Options,PositionalArguments,ParseOptions)`
Mode and number of proofs:
`parse(+list(object),+list(atom),-list,-list(atom),+list)` - `one_or_error`

### `help/2`

Synthesizes a help text `Help` as an atom from the option objects `OptionObjects` using default help options.

Compilation flags:
`static`
Template:
`help(OptionObjects,Help)`
Mode and number of proofs:
`help(+list(object),-atom)` - `one_or_error`

### `help/3`

Synthesizes a help text `Help` as an atom from the option objects `OptionObjects` using the given `HelpOptions`. `HelpOptions` include `line_width(Width)` (default 80), `min_help_width(Width)` (default 40), `break_long_flags(Boolean)` (default `false`), and `suppress_empty_meta(Boolean)` (default `true`).

Compilation flags:
`static`
Template:
`help(OptionObjects,Help,HelpOptions)`
Mode and number of proofs:
`help(+list(object),-atom,+list)` - `one_or_error`

## Protected predicates

(no local declarations; see entity ancestors if any)

## Private predicates

(no local declarations; see entity ancestors if any)

## Operators

(none)

See also

command_line_option