roswell.roswell/documents/html/ros-dump.html

50 lines
2.3 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="generator" content="pandoc">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>ros-dump(1)</title>
<style type="text/css">code{white-space: pre;}</style>
<link rel="stylesheet" href="ros.css">
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
<![endif]-->
</head>
<body>
<header>
<h1 class="title">ros-dump(1)</h1>
<ul>
<li class="author">Roswell Project Team</li>
</ul>
</header>
<p>ros-dump - make a dumped image of a roswell script</p>
<h1>Synopsis</h1>
<p><strong>ros [options] dump</strong> <em>type</em> args...</p>
<p>Where the types of subcommands are one of:</p>
<dl>
<dt>output</dt>
<dd><p>Create a dump image.</p>
</dd>
<dt>executable</dt>
<dd><p>Create an executable.</p>
</dd>
</dl>
<h1>Description</h1>
<p><code>ros-dump</code> creates a dumped lisp image of the state after processing all arguments passed.</p>
<p>Specifing <code>output</code> results in just an image which results in the same lisp state when loading the image. The image can be loaded by <code>ros -m IMAGE</code>. Standard roswell subcommands and additional arguments to the script are also available, for example <code>ros run</code> to resume with a repl, or <code>--restart FUNC</code> to call a specific function, leaving some flexibility.</p>
<p>In contrast, when a script is dumped with <code>executable</code>, the dumped image becomes an self-contained executable binary which implies <code>--restart main</code>.</p>
<p>In both cases, the global environment (e.g. global binding to a special variable such as <code>*package*</code>) is the environment which was effective when the script was dumped.</p>
<p>There might be a limitation regarding this feature depending on the lisp implementation roswell is configured to use at the time of building. Also, the dumped image is not compatible between the different implementations and even between the same implementations with different versions.</p>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1>SEE ALSO</h1>
<p><em>sbcl</em>(1) <em><a href="ros.html">ros</a></em>(1) <em><a href="ros-init.html">ros-init</a></em>(1) _</p>
</body>
</html>