The cl-argparse Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-argparse Reference Manual

This is the cl-argparse Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:01:58 2020 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

cl-argparse

A common lisp cmd argument parser inspired by python argparse

Dependencies

None

API

create-main-parser (var &optional description) elements* => parser

Create a parser with the given name and the variable of name

create-sub-parser (name &optional description) elements* => parser

Create a parser with the given name and the variable of name

add-flag parser &key short long help var

Add a flag to the current parser

add-optional parser &key short long default help var

Add a parameter to the current parser

add-positional parser &key name help

Add a positional argument to the parser

add-subparser parser subparser

adds a subparser to the parser

add-generic-parser parser gen

adds the parsing elements of the gen parser to the given parser

add-default parser &key var default

adds a default value to the parser

get-value name parser

get the cmd provided variable value of name from parser

parse parser argv

parse the stringlist argv using parser parser

create-mockup-parser key-value-list*

create a parser simulating a parsing resulting in the given key-value-list

Usage

You can either use the short example below to get started or the longer example provided as commented source code in ./src/examples/example.lisp.

Short Example

(in-package :cl-argparse)

(format t "~a~%"
        (parse
         (create-main-parser (main-parser "here comes the description of the program")
           (add-flag main-parser :short "g" :long "goo" :help "this is an example flag" :var "goo")
           (add-optional main-parser :short "t" :long "test" :help "this is an example optional argument" :var "test")
           (add-positional main-parser :name "pos" :help "this is an example for a positional")
           (add-subparser main-parser (create-sub-parser (sub "this is a sub action parser")
                                        (add-positional sub :name "action" :help "this is an example for a positional"))))
         (list "-g" "-t" "alle" "positional" "sub" "theaction")))

=> <PARSER
     goo -> T
     test -> alle
     pos -> positional
     action -> theaction
   >

Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-argparse

Maintainer

Simon Koch <projects@halcony.de>

Author

Simon Koch <projects@halcony.de>

License

MIT

Description

A python argparse inspired command line parser library

Source

cl-argparse.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-argparse.asd

Location

cl-argparse.asd

Systems

cl-argparse (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 cl-argparse/package.lisp

Parent

cl-argparse (system)

Location

package.lisp

Packages

de.halcony.argparse


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 cl-argparse/classes.lisp

Dependency

package.lisp (file)

Parent

cl-argparse (system)

Location

classes.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 cl-argparse/methods.lisp

Dependencies
Parent

cl-argparse (system)

Location

methods.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 de.halcony.argparse

Source

package.lisp (file)

Nickname

cl-argparse

Use List
Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: create-main-parser (VAR &optional DESCRIPTION) &body ELEMENTS

Macro for creating the main parser. Always names the parser main-parser (required for parsing
to work) and adds the help flag. Allows to add further parameters to the parser. Returns the parser at the end

Package

de.halcony.argparse

Source

methods.lisp (file)

Macro: create-sub-parser (NAME &optional DESCRIPTION) &body ELEMENTS

Macro for creating a sub parser, provides name as the subparser name to the help message, adds a help flag and allows to add further parameters to the parser. Returns the parser at the end.

Package

de.halcony.argparse

Source

methods.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Generic functions

Generic Function: add-default PARSER &key VAR DEFAULT
Package

de.halcony.argparse

Methods
Method: add-default (PARSER parser) &key VAR DEFAULT

Adds a default value to the parser value table. I.e., allows to define sub parser specific default values that cannot be set via the cmd

Source

methods.lisp (file)

Generic Function: add-flag PARSER &key SHORT LONG HELP VAR
Package

de.halcony.argparse

Methods
Method: add-flag (PARSER parser) &key SHORT LONG HELP VAR

Adds a flag to the given parser using short as the short value of the flag (has to be lead with a single - in the argument list. The var determines the name under which it is stored in the parser value table. long determines the long version of the flag (lead with two -) and help is the help string used to generate the help message

Source

methods.lisp (file)

Generic Function: add-generic-parser PARSER GEN
Package

de.halcony.argparse

Methods
Method: add-generic-parser (PARSER parser) (GEN parser)

Adds a generic parser to the given parser. Basically merges the generic parser into the given parser, adding all the flags, optional, and positional utilities. Subparsers are ignored.

Source

methods.lisp (file)

Generic Function: add-help PARSER
Package

de.halcony.argparse

Methods
Method: add-help (PARSER parser)

Adds the help flag to the parser

Source

methods.lisp (file)

Generic Function: add-optional PARSER &key SHORT LONG DEFAULT HELP VAR
Package

de.halcony.argparse

Methods
Method: add-optional (PARSER parser) &key SHORT LONG DEFAULT HELP VAR

Adds an optional value to the given parser. short is the to be used parameter name (with a single leading -). Var is the name under which to store the value in the parser table. long is the long version of the name (lead with two –). Default determines the default value and help is the help message string to be used in the auto generated help message

Source

methods.lisp (file)

Generic Function: add-positional PARSER &key NAME HELP
Package

de.halcony.argparse

Methods
Method: add-positional (PARSER parser) &key NAME HELP

Adds a positional argument to the given parser. Name is both the name of the positional used in the help message as well as the name under which the value is stored. Help defines the string to be used in the auto generated help message

Source

methods.lisp (file)

Generic Function: add-subparser PARSER SUBPARSER
Package

de.halcony.argparse

Methods
Method: add-subparser (PARSER parser) (SUBPARSER parser)

Adds the given sub parser to the given parser.

Source

methods.lisp (file)

Generic Function: get-key-value-pairs PARSER
Package

de.halcony.argparse

Methods
Method: get-key-value-pairs (PARSER parser)
Source

methods.lisp (file)

Generic Function: get-value NAME PARSER
Package

de.halcony.argparse

Methods
Method: get-value NAME (PARSER parser)

Get the stored value for name from the given parser.

Source

methods.lisp (file)

Generic Function: parse PARSER ARGV
Package

de.halcony.argparse

Methods
Method: parse (PARSER parser) ARGV

This is the main parsing method and providing a parser and a string of arguments it extracts and enters all provided parameters into the parser

Source

methods.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Conditions

Condition: cancel-parsing-error ()
Package

de.halcony.argparse

Source

classes.lisp (file)

Direct superclasses

simple-error (condition)

Direct methods
Direct slots
Slot: format-control
Initargs

:format-control

Initform

(quote "")

Readers

format-control (generic function)

Slot: format-arguments
Initargs

:format-arguments

Initform

(quote (list))

Readers

format-arguments (generic function)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Classes

Class: parser ()
Package

de.halcony.argparse

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: description
Initargs

:description

Initform

"no description"

Readers

description (generic function)

Slot: previous-parsers
Initform

(list)

Readers

previous-parsers (generic function)

Slot: name
Initargs

:name

Initform

""

Readers

name (generic function)

Slot: flags
Initform

(list)

Readers

flags (generic function)

Slot: optionals
Initform

(list)

Readers

optionals (generic function)

Slot: positionals
Initform

(list)

Readers

positionals (generic function)

Slot: subparsers
Initform

(list)

Readers

subparsers (generic function)

Slot: defaults
Initform

(make-hash-table :test (quote equalp))

Readers

defaults (generic function)

Slot: table
Initform

(make-hash-table :test (quote equalp))

Readers

table (generic function)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Macros

Macro: aif CONDITION IF THEN
Package

de.halcony.argparse

Source

methods.lisp (file)

Macro: create-mockup-parser &rest KEY-VALUE-LIST

allows for the creation of a mockup parser to enable creating a parser without actually parsing command line parameters

Package

de.halcony.argparse

Source

methods.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: merge-tables TABLE-A TABLE-B

merges table-b into table-a

Package

de.halcony.argparse

Source

methods.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Generic functions

Generic Function: default OBJECT
Package

de.halcony.argparse

Methods
Method: default (OPTIONAL optional)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: defaults OBJECT
Package

de.halcony.argparse

Methods
Method: defaults (PARSER parser)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: description OBJECT
Package

de.halcony.argparse

Methods
Method: description (PARSER parser)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: flags OBJECT
Package

de.halcony.argparse

Methods
Method: flags (PARSER parser)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: format-arguments CONDITION
Package

de.halcony.argparse

Methods
Method: format-arguments (CONDITION cancel-parsing-error)
Source

classes.lisp (file)

Method: format-arguments (CONDITION cmd-arg-error)
Source

classes.lisp (file)

Generic Function: format-control CONDITION
Package

de.halcony.argparse

Methods
Method: format-control (CONDITION cancel-parsing-error)
Source

classes.lisp (file)

Method: format-control (CONDITION cmd-arg-error)
Source

classes.lisp (file)

Generic Function: help-message OBJECT
Package

de.halcony.argparse

Methods
Method: help-message (POSITIONAL positional)

automatically generated reader method

Source

classes.lisp (file)

Method: help-message (OPTIONAL optional)

automatically generated reader method

Source

classes.lisp (file)

Method: help-message (FLAG flag)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: long OBJECT
Package

de.halcony.argparse

Methods
Method: long (OPTIONAL optional)

automatically generated reader method

Source

classes.lisp (file)

Method: long (FLAG flag)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: name OBJECT
Package

de.halcony.argparse

Methods
Method: name (PARSER parser)

automatically generated reader method

Source

classes.lisp (file)

Method: name (POSITIONAL positional)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: optionals OBJECT
Package

de.halcony.argparse

Methods
Method: optionals (PARSER parser)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: parse-flag FLAG ARGV TABLE
Package

de.halcony.argparse

Methods
Method: parse-flag (HELP-FLAG help-flag) ARGV TABLE

Tries to parse (car argv) using the passed flag (i.e., help flag). If the flag is successfully parsed the help-flag-condition is signaled, else argv and nil is returned.

Source

methods.lisp (file)

Method: parse-flag (FLAG flag) ARGV TABLE

This method tries to match the given (car argv) with the flag. If this succeeds the flag is entered into the parser value table and (cdr argv) and T is returned. If there is no match argv and nil is returned

Source

methods.lisp (file)

Generic Function: parse-optional OPTIONAL ARGV TABLE
Package

de.halcony.argparse

Methods
Method: parse-optional (OPTIONAL optional) ARGV TABLE

Tries to parse (car argv) using the given optional. If the optional matches the defined table value is set to (cadr argv) and (cddr argv) and T are returned. Else argv and nil are returned

Source

methods.lisp (file)

Generic Function: parse-optionals PARSER ARGV
Package

de.halcony.argparse

Methods
Method: parse-optionals (PARSER parser) ARGV

Given a parser and a list of strings this method extracts the provided flags and optional parameters and enters them into the parser table.
It returns the remaining list. The parsing either stops if all optionals or flags of the parser a filled or if the currently viewed list element does not match either an optional or flag.

Source

methods.lisp (file)

Generic Function: parse-positional POSITIONAL ARGV TABLE
Package

de.halcony.argparse

Methods
Method: parse-positional (POSITIONAL positional) ARGV TABLE

Parses a positional argument, i.e., (car argv) and stores it in the given table. Throws an error in case no value is contained in argv. Returns (cdr argv) as it either always works or has to throw an error.

Source

methods.lisp (file)

Generic Function: parse-positionals PARSER INITIAL-ARGV
Package

de.halcony.argparse

Methods
Method: parse-positionals (PARSER parser) INITIAL-ARGV

Given a parser and a list of strings this method extracts the provided positional parameters and enters them into the parser table. It returns the remaining list

Source

methods.lisp (file)

Generic Function: parse-subparsers PARSER ARGV
Package

de.halcony.argparse

Methods
Method: parse-subparsers (PARSER parser) ARGV

Given a parser and a list of strings this method extracts the subparser from which the parsing continues and continues the parsing with this parser

Source

methods.lisp (file)

Generic Function: positionals OBJECT
Package

de.halcony.argparse

Methods
Method: positionals (PARSER parser)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: previous-parsers OBJECT
Package

de.halcony.argparse

Methods
Method: previous-parsers (PARSER parser)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: print-help PARSER
Package

de.halcony.argparse

Methods
Method: print-help (PARSER parser)

Functionality to print the correct help message for the given parser

Source

methods.lisp (file)

Generic Function: short OBJECT
Package

de.halcony.argparse

Methods
Method: short (OPTIONAL optional)

automatically generated reader method

Source

classes.lisp (file)

Method: short (FLAG flag)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: subparsers OBJECT
Package

de.halcony.argparse

Methods
Method: subparsers (PARSER parser)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: sync-parser PARSER
Package

de.halcony.argparse

Methods
Method: sync-parser (PARSER parser)

Syncs the current parser, i.e., merges the value table (for defaults) as well as append the list of previous parsers to the sub parser for generating the help message

Source

methods.lisp (file)

Generic Function: table OBJECT
Package

de.halcony.argparse

Methods
Method: table (PARSER parser)

automatically generated reader method

Source

classes.lisp (file)

Generic Function: var OBJECT
Package

de.halcony.argparse

Methods
Method: var (OPTIONAL optional)

automatically generated reader method

Source

classes.lisp (file)

Method: var (FLAG flag)

automatically generated reader method

Source

classes.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Conditions

Condition: cmd-arg-error ()
Package

de.halcony.argparse

Source

classes.lisp (file)

Direct superclasses

simple-error (condition)

Direct methods
Direct slots
Slot: format-control
Initargs

:format-control

Initform

(quote "")

Readers

format-control (generic function)

Slot: format-arguments
Initargs

:format-arguments

Initform

(quote (list))

Readers

format-arguments (generic function)

Condition: help-flag-condition ()
Package

de.halcony.argparse

Source

classes.lisp (file)

Direct superclasses

simple-error (condition)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Classes

Class: flag ()
Package

de.halcony.argparse

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

help-flag (class)

Direct methods
Direct slots
Slot: short
Initargs

:short

Readers

short (generic function)

Slot: long
Initargs

:long

Readers

long (generic function)

Slot: var
Initargs

:var

Readers

var (generic function)

Slot: help-message
Initargs

:help-message

Readers

help-message (generic function)

Class: help-flag ()
Package

de.halcony.argparse

Source

classes.lisp (file)

Direct superclasses

flag (class)

Direct methods

parse-flag (method)

Direct slots
Slot: short
Initform

"h"

Slot: long
Initform

"help"

Slot: help-message
Initform

"displays this help message"

Class: optional ()
Package

de.halcony.argparse

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: short
Initargs

:short

Readers

short (generic function)

Slot: long
Initargs

:long

Readers

long (generic function)

Slot: var
Initargs

:var

Readers

var (generic function)

Slot: default
Initargs

:default

Readers

default (generic function)

Slot: help-message
Initargs

:help-message

Readers

help-message (generic function)

Class: positional ()
Package

de.halcony.argparse

Source

classes.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Slot: help-message
Initargs

:help-message

Readers

help-message (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-argparse.asd: The cl-argparse․asd file
cl-argparse/classes.lisp: The cl-argparse/classes․lisp file
cl-argparse/methods.lisp: The cl-argparse/methods․lisp file
cl-argparse/package.lisp: The cl-argparse/package․lisp file

F
File, Lisp, cl-argparse.asd: The cl-argparse․asd file
File, Lisp, cl-argparse/classes.lisp: The cl-argparse/classes․lisp file
File, Lisp, cl-argparse/methods.lisp: The cl-argparse/methods․lisp file
File, Lisp, cl-argparse/package.lisp: The cl-argparse/package․lisp file

L
Lisp File, cl-argparse.asd: The cl-argparse․asd file
Lisp File, cl-argparse/classes.lisp: The cl-argparse/classes․lisp file
Lisp File, cl-argparse/methods.lisp: The cl-argparse/methods․lisp file
Lisp File, cl-argparse/package.lisp: The cl-argparse/package․lisp file

Jump to:   C   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   C   D   F   G   H   L   M   N   O   P   S   T   V  
Index Entry  Section

A
add-default: Exported generic functions
add-default: Exported generic functions
add-flag: Exported generic functions
add-flag: Exported generic functions
add-generic-parser: Exported generic functions
add-generic-parser: Exported generic functions
add-help: Exported generic functions
add-help: Exported generic functions
add-optional: Exported generic functions
add-optional: Exported generic functions
add-positional: Exported generic functions
add-positional: Exported generic functions
add-subparser: Exported generic functions
add-subparser: Exported generic functions
aif: Internal macros

C
create-main-parser: Exported macros
create-mockup-parser: Internal macros
create-sub-parser: Exported macros

D
default: Internal generic functions
default: Internal generic functions
defaults: Internal generic functions
defaults: Internal generic functions
description: Internal generic functions
description: Internal generic functions

F
flags: Internal generic functions
flags: Internal generic functions
format-arguments: Internal generic functions
format-arguments: Internal generic functions
format-arguments: Internal generic functions
format-control: Internal generic functions
format-control: Internal generic functions
format-control: Internal generic functions
Function, merge-tables: Internal functions

G
Generic Function, add-default: Exported generic functions
Generic Function, add-flag: Exported generic functions
Generic Function, add-generic-parser: Exported generic functions
Generic Function, add-help: Exported generic functions
Generic Function, add-optional: Exported generic functions
Generic Function, add-positional: Exported generic functions
Generic Function, add-subparser: Exported generic functions
Generic Function, default: Internal generic functions
Generic Function, defaults: Internal generic functions
Generic Function, description: Internal generic functions
Generic Function, flags: Internal generic functions
Generic Function, format-arguments: Internal generic functions
Generic Function, format-control: Internal generic functions
Generic Function, get-key-value-pairs: Exported generic functions
Generic Function, get-value: Exported generic functions
Generic Function, help-message: Internal generic functions
Generic Function, long: Internal generic functions
Generic Function, name: Internal generic functions
Generic Function, optionals: Internal generic functions
Generic Function, parse: Exported generic functions
Generic Function, parse-flag: Internal generic functions
Generic Function, parse-optional: Internal generic functions
Generic Function, parse-optionals: Internal generic functions
Generic Function, parse-positional: Internal generic functions
Generic Function, parse-positionals: Internal generic functions
Generic Function, parse-subparsers: Internal generic functions
Generic Function, positionals: Internal generic functions
Generic Function, previous-parsers: Internal generic functions
Generic Function, print-help: Internal generic functions
Generic Function, short: Internal generic functions
Generic Function, subparsers: Internal generic functions
Generic Function, sync-parser: Internal generic functions
Generic Function, table: Internal generic functions
Generic Function, var: Internal generic functions
get-key-value-pairs: Exported generic functions
get-key-value-pairs: Exported generic functions
get-value: Exported generic functions
get-value: Exported generic functions

H
help-message: Internal generic functions
help-message: Internal generic functions
help-message: Internal generic functions
help-message: Internal generic functions

L
long: Internal generic functions
long: Internal generic functions
long: Internal generic functions

M
Macro, aif: Internal macros
Macro, create-main-parser: Exported macros
Macro, create-mockup-parser: Internal macros
Macro, create-sub-parser: Exported macros
merge-tables: Internal functions
Method, add-default: Exported generic functions
Method, add-flag: Exported generic functions
Method, add-generic-parser: Exported generic functions
Method, add-help: Exported generic functions
Method, add-optional: Exported generic functions
Method, add-positional: Exported generic functions
Method, add-subparser: Exported generic functions
Method, default: Internal generic functions
Method, defaults: Internal generic functions
Method, description: Internal generic functions
Method, flags: Internal generic functions
Method, format-arguments: Internal generic functions
Method, format-arguments: Internal generic functions
Method, format-control: Internal generic functions
Method, format-control: Internal generic functions
Method, get-key-value-pairs: Exported generic functions
Method, get-value: Exported generic functions
Method, help-message: Internal generic functions
Method, help-message: Internal generic functions
Method, help-message: Internal generic functions
Method, long: Internal generic functions
Method, long: Internal generic functions
Method, name: Internal generic functions
Method, name: Internal generic functions
Method, optionals: Internal generic functions
Method, parse: Exported generic functions
Method, parse-flag: Internal generic functions
Method, parse-flag: Internal generic functions
Method, parse-optional: Internal generic functions
Method, parse-optionals: Internal generic functions
Method, parse-positional: Internal generic functions
Method, parse-positionals: Internal generic functions
Method, parse-subparsers: Internal generic functions
Method, positionals: Internal generic functions
Method, previous-parsers: Internal generic functions
Method, print-help: Internal generic functions
Method, short: Internal generic functions
Method, short: Internal generic functions
Method, subparsers: Internal generic functions
Method, sync-parser: Internal generic functions
Method, table: Internal generic functions
Method, var: Internal generic functions
Method, var: Internal generic functions

N
name: Internal generic functions
name: Internal generic functions
name: Internal generic functions

O
optionals: Internal generic functions
optionals: Internal generic functions

P
parse: Exported generic functions
parse: Exported generic functions
parse-flag: Internal generic functions
parse-flag: Internal generic functions
parse-flag: Internal generic functions
parse-optional: Internal generic functions
parse-optional: Internal generic functions
parse-optionals: Internal generic functions
parse-optionals: Internal generic functions
parse-positional: Internal generic functions
parse-positional: Internal generic functions
parse-positionals: Internal generic functions
parse-positionals: Internal generic functions
parse-subparsers: Internal generic functions
parse-subparsers: Internal generic functions
positionals: Internal generic functions
positionals: Internal generic functions
previous-parsers: Internal generic functions
previous-parsers: Internal generic functions
print-help: Internal generic functions
print-help: Internal generic functions

S
short: Internal generic functions
short: Internal generic functions
short: Internal generic functions
subparsers: Internal generic functions
subparsers: Internal generic functions
sync-parser: Internal generic functions
sync-parser: Internal generic functions

T
table: Internal generic functions
table: Internal generic functions

V
var: Internal generic functions
var: Internal generic functions
var: Internal generic functions

Jump to:   A   C   D   F   G   H   L   M   N   O   P   S   T   V  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   D   F   H   L   N   O   P   S   T   V  
Index Entry  Section

D
default: Internal classes
defaults: Exported classes
description: Exported classes

F
flags: Exported classes
format-arguments: Exported conditions
format-arguments: Internal conditions
format-control: Exported conditions
format-control: Internal conditions

H
help-message: Internal classes
help-message: Internal classes
help-message: Internal classes
help-message: Internal classes

L
long: Internal classes
long: Internal classes
long: Internal classes

N
name: Exported classes
name: Internal classes

O
optionals: Exported classes

P
positionals: Exported classes
previous-parsers: Exported classes

S
short: Internal classes
short: Internal classes
short: Internal classes
Slot, default: Internal classes
Slot, defaults: Exported classes
Slot, description: Exported classes
Slot, flags: Exported classes
Slot, format-arguments: Exported conditions
Slot, format-arguments: Internal conditions
Slot, format-control: Exported conditions
Slot, format-control: Internal conditions
Slot, help-message: Internal classes
Slot, help-message: Internal classes
Slot, help-message: Internal classes
Slot, help-message: Internal classes
Slot, long: Internal classes
Slot, long: Internal classes
Slot, long: Internal classes
Slot, name: Exported classes
Slot, name: Internal classes
Slot, optionals: Exported classes
Slot, positionals: Exported classes
Slot, previous-parsers: Exported classes
Slot, short: Internal classes
Slot, short: Internal classes
Slot, short: Internal classes
Slot, subparsers: Exported classes
Slot, table: Exported classes
Slot, var: Internal classes
Slot, var: Internal classes
subparsers: Exported classes

T
table: Exported classes

V
var: Internal classes
var: Internal classes

Jump to:   D   F   H   L   N   O   P   S   T   V  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   C   D   F   H   O   P   S  
Index Entry  Section

C
cancel-parsing-error: Exported conditions
cl-argparse: The cl-argparse system
Class, flag: Internal classes
Class, help-flag: Internal classes
Class, optional: Internal classes
Class, parser: Exported classes
Class, positional: Internal classes
cmd-arg-error: Internal conditions
Condition, cancel-parsing-error: Exported conditions
Condition, cmd-arg-error: Internal conditions
Condition, help-flag-condition: Internal conditions

D
de.halcony.argparse: The de․halcony․argparse package

F
flag: Internal classes

H
help-flag: Internal classes
help-flag-condition: Internal conditions

O
optional: Internal classes

P
Package, de.halcony.argparse: The de․halcony․argparse package
parser: Exported classes
positional: Internal classes

S
System, cl-argparse: The cl-argparse system

Jump to:   C   D   F   H   O   P   S