The fr.epita.lrde.quickref Reference Manual

Table of Contents

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

The fr.epita.lrde.quickref Reference Manual

This is the fr.epita.lrde.quickref Reference Manual, version 1.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:40:23 2018 GMT+0.


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

1 Introduction

Quickref

Quickref is a global documentation project for Common Lisp libraries. It builds a website containing reference manuals for Quicklisp libraries (either those already installed or the whole thing). The reference manuals are generated by Declt in Texinfo format, and then processed by makeinfo.

The official Quickref website is kept up-to-date with Quicklisp. This repository contains the whole infrastructure needed to build your own version of the website.

Using Quickref

In order to build your local version of the website, you can use Quickref either through the provided Docker images, or directly from the source.

From Docker

If you want documentation for the whole Quicklisp world, this is the simplest way to use Quickref. The Docker image ships with a complete build environment that aims to reproduce the one used to create the Quicklisp releases. This means that it contains (almost) all the dependencies needed to build every library available in Quicklisp.

Type this to run Quickref in Docker:

docker run --name quickref quickref/quickref

This will automatically pull down the image and run Quickref inside it. If you have done this before, you may want to make sure you have the latest image by typing this first:

docker pull quickref/quickref

Also, note that you need a running Docker daemon for this to work. The Mac app takes care of this automatically. Otherwise, if the pull or run commands above fail, you may need to run the deamon yourself, for example with something like this:

sudo dockerd

When Quickref is done (this will take a while), you can extract the website from the container by typing this:

docker cp quickref:/home/quickref/quickref .

The website will be located under quickref/html/. You will also see some other directories containing the Texinfo files, and some logs in case there were errors during processing (from both Declt and makeinfo).

From the source

Running Quickref from the source makes sense if you only want to generate documentation for the libraries already installed on your machine. Of course, you can also build the whole thing, but beware that this will download the whole Quicklisp world, and that a lot of external dependencies will be required for processing. Look at the file docker/debian-9-packages.txt to get an idea of what's needed.

Assuming you have made Quickref available to ASDF, type this:

(ql:quickload :fr.epita.lrde.quickref)
(fr.epita.lrde.quickref:build :libraries :installed)

This will generate a website for your current Quicklisp installation. Selecting :all libraries instead of only those already installed (this is actually the default) will trigger a complete cycle, which includes downloading and installing the whole Quicklisp thing. The generated files (logs, Texinfo, and HTML) can be found in ~/quickref/.

Customization

In addition to the :libraries option, the BUILD function accepts a number of keyword arguments allowing you to tweak the behavior of Quickref. In particular, you have control on the output destination, error behavior, and a (still) rudimentary support for parallelism. Please refer to the docstring for more information.

Docker images

You can build your own Quickref Docker images by using the provided Docker image files located in the docker directory. The project is split in 2 separate image files:

With this 2-steps process, it is possible to rebuild the final Quickref image with the latest Quicklisp without rebuilding the whole environment (including the hundreds of dependencies installed from apt).

Building the images

The two Quickref Docker images are created by typing respectively (and in that order):

docker build -t quickref/buildenv -f Buildenv .
docker build -t quickref/quickref -f Quickref .

Then, as before, run it and extract the result like this:

docker run --name quickref quickref/quickref
docker cp quickref:/home/quickref/quickref .

In order to avoid conflicting with the official images, you may prefer to use different values for the -t (and possibly --name) options, but then, be sure to also change the line saying FROM quickref/buildenv in the Quickref Docker image file.


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

2 Systems

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


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

2.1 fr.epita.lrde.quickref

Maintainers

Antoine Martin
Didier Verna

Author

Antoine Martin

Contact

quickref@lrde.epita.fr

License

BSD

Description

Reference Manuals for Quicklisp Libraries

Long Description

Quickref is a global documentation project for Common Lisp libraries. It builds a website containing reference manuals for every Quicklisp[1] library available. The reference manuals are generated by Declt[2] in Texinfo[3] format, and then processed by makeinfo. The official Quickref website[4] is kept up-to-date with Quicklisp.

[1] https://www.quicklisp.org
[2] https://github.com/didierverna/declt
[3] https://www.gnu.org/software/texinfo/
[4] http://quickref.common-lisp.net

Version

1.0

Dependencies
Source

fr.epita.lrde.quickref.asd (file)


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

2.2 fr.epita.lrde.quickref.core

Long Name

Quickref Core

Maintainers

Antoine Martin
Didier Verna

Author

Antoine Martin

Contact

quickref@lrde.epita.fr

License

BSD

Description

Quickref’s core library

Long Description

Quickref’s core library provides the core functionality of Quickref. For a more complete description of Quickref, see the fr.epita.lrde.quickref system.

Version

1.0

Dependencies
Source

fr.epita.lrde.quickref.core.asd (file)

Components

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

2.3 fr.epita.lrde.quickref.cmark

Long Name

CommonMark Foreign Function Interface

Maintainers

Antoine Martin
Didier Verna

Author

Antoine Martin

Contact

quickref@lrde.epita.fr

License

BSD

Description

Bindings to libcmark

Long Description

CMark provides bindings to libcmark, the C implementation of CommonMark. CommonMark[1] is itself an attempt at properly specifying the MarkDown[2] format.

[1] http://commonmark.org/
[2] https://daringfireball.net/projects/markdown/

Version

1.0

Dependencies
Source

fr.epita.lrde.quickref.cmark.asd (file)

Component

cmark.lisp (file)


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

2.4 fr.epita.lrde.quickref.setup

Long Name

Quickref Setup

Maintainers

Antoine Martin
Didier Verna

Author

Didier Verna

Contact

quickref@lrde.epita.fr

License

BSD

Description

Quickref’s setup library

Long Description

Quickref’s setup library provides support for various preload configuration parameters. For a more complete description of Quickref, see the fr.epita.lrde.quickref system.

Source

fr.epita.lrde.quickref.setup.asd (file)

Component

setup.lisp (file)


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 fr.epita.lrde.quickref.core/src

Dependency

meta.lisp (file)

Parent

fr.epita.lrde.quickref.core (system)

Location

core/src/

Components

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 fr.epita.lrde.quickref.asd

Location

fr.epita.lrde.quickref.asd

Systems

fr.epita.lrde.quickref (system)


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

4.1.2 fr.epita.lrde.quickref.core.asd

Location

core/fr.epita.lrde.quickref.core.asd

Systems

fr.epita.lrde.quickref.core (system)


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

4.1.3 fr.epita.lrde.quickref.cmark.asd

Location

cmark/fr.epita.lrde.quickref.cmark.asd

Systems

fr.epita.lrde.quickref.cmark (system)


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

4.1.4 fr.epita.lrde.quickref.setup.asd

Location

setup/fr.epita.lrde.quickref.setup.asd

Systems

fr.epita.lrde.quickref.setup (system)


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

4.1.5 fr.epita.lrde.quickref.core/meta.lisp

Parent

fr.epita.lrde.quickref.core (system)

Location

core/meta.lisp

Packages

fr.epita.lrde.quickref

Exported Definitions

nickname-package (function)


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

4.1.6 fr.epita.lrde.quickref.core/src/util.lisp

Parent

src (module)

Location

core/src/util.lisp

Exported Definitions
Internal Definitions

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

4.1.7 fr.epita.lrde.quickref.core/src/texinfo.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

core/src/texinfo.lisp

Internal Definitions

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

4.1.8 fr.epita.lrde.quickref.core/src/html.lisp

Dependency

util.lisp (file)

Parent

src (module)

Location

core/src/html.lisp

Internal Definitions

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

4.1.9 fr.epita.lrde.quickref.core/src/quickref.lisp

Dependencies
Parent

src (module)

Location

core/src/quickref.lisp

Exported Definitions

build (function)

Internal Definitions

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

4.1.10 fr.epita.lrde.quickref.cmark/cmark.lisp

Parent

fr.epita.lrde.quickref.cmark (system)

Location

cmark/cmark.lisp

Packages

fr.epita.lrde.quickref.cmark

Exported Definitions

cmark-markdown-to-html (function)


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

4.1.11 fr.epita.lrde.quickref.setup/setup.lisp

Parent

fr.epita.lrde.quickref.setup (system)

Location

setup/setup.lisp

Packages

fr.epita.lrde.quickref.setup

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 fr.epita.lrde.quickref

The Quickref package.

Source

meta.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5.2 fr.epita.lrde.quickref.cmark

The Quickref/CMark package.

Source

cmark.lisp (file)

Use List

common-lisp

Exported Definitions

cmark-markdown-to-html (function)


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

5.3 fr.epita.lrde.quickref.setup

The Quickref setup package.

Source

setup.lisp (file)

Use List

common-lisp

Used By List

fr.epita.lrde.quickref

Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Special variables

Special Variable: *caching-behavior*

Behavior to adopt with respect to compilation cache (:global by default). If :global, the normal behavior is honored, meaning that compilation caches are shared across Declt calls. Otherwise, every Declt call uses a different cache.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Special Variable: *error-behavior*

Behavior to adopt when errors are encountered (:log by default).
If :log, just log the errors and continue processing. Otherwise, stop at the first error. Note also that when errors are logged (which is meant to be the non-interactive way of running Quickref), normal output from Declt and Makeinfo is discarded completely.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Special Variable: *libraries*

Quicklisp libraries to process (:all by default).
When :all, process (and hence download) all Quicklisp libraries. Otherwise, only process the libraries that are already installed.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Special Variable: *makeinfo-path*

Path to the ’makeinfo’ executable.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Special Variable: *output-directory*

Quickref’s output directory (~/quickref/ by default).

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Special Variable: *parallel*

Whether to parallelize the build process (NIL by default).

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Special Variable: *release-major-level*

The major level of this release.

Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Special Variable: *release-minor-level*

The minor level of this release.

Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Special Variable: *release-name*

The name of this release.
The general naming theme for Quickref is "Songs from Iron Maiden".

Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Special Variable: *release-status*

The status of this release.

Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Special Variable: *release-status-level*

The status level of this release.

Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Special Variable: *update*

Whether to update Quicklisp before processing (T by default).

Package

fr.epita.lrde.quickref

Source

util.lisp (file)


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

6.1.2 Functions

Function: build &key UPDATE LIBRARIES OUTPUT-DIRECTORY MAKEINFO-PATH CROSS-REFERENCE-VALIDATION ERROR-BEHAVIOR CACHING-BEHAVIOR PARALLEL

Build the Quickref website.
All keywords to this function are defaulted to their corresponding global parameter, which see.

Package

fr.epita.lrde.quickref

Source

quickref.lisp (file)

Function: cmark-markdown-to-html MD SIZE OPTIONS
Package

fr.epita.lrde.quickref.cmark

Source

cmark.lisp (file)

Function: configuration KEY

Return KEY’s value in the current Quickref configuration.

Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Function: configure KEY VALUE

Set KEY to VALUE in the current Quickref configuration.

Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Function: nickname-package &optional NICKNAME

Add NICKNAME (:QUICKREF by default) to the :FR.EPITA.LRDE.QUICKREF package.

Package

fr.epita.lrde.quickref

Source

meta.lisp (file)

Function: version &optional TYPE

Return the current version of Quickref.
TYPE can be one of :number, :short or :long.

A version number is computed as major*10000 + minor*100 + patchlevel, leaving two digits for each level. Alpha, beta and rc status are ignored in version numbers.

A short version is something like 1.3{a,b,rc}4, or 1.3.4 for patchlevel. Alpha, beta or rc levels start at 1. Patchlevels start at 0 but are ignored in the output, so that 1.3.0 appears as just 1.3.

A long version is something like
1.3 {alpha,beta,release candidate,patchlevel} 4 "The Trooper". As for
the short version, a patchlevel of 0 is ignored in the output.

Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)


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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *bin-directory*

Quickref’s bin sub-directory.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Special Variable: *configuration*

The Quickref configuration settings.
This variable contains a property list of configuration options. Current options are:
- :swank-eval-in-emacs (Boolean)

Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Special Variable: *cross-reference-validation*

Whether to validate cross references (NIL by default).
Validation will help catch Declt bugs, but also prevent otherwise usable manuals from being generated.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Special Variable: *declt-script*

Quickref’s Declt script.

Package

fr.epita.lrde.quickref

Source

texinfo.lisp (file)

Special Variable: *libraries-queue*
Package

fr.epita.lrde.quickref

Source

texinfo.lisp (file)

Special Variable: *other-systems-names*

Non-Quicklisp systems that need to be documented.

Package

fr.epita.lrde.quickref

Source

quickref.lisp (file)

Special Variable: *share-directory*

Quickref’s share sub-directory.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Special Variable: *top-directory*

Quickref’s top directory.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)


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

6.2.2 Macros

Macro: endpush OBJECT PLACE

Like PUSH, but at the end.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Macro: format-// STREAM &rest ARGS

Like FORMAT, but block until all output is flushed.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)


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

6.2.3 Functions

Function: %version TYPE MAJOR MINOR STATUS LEVEL NAME
Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Function: *.* DIRECTORY

Return a list of all pathnames matching *.* in DIRECTORY.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: <pre> STRING

Return STRING as html PRE.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: build-html-manuals-// MUTEX NEW-MANUAL

Build HTML manuals, parallel version.
Return the number of HTML files successfully built.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: build-index-file ()

Build Quickref’s index.html file.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: build-manuals LIBRARIES

Build LIBRARIES reference manuals.

Package

fr.epita.lrde.quickref

Source

quickref.lisp (file)

Function: build-manuals-// LIBRARIES

Build LIBRARIES reference manuals. This is the parallel version.

Package

fr.epita.lrde.quickref

Source

quickref.lisp (file)

Function: build-texinfo-manuals-// LIBRARIES MUTEX NEW-MANUAL

Build LIBRARIES Texinfo manuals, parallel version. Return the number of Texinfo files successfully built.

Package

fr.epita.lrde.quickref

Source

texinfo.lisp (file)

Function: cache-directory ()

Return Quickref’s compilation cache root directory.
This is the location used when the caching behavior is local. ASDF and Declt get their own subdirectory, every documented system also has its own one, leading to duplicate compilation of every shared dependency.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: column-lengths NUMBER

Spread NUMBER of entries in 3 different columns as uniformly as possible. Return the column lengths as 3 values.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: copy-style-sheets ()

Copy Quickref’s style sheets to the HTML output directory.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: declt SYSTEM-NAME

Run Declt on ASDF SYSTEM-NAME. Return T on success.

Package

fr.epita.lrde.quickref

Source

texinfo.lisp (file)

Function: declt-log-file SYSTEM-NAME

Return Quickref’s Declt log file for ASDF SYSTEM-NAME.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: declt-logs-directory ()

Return quickref’s Declt logs directory.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: ensure-quickref-directory &key DECLT MAKEINFO

Make sure we have fresh DECLT and/or MAKEINFO directories.
This function handles the cache, log and output directories at the same time.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: file-contents FILE

Attempt to safely read FILE into a string and return it. Safely means try to detect a proper encoding.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: format-cell MANUAL-NAME

Format an HTML TD linking to MANUAL-NAME’s HTML file.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: html-directory ()

Return Quickref’s generated HTML files directory.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: html-file SYSTEM-NAME

Return ASDF SYSTEM-NAME’s HTML file.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: index-character MANUAL-NAME

Return MANUAL-NAME’s index character.
Manuals are indexed by the first (upcased) letter of their trimmed name if it’s alphabetic, or under # otherwise.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: insert-readme-contents HTML-FILE README-FILE

Insert the contents of README-FILE into HTML-FILE.
README contents is rendered in HTML and inserted as introduction.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: logs-directory ()

Return Quickref’s logs directory.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: makeinfo SYSTEM-NAME

Run Makeinfo on ASDF SYSTEM-NAME. Return T on success.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: makeinfo-log-file SYSTEM-NAME

Return Quickref’s Makeinfo log file for ASDF SYSTEM-NAME.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: makeinfo-logs-directory ()

Return quickref’s Makeinfo logs directory.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: markdown-html STRING

Return Markdown STRING formatted as HTML.
Try our CommonMark FFI first, fall back to 3BMD otherwise.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: primary-system RELEASE

Return RELEASE’s primary system.
The primary system is determined heuristically as follows:
- it’s the only system,
- it has the same name as the release,
- it has the same name as the release, with "cl-" prefixed removed, - it has the shortest name.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: quicklisp-distribution ()

Return a Quicklisp distribution object for the "quicklisp" distribution.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: readme-file SYSTEM-NAME

Return the pathname of a README(.*) file for ASDF SYSTEM-NAME, if any. Try the system’s directory first. If that fails and the system is part of a Quicklisp RELEASE, also try the release’s directory (which may be different).

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: readme-html README

Return contents of README file formatted as HTML.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: release-status-number RELEASE-STATUS
Package

fr.epita.lrde.quickref.setup

Source

setup.lisp (file)

Function: render-index-entry CHARACTER MANUAL-NAMES NUMBER

Render index file’s first NUMBER MANUAL-NAMES entries under CHARACTER.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: render-index-header MANUALS-NUMBER

Render index file’s header to standard output. The header also advertise MANUALS-NUMBER.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Function: renew-directory DIRECTORY

Either create DIRECTORY, or remove everything from it.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: texinfo-directory ()

Return Quickref’s generated Texinfo files directory.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Function: texinfo-file SYSTEM-NAME

Return ASDF SYSTEM-NAME’s Texinfo file.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)


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

6.2.4 Generic functions

Generic Function: build-html-manual LIBRARY &key SILENT

Build LIBRARY’s HTML manual. Return T on success.

Package

fr.epita.lrde.quickref

Source

html.lisp (file)

Methods
Method: build-html-manual (SYSTEM-NAME string) &key SILENT

Build ASDF SYSTEM-NAME’s HTML manual. Return T on success.

Method: build-html-manual (SYSTEM system) &key SILENT

Build Quicklisp SYSTEM’s HTML manual. Return T on success.

Method: build-html-manual (RELEASE release) &key SILENT

Build Quicklisp RELEASE’s HTML manual. Return T on success.

Generic Function: build-manual LIBRARY

Build LIBRARY’s reference manual.
Return :html, :texi or NIL, indicating how far the process went.

Package

fr.epita.lrde.quickref

Source

quickref.lisp (file)

Methods
Method: build-manual (SYSTEM-NAME string)

Build ASDF SYSTEM-NAME’s reference manual.
Return :html, :texi or NIL, indicating how far the process went.

Method: build-manual (SYSTEM system)

Build Quicklisp SYSTEM’s reference manual.
Return :html, :texi or NIL, indicating how far the process went.

Method: build-manual (RELEASE release)

Build Quicklisp RELEASE’s reference manual.
Return :html, :texi or NIL, indicating how far the process went.

Generic Function: build-texinfo-manual LIBRARY &key SILENT

Build LIBRARY’s Texinfo manual. Return T on success.

Package

fr.epita.lrde.quickref

Source

texinfo.lisp (file)

Methods
Method: build-texinfo-manual (SYSTEM-NAME string) &key SILENT

Build ASDF SYSTEM-NAME’s Texinfo manual. Return T on success.

Method: build-texinfo-manual (SYSTEM system) &key SILENT

Build Quicklisp SYSTEM’s Texinfo manual. Return T on success.

Method: build-texinfo-manual (RELEASE release) &key SILENT

Build Quicklisp RELEASE’s Texinfo manual. Return T on success.

Generic Function: library-name LIBRARY

Return LIBRARY’s name.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Methods
Method: library-name (SYSTEM-NAME string)

Return ASDF SYSTEM-NAME.

Method: library-name (SYSTEM system)

Return Quicklisp SYSTEM’s name.

Method: library-name (RELEASE release)

Return Quicklisp RELEASE’s primary system’s name.

Generic Function: trim OBJECT

Remove potential CL- prefix from OBJECT’s name.

Package

fr.epita.lrde.quickref

Source

util.lisp (file)

Methods
Method: trim (STRING string)

Remove potential CL- prefix from STRING.

Method: trim (SYSTEM system)

Remove potential CL- prefix from SYSTEM’s name.

Method: trim (RELEASE release)

Remove potential CL- prefix from RELEASE’s name.


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, fr.epita.lrde.quickref.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>asd file
File, Lisp, fr.epita.lrde.quickref.cmark.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark<dot>asd file
File, Lisp, fr.epita.lrde.quickref.cmark/cmark.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark/cmark<dot>lisp file
File, Lisp, fr.epita.lrde.quickref.core.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>core<dot>asd file
File, Lisp, fr.epita.lrde.quickref.core/meta.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/meta<dot>lisp file
File, Lisp, fr.epita.lrde.quickref.core/src/html.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/html<dot>lisp file
File, Lisp, fr.epita.lrde.quickref.core/src/quickref.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/quickref<dot>lisp file
File, Lisp, fr.epita.lrde.quickref.core/src/texinfo.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/texinfo<dot>lisp file
File, Lisp, fr.epita.lrde.quickref.core/src/util.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/util<dot>lisp file
File, Lisp, fr.epita.lrde.quickref.setup.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup<dot>asd file
File, Lisp, fr.epita.lrde.quickref.setup/setup.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup/setup<dot>lisp file
fr.epita.lrde.quickref.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>asd file
fr.epita.lrde.quickref.cmark.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark<dot>asd file
fr.epita.lrde.quickref.cmark/cmark.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark/cmark<dot>lisp file
fr.epita.lrde.quickref.core.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>core<dot>asd file
fr.epita.lrde.quickref.core/meta.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/meta<dot>lisp file
fr.epita.lrde.quickref.core/src: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src module
fr.epita.lrde.quickref.core/src/html.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/html<dot>lisp file
fr.epita.lrde.quickref.core/src/quickref.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/quickref<dot>lisp file
fr.epita.lrde.quickref.core/src/texinfo.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/texinfo<dot>lisp file
fr.epita.lrde.quickref.core/src/util.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/util<dot>lisp file
fr.epita.lrde.quickref.setup.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup<dot>asd file
fr.epita.lrde.quickref.setup/setup.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup/setup<dot>lisp file

L
Lisp File, fr.epita.lrde.quickref.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>asd file
Lisp File, fr.epita.lrde.quickref.cmark.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark<dot>asd file
Lisp File, fr.epita.lrde.quickref.cmark/cmark.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark/cmark<dot>lisp file
Lisp File, fr.epita.lrde.quickref.core.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>core<dot>asd file
Lisp File, fr.epita.lrde.quickref.core/meta.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/meta<dot>lisp file
Lisp File, fr.epita.lrde.quickref.core/src/html.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/html<dot>lisp file
Lisp File, fr.epita.lrde.quickref.core/src/quickref.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/quickref<dot>lisp file
Lisp File, fr.epita.lrde.quickref.core/src/texinfo.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/texinfo<dot>lisp file
Lisp File, fr.epita.lrde.quickref.core/src/util.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/util<dot>lisp file
Lisp File, fr.epita.lrde.quickref.setup.asd: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup<dot>asd file
Lisp File, fr.epita.lrde.quickref.setup/setup.lisp: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup/setup<dot>lisp file

M
Module, fr.epita.lrde.quickref.core/src: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src module

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   %   *   <  
B   C   D   E   F   G   H   I   L   M   N   P   Q   R   T   V  
Index Entry  Section

%
%version: Internal functions

*
*.*: Internal functions

<
<pre>: Internal functions

B
build: Exported functions
build-html-manual: Internal generic functions
build-html-manual: Internal generic functions
build-html-manual: Internal generic functions
build-html-manual: Internal generic functions
build-html-manuals-//: Internal functions
build-index-file: Internal functions
build-manual: Internal generic functions
build-manual: Internal generic functions
build-manual: Internal generic functions
build-manual: Internal generic functions
build-manuals: Internal functions
build-manuals-//: Internal functions
build-texinfo-manual: Internal generic functions
build-texinfo-manual: Internal generic functions
build-texinfo-manual: Internal generic functions
build-texinfo-manual: Internal generic functions
build-texinfo-manuals-//: Internal functions

C
cache-directory: Internal functions
cmark-markdown-to-html: Exported functions
column-lengths: Internal functions
configuration: Exported functions
configure: Exported functions
copy-style-sheets: Internal functions

D
declt: Internal functions
declt-log-file: Internal functions
declt-logs-directory: Internal functions

E
endpush: Internal macros
ensure-quickref-directory: Internal functions

F
file-contents: Internal functions
format-//: Internal macros
format-cell: Internal functions
Function, %version: Internal functions
Function, *.*: Internal functions
Function, <pre>: Internal functions
Function, build: Exported functions
Function, build-html-manuals-//: Internal functions
Function, build-index-file: Internal functions
Function, build-manuals: Internal functions
Function, build-manuals-//: Internal functions
Function, build-texinfo-manuals-//: Internal functions
Function, cache-directory: Internal functions
Function, cmark-markdown-to-html: Exported functions
Function, column-lengths: Internal functions
Function, configuration: Exported functions
Function, configure: Exported functions
Function, copy-style-sheets: Internal functions
Function, declt: Internal functions
Function, declt-log-file: Internal functions
Function, declt-logs-directory: Internal functions
Function, ensure-quickref-directory: Internal functions
Function, file-contents: Internal functions
Function, format-cell: Internal functions
Function, html-directory: Internal functions
Function, html-file: Internal functions
Function, index-character: Internal functions
Function, insert-readme-contents: Internal functions
Function, logs-directory: Internal functions
Function, makeinfo: Internal functions
Function, makeinfo-log-file: Internal functions
Function, makeinfo-logs-directory: Internal functions
Function, markdown-html: Internal functions
Function, nickname-package: Exported functions
Function, primary-system: Internal functions
Function, quicklisp-distribution: Internal functions
Function, readme-file: Internal functions
Function, readme-html: Internal functions
Function, release-status-number: Internal functions
Function, render-index-entry: Internal functions
Function, render-index-header: Internal functions
Function, renew-directory: Internal functions
Function, texinfo-directory: Internal functions
Function, texinfo-file: Internal functions
Function, version: Exported functions

G
Generic Function, build-html-manual: Internal generic functions
Generic Function, build-manual: Internal generic functions
Generic Function, build-texinfo-manual: Internal generic functions
Generic Function, library-name: Internal generic functions
Generic Function, trim: Internal generic functions

H
html-directory: Internal functions
html-file: Internal functions

I
index-character: Internal functions
insert-readme-contents: Internal functions

L
library-name: Internal generic functions
library-name: Internal generic functions
library-name: Internal generic functions
library-name: Internal generic functions
logs-directory: Internal functions

M
Macro, endpush: Internal macros
Macro, format-//: Internal macros
makeinfo: Internal functions
makeinfo-log-file: Internal functions
makeinfo-logs-directory: Internal functions
markdown-html: Internal functions
Method, build-html-manual: Internal generic functions
Method, build-html-manual: Internal generic functions
Method, build-html-manual: Internal generic functions
Method, build-manual: Internal generic functions
Method, build-manual: Internal generic functions
Method, build-manual: Internal generic functions
Method, build-texinfo-manual: Internal generic functions
Method, build-texinfo-manual: Internal generic functions
Method, build-texinfo-manual: Internal generic functions
Method, library-name: Internal generic functions
Method, library-name: Internal generic functions
Method, library-name: Internal generic functions
Method, trim: Internal generic functions
Method, trim: Internal generic functions
Method, trim: Internal generic functions

N
nickname-package: Exported functions

P
primary-system: Internal functions

Q
quicklisp-distribution: Internal functions

R
readme-file: Internal functions
readme-html: Internal functions
release-status-number: Internal functions
render-index-entry: Internal functions
render-index-header: Internal functions
renew-directory: Internal functions

T
texinfo-directory: Internal functions
texinfo-file: Internal functions
trim: Internal generic functions
trim: Internal generic functions
trim: Internal generic functions
trim: Internal generic functions

V
version: Exported functions

Jump to:   %   *   <  
B   C   D   E   F   G   H   I   L   M   N   P   Q   R   T   V  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*bin-directory*: Internal special variables
*caching-behavior*: Exported special variables
*configuration*: Internal special variables
*cross-reference-validation*: Internal special variables
*declt-script*: Internal special variables
*error-behavior*: Exported special variables
*libraries*: Exported special variables
*libraries-queue*: Internal special variables
*makeinfo-path*: Exported special variables
*other-systems-names*: Internal special variables
*output-directory*: Exported special variables
*parallel*: Exported special variables
*release-major-level*: Exported special variables
*release-minor-level*: Exported special variables
*release-name*: Exported special variables
*release-status*: Exported special variables
*release-status-level*: Exported special variables
*share-directory*: Internal special variables
*top-directory*: Internal special variables
*update*: Exported special variables

S
Special Variable, *bin-directory*: Internal special variables
Special Variable, *caching-behavior*: Exported special variables
Special Variable, *configuration*: Internal special variables
Special Variable, *cross-reference-validation*: Internal special variables
Special Variable, *declt-script*: Internal special variables
Special Variable, *error-behavior*: Exported special variables
Special Variable, *libraries*: Exported special variables
Special Variable, *libraries-queue*: Internal special variables
Special Variable, *makeinfo-path*: Exported special variables
Special Variable, *other-systems-names*: Internal special variables
Special Variable, *output-directory*: Exported special variables
Special Variable, *parallel*: Exported special variables
Special Variable, *release-major-level*: Exported special variables
Special Variable, *release-minor-level*: Exported special variables
Special Variable, *release-name*: Exported special variables
Special Variable, *release-status*: Exported special variables
Special Variable, *release-status-level*: Exported special variables
Special Variable, *share-directory*: Internal special variables
Special Variable, *top-directory*: Internal special variables
Special Variable, *update*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   F   P   S  
Index Entry  Section

F
fr.epita.lrde.quickref: The fr<dot>epita<dot>lrde<dot>quickref system
fr.epita.lrde.quickref: The fr<dot>epita<dot>lrde<dot>quickref package
fr.epita.lrde.quickref.cmark: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark system
fr.epita.lrde.quickref.cmark: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark package
fr.epita.lrde.quickref.core: The fr<dot>epita<dot>lrde<dot>quickref<dot>core system
fr.epita.lrde.quickref.setup: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup system
fr.epita.lrde.quickref.setup: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup package

P
Package, fr.epita.lrde.quickref: The fr<dot>epita<dot>lrde<dot>quickref package
Package, fr.epita.lrde.quickref.cmark: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark package
Package, fr.epita.lrde.quickref.setup: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup package

S
System, fr.epita.lrde.quickref: The fr<dot>epita<dot>lrde<dot>quickref system
System, fr.epita.lrde.quickref.cmark: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark system
System, fr.epita.lrde.quickref.core: The fr<dot>epita<dot>lrde<dot>quickref<dot>core system
System, fr.epita.lrde.quickref.setup: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup system

Jump to:   F   P   S