The trivial-dump-core Reference Manual

This is the trivial-dump-core Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:32:19 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 trivial-dump-core

trivial-dump-core: Wrapper that allows the saving of the current lisp image as a "core" or as an "executable" across implementations.

Author

Rolando Pereira <>

License

MIT License

Source

trivial-dump-core.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 trivial-dump-core/trivial-dump-core.asd

Source

trivial-dump-core.asd.

Parent Component

trivial-dump-core (system).

ASDF Systems

trivial-dump-core.


3.1.2 trivial-dump-core/package.lisp

Source

trivial-dump-core.asd.

Parent Component

trivial-dump-core (system).

Packages

trivial-dump-core.


3.1.3 trivial-dump-core/trivial-dump-core.lisp

Dependency

package.lisp (file).

Source

trivial-dump-core.asd.

Parent Component

trivial-dump-core (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 trivial-dump-core

Source

package.lisp.

Nicknames
  • tdumpc
  • trivdumpcore
Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: save-executable (filename init-function)

Make a stand-alone executable file from the current Lisp process.

FILENAME: Path of the executable file

INIT-FUNCTION: Zero-argument function object that acts as the entry point to your executable (the equivalent of main() in C).

Some implementations (Clozure, SBCL) will quit after this function is called.

Package

trivial-dump-core.

Source

trivial-dump-core.lisp.


5.1.2 Ordinary functions

Function: dump-image (filename)

Dump the current state of the Lisp process to an image file.

Package

trivial-dump-core.

Source

trivial-dump-core.lisp.

Function: dump-image-init (filename init-function)

Dump the current state of the Lisp process to an image file, with an init function.

Package

trivial-dump-core.

Source

trivial-dump-core.lisp.


5.2 Internals


5.2.1 Macros

Macro: %save-executable-sbcl (filename init-function)
Package

trivial-dump-core.

Source

trivial-dump-core.lisp.

Macro: print-save-slime-and-die-help (filename init-function)

Print on the screen the command the user needs to run on the *inferior-lisp* buffer to save this image. This macro is only called when trying to save a sbcl lisp image inside slime.

Package

trivial-dump-core.

Source

trivial-dump-core.lisp.


5.2.2 Ordinary functions

Function: is-slime-running ()

Return T if slime is running in the lisp image, otherwise return NIL.

Package

trivial-dump-core.

Source

trivial-dump-core.lisp.

Function: print-dump-image-slime-help (filename)

Print on the screen the command the user needs to run on the *inferior-lisp* buffer to dump this image. This macro is only called when trying to dump a sbcl lisp image inside slime.

Package

trivial-dump-core.

Source

trivial-dump-core.lisp.

Function: sbcl-dump-image-slime (filename)

Save a sbcl image, even when running from inside Slime.

This function should only be used in the *inferior-buffer* buffer, inside emacs.

Package

trivial-dump-core.

Source

trivial-dump-core.lisp.

Function: sbcl-save-slime-and-die (filename init-function)

Save a sbcl image, even when running from inside Slime.

This function should only be used in the *inferior-buffer* buffer, inside emacs.

Package

trivial-dump-core.

Source

trivial-dump-core.lisp.

Function: string-to-symbol (string)

Convert a string to a symbol

Package

trivial-dump-core.

Source

trivial-dump-core.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables