The apply-argv Reference Manual

This is the apply-argv Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 11:41:19 2020 GMT+0.

1 Introduction

Simple argv parsing.

(parse-argv '("--foo" "bar"
              "--bar=qwe"
              "--qwe"
              "--no-xyz"
              "more" "stuff" "here"))

==> (("more" "stuff" "here") :FOO "bar" :BAR "qwe" :QWE T :XYZ NIL)

2 Systems

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

2.1 `apply-argv`

Author

Peter von Etter

License

LLGPL

Description

Apply-argv is a library for parsing command line arguments.

Version

0.1

Dependency

alexandria

Source

apply-argv.asd (file)

Components

package.lisp (file)
apply-argv.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 `apply-argv.asd`

Location: apply-argv.asd
Systems: apply-argv (system)

3.1.2 `apply-argv/package.lisp`

Parent: apply-argv (system)
Location: package.lisp
Packages: apply-argv

3.1.3 `apply-argv/apply-argv.lisp`

Dependency

package.lisp (file)

Parent

apply-argv (system)

Location

apply-argv.lisp

Exported Definitions

apply-argv (function)
get-argv (function)
parse-argv (function)
parse-argv* (function)

Internal Definitions

%parse-argv (function)
*end-keyword-args* (special variable)
argumentp (function)
collect-list-arg (function)
end-args-p (function)
get-argument (function)
get-long-arg (function)
get-no-arg (function)
get-short-arg (function)
keywordify (function)
long-arg-equals-value (function)
long-arg-has-equals-value-p (function)
long-arg-p (function)
no-arg-p (function)
short-arg-p (function)
test-apply (function)

4 Packages

Packages are listed by definition order.

4.1 `apply-argv`

Source

package.lisp (file)

Use List

alexandria
common-lisp

Exported Definitions

apply-argv (function)
get-argv (function)
parse-argv (function)
parse-argv* (function)

Internal Definitions

%parse-argv (function)
*end-keyword-args* (special variable)
argumentp (function)
collect-list-arg (function)
end-args-p (function)
get-argument (function)
get-long-arg (function)
get-no-arg (function)
get-short-arg (function)
keywordify (function)
long-arg-equals-value (function)
long-arg-has-equals-value-p (function)
long-arg-p (function)
no-arg-p (function)
short-arg-p (function)
test-apply (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: apply-argv FUNCTION &rest ARGV

Package: apply-argv
Source: apply-argv.lisp (file)

Function: get-argv ()

Package: apply-argv
Source: apply-argv.lisp (file)

Function: parse-argv ARGV

Package: apply-argv
Source: apply-argv.lisp (file)

Function: parse-argv* ARGV

Package: apply-argv
Source: apply-argv.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *end-keyword-args*

Package: apply-argv
Source: apply-argv.lisp (file)

5.2.2 Functions

Function: %parse-argv ARGV

Package: apply-argv
Source: apply-argv.lisp (file)

Function: argumentp STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: collect-list-arg INDICATOR PARSED-ARGV

Package: apply-argv
Source: apply-argv.lisp (file)

Function: end-args-p STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: get-argument ARG

Package: apply-argv
Source: apply-argv.lisp (file)

Function: get-long-arg STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: get-no-arg STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: get-short-arg STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: keywordify STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: long-arg-equals-value STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: long-arg-has-equals-value-p STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: long-arg-p STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: no-arg-p STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: short-arg-p STRING

Package: apply-argv
Source: apply-argv.lisp (file)

Function: test-apply QWE &key FOO BAR

Package: apply-argv
Source: apply-argv.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	A F L

	Index Entry	Section

A
	`apply-argv.asd`:	The apply-argv․asd file
	`apply-argv/apply-argv.lisp`:	The apply-argv/apply-argv․lisp file
	`apply-argv/package.lisp`:	The apply-argv/package․lisp file

F
	File, Lisp, `apply-argv.asd`:	The apply-argv․asd file
	File, Lisp, `apply-argv/apply-argv.lisp`:	The apply-argv/apply-argv․lisp file
	File, Lisp, `apply-argv/package.lisp`:	The apply-argv/package․lisp file

L
	Lisp File, `apply-argv.asd`:	The apply-argv․asd file
	Lisp File, `apply-argv/apply-argv.lisp`:	The apply-argv/apply-argv․lisp file
	Lisp File, `apply-argv/package.lisp`:	The apply-argv/package․lisp file

Jump to:	A F L

A.2 Functions

Jump to:	% A C E F G K L N P S T

	Index Entry	Section

%
	`%parse-argv`:	Internal functions

A
	`apply-argv`:	Exported functions
	`argumentp`:	Internal functions

C
	`collect-list-arg`:	Internal functions

E
	`end-args-p`:	Internal functions

F
	`Function, %parse-argv`:	Internal functions
	`Function, apply-argv`:	Exported functions
	`Function, argumentp`:	Internal functions
	`Function, collect-list-arg`:	Internal functions
	`Function, end-args-p`:	Internal functions
	`Function, get-argument`:	Internal functions
	`Function, get-argv`:	Exported functions
	`Function, get-long-arg`:	Internal functions
	`Function, get-no-arg`:	Internal functions
	`Function, get-short-arg`:	Internal functions
	`Function, keywordify`:	Internal functions
	`Function, long-arg-equals-value`:	Internal functions
	`Function, long-arg-has-equals-value-p`:	Internal functions
	`Function, long-arg-p`:	Internal functions
	`Function, no-arg-p`:	Internal functions
	`Function, parse-argv`:	Exported functions
	`Function, parse-argv*`:	Exported functions
	`Function, short-arg-p`:	Internal functions
	`Function, test-apply`:	Internal functions

G
	`get-argument`:	Internal functions
	`get-argv`:	Exported functions
	`get-long-arg`:	Internal functions
	`get-no-arg`:	Internal functions
	`get-short-arg`:	Internal functions

K
	`keywordify`:	Internal functions

L
	`long-arg-equals-value`:	Internal functions
	`long-arg-has-equals-value-p`:	Internal functions
	`long-arg-p`:	Internal functions

N
	`no-arg-p`:	Internal functions

P
	`parse-argv`:	Exported functions
	`parse-argv*`:	Exported functions

S
	`short-arg-p`:	Internal functions

T
	`test-apply`:	Internal functions

Jump to:	% A C E F G K L N P S T

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`end-keyword-args`:	Internal special variables

S
	`Special Variable, end-keyword-args`:	Internal special variables

Jump to:	* S

A.4 Data types

Jump to:	A P S

	Index Entry	Section

A
	`apply-argv`:	The apply-argv system
	`apply-argv`:	The apply-argv package

P
	`Package, apply-argv`:	The apply-argv package

S
	`System, apply-argv`:	The apply-argv system

Jump to:	A P S

• Introduction		What apply-argv is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• Concept index
• Function index
• Variable index
• Data type index

• The apply-argv.asd file
• The apply-argv/package.lisp file
• The apply-argv/apply-argv.lisp file

The apply-argv Reference Manual

Table of Contents

The apply-argv Reference Manual

1 Introduction

2 Systems

2.1 apply-argv

3 Files

3.1 Lisp

3.1.1 apply-argv.asd

3.1.2 apply-argv/package.lisp

3.1.3 apply-argv/apply-argv.lisp

4 Packages

4.1 apply-argv

5 Definitions

5.1 Exported definitions

5.1.1 Functions

5.2 Internal definitions

5.2.1 Special variables

5.2.2 Functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `apply-argv`

3.1.1 `apply-argv.asd`

3.1.2 `apply-argv/package.lisp`

3.1.3 `apply-argv/apply-argv.lisp`

4.1 `apply-argv`