The ziz Reference Manual

This is the ziz Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:08:36 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 ziz

An ad hoc Quicklisp distribution.

Author

Tarn W. Burton

License

MIT

Version

0.1

Dependencies
  • alexandria (system).
  • hunchentoot (system).
  • ironclad (system).
  • trivial-file-size (system).
Source

ziz.asd.

Child Component

src (module).


3 Modules

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


3.1 ziz/src

Source

ziz.asd.

Parent Component

ziz (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 ziz/ziz.asd

Source

ziz.asd.

Parent Component

ziz (system).

ASDF Systems

ziz.


4.1.2 ziz/src/packages.lisp

Source

ziz.asd.

Parent Component

src (module).

Packages

ziz.


4.1.3 ziz/src/distribution.lisp

Dependency

packages.lisp (file).

Source

ziz.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 ziz

Source

packages.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: with-distribution ((var &rest rest) &body body)
Package

ziz.

Source

distribution.lisp.


6.1.2 Ordinary functions

Function: distribution-archive-base-url (instance)
Package

ziz.

Source

distribution.lisp.

Function: distribution-info-url (instance)
Package

ziz.

Source

distribution.lisp.

Function: distribution-release-index-url (instance)
Package

ziz.

Source

distribution.lisp.

Function: distribution-system-index-url (instance)
Package

ziz.

Source

distribution.lisp.

Function: start (instance)
Package

ziz.

Source

distribution.lisp.

Function: stop (instance)
Package

ziz.

Source

distribution.lisp.


6.1.3 Generic functions

Generic Reader: distribution-hostname (object)
Package

ziz.

Methods
Reader Method: distribution-hostname ((distribution distribution))

automatically generated reader method

Source

distribution.lisp.

Target Slot

hostname.

Generic Writer: (setf distribution-hostname) (object)
Package

ziz.

Methods
Writer Method: (setf distribution-hostname) ((distribution distribution))

automatically generated writer method

Source

distribution.lisp.

Target Slot

hostname.

Generic Reader: distribution-info (object)
Package

ziz.

Methods
Reader Method: distribution-info ((distribution distribution))

automatically generated reader method

Source

distribution.lisp.

Target Slot

info.

Generic Writer: (setf distribution-info) (object)
Package

ziz.

Methods
Writer Method: (setf distribution-info) ((distribution distribution))

automatically generated writer method

Source

distribution.lisp.

Target Slot

info.

Generic Reader: distribution-name (object)
Package

ziz.

Methods
Reader Method: distribution-name ((distribution distribution))

automatically generated reader method

Source

distribution.lisp.

Target Slot

name.

Generic Writer: (setf distribution-name) (object)
Package

ziz.

Methods
Writer Method: (setf distribution-name) ((distribution distribution))

automatically generated writer method

Source

distribution.lisp.

Target Slot

name.

Generic Reader: distribution-port (object)
Package

ziz.

Methods
Reader Method: distribution-port ((distribution distribution))

automatically generated reader method

Source

distribution.lisp.

Target Slot

port.

Generic Writer: (setf distribution-port) (object)
Package

ziz.

Methods
Writer Method: (setf distribution-port) ((distribution distribution))

automatically generated writer method

Source

distribution.lisp.

Target Slot

port.

Generic Reader: distribution-release-index (object)
Package

ziz.

Methods
Reader Method: distribution-release-index ((distribution distribution))

automatically generated reader method

Source

distribution.lisp.

Target Slot

release-index.

Generic Writer: (setf distribution-release-index) (object)
Package

ziz.

Methods
Writer Method: (setf distribution-release-index) ((distribution distribution))

automatically generated writer method

Source

distribution.lisp.

Target Slot

release-index.

Generic Reader: distribution-releases (object)
Package

ziz.

Methods
Reader Method: distribution-releases ((distribution distribution))

automatically generated reader method

Source

distribution.lisp.

Target Slot

releases.

Generic Writer: (setf distribution-releases) (object)
Package

ziz.

Methods
Writer Method: (setf distribution-releases) ((distribution distribution))

automatically generated writer method

Source

distribution.lisp.

Target Slot

releases.

Generic Reader: distribution-server (object)
Package

ziz.

Methods
Reader Method: distribution-server ((distribution distribution))

automatically generated reader method

Source

distribution.lisp.

Target Slot

server.

Generic Writer: (setf distribution-server) (object)
Package

ziz.

Methods
Writer Method: (setf distribution-server) ((distribution distribution))

automatically generated writer method

Source

distribution.lisp.

Target Slot

server.

Generic Reader: distribution-system-index (object)
Package

ziz.

Methods
Reader Method: distribution-system-index ((distribution distribution))

automatically generated reader method

Source

distribution.lisp.

Target Slot

system-index.

Generic Writer: (setf distribution-system-index) (object)
Package

ziz.

Methods
Writer Method: (setf distribution-system-index) ((distribution distribution))

automatically generated writer method

Source

distribution.lisp.

Target Slot

system-index.

Generic Reader: distribution-version (object)
Package

ziz.

Methods
Reader Method: distribution-version ((distribution distribution))

automatically generated reader method

Source

distribution.lisp.

Target Slot

version.

Generic Writer: (setf distribution-version) (object)
Package

ziz.

Methods
Writer Method: (setf distribution-version) ((distribution distribution))

automatically generated writer method

Source

distribution.lisp.

Target Slot

version.


6.1.4 Classes

Class: distribution
Package

ziz.

Source

distribution.lisp.

Direct methods
Direct slots
Slot: name
Initform

"ziz"

Initargs

:name

Readers

distribution-name.

Writers

(setf distribution-name).

Slot: version
Initform

1

Initargs

:version

Readers

distribution-version.

Writers

(setf distribution-version).

Slot: hostname
Initform

"localhost"

Initargs

:hostname

Readers

distribution-hostname.

Writers

(setf distribution-hostname).

Slot: port
Initform

8000

Initargs

:port

Readers

distribution-port.

Writers

(setf distribution-port).

Slot: release-index
Initform

"releases.txt"

Initargs

:release-index

Readers

distribution-release-index.

Writers

(setf distribution-release-index).

Slot: releases
Initargs

:releases

Readers

distribution-releases.

Writers

(setf distribution-releases).

Slot: server
Readers

distribution-server.

Writers

(setf distribution-server).

Slot: info
Initform

"distinfo.txt"

Initargs

:info

Readers

distribution-info.

Writers

(setf distribution-info).

Slot: system-index
Initform

"systems.txt"

Initargs

:system-index

Readers

distribution-system-index.

Writers

(setf distribution-system-index).


6.2 Internals


6.2.1 Ordinary functions

Function: add-to-release-index (instance doc-root stream name release-path asd-paths)
Package

ziz.

Source

distribution.lisp.

Function: add-to-system-index (instance doc-root stream name release-path asd-paths)
Package

ziz.

Source

distribution.lisp.

Function: create-distinfo (instance doc-root)
Package

ziz.

Source

distribution.lisp.

Function: create-indicies (instance doc-root)
Package

ziz.

Source

distribution.lisp.

Function: create-release-tarball (doc-root release-path)
Package

ziz.

Source

distribution.lisp.

Function: digest-file (digest path)
Package

ziz.

Source

distribution.lisp.

Function: external-url (instance &optional file)
Package

ziz.

Source

distribution.lisp.

Function: load-asd (asd-path)
Package

ziz.

Source

distribution.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   G   L   M   S   W  
Index Entry  Section

(
(setf distribution-hostname): Public generic functions
(setf distribution-hostname): Public generic functions
(setf distribution-info): Public generic functions
(setf distribution-info): Public generic functions
(setf distribution-name): Public generic functions
(setf distribution-name): Public generic functions
(setf distribution-port): Public generic functions
(setf distribution-port): Public generic functions
(setf distribution-release-index): Public generic functions
(setf distribution-release-index): Public generic functions
(setf distribution-releases): Public generic functions
(setf distribution-releases): Public generic functions
(setf distribution-server): Public generic functions
(setf distribution-server): Public generic functions
(setf distribution-system-index): Public generic functions
(setf distribution-system-index): Public generic functions
(setf distribution-version): Public generic functions
(setf distribution-version): Public generic functions

A
add-to-release-index: Private ordinary functions
add-to-system-index: Private ordinary functions

C
create-distinfo: Private ordinary functions
create-indicies: Private ordinary functions
create-release-tarball: Private ordinary functions

D
digest-file: Private ordinary functions
distribution-archive-base-url: Public ordinary functions
distribution-hostname: Public generic functions
distribution-hostname: Public generic functions
distribution-info: Public generic functions
distribution-info: Public generic functions
distribution-info-url: Public ordinary functions
distribution-name: Public generic functions
distribution-name: Public generic functions
distribution-port: Public generic functions
distribution-port: Public generic functions
distribution-release-index: Public generic functions
distribution-release-index: Public generic functions
distribution-release-index-url: Public ordinary functions
distribution-releases: Public generic functions
distribution-releases: Public generic functions
distribution-server: Public generic functions
distribution-server: Public generic functions
distribution-system-index: Public generic functions
distribution-system-index: Public generic functions
distribution-system-index-url: Public ordinary functions
distribution-version: Public generic functions
distribution-version: Public generic functions

E
external-url: Private ordinary functions

F
Function, add-to-release-index: Private ordinary functions
Function, add-to-system-index: Private ordinary functions
Function, create-distinfo: Private ordinary functions
Function, create-indicies: Private ordinary functions
Function, create-release-tarball: Private ordinary functions
Function, digest-file: Private ordinary functions
Function, distribution-archive-base-url: Public ordinary functions
Function, distribution-info-url: Public ordinary functions
Function, distribution-release-index-url: Public ordinary functions
Function, distribution-system-index-url: Public ordinary functions
Function, external-url: Private ordinary functions
Function, load-asd: Private ordinary functions
Function, start: Public ordinary functions
Function, stop: Public ordinary functions

G
Generic Function, (setf distribution-hostname): Public generic functions
Generic Function, (setf distribution-info): Public generic functions
Generic Function, (setf distribution-name): Public generic functions
Generic Function, (setf distribution-port): Public generic functions
Generic Function, (setf distribution-release-index): Public generic functions
Generic Function, (setf distribution-releases): Public generic functions
Generic Function, (setf distribution-server): Public generic functions
Generic Function, (setf distribution-system-index): Public generic functions
Generic Function, (setf distribution-version): Public generic functions
Generic Function, distribution-hostname: Public generic functions
Generic Function, distribution-info: Public generic functions
Generic Function, distribution-name: Public generic functions
Generic Function, distribution-port: Public generic functions
Generic Function, distribution-release-index: Public generic functions
Generic Function, distribution-releases: Public generic functions
Generic Function, distribution-server: Public generic functions
Generic Function, distribution-system-index: Public generic functions
Generic Function, distribution-version: Public generic functions

L
load-asd: Private ordinary functions

M
Macro, with-distribution: Public macros
Method, (setf distribution-hostname): Public generic functions
Method, (setf distribution-info): Public generic functions
Method, (setf distribution-name): Public generic functions
Method, (setf distribution-port): Public generic functions
Method, (setf distribution-release-index): Public generic functions
Method, (setf distribution-releases): Public generic functions
Method, (setf distribution-server): Public generic functions
Method, (setf distribution-system-index): Public generic functions
Method, (setf distribution-version): Public generic functions
Method, distribution-hostname: Public generic functions
Method, distribution-info: Public generic functions
Method, distribution-name: Public generic functions
Method, distribution-port: Public generic functions
Method, distribution-release-index: Public generic functions
Method, distribution-releases: Public generic functions
Method, distribution-server: Public generic functions
Method, distribution-system-index: Public generic functions
Method, distribution-version: Public generic functions

S
start: Public ordinary functions
stop: Public ordinary functions

W
with-distribution: Public macros