The trivial-build Reference Manual

Table of Contents

The trivial-build Reference Manual

This is the trivial-build Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 18:03:49 2021 GMT+0.

1 Introduction

trivial-build

Compile a system into an executable.

Overview

trivial-build launches a new process of whichever implementation you're running, loads a system, sets up an entrypoint, and dumps the executable. The Lisp subprocess then dies, much like those deep-sea squids that die giving birth.

Usage

CL-USER> (build :system-name
                "(code-to-execute-on-startup)"
                #p"path/to/output.exe")

Example:

CL-USER> (trivial-build:build :uiop
                              "(format t \"~A~%\" 1)"
                              #p"/home/eudoxia/binary")
Launch: "/usr/local/bin/sbcl"  --eval "(ql:quickload :UIOP)" --eval "(setf uiop:*image-entry-point* #'(lambda () (format t \"~A~%\" 1)))" --eval "(uiop:dump-image #P\"/home/eudoxia/binary\" :executable t
  #+sb-core-compression :compression #+sb-core-compression t)"

This is SBCL 1.2.9, an implementation of ANSI Common Lisp.
More information about SBCL is available at <http://www.sbcl.org/>.

SBCL is free software, provided as is, with absolutely no warranty.
It is mostly in the public domain; some portions are provided under
BSD-style licenses.  See the CREDITS and COPYING files in the
distribution for more information.
To load "uiop":
  Load 1 ASDF system:
    uiop
; Loading "uiop"

[undoing binding stack and other enclosing state... done]
[saving current Lisp image into /home/eudoxia/binary:
writing 5824 bytes from the read-only space at 0x20000000
writing 3168 bytes from the static space at 0x20100000
writing 56950784 bytes from the dynamic space at 0x1000000000
done]
#P"/home/eudoxia/binary"

And the output:

$[ eudoxia@laptop ] ~
$> ./binary
1
$[ eudoxia@laptop ] ~
$>

License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.

2 Systems

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

2.1 trivial-build

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

Source Control

(:git "")

Bug Tracker

License

MIT

Description

Compile a system into an executable.

Long Description

# trivial-build

[](https://travis-ci.org/ceramic/trivial-build)
[](https://coveralls.io/github/ceramic/trivial-build?branch=master)

Compile a system into an executable.

# Overview

trivial-build launches a new process of whichever implementation you’re running,
loads a system, sets up an entrypoint, and dumps the executable. The Lisp
subprocess then dies, much like those deep-sea squids that die giving birth.

# Usage

“‘lisp
CL-USER> (build :system-name
"(code-to-execute-on-startup)"
#p"path/to/output.exe")
“‘

Example:

“‘lisp
CL-USER> (trivial-build:build :uiop
"(format t \"~A~%\" 1)"
#p"/home/eudoxia/binary")
Launch: "/usr/local/bin/sbcl" –eval "(ql:quickload :UIOP)" –eval "(setf uiop:*image-entry-point* #’(lambda () (format t \"~A~%\" 1)))" –eval "(uiop:dump-image #P\"/home/eudoxia/binary\" :executable t #+sb-core-compression :compression #+sb-core-compression t)"

This is SBCL 1.2.9, an implementation of ANSI Common Lisp.
More information about SBCL is available at <http://www.sbcl.org/>.

SBCL is free software, provided as is, with absolutely no warranty.
It is mostly in the public domain; some portions are provided under
BSD-style licenses. See the CREDITS and COPYING files in the
distribution for more information.
To load "uiop":
Load 1 ASDF system:
uiop
; Loading "uiop"

[undoing binding stack and other enclosing state... done]
[saving current Lisp image into /home/eudoxia/binary:
writing 5824 bytes from the read-only space at 0x20000000
writing 3168 bytes from the static space at 0x20100000
writing 56950784 bytes from the dynamic space at 0x1000000000
done]
#P"/home/eudoxia/binary"
“‘

And the output:

“‘
$[ eudoxia@laptop ] ~
$> ./binary
1
$[ eudoxia@laptop ] ~
$>
“‘

# License

Copyright (c) 2015 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies

• trivial-exe
• lisp-invocation

Source

trivial-build.asd (file)

Component

src (module)

3 Modules

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

3.1 trivial-build/src

Parent

trivial-build (system)

Location

src/

Component

trivial-build.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 trivial-build.asd

Location

trivial-build.asd

Systems

trivial-build (system)

4.1.2 trivial-build/src/trivial-build.lisp

Parent

src (module)

Location

src/trivial-build.lisp

Packages

trivial-build

Exported Definitions

build (function)

Internal Definitions

• boot-and-build (function)
• code-list-to-eval (function)
• load-and-build-code (function)
• roswellp (function)

5 Packages

Packages are listed by definition order.

5.1 trivial-build

Source

trivial-build.lisp (file)

Use List

common-lisp

Exported Definitions

build (function)

Internal Definitions

• boot-and-build (function)
• code-list-to-eval (function)
• load-and-build-code (function)
• roswellp (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Functions

Function: build SYSTEM-NAME ENTRY-POINT BINARY-PATHNAME

Build the system.

Package

trivial-build

Source

trivial-build.lisp (file)

6.2 Internal definitions

6.2.1 Functions

Function: boot-and-build SYSTEM-NAME ENTRY-POINT BINARY-PATHNAME IMPL-PATH IMPL-FLAGS LOAD-FLAG EVAL-FLAG

Package

trivial-build

Source

trivial-build.lisp (file)

Function: code-list-to-eval EVAL-FLAG LIST

Package

trivial-build

Source

trivial-build.lisp (file)

Function: load-and-build-code SYSTEM-NAME ENTRY-POINT BINARY-PATHNAME

Return a list of code strings to eval.

Package

trivial-build

Source

trivial-build.lisp (file)

Function: roswellp ()

Are we in a Roswell implementation?

Package

trivial-build

Source

trivial-build.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types