The print-licenses Reference Manual

Table of Contents

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

The print-licenses Reference Manual

This is the print-licenses Reference Manual, version 0.1.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Jul 29 16:26:59 2019 GMT+0.


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

1 Introduction

Print licenses used by the given project and its dependencies

Install with Quicklisp:

(ql:quickload "print-licenses")

Note that in order to do this the project must be quickloaded, so you might want to do this in a separate Lisp image if you don't want to clutter your current one.

If the project does not specify its license in its ASDF system definition it will be listed as 'Unspecified'. You should manually figure out what license it uses (and maybe send a pull request).

Example:

  (print-licenses 'fast-io)
  =>
  alexandria           | Public Domain / 0-clause MIT
  babel                | MIT
  cffi                 | MIT
  cffi-grovel          | MIT
  cffi-toolchain       | MIT
  fast-io              | NewBSD
  static-vectors       | MIT
  trivial-features     | MIT
  trivial-gray-streams | MIT
  uiop                 | Unspecified

Credit

Code entirely taken from @sjl's utilities, the original snippet to build the license tree coming from a @dk_jackdaniel's snippet.

MIT.


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

2 Systems

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


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

2.1 print-licenses

Author

vindarel

License

MIT

Description

Print the licenses used by the given project and its dependencies.

Version

0.1.0

Dependencies
Source

print-licenses.asd (file)

Component

print-licenses.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 print-licenses.asd

Location

print-licenses.asd

Systems

print-licenses (system)

Packages

print-licenses-asd


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

3.1.2 print-licenses/print-licenses.lisp

Parent

print-licenses (system)

Location

print-licenses.lisp

Packages

print-licenses

Exported Definitions

print-licenses (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 print-licenses-asd

Source

print-licenses.asd

Use List

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

4.2 print-licenses

Source

print-licenses.lisp (file)

Use List
Exported Definitions

print-licenses (function)

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


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

5.1.1 Functions

Function: print-licenses QUICKLISP-PROJECT-DESIGNATOR

Print the licenses used by the given project and its dependencies.
Note that in order to do this the project must be ‘quickload‘ed, so you might want to do this in a separate Lisp image if you don’t want to clutter your current one.
If the project does not specify its license in its ASDF system definition it will be listed as ’Unspecified’. You should manually figure out what license it uses (and maybe send a pull request).
Example:
(print-licenses ’fast-io)
=>
alexandria | Public Domain / 0-clause MIT
babel | MIT
cffi | MIT
cffi-grovel | MIT
cffi-toolchain | MIT
fast-io | NewBSD
static-vectors | MIT
trivial-features | MIT
trivial-gray-streams | MIT
uiop | Unspecified

Package

print-licenses

Source

print-licenses.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Macros

Macro: shut-up &body BODY

Run ‘body‘ with stdout and stderr redirected to the void.

Package

print-licenses

Source

print-licenses.lisp (file)


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

5.2.2 Functions

Function: aesthetic-string THING

Return the string used to represent ‘thing‘ when printing aesthetically.

Package

print-licenses

Source

print-licenses.lisp (file)

Function: license-list QUICKLISP-PROJECT-DESIGNATOR
Package

print-licenses

Source

print-licenses.lisp (file)

Function: license-tree QUICKLISP-PROJECT-DESIGNATOR
Package

print-licenses

Source

print-licenses.lisp (file)

Function: map-tree FUNCTION TREE

Map ‘function‘ to each of the leave of ‘tree‘.

Package

print-licenses

Source

print-licenses.lisp (file)

Function: print-table ROWS

Print ‘rows‘ as a nicely-formatted table.
Each row should have the same number of colums.
Columns will be justified properly to fit the longest item in each one. Example:
(print-table ’((1 :red something)
(2 :green more)))
=>
1 | RED | SOMETHING
2 | GREEN | MORE

Package

print-licenses

Source

print-licenses.lisp (file)

Function: weave &rest LISTS

Return a list whose elements alternate between each of the lists ‘lists‘. Weaving stops when any of the lists has been exhausted.

Package

print-licenses

Source

print-licenses.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, print-licenses.asd: The print-licenses<dot>asd file
File, Lisp, print-licenses/print-licenses.lisp: The print-licenses/print-licenses<dot>lisp file

L
Lisp File, print-licenses.asd: The print-licenses<dot>asd file
Lisp File, print-licenses/print-licenses.lisp: The print-licenses/print-licenses<dot>lisp file

P
print-licenses.asd: The print-licenses<dot>asd file
print-licenses/print-licenses.lisp: The print-licenses/print-licenses<dot>lisp file

Jump to:   F   L   P  

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

A.2 Functions

Jump to:   A   F   L   M   P   S   W  
Index Entry  Section

A
aesthetic-string: Internal functions

F
Function, aesthetic-string: Internal functions
Function, license-list: Internal functions
Function, license-tree: Internal functions
Function, map-tree: Internal functions
Function, print-licenses: Exported functions
Function, print-table: Internal functions
Function, weave: Internal functions

L
license-list: Internal functions
license-tree: Internal functions

M
Macro, shut-up: Internal macros
map-tree: Internal functions

P
print-licenses: Exported functions
print-table: Internal functions

S
shut-up: Internal macros

W
weave: Internal functions

Jump to:   A   F   L   M   P   S   W  

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

A.3 Variables


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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, print-licenses: The print-licenses package
Package, print-licenses-asd: The print-licenses-asd package
print-licenses: The print-licenses system
print-licenses: The print-licenses package
print-licenses-asd: The print-licenses-asd package

S
System, print-licenses: The print-licenses system

Jump to:   P   S