common-lisp/roswell.roswell
1
0
Fork 0
mirror of https://github.com/roswell/roswell.git synced 2026-09-10 07:16:17 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

[ci skip] documents update

Browse source
This commit is contained in:
github actions 2022-02-20 06:14:59 +00:00
parent 22a9e923ed
commit 1c8e46de17
37 changed files with 444 additions and 613 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
documents/html/ros-build.html
View file

@ -18,7 +18,7 @@
<li class="author">Roswell Project Team</li> <li class="author">Roswell Project Team</li>
</ul> </ul>
</header> </header>
<p>ros-build - Shortcut to &quot;ros dump executable&quot; # synopsis</p> <p>ros-build - Shortcut to “ros dump executable” # synopsis</p>
<p><strong>ros [options] build</strong> <file></p> <p><strong>ros [options] build</strong> <file></p>
<p>Equivalent to calling <code>ros dump executable &lt;file&gt;</code>.</p> <p>Equivalent to calling <code>ros dump executable &lt;file&gt;</code>.</p>
<!-- # subcommands --> <!-- # subcommands -->

2
documents/html/ros-checkout.html
View file

@ -19,7 +19,7 @@
</ul> </ul>
</header> </header>
<p>ros-checkout - # synopsis</p> <p>ros-checkout - # synopsis</p>
<p><strong>ros [options] checkout</strong> args...</p> <p><strong>ros [options] checkout</strong> args…</p>
<!-- # subcommands --> <!-- # subcommands -->
<!-- somecommand --> <!-- somecommand -->
<!-- : description. end with a period. --> <!-- : description. end with a period. -->

4
documents/html/ros-client.html
View file

@ -20,7 +20,7 @@
</header> </header>
<p>ros-client - one-shot connect to remote repl.</p> <p>ros-client - one-shot connect to remote repl.</p>
<h1 id="synopsis">synopsis</h1> <h1 id="synopsis">synopsis</h1>
<p><strong>ros client</strong> protocol [options for the protocol ...] ...</p> <p><strong>ros client</strong> protocol [options for the protocol …] …</p>
<!-- # subcommands --> <!-- # subcommands -->
<!-- somecommand --> <!-- somecommand -->
<!-- : description. end with a period. --> <!-- : description. end with a period. -->
@ -34,7 +34,7 @@
<dt><code>--interface interface</code></dt> <dt><code>--interface interface</code></dt>
<dd><p>interface for connect. default is <code>localhost</code>.</p> <dd><p>interface for connect. default is <code>localhost</code>.</p>
</dd> </dd>
<dt>-e FORM --eval FORM</dt> <dt>-e FORM –eval FORM</dt>
<dd><p>Evaluate FORM while building</p> <dd><p>Evaluate FORM while building</p>
</dd> </dd>
</dl> </dl>

4
documents/html/ros-config.html
View file

@ -19,9 +19,9 @@
</ul> </ul>
</header> </header>
<p>ros-config - get and set options # Synopsis</p> <p>ros-config - get and set options # Synopsis</p>
<p><strong>ros [options] config</strong> [SUBCOMMAND ARGS...]</p> <p><strong>ros [options] config</strong> [SUBCOMMAND ARGS…]</p>
<h1 id="description">Description</h1> <h1 id="description">Description</h1>
<p>Without any arguments, it shows all variables and it's value.</p> <p>Without any arguments, it shows all variables and it’s value.</p>
<dl> <dl>
<dt>show TARGET</dt> <dt>show TARGET</dt>
<dd><p>show TARGET.</p> <dd><p>show TARGET.</p>

8
documents/html/ros-delete.html
View file

@ -19,14 +19,14 @@
</ul> </ul>
</header> </header>
<p>ros-delete - # synopsis</p> <p>ros-delete - # synopsis</p>
<p><strong>ros delete</strong> ARGS...</p> <p><strong>ros delete</strong> ARGS…</p>
<p>Slightly complex arguments.</p> <p>Slightly complex arguments.</p>
<h2 id="ros-delete-dump-images...">ros delete dump IMAGES...</h2> <h2 id="ros-delete-dump-images">ros delete dump IMAGES…</h2>
<p>Whem ARGS starts with <code>dump</code>, it considers the remaining args as the names for the dumped images. It then deletes the image with the given name, if it exists.</p> <p>Whem ARGS starts with <code>dump</code>, it considers the remaining args as the names for the dumped images. It then deletes the image with the given name, if it exists.</p>
<p>The deletion happens only to the images compatible with the current lisp implementation/version. For example, when ccl-bin/1.10 and sbcl-bin/1.3.1 both have images named X, and if the current lisp in use is sbcl-bin/1.3.1, then <code>ros delete dump X</code> removes sbcl-bin/1.3.1/X only.</p> <p>The deletion happens only to the images compatible with the current lisp implementation/version. For example, when ccl-bin/1.10 and sbcl-bin/1.3.1 both have images named X, and if the current lisp in use is sbcl-bin/1.3.1, then <code>ros delete dump X</code> removes sbcl-bin/1.3.1/X only.</p>
<h2 id="ros-delete-impls...">ros delete IMPLS...</h2> <h2 id="ros-delete-impls">ros delete IMPLS…</h2>
<p>When the first argument is not <code>dump</code>, then the arguments are treated as a list of installed implementations.</p> <p>When the first argument is not <code>dump</code>, then the arguments are treated as a list of installed implementations.</p>
<p>If a name of some implementation is given without version specifiers, e.g. sbcl-bin, then it removes all instances (versions) of sbcl-bin.</p> <p>If a name of some implementation is given without version specifiers, e.g. sbcl-bin, then it removes all instances (versions) of sbcl-bin.</p>
<p>If a version is specified, then it removes only the specified instance.</p> <p>If a version is specified, then it removes only the specified instance.</p>
<!-- somecommand --> <!-- somecommand -->
<!-- : description. end with a period. --> <!-- : description. end with a period. -->

2
documents/html/ros-dist.html
View file

@ -19,7 +19,7 @@
</ul> </ul>
</header> </header>
<p>ros-dist - # synopsis</p> <p>ros-dist - # synopsis</p>
<p><strong>ros [options] dist</strong> args...</p> <p><strong>ros [options] dist</strong> args…</p>
<!-- # subcommands --> <!-- # subcommands -->
<!-- somecommand --> <!-- somecommand -->
<!-- : description. end with a period. --> <!-- : description. end with a period. -->

36
documents/html/ros-dump.html
View file

@ -20,11 +20,11 @@
</header> </header>
<p>ros-dump - make a dumped image of a roswell script</p> <p>ros-dump - make a dumped image of a roswell script</p>
<h1 id="synopsis">Synopsis</h1> <h1 id="synopsis">Synopsis</h1>
<p><strong>ros [OPTIONS1...] dump [OPTIONS2...] MODE</strong> args...</p> <p><strong>ros [OPTIONS1…] dump [OPTIONS2…] MODE</strong> args…</p>
<p><code>OPTIONS1</code> specify the standard roswell options such as <code>-L</code> or <code>-m LISP</code>. <code>OPTIONS2</code> specify the image reduction options we describe later. <code>MODE</code> is either <code>output</code> or <code>executable</code>.</p> <p><code>OPTIONS1</code> specify the standard roswell options such as <code>-L</code> or <code>-m LISP</code>. <code>OPTIONS2</code> specify the image reduction options we describe later. <code>MODE</code> is either <code>output</code> or <code>executable</code>.</p>
<h1 id="description">Description</h1> <h1 id="description">Description</h1>
<p><code>ros-dump</code> creates a dumped lisp image of the state after processing all options <code>OPTIONS1</code>.</p> <p><code>ros-dump</code> creates a dumped lisp image of the state after processing all options <code>OPTIONS1</code>.</p>
<p>It has two modes <code>output</code> and <code>executable</code>. In both modes, the global environment (e.g. global binding to special variables such as <code>*package*</code>) of the state just after the restart is the environment which was effective when the script was dumped.</p> <p>It has two modes <code>output</code> and <code>executable</code>. In both modes, the global environment (e.g. global binding to special variables such as <code>*package*</code>) of the state just after the restart is the environment which was effective when the script was dumped.</p>
<!-- Fixme: what kind of? this is unnecessarily retracting the users from using this feature --> <!-- Fixme: what kind of? this is unnecessarily retracting the users from using this feature -->
<!-- There might be a limitation regarding this feature depending on the lisp --> <!-- There might be a limitation regarding this feature depending on the lisp -->
<!-- implementation used by roswell at the time of building. --> <!-- implementation used by roswell at the time of building. -->
@ -52,37 +52,37 @@
<p>Care should be taken to ensure the resulting program works as expected, as some of these operation may destroy the common assumptions of the conforming programs. For example, package-related reduction options may inhibit the runtime calls to <code>READ</code> after the restart.</p> <p>Care should be taken to ensure the resulting program works as expected, as some of these operation may destroy the common assumptions of the conforming programs. For example, package-related reduction options may inhibit the runtime calls to <code>READ</code> after the restart.</p>
<p>Reduction options are processed in the left-to-right manner.</p> <p>Reduction options are processed in the left-to-right manner.</p>
<dl> <dl>
<dt>--disable-compression, --enable-compression, -c</dt> <dt>–disable-compression, –enable-compression, -c</dt>
<dd><p>These options disable/enable/enable the core compression feature in SBCL. Thus this option is meaningful only on SBCL. Compression is enabled by default.</p> <dd><p>These options disable/enable/enable the core compression feature in SBCL. Thus this option is meaningful only on SBCL. Compression is enabled by default.</p>
</dd> </dd>
<dt>--remove-docstrings</dt> <dt>–remove-docstrings</dt>
<dd><p>This option removes all docstrings from all symbols in the entire lisp image.</p> <dd><p>This option removes all docstrings from all symbols in the entire lisp image.</p>
</dd> </dd>
<dt>--delete-package PKG</dt> <dt>–delete-package PKG</dt>
<dd><p>This option can be specified multiple times. It uninterns the symbols in PACKAGE, calls <code>makeunbound</code> and <code>fmakeunbound</code> on each symbol and deletes the package. Package names are automatically string-upcase'd.</p> <dd><p>This option can be specified multiple times. It uninterns the symbols in PACKAGE, calls <code>makeunbound</code> and <code>fmakeunbound</code> on each symbol and deletes the package. Package names are automatically string-upcase’d.</p>
</dd> </dd>
<dt>--delete-all-packages</dt> <dt>–delete-all-packages</dt>
<dd><p>This option applies --delete-package PKG on all packages, except some blacklisted packages (keyword, roswell, ROS.SCRIPT.DUMP, and the package of the main function symbol).</p> <dd><p>This option applies –delete-package PKG on all packages, except some blacklisted packages (keyword, roswell, ROS.SCRIPT.DUMP, and the package of the main function symbol).</p>
</dd> </dd>
<dt>--delete-packages-except PACKAGE</dt> <dt>–delete-packages-except PACKAGE</dt>
<dd><p>This option can be specified multiple times. It is identical to --delete-all-packages except that it adds PACKAGE to the blacklist. Package names are automatically string-upcase'd.</p> <dd><p>This option can be specified multiple times. It is identical to –delete-all-packages except that it adds PACKAGE to the blacklist. Package names are automatically string-upcase’d.</p>
</dd> </dd>
<dt>--destroy-packages-sbcl</dt> <dt>–destroy-packages-sbcl</dt>
<dd><p>This is an sbcl-specific option which is even more aggressive than the above methods (&gt;10MB reduction). It destroys the package system by modifying the internal tables for packages, cleaning up the caches for package-use-list etc. The blacklist is shared among --delete-all-packages and --destroy-packages-sbcl. However, this method does not call fmakunbound/makunbound, so combining the two methods can result in a more aggressive image size reduction. Due to the nature of this option, it is desirable to specify it as the last method (i.e. rightmost).</p> <dd><p>This is an sbcl-specific option which is even more aggressive than the above methods (&gt;10MB reduction). It destroys the package system by modifying the internal tables for packages, cleaning up the caches for package-use-list etc. The blacklist is shared among –delete-all-packages and –destroy-packages-sbcl. However, this method does not call fmakunbound/makunbound, so combining the two methods can result in a more aggressive image size reduction. Due to the nature of this option, it is desirable to specify it as the last method (i.e. rightmost).</p>
</dd> </dd>
<dt>--purify, --no-purify</dt> <dt>–purify, –no-purify</dt>
<dd><p>This is common to CCL, SBCL, CMUCL. Moves all objects to the static space where GC does not scan, for the later performance of GC. Purification is enabled by default.</p> <dd><p>This is common to CCL, SBCL, CMUCL. Moves all objects to the static space where GC does not scan, for the later performance of GC. Purification is enabled by default.</p>
</dd> </dd>
<dt>--impurify, --no-impurify</dt> <dt>–impurify, –no-impurify</dt>
<dd><p>This is an CCL-specific option (enabled by default). It moves all objects to the dynamic space before saving the image. This allows the static-space objects to be GC'ed. When purification is enabled, it impurifies all objects before running the purifying GC.</p> <dd><p>This is an CCL-specific option (enabled by default). It moves all objects to the dynamic space before saving the image. This allows the static-space objects to be GC’ed. When purification is enabled, it impurifies all objects before running the purifying GC.</p>
</dd> </dd>
<dt>--delete-debug-info</dt> <dt>–delete-debug-info</dt>
<dd><p>This removes the debug infomation of functions (used to show the stack frame etc), as well as the source locations and the deprecation information of various symbols. SBCL only. This option has a large effect (+10MB reduction).</p> <dd><p>This removes the debug infomation of functions (used to show the stack frame etc), as well as the source locations and the deprecation information of various symbols. SBCL only. This option has a large effect (+10MB reduction).</p>
</dd> </dd>
<dt>--delete-macro-definitions, --delete-compiler-macro-definitions</dt> <dt>–delete-macro-definitions, –delete-compiler-macro-definitions</dt>
<dd><p>This removes all definitions of macros and compiler-macros, assuming that no runtime compilation/interpretation of code will be performed. This option should be portable across implementations. It has ~2MB reduction on SBCL.</p> <dd><p>This removes all definitions of macros and compiler-macros, assuming that no runtime compilation/interpretation of code will be performed. This option should be portable across implementations. It has ~2MB reduction on SBCL.</p>
</dd> </dd>
<dt>--delete-compiler-information-sbcl</dt> <dt>–delete-compiler-information-sbcl</dt>
<dd><p>This is an SBCL-specific option which is more aggressive than the above methods (~4MB reduction). In addition to the macro and the compiler-macro definitions, it destroys the internal compiler systems of SBCL by also removing the inlining information, IR1 transformer and IR2 (VOP).</p> <dd><p>This is an SBCL-specific option which is more aggressive than the above methods (~4MB reduction). In addition to the macro and the compiler-macro definitions, it destroys the internal compiler systems of SBCL by also removing the inlining information, IR1 transformer and IR2 (VOP).</p>
</dd> </dd>
</dl> </dl>

2
documents/html/ros-emacs.html
View file

@ -19,7 +19,7 @@
</ul> </ul>
</header> </header>
<p>ros-emacs - launch Emacs with Slime # Synopsis</p> <p>ros-emacs - launch Emacs with Slime # Synopsis</p>
<p><strong>ros emacs</strong> [ARGS...]</p> <p><strong>ros emacs</strong> [ARGS…]</p>
<!-- # subcommands --> <!-- # subcommands -->
<!-- somecommand --> <!-- somecommand -->
<!-- : description. end with a period. --> <!-- : description. end with a period. -->

4
documents/html/ros-init.html
View file

@ -20,14 +20,14 @@
</header> </header>
<p>ros-init - Create a roswell script (optionally based on a template)</p> <p>ros-init - Create a roswell script (optionally based on a template)</p>
<h1 id="synopsis">Synopsis</h1> <h1 id="synopsis">Synopsis</h1>
<p><strong>ros init [TEMPLATE] NAME [ARGS...]]</strong></p> <p><strong>ros init [TEMPLATE] NAME [ARGS…]]</strong></p>
<dl> <dl>
<dt>TEMPLATE</dt> <dt>TEMPLATE</dt>
<dd><p>Specifies the name of a template, defaulted to <em>default</em> template. However, if <em>TEMPLATE</em> is not specified and <em>FILENAME</em> matches one of the templates being stored, then it automatically uses the template. To suppress this behavior, you should explicitly specify <em>TEMPLATE</em> as <em>default</em>.</p> <dd><p>Specifies the name of a template, defaulted to <em>default</em> template. However, if <em>TEMPLATE</em> is not specified and <em>FILENAME</em> matches one of the templates being stored, then it automatically uses the template. To suppress this behavior, you should explicitly specify <em>TEMPLATE</em> as <em>default</em>.</p>
<p>Thus you are warned when you use this command from a shell script. In order to achieve a consistent and desired behavior, it is adviced that they should always explicitly specify the template name.</p> <p>Thus you are warned when you use this command from a shell script. In order to achieve a consistent and desired behavior, it is adviced that they should always explicitly specify the template name.</p>
</dd> </dd>
<dt>NAME</dt> <dt>NAME</dt>
<dd><p>Specify the output filename, or &quot;-&quot; to indicate <em>stdout</em>. When <em>TEMPLATE</em> is <em>default</em>, it automatically appends a file type &quot;.ros&quot;.</p> <dd><p>Specify the output filename, or “-” to indicate <em>stdout</em>. When <em>TEMPLATE</em> is <em>default</em>, it automatically appends a file type “.ros”.</p>
</dd> </dd>
</dl> </dl>
<!-- # subcommands --> <!-- # subcommands -->

6
documents/html/ros-install.html
View file

@ -21,8 +21,8 @@
<p>ros-install - Install lisp implementations or quicklisp system</p> <p>ros-install - Install lisp implementations or quicklisp system</p>
<h1 id="synopsis">Synopsis</h1> <h1 id="synopsis">Synopsis</h1>
<ul> <ul>
<li><strong>ros install</strong> system [system ...]</li> <li><strong>ros install</strong> system [system …]</li>
<li><strong>ros install</strong> impl[/version] [param ...]</li> <li><strong>ros install</strong> impl[/version] [param …]</li>
</ul> </ul>
<h1 id="description">Description</h1> <h1 id="description">Description</h1>
<dl> <dl>
@ -52,7 +52,7 @@ ccl-bin
sbcl-bin</code></pre> sbcl-bin</code></pre>
<p>The name can be optionally followed by a slash <code>/</code> and a version of the implementation.</p> <p>The name can be optionally followed by a slash <code>/</code> and a version of the implementation.</p>
<pre><code>$ ros install sbcl/1.2.14</code></pre> <pre><code>$ ros install sbcl/1.2.14</code></pre>
<p>There might be some <em>hidden</em> implementation that are not listed here --- they are in the alpha quality, but try the one you like or watch the website (https://github.com/roswell/roswell).</p> <p>There might be some <em>hidden</em> implementation that are not listed here — they are in the alpha quality, but try the one you like or watch the website (https://github.com/roswell/roswell).</p>
<pre><code>$ ros install ccl <pre><code>$ ros install ccl
$ ros install abcl $ ros install abcl
$ ...</code></pre> $ ...</code></pre>

2
documents/html/ros-list.html
View file

@ -27,7 +27,7 @@
<h1 id="description">Description</h1> <h1 id="description">Description</h1>
<p><strong>ros list</strong> shows the list of the materials installed by roswell.</p> <p><strong>ros list</strong> shows the list of the materials installed by roswell.</p>
<dl> <dl>
<dt>installed [ [ IMPL | IMPL/VERSION ]...]</dt> <dt>installed [ [ IMPL | IMPL/VERSION ]…]</dt>
<dd><p>List the implementations that have been already installed. Optionally providing IMPL shows the installed versions of the implementation.</p> <dd><p>List the implementations that have been already installed. Optionally providing IMPL shows the installed versions of the implementation.</p>
</dd> </dd>
<dt>dump [IMPL]</dt> <dt>dump [IMPL]</dt>

2
documents/html/ros-serve.html
View file

@ -20,7 +20,7 @@
</header> </header>
<p>ros-serve - start lisp server</p> <p>ros-serve - start lisp server</p>
<h1 id="synopsis">Synopsis</h1> <h1 id="synopsis">Synopsis</h1>
<p><strong>ros [options for roswell ... ] serve</strong> protocol [options for the protocol ...] ...</p> <p><strong>ros [options for roswell … ] serve</strong> protocol [options for the protocol …] …</p>
<!-- # subcommands --> <!-- # subcommands -->
<!-- somecommand --> <!-- somecommand -->
<!-- : description. end with a period. --> <!-- : description. end with a period. -->

16
documents/html/ros-template.html
View file

@ -21,7 +21,7 @@
<p>ros-template - Edit template for ros-init</p> <p>ros-template - Edit template for ros-init</p>
<h1 id="synopsis">synopsis</h1> <h1 id="synopsis">synopsis</h1>
<ul> <ul>
<li><strong>ros template</strong> command args...</li> <li><strong>ros template</strong> command args…</li>
</ul> </ul>
<h1 id="subcommands">Subcommands</h1> <h1 id="subcommands">Subcommands</h1>
<dl> <dl>
@ -37,25 +37,25 @@
<dt>checkout [template-name]</dt> <dt>checkout [template-name]</dt>
<dd><p>When invoked without template-name,this command shows candidates for current templates to operate.If with template-name, this command choose the name as current template.</p> <dd><p>When invoked without template-name,this command shows candidates for current templates to operate.If with template-name, this command choose the name as current template.</p>
</dd> </dd>
<dt>add [template-name] [files ...]</dt> <dt>add [template-name] [files …]</dt>
<dd><p>Add files to current template.First parameter could taken as a template-name when current template are <em>default</em>.</p> <dd><p>Add files to current template.First parameter could taken as a template-name when current template are <em>default</em>.</p>
</dd> </dd>
<dt>cat [template-name] [files ...]</dt> <dt>cat [template-name] [files …]</dt>
<dd><p>Show contents in the current template.</p> <dd><p>Show contents in the current template.</p>
</dd> </dd>
<dt>edit [template-name] [files ...]</dt> <dt>edit [template-name] [files …]</dt>
<dd><p>Edit content of files in template using <code>/usr/bin/editor</code>.</p> <dd><p>Edit content of files in template using <code>/usr/bin/editor</code>.</p>
</dd> </dd>
<dt>path [template-name] [files ...]</dt> <dt>path [template-name] [files …]</dt>
<dd><p>Show native path of files in template.</p> <dd><p>Show native path of files in template.</p>
</dd> </dd>
<dt>rm [template-name] [files ...]</dt> <dt>rm [template-name] [files …]</dt>
<dd><p>Remove file form current template.</p> <dd><p>Remove file form current template.</p>
</dd> </dd>
<dt>type [template-name] [type] [files ...]</dt> <dt>type [template-name] [type] [files …]</dt>
<dd><p>Change file type. current choice for <em>type</em>s are <em>djula</em> or <em>copy</em> {{name}} {{author}} {{email}} {{universal_time}} are available variable in the template file. Withoug files, change default type.</p> <dd><p>Change file type. current choice for <em>type</em>s are <em>djula</em> or <em>copy</em> {{name}} {{author}} {{email}} {{universal_time}} are available variable in the template file. Withoug files, change default type.</p>
</dd> </dd>
<dt>chmod [template-name] [mode] [files ...]</dt> <dt>chmod [template-name] [mode] [files …]</dt>
<dd><p>Change file mode bits to generate. specify mode in octal format.</p> <dd><p>Change file mode bits to generate. specify mode in octal format.</p>
</dd> </dd>
<dt>rewrite [template-name] file rewrite-rule</dt> <dt>rewrite [template-name] file rewrite-rule</dt>

4
documents/html/ros-update.html
View file

@ -21,8 +21,8 @@
<p>ros-update - Update system installed from vcs</p> <p>ros-update - Update system installed from vcs</p>
<h1 id="synopsis">Synopsis</h1> <h1 id="synopsis">Synopsis</h1>
<ul> <ul>
<li><strong>ros update</strong> system [system ...]</li> <li><strong>ros update</strong> system [system …]</li>
<li><strong>ros update</strong> method [params ...]</li> <li><strong>ros update</strong> method [params …]</li>
</ul> </ul>
<h1 id="description">Description</h1> <h1 id="description">Description</h1>
<dl> <dl>

4
documents/html/ros-use.html
View file

@ -21,10 +21,10 @@
<p>ros-use - sets the default implementation used by roswell # synopsis</p> <p>ros-use - sets the default implementation used by roswell # synopsis</p>
<p><strong>ros [options] use</strong> impl[/version]</p> <p><strong>ros [options] use</strong> impl[/version]</p>
<p>impl : The name of an implementation which is already installed. New implementations can be downloaded by <em><a href="ros-install.html">ros-install</a></em>(1). The list of installed implementations is available in <em><a href="ros-list.html">ros-list</a></em>(1).</p> <p>impl : The name of an implementation which is already installed. New implementations can be downloaded by <em><a href="ros-install.html">ros-install</a></em>(1). The list of installed implementations is available in <em><a href="ros-list.html">ros-list</a></em>(1).</p>
<p>version: : The version specifier. The string representation of the version (e.g. <major>.<minor>) depends on each implementation and roswell generally follows the representation used by the implementation. In addition, <em>a special version name &quot;system&quot;</em> tells roswell to use the implementation that is installed in your system, which should be in PATH.</p> <p>version: : The version specifier. The string representation of the version (e.g. <major>.<minor>) depends on each implementation and roswell generally follows the representation used by the implementation. In addition, <em>a special version name “system”</em> tells roswell to use the implementation that is installed in your system, which should be in PATH.</p>
<h1 id="example">example</h1> <h1 id="example">example</h1>
<p>ros use sbcl : use the latest SBCL among several versions of SBCLs installed by <em><a href="ros-install.html">ros-install</a></em>. This is compiled from the source, which may take some time to install but allows SLIME to jump to the implementation source code.</p> <p>ros use sbcl : use the latest SBCL among several versions of SBCLs installed by <em><a href="ros-install.html">ros-install</a></em>. This is compiled from the source, which may take some time to install but allows SLIME to jump to the implementation source code.</p>
<p>ros use sbcl-bin : use the latest stable SBCL binary downloaded from vendor's website. Roswell uses this by default. <code>sbcl-bin</code> tends to be an older version compared to <code>sbcl</code>, but surely newer than your <em>apt-get</em> installed counterpart!</p> <p>ros use sbcl-bin : use the latest stable SBCL binary downloaded from vendor’s website. Roswell uses this by default. <code>sbcl-bin</code> tends to be an older version compared to <code>sbcl</code>, but surely newer than your <em>apt-get</em> installed counterpart!</p>
<p>ros use sbcl/1.3.1 : use the compiled SBCL 1.3.1.</p> <p>ros use sbcl/1.3.1 : use the compiled SBCL 1.3.1.</p>
<p>ros use sbcl-bin/1.3.1 : use the prebuilt SBCL 1.3.1.</p> <p>ros use sbcl-bin/1.3.1 : use the prebuilt SBCL 1.3.1.</p>
<p>ros use sbcl/system : use the SBCL available in the PATH.</p> <p>ros use sbcl/system : use the SBCL available in the PATH.</p>

56
documents/html/ros.html
View file

@ -33,7 +33,7 @@
<p>In an order of utility/frequency.</p> <p>In an order of utility/frequency.</p>
<dl> <dl>
<dt>install</dt> <dt>install</dt>
<dd><p>Install a given implementation (e.g. sbcl, ccl) or a system (e.g. alexandria) for roswell environment. See <em><a href="ros-install.html">ros-install</a></em>(1).</p> <dd><p>Install a given implementation (e.g. sbcl, ccl) or a system (e.g. alexandria) for roswell environment. See <em><a href="ros-install.html">ros-install</a></em>(1).</p>
</dd> </dd>
<dt>init [name[.ros]]</dt> <dt>init [name[.ros]]</dt>
<dd><p>Create a new ros script. <code>.ros</code> is optional, and is added automaticaly. See <em><a href="ros-init.html">ros-init</a></em>.</p> <dd><p>Create a new ros script. <code>.ros</code> is optional, and is added automaticaly. See <em><a href="ros-init.html">ros-init</a></em>.</p>
@ -78,79 +78,79 @@
<h1 id="options">Options</h1> <h1 id="options">Options</h1>
<p>Options are processed in left-to-right order.</p> <p>Options are processed in left-to-right order.</p>
<dl> <dl>
<dt>-w CODE --wrap CODE</dt> <dt>-w CODE –wrap CODE</dt>
<dd><p>Run the script with a shell wrapper CODE, e.g. rlwrap</p> <dd><p>Run the script with a shell wrapper CODE, e.g. rlwrap</p>
</dd> </dd>
<dt>-m IMAGE --image IMAGE</dt> <dt>-m IMAGE –image IMAGE</dt>
<dd><p>Continue from Lisp image IMAGE</p> <dd><p>Continue from Lisp image IMAGE</p>
</dd> </dd>
<dt>-L NAME --lisp NAME</dt> <dt>-L NAME –lisp NAME</dt>
<dd><p>Run the script with a lisp impl NAME[/VERSION] if present, e.g. sbcl-bin, sbcl/1.2.16. Fails otherwise.</p> <dd><p>Run the script with a lisp impl NAME[/VERSION] if present, e.g. sbcl-bin, sbcl/1.2.16. Fails otherwise.</p>
</dd> </dd>
<dt>-l FILE --load FILE</dt> <dt>-l FILE –load FILE</dt>
<dd><p>Load a lisp file FILE while building</p> <dd><p>Load a lisp file FILE while building</p>
</dd> </dd>
<dt>-S X --source-registry X</dt> <dt>-S X –source-registry X</dt>
<dd><p>Override the source registry of asdf systems.</p> <dd><p>Override the source registry of asdf systems.</p>
</dd> </dd>
<dt>-s SYSTEM --system SYSTEM</dt> <dt>-s SYSTEM –system SYSTEM</dt>
<dd><p>Load the asdf SYSTEM while building.</p> <dd><p>Load the asdf SYSTEM while building.</p>
</dd> </dd>
<dt>--load-system SYSTEM</dt> <dt>–load-system SYSTEM</dt>
<dd><p>Same as above (buildapp compatibility)</p> <dd><p>Same as above (buildapp compatibility)</p>
</dd> </dd>
<dt>-p PACKAGE --package PACKAGE</dt> <dt>-p PACKAGE –package PACKAGE</dt>
<dd><p>Change the current package to PACKAGE</p> <dd><p>Change the current package to PACKAGE</p>
</dd> </dd>
<dt>-sp SP --system-package SP</dt> <dt>-sp SP –system-package SP</dt>
<dd><p>Combination of -s SP and -p SP</p> <dd><p>Combination of -s SP and -p SP</p>
</dd> </dd>
<dt>-e FORM --eval FORM</dt> <dt>-e FORM –eval FORM</dt>
<dd><p>Evaluate FORM while building</p> <dd><p>Evaluate FORM while building</p>
</dd> </dd>
<dt>--require MODULE</dt> <dt>–require MODULE</dt>
<dd><p>require MODULE while building</p> <dd><p>require MODULE while building</p>
</dd> </dd>
<dt>-q --quit</dt> <dt>-q –quit</dt>
<dd><p>quit lisp here</p> <dd><p>quit lisp here</p>
</dd> </dd>
<dt>-r FUNC --restart FUNC</dt> <dt>-r FUNC –restart FUNC</dt>
<dd><p>the build image restarts from calling FUNC</p> <dd><p>the build image restarts from calling FUNC</p>
</dd> </dd>
<dt>-E FUNC --entry FUNC</dt> <dt>-E FUNC –entry FUNC</dt>
<dd><p>the build image restarts from calling (FUNC argv).</p> <dd><p>the build image restarts from calling (FUNC argv).</p>
</dd> </dd>
<dt>-i FORM --init FORM</dt> <dt>-i FORM –init FORM</dt>
<dd><p>evaluate FORM after the restart.</p> <dd><p>evaluate FORM after the restart.</p>
</dd> </dd>
<dt>-ip FORM --print FORM</dt> <dt>-ip FORM –print FORM</dt>
<dd><p>evaluate and princ FORM after the restart</p> <dd><p>evaluate and princ FORM after the restart</p>
</dd> </dd>
<dt>-iw FORM --write FORM</dt> <dt>-iw FORM –write FORM</dt>
<dd><p>evaluate and write FORM after the restart</p> <dd><p>evaluate and write FORM after the restart</p>
</dd> </dd>
<dt>-F FORM --final FORM</dt> <dt>-F FORM –final FORM</dt>
<dd><p>evaluate FORM before dumping the IMAGE</p> <dd><p>evaluate FORM before dumping the IMAGE</p>
</dd> </dd>
<dt>-R --rc</dt> <dt>-R –rc</dt>
<dd><p>try to read /etc/rosrc, ~/.roswell/init.lisp</p> <dd><p>try to read /etc/rosrc, ~/.roswell/init.lisp</p>
</dd> </dd>
<dt>+R --no-rc</dt> <dt>+R –no-rc</dt>
<dd><p>skip /etc/rosrc, ~/.roswell/init.lisp</p> <dd><p>skip /etc/rosrc, ~/.roswell/init.lisp</p>
</dd> </dd>
<dt>-Q --quicklisp</dt> <dt>-Q –quicklisp</dt>
<dd><p>load quicklisp (default)</p> <dd><p>load quicklisp (default)</p>
</dd> </dd>
<dt>+Q --no-quicklisp</dt> <dt>+Q –no-quicklisp</dt>
<dd><p>do not load quicklisp</p> <dd><p>do not load quicklisp</p>
</dd> </dd>
<dt>-v --verbose</dt> <dt>-v –verbose</dt>
<dd><p>be quite verbose while building</p> <dd><p>be quite verbose while building</p>
</dd> </dd>
<dt>--quiet</dt> <dt>–quiet</dt>
<dd><p>suppress output while building (default)</p> <dd><p>suppress output while building (default)</p>
</dd> </dd>
<dt>--test</dt> <dt>–test</dt>
<dd><p>for test purpose</p> <dd><p>for test purpose</p>
</dd> </dd>
<dt>dynamic-space-size=[size in MB]</dt> <dt>dynamic-space-size=[size in MB]</dt>

8
documents/man/ros-asdf.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-asdf" "1" "January 2022" "" "" .TH "ros-asdf" "1" "January 2022" "" ""
.hy .hy
@ -7,13 +7,13 @@
ros\-asdf \- ros\-asdf \-
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\f[B]ros [options] asdf [subcommand]\f[] \f[B]ros [options] asdf [subcommand]\f[R]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\f[B]ros asdf\f[] install and manage \f[B]ros asdf\f[R] install and manage
ASDF(https://common\-lisp.net/project/asdf/). ASDF(https://common\-lisp.net/project/asdf/).
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

10
documents/man/ros-build.1
View file

@ -1,16 +1,16 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-build" "1" "" "" "" .TH "ros-build" "1" "" "" ""
.hy .hy
.PP .PP
ros\-build \- Shortcut to "ros dump executable" # synopsis ros\-build \- Shortcut to \[lq]ros dump executable\[rq] # synopsis
.PP .PP
\f[B]ros [options] build\f[] \f[B]ros [options] build\f[R]
.PP .PP
Equivalent to calling \f[C]ros\ dump\ executable\ <file>\f[]. Equivalent to calling \f[C]ros dump executable <file>\f[R].
.SH description .SH description
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

6
documents/man/ros-checkout.1
View file

@ -1,16 +1,16 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-checkout" "1" "" "" "" .TH "ros-checkout" "1" "" "" ""
.hy .hy
.PP .PP
ros\-checkout \- # synopsis ros\-checkout \- # synopsis
.PP .PP
\f[B]ros [options] checkout\f[] args... \f[B]ros [options] checkout\f[R] args\&...
.SH description .SH description
.PP .PP
to enable this command ros install roswell/ql\-checkout is needed. to enable this command ros install roswell/ql\-checkout is needed.
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

24
documents/man/ros-client.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-client" "1" "" "" "" .TH "ros-client" "1" "" "" ""
.hy .hy
@ -6,31 +6,25 @@
ros\-client \- one\-shot connect to remote repl. ros\-client \- one\-shot connect to remote repl.
.SH synopsis .SH synopsis
.PP .PP
\f[B]ros client\f[] protocol [options for the protocol ...] ... \f[B]ros client\f[R] protocol [options for the protocol \&...] \&...
.SH description .SH description
.PP .PP
\f[C]ros\-client\f[] send message to lisp server and wait for message \f[C]ros\-client\f[R] send message to lisp server and wait for message
sent back. sent back.
.SH swank protocol options .SH swank protocol options
.TP .TP
.B \f[C]\-\-port\ port\f[] .B \f[C]\-\-port port\f[R]
set server \f[C]port\f[] to connect. set server \f[C]port\f[R] to connect.
default port 4005. default port 4005.
.RS
.RE
.TP .TP
.B \f[C]\-\-interface\ interface\f[] .B \f[C]\-\-interface interface\f[R]
interface for connect. interface for connect.
default is \f[C]localhost\f[]. default is \f[C]localhost\f[R].
.RS
.RE
.TP .TP
.B \-e FORM \-\-eval FORM .B \-e FORM \[en]eval FORM
Evaluate FORM while building Evaluate FORM while building
.RS
.RE
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\-serve\f[](1) \f[I]ros\f[R](1) \f[I]ros\-serve\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

12
documents/man/ros-config.1
View file

@ -1,26 +1,22 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-config" "1" "" "" "" .TH "ros-config" "1" "" "" ""
.hy .hy
.PP .PP
ros\-config \- get and set options # Synopsis ros\-config \- get and set options # Synopsis
.PP .PP
\f[B]ros [options] config\f[] [SUBCOMMAND ARGS...] \f[B]ros [options] config\f[R] [SUBCOMMAND ARGS\&...]
.SH Description .SH Description
.PP .PP
Without any arguments, it shows all variables and it\[aq]s value. Without any arguments, it shows all variables and it\[cq]s value.
.TP .TP
.B show TARGET .B show TARGET
show TARGET. show TARGET.
.RS
.RE
.TP .TP
.B set TARGET VALUE .B set TARGET VALUE
set the VALUE to the TARGET. set the VALUE to the TARGET.
.RS
.RE
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

19
documents/man/ros-delete.1
View file

@ -1,16 +1,16 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-delete" "1" "" "" "" .TH "ros-delete" "1" "" "" ""
.hy .hy
.PP .PP
ros\-delete \- # synopsis ros\-delete \- # synopsis
.PP .PP
\f[B]ros delete\f[] ARGS... \f[B]ros delete\f[R] ARGS\&...
.PP .PP
Slightly complex arguments. Slightly complex arguments.
.SS ros delete dump IMAGES... .SS ros delete dump IMAGES\&...
.PP .PP
Whem ARGS starts with \f[C]dump\f[], it considers the remaining args as Whem ARGS starts with \f[C]dump\f[R], it considers the remaining args as
the names for the dumped images. the names for the dumped images.
It then deletes the image with the given name, if it exists. It then deletes the image with the given name, if it exists.
.PP .PP
@ -18,20 +18,19 @@ The deletion happens only to the images compatible with the current lisp
implementation/version. implementation/version.
For example, when ccl\-bin/1.10 and sbcl\-bin/1.3.1 both have images For example, when ccl\-bin/1.10 and sbcl\-bin/1.3.1 both have images
named X, and if the current lisp in use is sbcl\-bin/1.3.1, then named X, and if the current lisp in use is sbcl\-bin/1.3.1, then
\f[C]ros\ delete\ dump\ X\f[] removes sbcl\-bin/1.3.1/X only. \f[C]ros delete dump X\f[R] removes sbcl\-bin/1.3.1/X only.
.SS ros delete IMPLS... .SS ros delete IMPLS\&...
.PP .PP
When the first argument is not \f[C]dump\f[], then the arguments are When the first argument is not \f[C]dump\f[R], then the arguments are
treated as a list of installed implementations. treated as a list of installed implementations.
.PP .PP
If a name of some implementation is given without version specifiers, If a name of some implementation is given without version specifiers,
e.g. e.g.\ sbcl\-bin, then it removes all instances (versions) of sbcl\-bin.
sbcl\-bin, then it removes all instances (versions) of sbcl\-bin.
.PP .PP
If a version is specified, then it removes only the specified instance. If a version is specified, then it removes only the specified instance.
.SH description .SH description
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

6
documents/man/ros-dist.1
View file

@ -1,14 +1,14 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-dist" "1" "" "" "" .TH "ros-dist" "1" "" "" ""
.hy .hy
.PP .PP
ros\-dist \- # synopsis ros\-dist \- # synopsis
.PP .PP
\f[B]ros [options] dist\f[] args... \f[B]ros [options] dist\f[R] args\&...
.SH description .SH description
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

141
documents/man/ros-dump.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-dump" "1" "" "" "" .TH "ros-dump" "1" "" "" ""
.hy .hy
@ -6,67 +6,65 @@
ros\-dump \- make a dumped image of a roswell script ros\-dump \- make a dumped image of a roswell script
.SH Synopsis .SH Synopsis
.PP .PP
\f[B]ros [OPTIONS1...] dump [OPTIONS2...] MODE\f[] args... \f[B]ros [OPTIONS1\&...] dump [OPTIONS2\&...] MODE\f[R] args\&...
.PP .PP
\f[C]OPTIONS1\f[] specify the standard roswell options such as \f[C]OPTIONS1\f[R] specify the standard roswell options such as
\f[C]\-L\f[] or \f[C]\-m\ LISP\f[]. \f[C]\-L\f[R] or \f[C]\-m LISP\f[R].
\f[C]OPTIONS2\f[] specify the image reduction options we describe later. \f[C]OPTIONS2\f[R] specify the image reduction options we describe
\f[C]MODE\f[] is either \f[C]output\f[] or \f[C]executable\f[]. later.
\f[C]MODE\f[R] is either \f[C]output\f[R] or \f[C]executable\f[R].
.SH Description .SH Description
.PP .PP
\f[C]ros\-dump\f[] creates a dumped lisp image of the state after \f[C]ros\-dump\f[R] creates a dumped lisp image of the state after
processing all options \f[C]OPTIONS1\f[]. processing all options \f[C]OPTIONS1\f[R].
.PP .PP
It has two modes \f[C]output\f[] and \f[C]executable\f[]. It has two modes \f[C]output\f[R] and \f[C]executable\f[R].
In both modes, the global environment (e.g. In both modes, the global environment (e.g.\ global binding to special
global binding to special variables such as \f[C]*package*\f[]) of the variables such as \f[C]*package*\f[R]) of the state just after the
state just after the restart is the environment which was effective when restart is the environment which was effective when the script was
the script was dumped. dumped.
.PP .PP
The dumped image is generally not compatible between the different The dumped image is generally not compatible between the different
implementations, and also between the versions. implementations, and also between the versions.
.SH Dump modes .SH Dump modes
.SS output [\-f] [\-o OUTPUT] NAME .SS output [\-f] [\-o OUTPUT] NAME
.PP .PP
It loads the roswell script \f[C]NAME\f[] and saves the current lisp It loads the roswell script \f[C]NAME\f[R] and saves the current lisp
state to an image. state to an image.
.PP .PP
The image file is by default written to an internal directory of roswell The image file is by default written to an internal directory of roswell
in an organized manner, i.e., somewhere under in an organized manner, i.e., somewhere under
\f[C]$ROSWELL_INSTALL_DIR\f[] deduced by the current implementation, its \f[C]$ROSWELL_INSTALL_DIR\f[R] deduced by the current implementation,
version and the given NAME. its version and the given NAME.
.PP .PP
When the output file already exists, the command fails with an error When the output file already exists, the command fails with an error
code. code.
.PP .PP
The image can be loaded by \f[C]ros\ \-m\ IMAGE\f[]. The image can be loaded by \f[C]ros \-m IMAGE\f[R].
When restarting from the image, standard roswell subcommands and When restarting from the image, standard roswell subcommands and
additional arguments to the script are also available, for example additional arguments to the script are also available, for example
\f[C]ros\ run\f[] to resume with a repl, or \f[C]\-\-restart\ FUNC\f[] \f[C]ros run\f[R] to resume with a repl, or \f[C]\-\-restart FUNC\f[R]
to call a specific function, leaving some flexibility. to call a specific function, leaving some flexibility.
.TP .TP
.B \f[C]\-o\ OUTPUT\f[] .B \f[C]\-o OUTPUT\f[R]
The image is written to \f[C]OUTPUT\f[] instead of the default location. The image is written to \f[C]OUTPUT\f[R] instead of the default
.RS location.
.RE
.TP .TP
.B \f[C]\-f\f[] .B \f[C]\-f\f[R]
Force output when the output already exists. Force output when the output already exists.
.RS
.RE
.SS executable NAME [\-o OUTPUT] .SS executable NAME [\-o OUTPUT]
.PP .PP
When a script is dumped with \f[C]executable\f[], the dumped image When a script is dumped with \f[C]executable\f[R], the dumped image
becomes an self\-contained executable binary which implies becomes an self\-contained executable binary which implies
\f[C]\-\-restart\ main\f[]. \f[C]\-\-restart main\f[R].
.PP .PP
If \f[C]OUTPUT\f[] is given, the resulting binary is written to this If \f[C]OUTPUT\f[R] is given, the resulting binary is written to this
file. file.
Otherwise, the output filename is deduced from \f[C]NAME\f[] and is Otherwise, the output filename is deduced from \f[C]NAME\f[R] and is
written in the same directory. written in the same directory.
On Windows and if \f[C]SCRIPT\f[] has \f[C]\&.ros\f[] extension, the On Windows and if \f[C]SCRIPT\f[R] has \f[C].ros\f[R] extension, the
filename will be \f[C]SCRIPT.exe\f[]. filename will be \f[C]SCRIPT.exe\f[R].
On the other systems, the result will be \f[C]SCRIPT\f[] (without On the other systems, the result will be \f[C]SCRIPT\f[R] (without
extension). extension).
.PP .PP
This feature is supported on SBCL, CCL, CMUCL, CLISP, ECL. This feature is supported on SBCL, CCL, CMUCL, CLISP, ECL.
@ -80,106 +78,83 @@ Care should be taken to ensure the resulting program works as expected,
as some of these operation may destroy the common assumptions of the as some of these operation may destroy the common assumptions of the
conforming programs. conforming programs.
For example, package\-related reduction options may inhibit the runtime For example, package\-related reduction options may inhibit the runtime
calls to \f[C]READ\f[] after the restart. calls to \f[C]READ\f[R] after the restart.
.PP .PP
Reduction options are processed in the left\-to\-right manner. Reduction options are processed in the left\-to\-right manner.
.TP .TP
.B \-\-disable\-compression, \-\-enable\-compression, \-c .B \[en]disable\-compression, \[en]enable\-compression, \-c
These options disable/enable/enable the core compression feature in These options disable/enable/enable the core compression feature in
SBCL. SBCL.
Thus this option is meaningful only on SBCL. Thus this option is meaningful only on SBCL.
Compression is enabled by default. Compression is enabled by default.
.RS
.RE
.TP .TP
.B \-\-remove\-docstrings .B \[en]remove\-docstrings
This option removes all docstrings from all symbols in the entire lisp This option removes all docstrings from all symbols in the entire lisp
image. image.
.RS
.RE
.TP .TP
.B \-\-delete\-package PKG .B \[en]delete\-package PKG
This option can be specified multiple times. This option can be specified multiple times.
It uninterns the symbols in PACKAGE, calls \f[C]makeunbound\f[] and It uninterns the symbols in PACKAGE, calls \f[C]makeunbound\f[R] and
\f[C]fmakeunbound\f[] on each symbol and deletes the package. \f[C]fmakeunbound\f[R] on each symbol and deletes the package.
Package names are automatically string\-upcase\[aq]d. Package names are automatically string\-upcase\[cq]d.
.RS
.RE
.TP .TP
.B \-\-delete\-all\-packages .B \[en]delete\-all\-packages
This option applies \-\-delete\-package PKG on all packages, except some This option applies \[en]delete\-package PKG on all packages, except
blacklisted packages (keyword, roswell, ROS.SCRIPT.DUMP, and the package some blacklisted packages (keyword, roswell, ROS.SCRIPT.DUMP, and the
of the main function symbol). package of the main function symbol).
.RS
.RE
.TP .TP
.B \-\-delete\-packages\-except PACKAGE .B \[en]delete\-packages\-except PACKAGE
This option can be specified multiple times. This option can be specified multiple times.
It is identical to \-\-delete\-all\-packages except that it adds PACKAGE It is identical to \[en]delete\-all\-packages except that it adds
to the blacklist. PACKAGE to the blacklist.
Package names are automatically string\-upcase\[aq]d. Package names are automatically string\-upcase\[cq]d.
.RS
.RE
.TP .TP
.B \-\-destroy\-packages\-sbcl .B \[en]destroy\-packages\-sbcl
This is an sbcl\-specific option which is even more aggressive than the This is an sbcl\-specific option which is even more aggressive than the
above methods (>10MB reduction). above methods (>10MB reduction).
It destroys the package system by modifying the internal tables for It destroys the package system by modifying the internal tables for
packages, cleaning up the caches for package\-use\-list etc. packages, cleaning up the caches for package\-use\-list etc.
The blacklist is shared among \-\-delete\-all\-packages and The blacklist is shared among \[en]delete\-all\-packages and
\-\-destroy\-packages\-sbcl. \[en]destroy\-packages\-sbcl.
However, this method does not call fmakunbound/makunbound, so combining However, this method does not call fmakunbound/makunbound, so combining
the two methods can result in a more aggressive image size reduction. the two methods can result in a more aggressive image size reduction.
Due to the nature of this option, it is desirable to specify it as the Due to the nature of this option, it is desirable to specify it as the
last method (i.e. last method (i.e.\ rightmost).
rightmost).
.RS
.RE
.TP .TP
.B \-\-purify, \-\-no\-purify .B \[en]purify, \[en]no\-purify
This is common to CCL, SBCL, CMUCL. This is common to CCL, SBCL, CMUCL.
Moves all objects to the static space where GC does not scan, for the Moves all objects to the static space where GC does not scan, for the
later performance of GC. later performance of GC.
Purification is enabled by default. Purification is enabled by default.
.RS
.RE
.TP .TP
.B \-\-impurify, \-\-no\-impurify .B \[en]impurify, \[en]no\-impurify
This is an CCL\-specific option (enabled by default). This is an CCL\-specific option (enabled by default).
It moves all objects to the dynamic space before saving the image. It moves all objects to the dynamic space before saving the image.
This allows the static\-space objects to be GC\[aq]ed. This allows the static\-space objects to be GC\[cq]ed.
When purification is enabled, it impurifies all objects before running When purification is enabled, it impurifies all objects before running
the purifying GC. the purifying GC.
.RS
.RE
.TP .TP
.B \-\-delete\-debug\-info .B \[en]delete\-debug\-info
This removes the debug infomation of functions (used to show the stack This removes the debug infomation of functions (used to show the stack
frame etc), as well as the source locations and the deprecation frame etc), as well as the source locations and the deprecation
information of various symbols. information of various symbols.
SBCL only. SBCL only.
This option has a large effect (+10MB reduction). This option has a large effect (+10MB reduction).
.RS
.RE
.TP .TP
.B \-\-delete\-macro\-definitions, \-\-delete\-compiler\-macro\-definitions .B \[en]delete\-macro\-definitions, \[en]delete\-compiler\-macro\-definitions
This removes all definitions of macros and compiler\-macros, assuming This removes all definitions of macros and compiler\-macros, assuming
that no runtime compilation/interpretation of code will be performed. that no runtime compilation/interpretation of code will be performed.
This option should be portable across implementations. This option should be portable across implementations.
It has ~2MB reduction on SBCL. It has \[ti]2MB reduction on SBCL.
.RS
.RE
.TP .TP
.B \-\-delete\-compiler\-information\-sbcl .B \[en]delete\-compiler\-information\-sbcl
This is an SBCL\-specific option which is more aggressive than the above This is an SBCL\-specific option which is more aggressive than the above
methods (~4MB reduction). methods (\[ti]4MB reduction).
In addition to the macro and the compiler\-macro definitions, it In addition to the macro and the compiler\-macro definitions, it
destroys the internal compiler systems of SBCL by also removing the destroys the internal compiler systems of SBCL by also removing the
inlining information, IR1 transformer and IR2 (VOP). inlining information, IR1 transformer and IR2 (VOP).
.RS
.RE
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]sbcl\f[](1) \f[I]ros\f[](1) \f[I]ros\-init\f[](1) \f[I]sbcl\f[R](1) \f[I]ros\f[R](1) \f[I]ros\-init\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

6
documents/man/ros-emacs.1
View file

@ -1,11 +1,11 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-emacs" "1" "" "" "" .TH "ros-emacs" "1" "" "" ""
.hy .hy
.PP .PP
ros\-emacs \- launch Emacs with Slime # Synopsis ros\-emacs \- launch Emacs with Slime # Synopsis
.PP .PP
\f[B]ros emacs\f[] [ARGS...] \f[B]ros emacs\f[R] [ARGS\&...]
.SH Description .SH Description
.PP .PP
Launches Emacs with a Slime(https://common\-lisp.net/project/slime/) Launches Emacs with a Slime(https://common\-lisp.net/project/slime/)
@ -14,6 +14,6 @@ of roswell.
Additional arguments are passed to emacs. Additional arguments are passed to emacs.
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1), \f[I]emacs\f[](1) \f[I]ros\f[R](1), \f[I]emacs\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

8
documents/man/ros-help.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-help" "1" "" "" "" .TH "ros-help" "1" "" "" ""
.hy .hy
@ -6,12 +6,12 @@
ros\-help \- Show Command help ros\-help \- Show Command help
.SH Synopsis .SH Synopsis
.PP .PP
\f[B]ros help\f[] [subcommand or topics] \f[B]ros help\f[R] [subcommand or topics]
.SH Description .SH Description
.PP .PP
\f[B]ros help\f[] shows description of subcommand or topics \f[B]ros help\f[R] shows description of subcommand or topics
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]sbcl\f[](1), \f[I]ros\f[](1) \f[I]sbcl\f[R](1), \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

53
documents/man/ros-init.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-init" "1" "" "" "" .TH "ros-init" "1" "" "" ""
.hy .hy
@ -6,16 +6,16 @@
ros\-init \- Create a roswell script (optionally based on a template) ros\-init \- Create a roswell script (optionally based on a template)
.SH Synopsis .SH Synopsis
.PP .PP
\f[B]ros init [TEMPLATE] NAME [ARGS...]]\f[] \f[B]ros init [TEMPLATE] NAME [ARGS\&...]]\f[R]
.TP .TP
.B TEMPLATE .B TEMPLATE
Specifies the name of a template, defaulted to \f[I]default\f[] Specifies the name of a template, defaulted to \f[I]default\f[R]
template. template.
However, if \f[I]TEMPLATE\f[] is not specified and \f[I]FILENAME\f[] However, if \f[I]TEMPLATE\f[R] is not specified and \f[I]FILENAME\f[R]
matches one of the templates being stored, then it automatically uses matches one of the templates being stored, then it automatically uses
the template. the template.
To suppress this behavior, you should explicitly specify To suppress this behavior, you should explicitly specify
\f[I]TEMPLATE\f[] as \f[I]default\f[]. \f[I]TEMPLATE\f[R] as \f[I]default\f[R].
.RS .RS
.PP .PP
Thus you are warned when you use this command from a shell script. Thus you are warned when you use this command from a shell script.
@ -24,47 +24,46 @@ that they should always explicitly specify the template name.
.RE .RE
.TP .TP
.B NAME .B NAME
Specify the output filename, or "\-" to indicate \f[I]stdout\f[]. Specify the output filename, or \[lq]\-\[rq] to indicate
When \f[I]TEMPLATE\f[] is \f[I]default\f[], it automatically appends a \f[I]stdout\f[R].
file type ".ros". When \f[I]TEMPLATE\f[R] is \f[I]default\f[R], it automatically appends a
.RS file type \[lq].ros\[rq].
.RE
.SH Description .SH Description
.PP .PP
Initialises a roswell file based on a template. Initialises a roswell file based on a template.
User\-specified templates can be added by \f[I]ros\-template\f[](1). User\-specified templates can be added by \f[I]ros\-template\f[R](1).
.PP .PP
The default template is something like: The default template is something like:
.IP .IP
.nf .nf
\f[C] \f[C]
#!/bin/sh #!/bin/sh
#|\-*\-\ mode:lisp\ \-*\-|# #|\-*\- mode:lisp \-*\-|#
#|\ <Put\ a\ one\-line\ description\ here> #| <Put a one\-line description here>
exec\ ros\ \-Q\ \-\-\ $0\ "$\@" exec ros \-Q \-\- $0 \[dq]$\[at]\[dq]
|# |#
(progn\ ;;init\ forms (progn ;;init forms
\ \ (ros:ensure\-asdf) (ros:ensure\-asdf)
\ \ ;;#+quicklisp\ (ql:quickload\ \[aq]()\ :silent\ t) ;;#+quicklisp (ql:quickload \[aq]() :silent t)
\ \ ) )
(defpackage\ :ros.script.test.3703600390 (defpackage :ros.script.test.3703600390
\ \ (:use\ :cl)) (:use :cl))
(in\-package\ :ros.script.test.3703600390) (in\-package :ros.script.test.3703600390)
(defun\ main\ (&rest\ argv) (defun main (&rest argv)
\ \ (declare\ (ignorable\ argv))) (declare (ignorable argv)))
;;;\ vim:\ set\ ft=lisp\ lisp: ;;; vim: set ft=lisp lisp:
\f[] \f[R]
.fi .fi
.PP .PP
This is basically a shell script which immediately invokes Roswell by This is basically a shell script which immediately invokes Roswell by
exec (see \f[I]sh(1)\f[]). exec (see \f[I]sh(1)\f[R]).
Roswell loads the same script as an input, skips multi\-line comments, Roswell loads the same script as an input, skips multi\-line comments,
reads the rest of the file as a Common Lisp program, and finally invokes reads the rest of the file as a Common Lisp program, and finally invokes
a function main with command\-line arguments. a function main with command\-line arguments.
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]sbcl\f[](1) \f[I]ros\f[](1) \f[I]ros\-template\f[](1) \f[I]sbcl\f[R](1) \f[I]ros\f[R](1) \f[I]ros\-template\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

88
documents/man/ros-install.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-install" "1" "" "" "" .TH "ros-install" "1" "" "" ""
.hy .hy
@ -6,82 +6,78 @@
ros\-install \- Install lisp implementations or quicklisp system ros\-install \- Install lisp implementations or quicklisp system
.SH Synopsis .SH Synopsis
.IP \[bu] 2 .IP \[bu] 2
\f[B]ros install\f[] system [system ...] \f[B]ros install\f[R] system [system \&...]
.IP \[bu] 2 .IP \[bu] 2
\f[B]ros install\f[] impl[/version] [param ...] \f[B]ros install\f[R] impl[/version] [param \&...]
.SH Description .SH Description
.TP .TP
.B system .B system
a name specifying a system. a name specifying a system.
.RS
.RE
.TP .TP
.B impl .B impl
a name specifying a lisp implementation. a name specifying a lisp implementation.
.RS
.RE
.SH Installing a Lisp Implementation .SH Installing a Lisp Implementation
.PP .PP
When the \f[C]impl\f[] or \f[C]system\f[] matches to one of the When the \f[C]impl\f[R] or \f[C]system\f[R] matches to one of the
supported implementations, it fetches, downloads and installs it to one supported implementations, it fetches, downloads and installs it to one
of the internal directory managed by roswell (~/.roswell, or of the internal directory managed by roswell (\[ti]/.roswell, or
\f[C]ROSWELL_INSTALL_DIR\f[]). \f[C]ROSWELL_INSTALL_DIR\f[R]).
In order to use the installed implementation, you have to run In order to use the installed implementation, you have to run
\f[I]ros\-use(1)\f[]. \f[I]ros\-use(1)\f[R].
.PP .PP
For example, the following command downloads the latest sbcl binary from For example, the following command downloads the latest sbcl binary from
sbcl.org. sbcl.org.
Note that this may be different from the default binary installed by Note that this may be different from the default binary installed by
roswell, called \f[C]sbcl\-bin\f[]. roswell, called \f[C]sbcl\-bin\f[R].
\f[C]sbcl\-bin\f[] is a stable and well\-tested version of the sbcl \f[C]sbcl\-bin\f[R] is a stable and well\-tested version of the sbcl
binary which is supposed to be a little older than the latest sbcl. binary which is supposed to be a little older than the latest sbcl.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ install\ sbcl $ ros install sbcl
\f[] \f[R]
.fi .fi
.PP .PP
When invoked without a name, it prints the list of installable When invoked without a name, it prints the list of installable
implementations. implementations.
(Not to be confused with \f[C]ros\ list\ installed\f[], which shows the (Not to be confused with \f[C]ros list installed\f[R], which shows the
implementations already installed.) implementations already installed.)
.IP .IP
.nf .nf
\f[C] \f[C]
Usage:\ ros\ install\ impl\ [OPTIONS] Usage: ros install impl [OPTIONS]
For\ more\ details\ on\ impl\ specific\ options,\ type: For more details on impl specific options, type:
ros\ help\ install\ impl ros help install impl
Candidates\ impls\ for\ installation\ are: Candidates impls for installation are:
ecl ecl
sbcl sbcl
clisp clisp
ccl\-bin ccl\-bin
sbcl\-bin sbcl\-bin
\f[] \f[R]
.fi .fi
.PP .PP
The name can be optionally followed by a slash \f[C]/\f[] and a version The name can be optionally followed by a slash \f[C]/\f[R] and a version
of the implementation. of the implementation.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ install\ sbcl/1.2.14 $ ros install sbcl/1.2.14
\f[] \f[R]
.fi .fi
.PP .PP
There might be some \f[I]hidden\f[] implementation that are not listed There might be some \f[I]hidden\f[R] implementation that are not listed
here \-\-\- they are in the alpha quality, but try the one you like or here \[em] they are in the alpha quality, but try the one you like or
watch the website (https://github.com/roswell/roswell). watch the website (https://github.com/roswell/roswell).
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ install\ ccl $ ros install ccl
$\ ros\ install\ abcl $ ros install abcl
$\ ... $ ...
\f[] \f[R]
.fi .fi
.SH Installing a quicklisp system and the bundled roswell scripts .SH Installing a quicklisp system and the bundled roswell scripts
.PP .PP
@ -90,36 +86,36 @@ tries to find a quicklisp system of the given name.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ install\ alexandria $ ros install alexandria
\f[] \f[R]
.fi .fi
.PP .PP
After compiling and loading the system, it funcalls After compiling and loading the system, it funcalls
\f[C]ros:*build\-hook*\f[] special variable with no argument, if some \f[C]ros:*build\-hook*\f[R] special variable with no argument, if some
function is set during the compilation/load. function is set during the compilation/load.
.PP .PP
When the system comes with a \f[B]roswell script\f[] created by When the system comes with a \f[B]roswell script\f[R] created by
\f[I]ros\-init\f[](1) in the subdirectory \f[C]roswell\f[], they are \f[I]ros\-init\f[R](1) in the subdirectory \f[C]roswell\f[R], they are
installed into \f[B]ROSWELL_INSTALL_DIR/bin\f[]. installed into \f[B]ROSWELL_INSTALL_DIR/bin\f[R].
Setting the path to this directory makes those scripts available from Setting the path to this directory makes those scripts available from
the shell command line. the shell command line.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ install\ qlot $ ros install qlot
System\ \[aq]qlot\[aq]\ found.\ Loading\ the\ system.. System \[aq]qlot\[aq] found. Loading the system..
Processing\ build\-hook.. Processing build\-hook..
Found\ 1\ scripts:\ qlot Found 1 scripts: qlot
Attempting\ to\ install\ the\ scripts\ in\ roswell/\ subdirectory\ of\ the\ system... Attempting to install the scripts in roswell/ subdirectory of the system...
/home/user/.roswell/bin/qlot /home/user/.roswell/bin/qlot
$\ qlot $ qlot
Usage:\ qlot\ [install\ |\ update\ |\ bundle\ |\ exec\ shell\-args..] Usage: qlot [install | update | bundle | exec shell\-args..]
\f[] \f[R]
.fi .fi
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]sbcl\f[](1), \f[I]ros\f[](1), \f[I]ros\-list\f[](1), \f[I]sbcl\f[R](1), \f[I]ros\f[R](1), \f[I]ros\-list\f[R](1),
\f[I]ros\-init\f[](1) \f[I]ros\-init\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

18
documents/man/ros-list.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-list" "1" "" "" "" .TH "ros-list" "1" "" "" ""
.hy .hy
@ -6,35 +6,29 @@
ros\-list \- list the materials installed by roswell ros\-list \- list the materials installed by roswell
.SH Synopsis .SH Synopsis
.PP .PP
\f[B]ros list [type] [options]\f[] \f[B]ros list [type] [options]\f[R]
.SH Description .SH Description
.PP .PP
\f[B]ros list\f[] shows the list of the materials installed by roswell. \f[B]ros list\f[R] shows the list of the materials installed by roswell.
.TP .TP
.B installed [ [ IMPL | IMPL/VERSION ]...] .B installed [ [ IMPL | IMPL/VERSION ]\&...]
List the implementations that have been already installed. List the implementations that have been already installed.
Optionally providing IMPL shows the installed versions of the Optionally providing IMPL shows the installed versions of the
implementation. implementation.
.RS
.RE
.TP .TP
.B dump [IMPL] .B dump [IMPL]
List the internal dumped images that are compatible with IMPL. List the internal dumped images that are compatible with IMPL.
When IMPL is ommited, it is defaulted to the current lisp implementation When IMPL is ommited, it is defaulted to the current lisp implementation
in use. in use.
Images are in \f[C]$ROSWELL_INSTALL_DIR/impl/.../dump/\f[]. Images are in \f[C]$ROSWELL_INSTALL_DIR/impl/.../dump/\f[R].
.RS
.RE
.TP .TP
.B versions [IMPL] .B versions [IMPL]
List the installable versions for IMPL. List the installable versions for IMPL.
When IMPL is ommited, it is defaulted to the current lisp implementation When IMPL is ommited, it is defaulted to the current lisp implementation
in use. in use.
This feature is experimental. This feature is experimental.
.RS
.RE
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]sbcl\f[](1) \f[I]ros\f[](1) \f[I]sbcl\f[R](1) \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

8
documents/man/ros-run.1
View file

@ -1,17 +1,17 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-run" "1" "" "" "" .TH "ros-run" "1" "" "" ""
.hy .hy
.PP .PP
ros\-run \- start a REPL # Synopsis ros\-run \- start a REPL # Synopsis
.PP .PP
\f[B]ros [options] run\f[] \f[B]ros [options] run\f[R]
.SH Description .SH Description
.PP .PP
Processes the given options and start a REPL using the currently Processes the given options and start a REPL using the currently
effective lisp implementation set by \f[I]ros\-use\f[](1). effective lisp implementation set by \f[I]ros\-use\f[R](1).
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

22
documents/man/ros-serve.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-serve" "1" "" "" "" .TH "ros-serve" "1" "" "" ""
.hy .hy
@ -6,26 +6,22 @@
ros\-serve \- start lisp server ros\-serve \- start lisp server
.SH Synopsis .SH Synopsis
.PP .PP
\f[B]ros [options for roswell ... ] serve\f[] protocol [options for the \f[B]ros [options for roswell \&... ] serve\f[R] protocol [options for
protocol ...] ... the protocol \&...] \&...
.SH description .SH description
.PP .PP
\f[C]ros\-serve\f[] start lisp and wait for clients to connect to the \f[C]ros\-serve\f[R] start lisp and wait for clients to connect to the
lisp. lisp.
.SH swank protocol options .SH swank protocol options
.TP .TP
.B \f[C]\-\-port\ port\f[] .B \f[C]\-\-port port\f[R]
Listen port would be \f[C]port\f[] instead of the default port 4005. Listen port would be \f[C]port\f[R] instead of the default port 4005.
.RS
.RE
.TP .TP
.B \f[C]\-\-interface\ interface\f[] .B \f[C]\-\-interface interface\f[R]
limit interface for listen. limit interface for listen.
default is \f[C]localhost\f[] so there would be no limitation. default is \f[C]localhost\f[R] so there would be no limitation.
.RS
.RE
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\-client\f[](1) \f[I]ros\f[R](1) \f[I]ros\-client\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

14
documents/man/ros-setup.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-setup" "1" "" "" "" .TH "ros-setup" "1" "" "" ""
.hy .hy
@ -6,22 +6,22 @@
ros\-setup \- setup the backend of roswell ros\-setup \- setup the backend of roswell
.SH Synopsis .SH Synopsis
.PP .PP
\f[B]ros setup\f[] \f[B]ros setup\f[R]
.SH Description .SH Description
.PP .PP
\f[B]ros setup\f[] initializes roswell. \f[B]ros setup\f[R] initializes roswell.
The process includes the following steps: The process includes the following steps:
.IP \[bu] 2 .IP \[bu] 2
Downloading the default stable lisp implementation (sbcl\-bin) to Downloading the default stable lisp implementation (sbcl\-bin) to
\f[C]ROSWELL_INSTALL_DIR\f[]. \f[C]ROSWELL_INSTALL_DIR\f[R].
.IP \[bu] 2 .IP \[bu] 2
Installing quicklisp to \f[C]ROSWELL_INSTALL_DIR\f[]. Installing quicklisp to \f[C]ROSWELL_INSTALL_DIR\f[R].
.IP \[bu] 2 .IP \[bu] 2
On Windows, install 7zip to \f[C]ROSWELL_INSTALL_DIR\f[]. On Windows, install 7zip to \f[C]ROSWELL_INSTALL_DIR\f[R].
.IP \[bu] 2 .IP \[bu] 2
Making the core image of roswell itself. Making the core image of roswell itself.
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]sbcl\f[](1), \f[I]ros\f[](1), section Environmental Variables \f[I]sbcl\f[R](1), \f[I]ros\f[R](1), section Environmental Variables
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

202
documents/man/ros-template.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-template" "1" "" "" "" .TH "ros-template" "1" "" "" ""
.hy .hy
@ -6,253 +6,223 @@
ros\-template \- Edit template for ros\-init ros\-template \- Edit template for ros\-init
.SH synopsis .SH synopsis
.IP \[bu] 2 .IP \[bu] 2
\f[B]ros template\f[] command args... \f[B]ros template\f[R] command args\&...
.SH Subcommands .SH Subcommands
.TP .TP
.B init template\-name .B init template\-name
Create new template in local\-project directory. Create new template in local\-project directory.
.RS
.RE
.TP .TP
.B deinit template\-name .B deinit template\-name
Remove a template from local\-project directory. Remove a template from local\-project directory.
.RS
.RE
.TP .TP
.B list .B list
Show file list and states of the files \f[I]type\f[] \f[I]chmod\f[] Show file list and states of the files \f[I]type\f[R] \f[I]chmod\f[R]
\f[I]rewrite\f[] in templates. \f[I]rewrite\f[R] in templates.
.RS
.RE
.TP .TP
.B checkout [template\-name] .B checkout [template\-name]
When invoked without template\-name,this command shows candidates for When invoked without template\-name,this command shows candidates for
current templates to operate.If with template\-name, this command choose current templates to operate.If with template\-name, this command choose
the name as current template. the name as current template.
.RS
.RE
.TP .TP
.B add [template\-name] [files ...] .B add [template\-name] [files \&...]
Add files to current template.First parameter could taken as a Add files to current template.First parameter could taken as a
template\-name when current template are \f[I]default\f[]. template\-name when current template are \f[I]default\f[R].
.RS
.RE
.TP .TP
.B cat [template\-name] [files ...] .B cat [template\-name] [files \&...]
Show contents in the current template. Show contents in the current template.
.RS
.RE
.TP .TP
.B edit [template\-name] [files ...] .B edit [template\-name] [files \&...]
Edit content of files in template using \f[C]/usr/bin/editor\f[]. Edit content of files in template using \f[C]/usr/bin/editor\f[R].
.RS
.RE
.TP .TP
.B path [template\-name] [files ...] .B path [template\-name] [files \&...]
Show native path of files in template. Show native path of files in template.
.RS
.RE
.TP .TP
.B rm [template\-name] [files ...] .B rm [template\-name] [files \&...]
Remove file form current template. Remove file form current template.
.RS
.RE
.TP .TP
.B type [template\-name] [type] [files ...] .B type [template\-name] [type] [files \&...]
Change file type. Change file type.
current choice for \f[I]type\f[]s are \f[I]djula\f[] or \f[I]copy\f[] current choice for \f[I]type\f[R]s are \f[I]djula\f[R] or \f[I]copy\f[R]
{{name}} {{author}} {{email}} {{universal_time}} are available variable {{name}} {{author}} {{email}} {{universal_time}} are available variable
in the template file. in the template file.
Withoug files, change default type. Withoug files, change default type.
.RS
.RE
.TP .TP
.B chmod [template\-name] [mode] [files ...] .B chmod [template\-name] [mode] [files \&...]
Change file mode bits to generate. Change file mode bits to generate.
specify mode in octal format. specify mode in octal format.
.RS
.RE
.TP .TP
.B rewrite [template\-name] file rewrite\-rule .B rewrite [template\-name] file rewrite\-rule
Change file name using djula template.Variables {{name}} {{author}} Change file name using djula template.Variables {{name}} {{author}}
{{email}} {{universal_time}} are available for rewrite\-rule. {{email}} {{universal_time}} are available for rewrite\-rule.
.RS
.RE
.TP .TP
.B export [template\-name] [directory] .B export [template\-name] [directory]
Export files in current template to current directory. Export files in current template to current directory.
.RS
.RE
.TP .TP
.B import [directory] .B import [directory]
Import template in current directory Import template in current directory
.RS
.RE
.TP .TP
.B help .B help
Show the subcommand help. Show the subcommand help.
.RS
.RE
.SH Description .SH Description
.PP .PP
The \f[I]ros\-template\f[](1) command manages templates of projects. The \f[I]ros\-template\f[R](1) command manages templates of projects.
.SS Create template .SS Create template
.PP .PP
First, the \f[C]init\f[] sub\-command creates an empty template. First, the \f[C]init\f[R] sub\-command creates an empty template.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ template\ init\ sample\-template $ ros template init sample\-template
\f[] \f[R]
.fi .fi
.PP .PP
Many of sub\-commands take a template name as first argument. Many of sub\-commands take a template name as first argument.
But you can omit it by the \f[C]checkout\f[] sub\-commands. But you can omit it by the \f[C]checkout\f[R] sub\-commands.
After the following, such sub\-commands are applied to After the following, such sub\-commands are applied to
\f[C]sample\-template\f[]. \f[C]sample\-template\f[R].
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ template\ checkout\ sample\-template $ ros template checkout sample\-template
\f[] \f[R]
.fi .fi
.PP .PP
Next, the \f[C]add\f[] sub\-command adds local file[s] to template. Next, the \f[C]add\f[R] sub\-command adds local file[s] to template.
Then, the \f[C]list\f[] sub\-command shows information of files in Then, the \f[C]list\f[R] sub\-command shows information of files in
template. template.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ echo\ "Hello\ {{\ author\ }}!!"\ >\ sample.txt $ echo \[dq]Hello {{ author }}!!\[dq] > sample.txt
$\ ros\ template\ add\ sample.txt $ ros template add sample.txt
$\ ros\ template\ list $ ros template list
\ \ \ \ \ \ copy\ \ sample.txt\ copy sample.txt
\f[] \f[R]
.fi .fi
.PP .PP
The word \f[I]copy\f[] means a strategy when applying the template. The word \f[I]copy\f[R] means a strategy when applying the template.
There are the following 2 strategies. There are the following 2 strategies.
.IP \[bu] 2 .IP \[bu] 2
\f[I]copy\f[] simply copies the file as\-is. \f[I]copy\f[R] simply copies the file as\-is.
.IP \[bu] 2 .IP \[bu] 2
\f[I]djula\f[] processes the content of the file by template engine, \f[I]djula\f[R] processes the content of the file by template engine,
Djula (http://mmontone.github.io/djula/). Djula (http://mmontone.github.io/djula/).
.RS 2 .RS 2
.IP \[bu] 2 .IP \[bu] 2
Available variables are explained later. Available variables are explained later.
.RE .RE
.PP .PP
The \f[C]type\f[] sub\-command changes it. The \f[C]type\f[R] sub\-command changes it.
In addition, default strategy (\f[I]copy\f[]) can be changed for each In addition, default strategy (\f[I]copy\f[R]) can be changed for each
template by the \f[C]type\f[] sub\-command without file names (Ex. template by the \f[C]type\f[R] sub\-command without file names (Ex.
\f[C]ros\ template\ type\ djula\f[]). \f[C]ros template type djula\f[R]).
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ template\ type\ djula\ sample.txt $ ros template type djula sample.txt
$\ ros\ template\ list $ ros template list
\ \ \ \ \ \ djula\ sample.txt\ djula sample.txt
\f[] \f[R]
.fi .fi
.PP .PP
The \f[C]sample.txt\f[] will be simply output as \f[C]sample.txt\f[] in The \f[C]sample.txt\f[R] will be simply output as \f[C]sample.txt\f[R]
default. in default.
But you can change it by the \f[C]rewrite\f[] sub\-command. But you can change it by the \f[C]rewrite\f[R] sub\-command.
In the following example, it will be output as In the following example, it will be output as
\f[C]sample_<project\ name>.txt\f[]. \f[C]sample_<project name>.txt\f[R].
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ template\ rewrite\ sample.txt\ "sample\-{{\ name\ }}.txt" $ ros template rewrite sample.txt \[dq]sample\-{{ name }}.txt\[dq]
$\ ros\ template\ list $ ros template list
\ \ \ \ \ \ djula\ sample.txt\ \->\ "sample\-{{\ name\ }}.txt" djula sample.txt \-> \[dq]sample\-{{ name }}.txt\[dq]
\f[] \f[R]
.fi .fi
.PP .PP
Note: Rewrite rules are always processed by Djula irrespective of Note: Rewrite rules are always processed by Djula irrespective of
strategy of the file. strategy of the file.
.SS Apply template .SS Apply template
.PP .PP
\f[I]ros\-init\f[](1) can specify a template. \f[I]ros\-init\f[R](1) can specify a template.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ mkdir\ temp\ ;\ cd\ temp $ mkdir temp ; cd temp
$\ ros\ init\ sample\-template\ some\-project $ ros init sample\-template some\-project
$\ ls $ ls
sample\-some\-project.txt sample\-some\-project.txt
$\ cat\ sample\-some\-project.txt\ #\ Assume\ that\ "author"\ is\ "alien" $ cat sample\-some\-project.txt # Assume that \[dq]author\[dq] is \[dq]alien\[dq]
Hello\ alien!! Hello alien!!
\f[] \f[R]
.fi .fi
.PP .PP
The file name and its content are processed by Djula as explained in the The file name and its content are processed by Djula as explained in the
above. above.
The following variables can be used in defaut. The following variables can be used in defaut.
.IP \[bu] 2 .IP \[bu] 2
{{name}}: A project name specified in \f[I]ros\-init\f[](1) {{name}}: A project name specified in \f[I]ros\-init\f[R](1)
.IP \[bu] 2 .IP \[bu] 2
{{author}}: An author name extracted from config of Git or {{author}}: An author name extracted from config of Git or
\f[C]whoami\f[] \f[C]whoami\f[R]
.IP \[bu] 2 .IP \[bu] 2
{{email}}: An e\-mail address extracted from config of Git or created {{email}}: An e\-mail address extracted from config of Git or created
using \f[C]whoami\f[] and \f[C]hostname\f[] using \f[C]whoami\f[R] and \f[C]hostname\f[R]
.IP \[bu] 2 .IP \[bu] 2
{{universal_time}}: A universal time created by {{universal_time}}: A universal time created by
\f[C]get\-universal\-time\f[] function \f[C]get\-universal\-time\f[R] function
.PP .PP
In addition, you can use original variables as the followings. In addition, you can use original variables as the followings.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ echo\ "Hello\ {{\ area\ }}!!"\ >\ sample.txt $ echo \[dq]Hello {{ area }}!!\[dq] > sample.txt
$\ ros\ template\ add\ sample.txt\ #\ Note:\ It\ overwrites\ existing $ ros template add sample.txt # Note: It overwrites existing
$\ mkdir\ temp\ ;\ cd\ temp $ mkdir temp ; cd temp
$\ ros\ init\ sample\-template\ roswell\ \-\-area\ 51 $ ros init sample\-template roswell \-\-area 51
$\ cat\ sample\-roswell.txt $ cat sample\-roswell.txt
Hello\ 51!! Hello 51!!
\f[] \f[R]
.fi .fi
.SS Export and import template .SS Export and import template
.PP .PP
Basically, \f[I]ros\-template\f[](1) is designed to internally manage Basically, \f[I]ros\-template\f[R](1) is designed to internally manage
added files. added files.
.PP .PP
However, if you want to, for example, manage it using Git in a local However, if you want to, for example, manage it using Git in a local
directory or to install distributed templates, you can use the directory or to install distributed templates, you can use the
\f[C]export\f[] and \f[C]import\f[] sub\-commands. \f[C]export\f[R] and \f[C]import\f[R] sub\-commands.
.PP .PP
First, the \f[C]export\f[] sub\-command exports added files and a First, the \f[C]export\f[R] sub\-command exports added files and a
setting file \f[C]roswell.init.<template\ name>.asd\f[] that is setting file \f[C]roswell.init.<template name>.asd\f[R] that is
internally created and editted. internally created and editted.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ template\ export\ dir $ ros template export dir
$\ ls\ dir $ ls dir
roswell.init.sample\-template.asd\ \ sample.txt roswell.init.sample\-template.asd sample.txt
$\ cat\ dir/sample.txt $ cat dir/sample.txt
Hello\ {{\ area\ }}!! Hello {{ area }}!!
\f[] \f[R]
.fi .fi
.PP .PP
Second, the \f[C]import\f[] sub\-command imports them. Second, the \f[C]import\f[R] sub\-command imports them.
.IP .IP
.nf .nf
\f[C] \f[C]
#\ Assume\ that\ this\ is\ another\ machine... # Assume that this is another machine...
$\ ros\ template\ list\ sample\-template\ #\ nothing\ is\ output\ $ ros template list sample\-template # nothing is output
$\ ls\ downloaded $ ls downloaded
roswell.init.sample\-template.asd\ \ sample.txt roswell.init.sample\-template.asd sample.txt
$\ ros\ template\ import\ downloaded $ ros template import downloaded
$\ ros\ template\ list\ sample\-template $ ros template list sample\-template
\ \ \ \ \ \ djula\ sample.txt\ \->\ "sample\-{{\ name\ }}.txt" djula sample.txt \-> \[dq]sample\-{{ name }}.txt\[dq]
\f[] \f[R]
.fi .fi
.PP .PP
Note: If there is a template whose name is same, it will be overwritten. Note: If there is a template whose name is same, it will be overwritten.
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\-init\f[](1) \f[I]ros\f[R](1) \f[I]ros\-init\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

20
documents/man/ros-update.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-update" "1" "" "" "" .TH "ros-update" "1" "" "" ""
.hy .hy
@ -6,27 +6,23 @@
ros\-update \- Update system installed from vcs ros\-update \- Update system installed from vcs
.SH Synopsis .SH Synopsis
.IP \[bu] 2 .IP \[bu] 2
\f[B]ros update\f[] system [system ...] \f[B]ros update\f[R] system [system \&...]
.IP \[bu] 2 .IP \[bu] 2
\f[B]ros update\f[] method [params ...] \f[B]ros update\f[R] method [params \&...]
.SH Description .SH Description
.TP .TP
.B system .B system
a name specifying a system. a name specifying a system.
.RS
.RE
.TP .TP
.B method .B method
currently supported method is \f[C]git\f[]. currently supported method is \f[C]git\f[R].
.RS
.RE
.SH Update system .SH Update system
.PP .PP
When system are already installed and the system has \f[C]\&.git\f[] in When system are already installed and the system has \f[C].git\f[R] in
the system directory it invoke \f[C]git\ pull\f[] and the system directory it invoke \f[C]git pull\f[R] and
\f[C]ros\ install\f[] the system. \f[C]ros install\f[R] the system.
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1), \f[I]ros\-install\f[](1) \f[I]ros\f[R](1), \f[I]ros\-install\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

36
documents/man/ros-use.1
View file

@ -1,36 +1,36 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-use" "1" "" "" "" .TH "ros-use" "1" "" "" ""
.hy .hy
.PP .PP
ros\-use \- sets the default implementation used by roswell # synopsis ros\-use \- sets the default implementation used by roswell # synopsis
.PP .PP
\f[B]ros [options] use\f[] impl[/version] \f[B]ros [options] use\f[R] impl[/version]
.PP .PP
impl : The name of an implementation which is already installed. impl : The name of an implementation which is already installed.
New implementations can be downloaded by \f[I]ros\-install\f[](1). New implementations can be downloaded by \f[I]ros\-install\f[R](1).
The list of installed implementations is available in The list of installed implementations is available in
\f[I]ros\-list\f[](1). \f[I]ros\-list\f[R](1).
.PP .PP
version: : The version specifier. version: : The version specifier.
The string representation of the version (e.g. The string representation of the version (e.g.\ .) depends on each
.) depends on each implementation and roswell generally follows the implementation and roswell generally follows the representation used by
representation used by the implementation. the implementation.
In addition, \f[I]a special version name "system"\f[] tells roswell to In addition, \f[I]a special version name \[lq]system\[rq]\f[R] tells
use the implementation that is installed in your system, which should be roswell to use the implementation that is installed in your system,
in PATH. which should be in PATH.
.SH example .SH example
.PP .PP
ros use sbcl : use the latest SBCL among several versions of SBCLs ros use sbcl : use the latest SBCL among several versions of SBCLs
installed by \f[I]ros\-install\f[]. installed by \f[I]ros\-install\f[R].
This is compiled from the source, which may take some time to install This is compiled from the source, which may take some time to install
but allows SLIME to jump to the implementation source code. but allows SLIME to jump to the implementation source code.
.PP .PP
ros use sbcl\-bin : use the latest stable SBCL binary downloaded from ros use sbcl\-bin : use the latest stable SBCL binary downloaded from
vendor\[aq]s website. vendor\[cq]s website.
Roswell uses this by default. Roswell uses this by default.
\f[C]sbcl\-bin\f[] tends to be an older version compared to \f[C]sbcl\-bin\f[R] tends to be an older version compared to
\f[C]sbcl\f[], but surely newer than your \f[I]apt\-get\f[] installed \f[C]sbcl\f[R], but surely newer than your \f[I]apt\-get\f[R] installed
counterpart! counterpart!
.PP .PP
ros use sbcl/1.3.1 : use the compiled SBCL 1.3.1. ros use sbcl/1.3.1 : use the compiled SBCL 1.3.1.
@ -42,11 +42,11 @@ ros use sbcl/system : use the SBCL available in the PATH.
ros use ccl : use the CCL compiled from the source. ros use ccl : use the CCL compiled from the source.
Same set of version specifiers as for SBCL can be applied. Same set of version specifiers as for SBCL can be applied.
.PP .PP
Roswell also supports \f[I]abcl\f[], \f[I]acl\f[], \f[I]clisp\f[], Roswell also supports \f[I]abcl\f[R], \f[I]acl\f[R], \f[I]clisp\f[R],
\f[I]cmu\f[] and \f[I]ecl\f[]. \f[I]cmu\f[R] and \f[I]ecl\f[R].
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]sbcl\f[](1), \f[I]ros\f[](1), \f[I]ros\-install\f[](1), \f[I]sbcl\f[R](1), \f[I]ros\f[R](1), \f[I]ros\-install\f[R](1),
\f[I]ros\-list\f[](1) \f[I]ros\-list\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

10
documents/man/ros-wait.1
View file

@ -1,11 +1,11 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros-wait" "1" "" "" "" .TH "ros-wait" "1" "" "" ""
.hy .hy
.PP .PP
ros\-wait \- # synopsis ros\-wait \- # synopsis
.PP .PP
\f[B]ros [options] wait\f[] \f[B]ros [options] wait\f[R]
.SH Description .SH Description
.PP .PP
Wait forever after processing the options. Wait forever after processing the options.
@ -19,11 +19,11 @@ from the client.
.IP .IP
.nf .nf
\f[C] \f[C]
$\ ros\ \-sp\ clack\ \-l\ app.lisp\ \-e\ \[aq](clack:clackup)\[aq]\ wait $ ros \-sp clack \-l app.lisp \-e \[aq](clack:clackup)\[aq] wait
\f[] \f[R]
.fi .fi
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]ros\f[](1) \f[I]ros\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.

192
documents/man/ros.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 1.16.0.2 .\" Automatically generated by Pandoc 2.5
.\" .\"
.TH "ros" "1" "" "" "" .TH "ros" "1" "" "" ""
.hy .hy
@ -6,11 +6,11 @@
Roswell \- Common Lisp environment setup Utility Roswell \- Common Lisp environment setup Utility
.SH Synopsis .SH Synopsis
.IP \[bu] 2 .IP \[bu] 2
\f[B]ros\f[] [\f[B]options\f[]] \f[C][command\ [args...]\f[] \f[B]ros\f[R] [\f[B]options\f[R]] \f[C][command [args...]\f[R]
.IP \[bu] 2 .IP \[bu] 2
\f[B]ros\f[] [\f[B]options\f[]] \f[C][\-\-]script\ [args...]\f[] \f[B]ros\f[R] [\f[B]options\f[R]] \f[C][\-\-]script [args...]\f[R]
.IP \[bu] 2 .IP \[bu] 2
\f[B]ros\f[] [\f[B]options\f[]] < script.ros \f[B]ros\f[R] [\f[B]options\f[R]] < script.ros
.SH Description .SH Description
.PP .PP
Roswell is a command line tool for installing and managing Common Lisp Roswell is a command line tool for installing and managing Common Lisp
@ -20,7 +20,7 @@ ROSWELL\-SCRIPTS written in Common Lisp.
.PP .PP
Currently roswell supports sbcl, ccl, clisp and ecl as its supported Currently roswell supports sbcl, ccl, clisp and ecl as its supported
lisp implementations. lisp implementations.
For further details see \f[I]ros\-install\f[](1). For further details see \f[I]ros\-install\f[R](1).
.PP .PP
Scripts installed by roswell will be system wide if appropriate Scripts installed by roswell will be system wide if appropriate
directory is included in PATH. directory is included in PATH.
@ -29,241 +29,157 @@ directory is included in PATH.
In an order of utility/frequency. In an order of utility/frequency.
.TP .TP
.B install .B install
Install a given implementation (e.g. Install a given implementation (e.g.\ sbcl, ccl) or a system
sbcl, ccl) or a system (e.g. (e.g.\ alexandria) for roswell environment.
alexandria) for roswell environment. See \f[I]ros\-install\f[R](1).
See \f[I]ros\-install\f[](1).
.RS
.RE
.TP .TP
.B init [name[.ros]] .B init [name[.ros]]
Create a new ros script. Create a new ros script.
\f[C]\&.ros\f[] is optional, and is added automaticaly. \f[C].ros\f[R] is optional, and is added automaticaly.
See \f[I]ros\-init\f[]. See \f[I]ros\-init\f[R].
.RS
.RE
.TP .TP
.B dump [executable|output] [script] .B dump [executable|output] [script]
Dump an image of the script for the faster startup or to make an Dump an image of the script for the faster startup or to make an
executable. executable.
See \f[I]ros\-dump\f[]. See \f[I]ros\-dump\f[R].
.RS
.RE
.TP .TP
.B build .B build
Make an executable from the script. Make an executable from the script.
See \f[I]ros\-build\f[]. See \f[I]ros\-build\f[R].
.RS
.RE
.TP .TP
.B run .B run
Initiate REPL. Initiate REPL.
See \f[I]ros\-run\f[]. See \f[I]ros\-run\f[R].
.RS
.RE
.TP .TP
.B use .B use
Change the default implementation used by roswell. Change the default implementation used by roswell.
See \f[I]ros\-use\f[]. See \f[I]ros\-use\f[R].
.RS
.RE
.TP .TP
.B list .B list
List the various informations. List the various informations.
See \f[I]ros\-list\f[]. See \f[I]ros\-list\f[R].
.RS
.RE
.TP .TP
.B config .B config
Get and set the options. Get and set the options.
See \f[I]ros\-config\f[]. See \f[I]ros\-config\f[R].
.RS
.RE
.TP .TP
.B setup .B setup
Run the initial setup. Run the initial setup.
See \f[I]ros\-setup\f[]. See \f[I]ros\-setup\f[R].
.RS
.RE
.TP .TP
.B emacs .B emacs
Launch emacs with slime. Launch emacs with slime.
See \f[I]ros\-emacs\f[]. See \f[I]ros\-emacs\f[R].
.RS
.RE
.TP .TP
.B wait .B wait
Wait forever, used for daemonizing the script. Wait forever, used for daemonizing the script.
See \f[I]ros\-wait\f[]. See \f[I]ros\-wait\f[R].
.RS
.RE
.TP .TP
.B delete .B delete
Delete an installed implementation. Delete an installed implementation.
See \f[I]ros\-delete\f[]. See \f[I]ros\-delete\f[R].
.RS
.RE
.TP .TP
.B version .B version
Show the roswell version information. Show the roswell version information.
See \f[I]ros\-version\f[]. See \f[I]ros\-version\f[R].
.RS
.RE
.TP .TP
.B help .B help
Show the subcommand help. Show the subcommand help.
.RS
.RE
.SH Options .SH Options
.PP .PP
Options are processed in left\-to\-right order. Options are processed in left\-to\-right order.
.TP .TP
.B \-w CODE \-\-wrap CODE .B \-w CODE \[en]wrap CODE
Run the script with a shell wrapper CODE, e.g. Run the script with a shell wrapper CODE, e.g.\ rlwrap
rlwrap
.RS
.RE
.TP .TP
.B \-m IMAGE \-\-image IMAGE .B \-m IMAGE \[en]image IMAGE
Continue from Lisp image IMAGE Continue from Lisp image IMAGE
.RS
.RE
.TP .TP
.B \-L NAME \-\-lisp NAME .B \-L NAME \[en]lisp NAME
Run the script with a lisp impl NAME[/VERSION] if present, e.g. Run the script with a lisp impl NAME[/VERSION] if present,
sbcl\-bin, sbcl/1.2.16. e.g.\ sbcl\-bin, sbcl/1.2.16.
Fails otherwise. Fails otherwise.
.RS
.RE
.TP .TP
.B \-l FILE \-\-load FILE .B \-l FILE \[en]load FILE
Load a lisp file FILE while building Load a lisp file FILE while building
.RS
.RE
.TP .TP
.B \-S X \-\-source\-registry X .B \-S X \[en]source\-registry X
Override the source registry of asdf systems. Override the source registry of asdf systems.
.RS
.RE
.TP .TP
.B \-s SYSTEM \-\-system SYSTEM .B \-s SYSTEM \[en]system SYSTEM
Load the asdf SYSTEM while building. Load the asdf SYSTEM while building.
.RS
.RE
.TP .TP
.B \-\-load\-system SYSTEM .B \[en]load\-system SYSTEM
Same as above (buildapp compatibility) Same as above (buildapp compatibility)
.RS
.RE
.TP .TP
.B \-p PACKAGE \-\-package PACKAGE .B \-p PACKAGE \[en]package PACKAGE
Change the current package to PACKAGE Change the current package to PACKAGE
.RS
.RE
.TP .TP
.B \-sp SP \-\-system\-package SP .B \-sp SP \[en]system\-package SP
Combination of \-s SP and \-p SP Combination of \-s SP and \-p SP
.RS
.RE
.TP .TP
.B \-e FORM \-\-eval FORM .B \-e FORM \[en]eval FORM
Evaluate FORM while building Evaluate FORM while building
.RS
.RE
.TP .TP
.B \-\-require MODULE .B \[en]require MODULE
require MODULE while building require MODULE while building
.RS
.RE
.TP .TP
.B \-q \-\-quit .B \-q \[en]quit
quit lisp here quit lisp here
.RS
.RE
.TP .TP
.B \-r FUNC \-\-restart FUNC .B \-r FUNC \[en]restart FUNC
the build image restarts from calling FUNC the build image restarts from calling FUNC
.RS
.RE
.TP .TP
.B \-E FUNC \-\-entry FUNC .B \-E FUNC \[en]entry FUNC
the build image restarts from calling (FUNC argv). the build image restarts from calling (FUNC argv).
.RS
.RE
.TP .TP
.B \-i FORM \-\-init FORM .B \-i FORM \[en]init FORM
evaluate FORM after the restart. evaluate FORM after the restart.
.RS
.RE
.TP .TP
.B \-ip FORM \-\-print FORM .B \-ip FORM \[en]print FORM
evaluate and princ FORM after the restart evaluate and princ FORM after the restart
.RS
.RE
.TP .TP
.B \-iw FORM \-\-write FORM .B \-iw FORM \[en]write FORM
evaluate and write FORM after the restart evaluate and write FORM after the restart
.RS
.RE
.TP .TP
.B \-F FORM \-\-final FORM .B \-F FORM \[en]final FORM
evaluate FORM before dumping the IMAGE evaluate FORM before dumping the IMAGE
.RS
.RE
.TP .TP
.B \-R \-\-rc .B \-R \[en]rc
try to read /etc/rosrc, ~/.roswell/init.lisp try to read /etc/rosrc, \[ti]/.roswell/init.lisp
.RS
.RE
.TP .TP
.B +R \-\-no\-rc .B +R \[en]no\-rc
skip /etc/rosrc, ~/.roswell/init.lisp skip /etc/rosrc, \[ti]/.roswell/init.lisp
.RS
.RE
.TP .TP
.B \-Q \-\-quicklisp .B \-Q \[en]quicklisp
load quicklisp (default) load quicklisp (default)
.RS
.RE
.TP .TP
.B +Q \-\-no\-quicklisp .B +Q \[en]no\-quicklisp
do not load quicklisp do not load quicklisp
.RS
.RE
.TP .TP
.B \-v \-\-verbose .B \-v \[en]verbose
be quite verbose while building be quite verbose while building
.RS
.RE
.TP .TP
.B \-\-quiet .B \[en]quiet
suppress output while building (default) suppress output while building (default)
.RS
.RE
.TP .TP
.B \-\-test .B \[en]test
for test purpose for test purpose
.RS
.RE
.TP .TP
.B dynamic\-space\-size=[size in MB] .B dynamic\-space\-size=[size in MB]
SBCL specific. SBCL specific.
The argument is passed to SBCL by \f[C]\-\-dynamic\-space\-size\f[] The argument is passed to SBCL by \f[C]\-\-dynamic\-space\-size\f[R]
.RS
.RE
.SH Environmental Variables .SH Environmental Variables
.TP .TP
.B ROSWELL_HOME .B ROSWELL_HOME
Specifies the home directory of roswell, defaulted to $HOME on Unix Specifies the home directory of roswell, defaulted to $HOME on Unix
platform . platform .
.RS
.RE
.SH Bugs .SH Bugs
.PP .PP
Check out issues list (https://github.com/roswell/roswell/issues) Check out issues list (https://github.com/roswell/roswell/issues)
.SH SEE ALSO .SH SEE ALSO
.PP .PP
\f[I]sbcl\f[](1) \f[I]ros\-dump\f[](1) \f[I]ros\-init\f[](1) \f[I]sbcl\f[R](1) \f[I]ros\-dump\f[R](1) \f[I]ros\-init\f[R](1)
\f[I]ros\-install\f[](1) \f[I]ros\-list\f[](1) \f[I]ros\-setup\f[](1) \f[I]ros\-install\f[R](1) \f[I]ros\-list\f[R](1) \f[I]ros\-setup\f[R](1)
.SH AUTHORS .SH AUTHORS
Roswell Project Team. Roswell Project Team.