The cl-info Reference Manual

Table of Contents

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

The cl-info Reference Manual

This is the cl-info Reference Manual, version 0.4.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Oct 13 09:44:28 2021 GMT+0.


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

1 Introduction

CL-INFO - Common Lisp Environment Reporter

Table of Contents

[in package CL-INFO with nicknames CL-INFO/CORE]

This is a small utility, useful to display information about you Common Lisp environment. You might want to call it in the CI pipeline or to use it when rendering a crash report in some client applications.

Usage from Common Lisp

It's main entry point is CL-INFO:GET-CL-INFO function. It returns an object with customized PRINT-OBJECT method. You can use it to output debug information in your programs.

CL-INFO collects inforrmation about OS, Lisp Implementation, ASDF, installed Quicklisp distributions:

CL-USER> (cl-info:get-cl-info)
OS:   Darwin 15.6.0
Lisp: SBCL 1.4.8
ASDF: 3.3.1.1
QL:   ceramic github-e0d905187946f8f2358f7b05e1ce87b302e34312
      cl-prevalence github-c163c227ed85d430b82cb1e3502f72d4f88e3cfa
      log4cl-json github-c4f786e252d89a45372186aaf32fb8e8736b444b
      log4cl github-6a857b0b41c030a8a3b04096205e221baaa1755f
      quicklisp 2018-04-30
      slynk github-3314cf8c3021cb758e0e30fe3ece54accf1dcf3d
      weblocks-lass github-1b043afbf2f3e84e495dfeae5e63fe67a435019f
      weblocks-parenscript github-8ef4ca2f837403a05c4e9b92dcf1c41771d16f17
      weblocks-ui github-5afdf238534d70edc2447d0bc8bc63da8e35999f
      weblocks-websocket github-b098db7f179dce3bfb045afd4e35e7cc868893f0
      weblocks github-282483f97d6ca351265ebfebb017867c295d01ad
      websocket-driver github-a3046b11dfb9803ac3bff7734dd017390c2b54bb
CL-USER>

Also, you can gather information about separate systems using CL-INFO:GET-SYSTEM-INFO function:

CL-USER> (cl-info:get-system-info :hamcrest)
System: HAMCREST 0.4.2
       /Users/art/common-lisp/cl-hamcrest/src/

Usage From Command-line

Also, you can use CL-INFO as a command-line utility. It is useful to output information about common lisp environment running on CI server.

Here is how to do it:

# Here we use a Roswell, to install utility
[art@art-osx:~]% ros install 40ants/cl-info
   
# And now request information about lisp and some systems
[art@art-osx:~]% cl-info weblocks clack jonathan some-other-system
OS:   Darwin 15.6.0
Lisp: Clozure Common Lisp Version 1.11.5/v1.11.5  (DarwinX8664)
ASDF: 3.3.1.1
QL:   org.borodust.bodge 20180214223017
      quicklisp 2017-10-23
System: weblocks 0.31.1
        /Users/art/common-lisp/weblocks/src/
System: clack 2.0.0
        /Users/art/common-lisp/clack/
System: jonathan 0.1
        /Users/art/.roswell/lisp/quicklisp/dists/quicklisp/software/jonathan-20170630-git/
System: some-other-system is not available

API Reference


[generated by 40ANTS-DOC]

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 cl-info

Author

Alexander Artemenko

Home Page

https://40ants.com/cl-info

Source Control

(:git "https://github.com/40ants/cl-info")

Bug Tracker

https://github.com/40ants/cl-info/issues

License

BSD

Description

A helper to an answer a question about OS, Lisp and Everything.

Version

0.4.0

Dependency

cl-info/core (system)

Source

cl-info.asd (file)


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

2.2 cl-info/core

Author

Alexander Artemenko

Home Page

https://40ants.com/cl-info

Source Control

(:git "https://github.com/40ants/cl-info")

Bug Tracker

https://github.com/40ants/cl-info/issues

License

BSD

Dependency

40ants-doc

Source

cl-info.asd (file)

Component

file-type.lisp (file)


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

3 Files

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


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

3.1 Lisp


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

3.1.1 cl-info.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/cl-info-20210531-git/cl-info.asd

Systems

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

3.1.2 cl-info/core/file-type.lisp

Parent

cl-info/core (system)

Location

core.lisp

Packages

cl-info

Exported Definitions
Internal Definitions

get-ql-dists (method)


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

4 Packages

Packages are listed by definition order.


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

4.1 cl-info

Source

file-type.lisp (file)

Nickname

cl-info/core

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: @index
Package

cl-info

Source

file-type.lisp (file)


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

5.1.2 Functions

Function: get-cl-info ()

Returns information about lisp implementation, asdf and quicklisp.

Package

cl-info

Source

file-type.lisp (file)

Function: get-system-info SYSTEM-NAME
Package

cl-info

Source

file-type.lisp (file)


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

5.1.3 Generic functions

Generic Function: absent-p OBJECT
Package

cl-info

Methods
Method: absent-p (SYSTEM-INFO system-info)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-asdf-version OBJECT
Package

cl-info

Methods
Method: get-asdf-version (CL-INFO cl-info)

Returns ASDF version.

Source

file-type.lisp (file)

Generic Function: get-lisp-type OBJECT
Package

cl-info

Methods
Method: get-lisp-type (CL-INFO cl-info)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-lisp-version OBJECT
Package

cl-info

Methods
Method: get-lisp-version (CL-INFO cl-info)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-name OBJECT
Package

cl-info

Methods
Method: get-name (SYSTEM-INFO system-info)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-path OBJECT
Package

cl-info

Methods
Method: get-path (SYSTEM-INFO system-info)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-software-type OBJECT
Package

cl-info

Methods
Method: get-software-type (CL-INFO cl-info)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-software-version OBJECT
Package

cl-info

Methods
Method: get-software-version (CL-INFO cl-info)

automatically generated reader method

Source

file-type.lisp (file)

Generic Function: get-version OBJECT
Package

cl-info

Methods
Method: get-version (SYSTEM-INFO system-info)

automatically generated reader method

Source

file-type.lisp (file)


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

5.1.4 Classes

Class: cl-info ()
Package

cl-info

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: asdf-version

Returns ASDF version.

Initform

(asdf/upgrade:asdf-version)

Readers

get-asdf-version (generic function)

Slot: lisp-type
Initform

(lisp-implementation-type)

Readers

get-lisp-type (generic function)

Slot: lisp-version
Initform

(lisp-implementation-version)

Readers

get-lisp-version (generic function)

Slot: software-type
Initform

(software-type)

Readers

get-software-type (generic function)

Slot: software-version
Initform

(software-version)

Readers

get-software-version (generic function)

Slot: ql-dists
Initform

(ql-dist:all-dists)

Readers

get-ql-dists (generic function)

Class: system-info ()
Package

cl-info

Source

file-type.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

get-name (generic function)

Slot: version
Initargs

:version

Readers

get-version (generic function)

Slot: path
Initargs

:path

Readers

get-path (generic function)

Slot: absent
Initargs

:absent

Readers

absent-p (generic function)


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

5.2 Internal definitions


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

5.2.1 Generic functions

Generic Function: get-ql-dists OBJECT
Package

cl-info

Methods
Method: get-ql-dists (CL-INFO cl-info)

automatically generated reader method

Source

file-type.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-info.asd: The cl-info․asd file
cl-info/core/file-type.lisp: The cl-info/core/file-type․lisp file

F
File, Lisp, cl-info.asd: The cl-info․asd file
File, Lisp, cl-info/core/file-type.lisp: The cl-info/core/file-type․lisp file

L
Lisp File, cl-info.asd: The cl-info․asd file
Lisp File, cl-info/core/file-type.lisp: The cl-info/core/file-type․lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   A   F   G   M  
Index Entry  Section

A
absent-p: Exported generic functions
absent-p: Exported generic functions

F
Function, get-cl-info: Exported functions
Function, get-system-info: Exported functions

G
Generic Function, absent-p: Exported generic functions
Generic Function, get-asdf-version: Exported generic functions
Generic Function, get-lisp-type: Exported generic functions
Generic Function, get-lisp-version: Exported generic functions
Generic Function, get-name: Exported generic functions
Generic Function, get-path: Exported generic functions
Generic Function, get-ql-dists: Internal generic functions
Generic Function, get-software-type: Exported generic functions
Generic Function, get-software-version: Exported generic functions
Generic Function, get-version: Exported generic functions
get-asdf-version: Exported generic functions
get-asdf-version: Exported generic functions
get-cl-info: Exported functions
get-lisp-type: Exported generic functions
get-lisp-type: Exported generic functions
get-lisp-version: Exported generic functions
get-lisp-version: Exported generic functions
get-name: Exported generic functions
get-name: Exported generic functions
get-path: Exported generic functions
get-path: Exported generic functions
get-ql-dists: Internal generic functions
get-ql-dists: Internal generic functions
get-software-type: Exported generic functions
get-software-type: Exported generic functions
get-software-version: Exported generic functions
get-software-version: Exported generic functions
get-system-info: Exported functions
get-version: Exported generic functions
get-version: Exported generic functions

M
Method, absent-p: Exported generic functions
Method, get-asdf-version: Exported generic functions
Method, get-lisp-type: Exported generic functions
Method, get-lisp-version: Exported generic functions
Method, get-name: Exported generic functions
Method, get-path: Exported generic functions
Method, get-ql-dists: Internal generic functions
Method, get-software-type: Exported generic functions
Method, get-software-version: Exported generic functions
Method, get-version: Exported generic functions

Jump to:   A   F   G   M  

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

A.3 Variables

Jump to:   @  
A   L   N   P   Q   S   V  
Index Entry  Section

@
@index: Exported special variables

A
absent: Exported classes
asdf-version: Exported classes

L
lisp-type: Exported classes
lisp-version: Exported classes

N
name: Exported classes

P
path: Exported classes

Q
ql-dists: Exported classes

S
Slot, absent: Exported classes
Slot, asdf-version: Exported classes
Slot, lisp-type: Exported classes
Slot, lisp-version: Exported classes
Slot, name: Exported classes
Slot, path: Exported classes
Slot, ql-dists: Exported classes
Slot, software-type: Exported classes
Slot, software-version: Exported classes
Slot, version: Exported classes
software-type: Exported classes
software-version: Exported classes
Special Variable, @index: Exported special variables

V
version: Exported classes

Jump to:   @  
A   L   N   P   Q   S   V  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-info: The cl-info system
cl-info: The cl-info package
cl-info: Exported classes
cl-info/core: The cl-info/core system
Class, cl-info: Exported classes
Class, system-info: Exported classes

P
Package, cl-info: The cl-info package

S
System, cl-info: The cl-info system
System, cl-info/core: The cl-info/core system
system-info: Exported classes

Jump to:   C   P   S