The asdf-manager Reference Manual

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 4.0 beta 2 "William Riker" on Mon Aug 15 03:12:56 2022 GMT+0.

Table of Contents


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.


2 Systems

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


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

2.1 asdf-manager

Download and manage ASDF versions.

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

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
  • uiop (system).
  • trivial-download (system).
  • trivial-extract (system).
Source

asdf-manager.asd.

Child Component

src (module).


3 Modules

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


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

3.1 asdf-manager/src

Source

asdf-manager.asd.

Parent Component

asdf-manager (system).

Child Component

asdf-manager.lisp (file).


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


4.1.1 asdf-manager/asdf-manager.asd

Source

asdf-manager.asd.

Parent Component

asdf-manager (system).

ASDF Systems

asdf-manager.


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

Source

asdf-manager.asd.

Parent Component

src (module).

Packages

asdf-manager.

Public Interface

5 Packages

Packages are listed by definition order.


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

5.1 asdf-manager

ASDF manager interface.

Source

asdf-manager.lisp.

Use List

common-lisp.

Public Interface

6 Definitions

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


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

6.1 Public Interface


6.1.1 Special variables

Special Variable: +available-versions+

A vector of available ASDF versions.

Package

asdf-manager.

Source

asdf-manager.lisp.


6.1.2 Ordinary functions

Function: archive-url (version)

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

Package

asdf-manager.

Source

asdf-manager.lisp.

Function: valid-version-p (keyword)

Does this keyword represent a valid version?

Package

asdf-manager.

Source

asdf-manager.lisp.


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.

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.

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.

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.

Generic Reader: manager-directory (object)
Package

asdf-manager.

Methods
Reader Method: manager-directory ((manager manager))

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

Source

asdf-manager.lisp.

Target Slot

directory.

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.


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

6.1.4 Classes

Class: manager

A manager instance.

Package

asdf-manager.

Source

asdf-manager.lisp.

Direct methods
Direct slots
Slot: directory

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

Package

common-lisp.

Type

pathname

Initargs

:directory

Readers

manager-directory.

Writers

This slot is read-only.


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

6.1.5 Types

Type: version ()

An ASDF version.

Package

asdf-manager.

Source

asdf-manager.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

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

A
archive-pathname: Public generic functions
archive-pathname: Public generic functions
archive-url: Public ordinary functions

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

E
extract: Public generic functions
extract: Public generic functions

F
Function, archive-url: Public ordinary functions
Function, valid-version-p: Public ordinary functions

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

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

V
valid-version-p: Public ordinary functions
versions-directory: Public generic functions
versions-directory: Public 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+: Public special variables

D
directory: Public classes

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

Jump to:   +  
D   S