Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
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.
| • Introduction: | What fr.epita.lrde.quickref is all about | |
| • Systems: | The systems documentation | |
| • Modules: | The modules documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
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.
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.
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).
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/.
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.
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:
Buildenv creates a Debian 9 image with all the dependencies needed to
buid the various Quicklisp libraries inside.Quickref builds on top of the Buildenv image to set up a quickref
user, pull the latest versions of Quickref and Declt, and finally launch
Quickref.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).
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: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The fr.epita.lrde.quickref system: | ||
| • The fr.epita.lrde.quickref.core system: | ||
| • The fr.epita.lrde.quickref.cmark system: | ||
| • The fr.epita.lrde.quickref.setup system: |
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>core system, Previous: Systems, Up: Systems [Contents][Index]
Antoine Martin
Didier Verna
Antoine Martin
BSD
Reference Manuals for Quicklisp Libraries
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
1.0
fr.epita.lrde.quickref.asd (file)
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark system, Previous: The fr<dot>epita<dot>lrde<dot>quickref system, Up: Systems [Contents][Index]
Quickref Core
Antoine Martin
Didier Verna
Antoine Martin
BSD
Quickref’s core library
Quickref’s core library provides the core functionality of Quickref. For a more complete description of Quickref, see the fr.epita.lrde.quickref system.
1.0
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup system, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>core system, Up: Systems [Contents][Index]
CommonMark Foreign Function Interface
Antoine Martin
Didier Verna
Antoine Martin
BSD
Bindings to libcmark
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/
1.0
cmark.lisp (file)
Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark system, Up: Systems [Contents][Index]
Quickref Setup
Antoine Martin
Didier Verna
Didier Verna
BSD
Quickref’s setup library
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.
setup.lisp (file)
Modules are listed depth-first from the system components tree.
| • The fr.epita.lrde.quickref.core/src module: |
meta.lisp (file)
fr.epita.lrde.quickref.core (system)
core/src/
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>core<dot>asd file, Previous: Lisp files, Up: Lisp files [Contents][Index]
fr.epita.lrde.quickref.asd
fr.epita.lrde.quickref (system)
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark<dot>asd file, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>asd file, Up: Lisp files [Contents][Index]
core/fr.epita.lrde.quickref.core.asd
fr.epita.lrde.quickref.core (system)
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup<dot>asd file, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>core<dot>asd file, Up: Lisp files [Contents][Index]
cmark/fr.epita.lrde.quickref.cmark.asd
fr.epita.lrde.quickref.cmark (system)
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/meta<dot>lisp file, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark<dot>asd file, Up: Lisp files [Contents][Index]
setup/fr.epita.lrde.quickref.setup.asd
fr.epita.lrde.quickref.setup (system)
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/util<dot>lisp file, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup<dot>asd file, Up: Lisp files [Contents][Index]
fr.epita.lrde.quickref.core (system)
core/meta.lisp
nickname-package (function)
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/texinfo<dot>lisp file, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/meta<dot>lisp file, Up: Lisp files [Contents][Index]
src (module)
core/src/util.lisp
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/html<dot>lisp file, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/util<dot>lisp file, Up: Lisp files [Contents][Index]
util.lisp (file)
src (module)
core/src/texinfo.lisp
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/quickref<dot>lisp file, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/texinfo<dot>lisp file, Up: Lisp files [Contents][Index]
util.lisp (file)
src (module)
core/src/html.lisp
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark/cmark<dot>lisp file, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/html<dot>lisp file, Up: Lisp files [Contents][Index]
src (module)
core/src/quickref.lisp
build (function)
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup/setup<dot>lisp file, Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>core/src/quickref<dot>lisp file, Up: Lisp files [Contents][Index]
fr.epita.lrde.quickref.cmark (system)
cmark/cmark.lisp
cmark-markdown-to-html (function)
Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark/cmark<dot>lisp file, Up: Lisp files [Contents][Index]
fr.epita.lrde.quickref.setup (system)
setup/setup.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The fr.epita.lrde.quickref package: | ||
| • The fr.epita.lrde.quickref.cmark package: | ||
| • The fr.epita.lrde.quickref.setup package: |
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark package, Previous: Packages, Up: Packages [Contents][Index]
The Quickref package.
meta.lisp (file)
Next: The fr<dot>epita<dot>lrde<dot>quickref<dot>setup package, Previous: The fr<dot>epita<dot>lrde<dot>quickref package, Up: Packages [Contents][Index]
The Quickref/CMark package.
cmark.lisp (file)
common-lisp
cmark-markdown-to-html (function)
Previous: The fr<dot>epita<dot>lrde<dot>quickref<dot>cmark package, Up: Packages [Contents][Index]
The Quickref setup package.
setup.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported special variables: | ||
| • Exported functions: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
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.
util.lisp (file)
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.
util.lisp (file)
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.
util.lisp (file)
Path to the ’makeinfo’ executable.
util.lisp (file)
Quickref’s output directory (~/quickref/ by default).
util.lisp (file)
Whether to parallelize the build process (NIL by default).
util.lisp (file)
The major level of this release.
setup.lisp (file)
The minor level of this release.
setup.lisp (file)
The name of this release.
The general naming theme for Quickref is "Songs from Iron Maiden".
setup.lisp (file)
The status of this release.
setup.lisp (file)
The status level of this release.
setup.lisp (file)
Whether to update Quicklisp before processing (T by default).
util.lisp (file)
Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Build the Quickref website.
All keywords to this function are defaulted to their corresponding global
parameter, which see.
quickref.lisp (file)
cmark.lisp (file)
Return KEY’s value in the current Quickref configuration.
setup.lisp (file)
Set KEY to VALUE in the current Quickref configuration.
setup.lisp (file)
Add NICKNAME (:QUICKREF by default) to the :FR.EPITA.LRDE.QUICKREF package.
meta.lisp (file)
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.
setup.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables: | ||
| • Internal macros: | ||
| • Internal functions: | ||
| • Internal generic functions: |
Next: Internal macros, Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Quickref’s bin sub-directory.
util.lisp (file)
The Quickref configuration settings.
This variable contains a property list of configuration options.
Current options are:
- :swank-eval-in-emacs (Boolean)
setup.lisp (file)
Whether to validate cross references (NIL by default).
Validation will help catch Declt bugs, but also prevent otherwise usable
manuals from being generated.
util.lisp (file)
Quickref’s Declt script.
texinfo.lisp (file)
texinfo.lisp (file)
Non-Quicklisp systems that need to be documented.
quickref.lisp (file)
Quickref’s share sub-directory.
util.lisp (file)
Quickref’s top directory.
util.lisp (file)
Next: Internal functions, Previous: Internal special variables, Up: Internal definitions [Contents][Index]
Like PUSH, but at the end.
util.lisp (file)
Like FORMAT, but block until all output is flushed.
util.lisp (file)
Next: Internal generic functions, Previous: Internal macros, Up: Internal definitions [Contents][Index]
setup.lisp (file)
Return a list of all pathnames matching *.* in DIRECTORY.
util.lisp (file)
Return STRING as html PRE.
html.lisp (file)
Build HTML manuals, parallel version.
Return the number of HTML files successfully built.
html.lisp (file)
Build Quickref’s index.html file.
html.lisp (file)
Build LIBRARIES reference manuals.
quickref.lisp (file)
Build LIBRARIES reference manuals. This is the parallel version.
quickref.lisp (file)
Build LIBRARIES Texinfo manuals, parallel version. Return the number of Texinfo files successfully built.
texinfo.lisp (file)
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.
util.lisp (file)
Spread NUMBER of entries in 3 different columns as uniformly as possible. Return the column lengths as 3 values.
html.lisp (file)
Copy Quickref’s style sheets to the HTML output directory.
html.lisp (file)
Run Declt on ASDF SYSTEM-NAME. Return T on success.
texinfo.lisp (file)
Return Quickref’s Declt log file for ASDF SYSTEM-NAME.
util.lisp (file)
Return quickref’s Declt logs directory.
util.lisp (file)
Make sure we have fresh DECLT and/or MAKEINFO directories.
This function handles the cache, log and output directories at the same time.
util.lisp (file)
Attempt to safely read FILE into a string and return it. Safely means try to detect a proper encoding.
util.lisp (file)
Format an HTML TD linking to MANUAL-NAME’s HTML file.
html.lisp (file)
Return Quickref’s generated HTML files directory.
util.lisp (file)
Return ASDF SYSTEM-NAME’s HTML file.
util.lisp (file)
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.
html.lisp (file)
Insert the contents of README-FILE into HTML-FILE.
README contents is rendered in HTML and inserted as introduction.
html.lisp (file)
Return Quickref’s logs directory.
util.lisp (file)
Run Makeinfo on ASDF SYSTEM-NAME. Return T on success.
html.lisp (file)
Return Quickref’s Makeinfo log file for ASDF SYSTEM-NAME.
util.lisp (file)
Return quickref’s Makeinfo logs directory.
util.lisp (file)
Return Markdown STRING formatted as HTML.
Try our CommonMark FFI first, fall back to 3BMD otherwise.
html.lisp (file)
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.
util.lisp (file)
Return a Quicklisp distribution object for the "quicklisp" distribution.
util.lisp (file)
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).
util.lisp (file)
Return contents of README file formatted as HTML.
html.lisp (file)
setup.lisp (file)
Render index file’s first NUMBER MANUAL-NAMES entries under CHARACTER.
html.lisp (file)
Render index file’s header to standard output. The header also advertise MANUALS-NUMBER.
html.lisp (file)
Either create DIRECTORY, or remove everything from it.
util.lisp (file)
Return Quickref’s generated Texinfo files directory.
util.lisp (file)
Return ASDF SYSTEM-NAME’s Texinfo file.
util.lisp (file)
Previous: Internal functions, Up: Internal definitions [Contents][Index]
Build LIBRARY’s HTML manual. Return T on success.
html.lisp (file)
Build ASDF SYSTEM-NAME’s HTML manual. Return T on success.
Build Quicklisp SYSTEM’s HTML manual. Return T on success.
Build Quicklisp RELEASE’s HTML manual. Return T on success.
Build LIBRARY’s reference manual.
Return :html, :texi or NIL, indicating how far the process went.
quickref.lisp (file)
Build ASDF SYSTEM-NAME’s reference manual.
Return :html, :texi or NIL, indicating how far the process went.
Build Quicklisp SYSTEM’s reference manual.
Return :html, :texi or NIL, indicating how far the process went.
Build Quicklisp RELEASE’s reference manual.
Return :html, :texi or NIL, indicating how far the process went.
Build LIBRARY’s Texinfo manual. Return T on success.
texinfo.lisp (file)
Build ASDF SYSTEM-NAME’s Texinfo manual. Return T on success.
Build Quicklisp SYSTEM’s Texinfo manual. Return T on success.
Build Quicklisp RELEASE’s Texinfo manual. Return T on success.
Return LIBRARY’s name.
util.lisp (file)
Return ASDF SYSTEM-NAME.
Return Quicklisp SYSTEM’s name.
Return Quicklisp RELEASE’s primary system’s name.
Remove potential CL- prefix from OBJECT’s name.
util.lisp (file)
Remove potential CL- prefix from STRING.
Remove potential CL- prefix from SYSTEM’s name.
Remove potential CL- prefix from RELEASE’s name.
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L M |
|---|
| Jump to: | F L M |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | %
*
<
B C D E F G H I L M N P Q R T V |
|---|
| Jump to: | %
*
<
B C D E F G H I L M N P Q R T V |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | F P S |
|---|
| Jump to: | F P S |
|---|