The asdf-manager Reference Manual

Table of Contents

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

The asdf-manager Reference Manual

This is the asdf-manager Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 02:55:17 2018 GMT+0.


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

1 Introduction

asdf-manager

Build Status

Download and manage ASDF versions.

Overview

Really, that's all it does. It's meant to be used as part of a larger Common Lisp environment manager, the other components being ql-manager to manage different Quicklisp environments, and Roswell to manage implementations.

Usage

First, you have to create a manager object. You need to pass a directory where the ASDF source trees will be stored.

(defvar *manager* (make-instance 'asdf-manager:manager
                                 :directory #p"/path/to/some/directory/"))

Then you can start downloading ASDF versions:

(asdf-manager:download-extract-delete *manager* :3.1.6.6)

This will download the source archive for version 3.1.6.6, extract it to <directory>/sources/asdf-3.1.6.6, and delete the archive.

Available versions are stored in the asdf-manager:+available-versions+ vector.

License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.


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 asdf-manager

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/roswell/asdf-manager

Source Control

(:git "git@github.com:roswell/asdf-manager.git")

Bug Tracker

https://github.com/roswell/asdf-manager/issues

License

MIT

Description

Download and manage ASDF versions.

Long Description

# asdf-manager

[![Build Status](https://travis-ci.org/roswell/asdf-manager.svg?branch=master)](https://travis-ci.org/roswell/asdf-manager)

Download and manage ASDF versions.

# Overview

Really, that’s all it does. It’s meant to be used as part of a larger Common
Lisp environment manager, the other components being [ql-manager][ql] to manage
different Quicklisp environments, and [Roswell][ros] to manage implementations.

# Usage

First, you have to create a manager object. You need to pass a directory where
the ASDF source trees will be stored.

“‘lisp
(defvar *manager* (make-instance ’asdf-manager:manager
:directory #p"/path/to/some/directory/"))
“‘

Then you can start downloading ASDF versions:

“‘lisp
(asdf-manager:download-extract-delete *manager* :3.1.6.6)
“‘

This will download the source archive for version 3.1.6.6, extract it to
‘<directory>/sources/asdf-3.1.6.6‘, and delete the archive.

Available versions are stored in the ‘asdf-manager:+available-versions+‘ vector.

# License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.

[ql]: https://github.com/roswell/ql-manager
[ros]: https://github.com/roswell/roswell

Version

0.1

Dependencies
Source

asdf-manager.asd (file)

Component

src (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 asdf-manager/src

Parent

asdf-manager (system)

Location

src/

Component

asdf-manager.lisp (file)


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

4 Files

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


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

4.1 Lisp


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

4.1.1 asdf-manager.asd

Location

asdf-manager.asd

Systems

asdf-manager (system)


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

4.1.2 asdf-manager/src/asdf-manager.lisp

Parent

src (module)

Location

src/asdf-manager.lisp

Packages

asdf-manager

Exported Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 asdf-manager

ASDF manager interface.

Source

asdf-manager.lisp (file)

Use List

common-lisp

Exported Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Special variables

Special Variable: +available-versions+

A vector of available ASDF versions.

Package

asdf-manager

Source

asdf-manager.lisp (file)


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

6.1.2 Functions

Function: archive-url VERSION

Return the URL of the archive containing the given ASDF version.

Package

asdf-manager

Source

asdf-manager.lisp (file)

Function: valid-version-p KEYWORD

Does this keyword represent a valid version?

Package

asdf-manager

Source

asdf-manager.lisp (file)


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

6.1.3 Generic functions

Generic Function: archive-pathname MANAGER VERSION
Package

asdf-manager

Methods
Method: archive-pathname (MANAGER manager) VERSION

The absolute pathname to the file where the archive of the given version will be downloaded.

Source

asdf-manager.lisp (file)

Generic Function: download MANAGER VERSION
Package

asdf-manager

Methods
Method: download (MANAGER manager) VERSION

Download an ASDF version. Returns the pathname to the archive.

Source

asdf-manager.lisp (file)

Generic Function: download-extract-delete MANAGER VERSION
Package

asdf-manager

Methods
Method: download-extract-delete (MANAGER manager) VERSION

Download an archive for the given ASDF version, extract it, and delete the archive file. Returns the path to the directory.

Source

asdf-manager.lisp (file)

Generic Function: extract MANAGER VERSION
Package

asdf-manager

Methods
Method: extract (MANAGER manager) VERSION

Extract a previously downloaded archive. Returns the path to the directory.

Source

asdf-manager.lisp (file)

Generic Function: manager-directory OBJECT
Package

asdf-manager

Methods
Method: manager-directory (MANAGER manager)

The absolute pathname to the directory where ASDF versions are stored.

Source

asdf-manager.lisp (file)

Generic Function: versions-directory MANAGER
Package

asdf-manager

Methods
Method: versions-directory (MANAGER manager)

The absolute pathname to the directory where the manager downloads ASDF versions.

Source

asdf-manager.lisp (file)


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

6.1.4 Classes

Class: manager ()

A manager instance.

Package

asdf-manager

Source

asdf-manager.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: directory

The absolute pathname to the directory where ASDF versions are stored.

Type

pathname

Initargs

:directory

Readers

manager-directory (generic function)


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

6.1.5 Types

Type: version ()

An ASDF version.

Package

asdf-manager

Source

asdf-manager.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   A   F   L   M  
Index Entry  Section

A
asdf-manager.asd: The asdf-manager<dot>asd file
asdf-manager/src: The asdf-manager/src module
asdf-manager/src/asdf-manager.lisp: The asdf-manager/src/asdf-manager<dot>lisp file

F
File, Lisp, asdf-manager.asd: The asdf-manager<dot>asd file
File, Lisp, asdf-manager/src/asdf-manager.lisp: The asdf-manager/src/asdf-manager<dot>lisp file

L
Lisp File, asdf-manager.asd: The asdf-manager<dot>asd file
Lisp File, asdf-manager/src/asdf-manager.lisp: The asdf-manager/src/asdf-manager<dot>lisp file

M
Module, asdf-manager/src: The asdf-manager/src module

Jump to:   A   F   L   M  

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

A.2 Functions

Jump to:   A   D   E   F   G   M   V  
Index Entry  Section

A
archive-pathname: Exported generic functions
archive-pathname: Exported generic functions
archive-url: Exported functions

D
download: Exported generic functions
download: Exported generic functions
download-extract-delete: Exported generic functions
download-extract-delete: Exported generic functions

E
extract: Exported generic functions
extract: Exported generic functions

F
Function, archive-url: Exported functions
Function, valid-version-p: Exported functions

G
Generic Function, archive-pathname: Exported generic functions
Generic Function, download: Exported generic functions
Generic Function, download-extract-delete: Exported generic functions
Generic Function, extract: Exported generic functions
Generic Function, manager-directory: Exported generic functions
Generic Function, versions-directory: Exported generic functions

M
manager-directory: Exported generic functions
manager-directory: Exported generic functions
Method, archive-pathname: Exported generic functions
Method, download: Exported generic functions
Method, download-extract-delete: Exported generic functions
Method, extract: Exported generic functions
Method, manager-directory: Exported generic functions
Method, versions-directory: Exported generic functions

V
valid-version-p: Exported functions
versions-directory: Exported generic functions
versions-directory: Exported generic functions

Jump to:   A   D   E   F   G   M   V  

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

A.3 Variables

Jump to:   +  
D   S  
Index Entry  Section

+
+available-versions+: Exported special variables

D
directory: Exported classes

S
Slot, directory: Exported classes
Special Variable, +available-versions+: Exported special variables

Jump to:   +  
D   S  

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

A.4 Data types

Jump to:   A   C   M   P   S   T   V  
Index Entry  Section

A
asdf-manager: The asdf-manager system
asdf-manager: The asdf-manager package

C
Class, manager: Exported classes

M
manager: Exported classes

P
Package, asdf-manager: The asdf-manager package

S
System, asdf-manager: The asdf-manager system

T
Type, version: Exported types

V
version: Exported types

Jump to:   A   C   M   P   S   T   V