The getopt Reference Manual

Table of Contents

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

The getopt Reference Manual

This is the getopt Reference Manual, version 1.0, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:57:46 2018 GMT+0.


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

1 Introduction

Library: getopt
Author:  Kevin Rosenberg 
URL:     http://kpe.io/files/getopt/

This package provides a module for analyzing a list of command-line
arguments. It uses a command-line syntax similar to the GNU getopt_long
function. The package also provides an automated test suite which
uses the ptester library from http://kpe.io/files/ptester/

 


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 getopt

Maintainer

Kevin M. Rosenberg <kmr@debian.org>

Author

Kevin Rosenberg <kevin@rosenberg.net>

License

BSD

Version

1.0

Source

getopt.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 getopt.asd

Location

getopt.asd

Systems

getopt (system)

Packages

getopt-system


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

3.1.2 getopt/package.lisp

Parent

getopt (system)

Location

package.lisp

Packages

getopt


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

3.1.3 getopt/main.lisp

Dependency

package.lisp (file)

Parent

getopt (system)

Location

main.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 getopt-system

Source

getopt.asd

Use List

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

4.2 getopt

Source

package.lisp (file)

Use List

common-lisp

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


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

5.1.1 Functions

Function: getopt ARGS OPTIONS

Processes a list of arguments and options. Returns filtered argument list and alist of options.
opts is a list of option lists. The fields of the list are
- NAME name of the long option
- HAS-ARG with legal values of :NONE, :REQUIRED, :OPTIONAL
- VAL value to return for a option with no arguments

Package

getopt

Source

main.lisp (file)

Function: match-unique-abbreviation ABBR STRINGS

Returns position of ABBR in STRINGS. ABBR may be a unique abbreviation. Returns NIL if no match found.

Package

getopt

Source

main.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: analyze-arg ARG

Analyzes an argument. Returns option-type,base-name,argument

Package

getopt

Source

main.lisp (file)

Function: decompose-arg ARG OPTION-TYPE

Returns base-name,argument

Package

getopt

Source

main.lisp (file)

Function: find-option NAME OPTIONS

Find an option in option list. Handles using unique abbreviations

Package

getopt

Source

main.lisp (file)

Function: is-long-option ARG
Package

getopt

Source

main.lisp (file)

Function: is-option-terminator ARG
Package

getopt

Source

main.lisp (file)

Function: is-short-option ARG
Package

getopt

Source

main.lisp (file)

Function: match-option ARG OPTIONS

Matches an argument to an option. Returns option-list,option-type,base-name,argument

Package

getopt

Source

main.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   G   L  
Index Entry  Section

F
File, Lisp, getopt.asd: The getopt<dot>asd file
File, Lisp, getopt/main.lisp: The getopt/main<dot>lisp file
File, Lisp, getopt/package.lisp: The getopt/package<dot>lisp file

G
getopt.asd: The getopt<dot>asd file
getopt/main.lisp: The getopt/main<dot>lisp file
getopt/package.lisp: The getopt/package<dot>lisp file

L
Lisp File, getopt.asd: The getopt<dot>asd file
Lisp File, getopt/main.lisp: The getopt/main<dot>lisp file
Lisp File, getopt/package.lisp: The getopt/package<dot>lisp file

Jump to:   F   G   L  

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

A.2 Functions

Jump to:   A   D   F   G   I   M  
Index Entry  Section

A
analyze-arg: Internal functions

D
decompose-arg: Internal functions

F
find-option: Internal functions
Function, analyze-arg: Internal functions
Function, decompose-arg: Internal functions
Function, find-option: Internal functions
Function, getopt: Exported functions
Function, is-long-option: Internal functions
Function, is-option-terminator: Internal functions
Function, is-short-option: Internal functions
Function, match-option: Internal functions
Function, match-unique-abbreviation: Exported functions

G
getopt: Exported functions

I
is-long-option: Internal functions
is-option-terminator: Internal functions
is-short-option: Internal functions

M
match-option: Internal functions
match-unique-abbreviation: Exported functions

Jump to:   A   D   F   G   I   M  

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

A.3 Variables


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

A.4 Data types

Jump to:   G   P   S  
Index Entry  Section

G
getopt: The getopt system
getopt: The getopt package
getopt-system: The getopt-system package

P
Package, getopt: The getopt package
Package, getopt-system: The getopt-system package

S
System, getopt: The getopt system

Jump to:   G   P   S