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

The apply-argv Reference Manual

This is the apply-argv Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:34:35 2024 GMT+0.

Next: Systems, Previous: The apply-argv Reference Manual, Up: The apply-argv Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The apply-argv Reference Manual [Contents][Index]

2 Systems

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

apply-argv

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

2.1 `apply-argv`

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

Author

Peter von Etter

License

LLGPL

Version

0.1

Dependency

alexandria (system).

Source

apply-argv.asd.

Child Components

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

Next: Packages, Previous: Systems, Up: The apply-argv Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: apply-argv/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `apply-argv/apply-argv.asd`

Source: apply-argv.asd.
Parent Component: apply-argv (system).
ASDF Systems: apply-argv.

Next: apply-argv/apply-argv.lisp, Previous: apply-argv/apply-argv.asd, Up: Lisp [Contents][Index]

3.1.2 `apply-argv/package.lisp`

Source: apply-argv.asd.
Parent Component: apply-argv (system).
Packages: apply-argv.

Previous: apply-argv/package.lisp, Up: Lisp [Contents][Index]

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

Dependency

package.lisp (file).

Source

apply-argv.asd.

Parent Component

apply-argv (system).

Public Interface

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

Internals

%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).

Next: Definitions, Previous: Files, Up: The apply-argv Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

apply-argv

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

4.1 `apply-argv`

Source

package.lisp.

Use List

alexandria.
common-lisp.

Public Interface

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

Internals

%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).

Next: Indexes, Previous: Packages, Up: The apply-argv Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: apply-argv (function &rest argv) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: get-argv () ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: parse-argv (argv) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: parse-argv* (argv) ¶

Package: apply-argv.
Source: apply-argv.lisp.

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

5.2 Internals

Special variables
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Special variables

Special Variable: *end-keyword-args* ¶

Package: apply-argv.
Source: apply-argv.lisp.

Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: %parse-argv (argv) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: argumentp (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: collect-list-arg (indicator parsed-argv) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: end-args-p (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: get-argument (arg) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: get-long-arg (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: get-no-arg (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: get-short-arg (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: keywordify (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: long-arg-equals-value (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: long-arg-has-equals-value-p (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: long-arg-p (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: no-arg-p (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: short-arg-p (string) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Function: test-apply (qwe &key foo bar) ¶

Package: apply-argv.
Source: apply-argv.lisp.

Previous: Definitions, Up: The apply-argv Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

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

	Index Entry	Section

%
	`%parse-argv`:	Private ordinary functions

A
	`apply-argv`:	Public ordinary functions
	`argumentp`:	Private ordinary functions

C
	`collect-list-arg`:	Private ordinary functions

E
	`end-args-p`:	Private ordinary functions

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

G
	`get-argument`:	Private ordinary functions
	`get-argv`:	Public ordinary functions
	`get-long-arg`:	Private ordinary functions
	`get-no-arg`:	Private ordinary functions
	`get-short-arg`:	Private ordinary functions

K
	`keywordify`:	Private ordinary functions

L
	`long-arg-equals-value`:	Private ordinary functions
	`long-arg-has-equals-value-p`:	Private ordinary functions
	`long-arg-p`:	Private ordinary functions

N
	`no-arg-p`:	Private ordinary functions

P
	`parse-argv`:	Public ordinary functions
	`parse-argv*`:	Public ordinary functions

S
	`short-arg-p`:	Private ordinary functions

T
	`test-apply`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	* S

	Index Entry	Section

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

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

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

A.4 Data types

Jump to:	A F P S

	Index Entry	Section

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

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

P
	`Package, apply-argv`:	The apply-argv package
	`package.lisp`:	The apply-argv/package․lisp file

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

The apply-argv Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 apply-argv

3 Files

3.1 Lisp

3.1.1 apply-argv/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 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary 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/apply-argv.asd`

3.1.2 `apply-argv/package.lisp`

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

4.1 `apply-argv`