mirror of
https://github.com/roswell/roswell.git
synced 2026-09-10 07:16:17 -04:00
[ci skip] documents update
This commit is contained in:
github actions
parent
22a9e923ed
commit
1c8e46de17
|
|
@ -18,7 +18,7 @@
|
|||
<li class="author">Roswell Project Team</li>
|
||||
</ul>
|
||||
</header>
|
||||
<p>ros-build - Shortcut to "ros dump executable" # synopsis</p>
|
||||
<p>ros-build - Shortcut to “ros dump executable” # synopsis</p>
|
||||
<p><strong>ros [options] build</strong> <file></p>
|
||||
<p>Equivalent to calling <code>ros dump executable <file></code>.</p>
|
||||
<!-- # subcommands -->
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@
|
|||
</ul>
|
||||
</header>
|
||||
<p>ros-checkout - # synopsis</p>
|
||||
<p><strong>ros [options] checkout</strong> args...</p>
|
||||
<p><strong>ros [options] checkout</strong> args…</p>
|
||||
<!-- # subcommands -->
|
||||
<!-- somecommand -->
|
||||
<!-- : description. end with a period. -->
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@
|
|||
</header>
|
||||
<p>ros-client - one-shot connect to remote repl.</p>
|
||||
<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 -->
|
||||
<!-- somecommand -->
|
||||
<!-- : description. end with a period. -->
|
||||
|
|
@ -34,7 +34,7 @@
|
|||
<dt><code>--interface interface</code></dt>
|
||||
<dd><p>interface for connect. default is <code>localhost</code>.</p>
|
||||
</dd>
|
||||
<dt>-e FORM --eval FORM</dt>
|
||||
<dt>-e FORM –eval FORM</dt>
|
||||
<dd><p>Evaluate FORM while building</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
|
|
|||
|
|
@ -19,9 +19,9 @@
|
|||
</ul>
|
||||
</header>
|
||||
<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>
|
||||
<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>
|
||||
<dt>show TARGET</dt>
|
||||
<dd><p>show TARGET.</p>
|
||||
|
|
|
|||
|
|
@ -19,14 +19,14 @@
|
|||
</ul>
|
||||
</header>
|
||||
<p>ros-delete - # synopsis</p>
|
||||
<p><strong>ros delete</strong> ARGS...</p>
|
||||
<p><strong>ros delete</strong> ARGS…</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>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>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>
|
||||
<!-- somecommand -->
|
||||
<!-- : description. end with a period. -->
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@
|
|||
</ul>
|
||||
</header>
|
||||
<p>ros-dist - # synopsis</p>
|
||||
<p><strong>ros [options] dist</strong> args...</p>
|
||||
<p><strong>ros [options] dist</strong> args…</p>
|
||||
<!-- # subcommands -->
|
||||
<!-- somecommand -->
|
||||
<!-- : description. end with a period. -->
|
||||
|
|
|
|||
|
|
@ -20,11 +20,11 @@
|
|||
</header>
|
||||
<p>ros-dump - make a dumped image of a roswell script</p>
|
||||
<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>
|
||||
<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>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 -->
|
||||
<!-- There might be a limitation regarding this feature depending on the lisp -->
|
||||
<!-- 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>Reduction options are processed in the left-to-right manner.</p>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<dt>--destroy-packages-sbcl</dt>
|
||||
<dd><p>This is an sbcl-specific option which is even more aggressive than the above methods (>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>
|
||||
<dt>–destroy-packages-sbcl</dt>
|
||||
<dd><p>This is an sbcl-specific option which is even more aggressive than the above methods (>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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
<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>
|
||||
</dl>
|
||||
|
|
|
|||
|
|
@ -19,7 +19,7 @@
|
|||
</ul>
|
||||
</header>
|
||||
<p>ros-emacs - launch Emacs with Slime # Synopsis</p>
|
||||
<p><strong>ros emacs</strong> [ARGS...]</p>
|
||||
<p><strong>ros emacs</strong> [ARGS…]</p>
|
||||
<!-- # subcommands -->
|
||||
<!-- somecommand -->
|
||||
<!-- : description. end with a period. -->
|
||||
|
|
|
|||
|
|
@ -20,14 +20,14 @@
|
|||
</header>
|
||||
<p>ros-init - Create a roswell script (optionally based on a template)</p>
|
||||
<h1 id="synopsis">Synopsis</h1>
|
||||
<p><strong>ros init [TEMPLATE] NAME [ARGS...]]</strong></p>
|
||||
<p><strong>ros init [TEMPLATE] NAME [ARGS…]]</strong></p>
|
||||
<dl>
|
||||
<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>
|
||||
<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>
|
||||
<dt>NAME</dt>
|
||||
<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><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>
|
||||
</dl>
|
||||
<!-- # subcommands -->
|
||||
|
|
|
|||
|
|
@ -21,8 +21,8 @@
|
|||
<p>ros-install - Install lisp implementations or quicklisp system</p>
|
||||
<h1 id="synopsis">Synopsis</h1>
|
||||
<ul>
|
||||
<li><strong>ros install</strong> system [system ...]</li>
|
||||
<li><strong>ros install</strong> impl[/version] [param ...]</li>
|
||||
<li><strong>ros install</strong> system [system …]</li>
|
||||
<li><strong>ros install</strong> impl[/version] [param …]</li>
|
||||
</ul>
|
||||
<h1 id="description">Description</h1>
|
||||
<dl>
|
||||
|
|
@ -52,7 +52,7 @@ ccl-bin
|
|||
sbcl-bin</code></pre>
|
||||
<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>
|
||||
<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
|
||||
$ ros install abcl
|
||||
$ ...</code></pre>
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@
|
|||
<h1 id="description">Description</h1>
|
||||
<p><strong>ros list</strong> shows the list of the materials installed by roswell.</p>
|
||||
<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>
|
||||
<dt>dump [IMPL]</dt>
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@
|
|||
</header>
|
||||
<p>ros-serve - start lisp server</p>
|
||||
<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 -->
|
||||
<!-- somecommand -->
|
||||
<!-- : description. end with a period. -->
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@
|
|||
<p>ros-template - Edit template for ros-init</p>
|
||||
<h1 id="synopsis">synopsis</h1>
|
||||
<ul>
|
||||
<li><strong>ros template</strong> command args...</li>
|
||||
<li><strong>ros template</strong> command args…</li>
|
||||
</ul>
|
||||
<h1 id="subcommands">Subcommands</h1>
|
||||
<dl>
|
||||
|
|
@ -37,25 +37,25 @@
|
|||
<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>
|
||||
<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>
|
||||
<dt>cat [template-name] [files ...]</dt>
|
||||
<dt>cat [template-name] [files …]</dt>
|
||||
<dd><p>Show contents in the current template.</p>
|
||||
</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>
|
||||
<dt>path [template-name] [files ...]</dt>
|
||||
<dt>path [template-name] [files …]</dt>
|
||||
<dd><p>Show native path of files in template.</p>
|
||||
</dd>
|
||||
<dt>rm [template-name] [files ...]</dt>
|
||||
<dt>rm [template-name] [files …]</dt>
|
||||
<dd><p>Remove file form current template.</p>
|
||||
</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>
|
||||
<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>
|
||||
<dt>rewrite [template-name] file rewrite-rule</dt>
|
||||
|
|
|
|||
|
|
@ -21,8 +21,8 @@
|
|||
<p>ros-update - Update system installed from vcs</p>
|
||||
<h1 id="synopsis">Synopsis</h1>
|
||||
<ul>
|
||||
<li><strong>ros update</strong> system [system ...]</li>
|
||||
<li><strong>ros update</strong> method [params ...]</li>
|
||||
<li><strong>ros update</strong> system [system …]</li>
|
||||
<li><strong>ros update</strong> method [params …]</li>
|
||||
</ul>
|
||||
<h1 id="description">Description</h1>
|
||||
<dl>
|
||||
|
|
|
|||
|
|
@ -21,10 +21,10 @@
|
|||
<p>ros-use - sets the default implementation used by roswell # synopsis</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>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>
|
||||
<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>
|
||||
<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-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>
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@
|
|||
<p>In an order of utility/frequency.</p>
|
||||
<dl>
|
||||
<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>
|
||||
<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>
|
||||
|
|
@ -78,79 +78,79 @@
|
|||
<h1 id="options">Options</h1>
|
||||
<p>Options are processed in left-to-right order.</p>
|
||||
<dl>
|
||||
<dt>-w CODE --wrap CODE</dt>
|
||||
<dd><p>Run the script with a shell wrapper CODE, e.g. rlwrap</p>
|
||||
<dt>-w CODE –wrap CODE</dt>
|
||||
<dd><p>Run the script with a shell wrapper CODE, e.g. rlwrap</p>
|
||||
</dd>
|
||||
<dt>-m IMAGE --image IMAGE</dt>
|
||||
<dt>-m IMAGE –image IMAGE</dt>
|
||||
<dd><p>Continue from Lisp image IMAGE</p>
|
||||
</dd>
|
||||
<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>
|
||||
<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>
|
||||
<dt>-l FILE --load FILE</dt>
|
||||
<dt>-l FILE –load FILE</dt>
|
||||
<dd><p>Load a lisp file FILE while building</p>
|
||||
</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>
|
||||
<dt>-s SYSTEM --system SYSTEM</dt>
|
||||
<dt>-s SYSTEM –system SYSTEM</dt>
|
||||
<dd><p>Load the asdf SYSTEM while building.</p>
|
||||
</dd>
|
||||
<dt>--load-system SYSTEM</dt>
|
||||
<dt>–load-system SYSTEM</dt>
|
||||
<dd><p>Same as above (buildapp compatibility)</p>
|
||||
</dd>
|
||||
<dt>-p PACKAGE --package PACKAGE</dt>
|
||||
<dt>-p PACKAGE –package PACKAGE</dt>
|
||||
<dd><p>Change the current package to PACKAGE</p>
|
||||
</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>
|
||||
<dt>-e FORM --eval FORM</dt>
|
||||
<dt>-e FORM –eval FORM</dt>
|
||||
<dd><p>Evaluate FORM while building</p>
|
||||
</dd>
|
||||
<dt>--require MODULE</dt>
|
||||
<dt>–require MODULE</dt>
|
||||
<dd><p>require MODULE while building</p>
|
||||
</dd>
|
||||
<dt>-q --quit</dt>
|
||||
<dt>-q –quit</dt>
|
||||
<dd><p>quit lisp here</p>
|
||||
</dd>
|
||||
<dt>-r FUNC --restart FUNC</dt>
|
||||
<dt>-r FUNC –restart FUNC</dt>
|
||||
<dd><p>the build image restarts from calling FUNC</p>
|
||||
</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>
|
||||
<dt>-i FORM --init FORM</dt>
|
||||
<dt>-i FORM –init FORM</dt>
|
||||
<dd><p>evaluate FORM after the restart.</p>
|
||||
</dd>
|
||||
<dt>-ip FORM --print FORM</dt>
|
||||
<dt>-ip FORM –print FORM</dt>
|
||||
<dd><p>evaluate and princ FORM after the restart</p>
|
||||
</dd>
|
||||
<dt>-iw FORM --write FORM</dt>
|
||||
<dt>-iw FORM –write FORM</dt>
|
||||
<dd><p>evaluate and write FORM after the restart</p>
|
||||
</dd>
|
||||
<dt>-F FORM --final FORM</dt>
|
||||
<dt>-F FORM –final FORM</dt>
|
||||
<dd><p>evaluate FORM before dumping the IMAGE</p>
|
||||
</dd>
|
||||
<dt>-R --rc</dt>
|
||||
<dt>-R –rc</dt>
|
||||
<dd><p>try to read /etc/rosrc, ~/.roswell/init.lisp</p>
|
||||
</dd>
|
||||
<dt>+R --no-rc</dt>
|
||||
<dt>+R –no-rc</dt>
|
||||
<dd><p>skip /etc/rosrc, ~/.roswell/init.lisp</p>
|
||||
</dd>
|
||||
<dt>-Q --quicklisp</dt>
|
||||
<dt>-Q –quicklisp</dt>
|
||||
<dd><p>load quicklisp (default)</p>
|
||||
</dd>
|
||||
<dt>+Q --no-quicklisp</dt>
|
||||
<dt>+Q –no-quicklisp</dt>
|
||||
<dd><p>do not load quicklisp</p>
|
||||
</dd>
|
||||
<dt>-v --verbose</dt>
|
||||
<dt>-v –verbose</dt>
|
||||
<dd><p>be quite verbose while building</p>
|
||||
</dd>
|
||||
<dt>--quiet</dt>
|
||||
<dt>–quiet</dt>
|
||||
<dd><p>suppress output while building (default)</p>
|
||||
</dd>
|
||||
<dt>--test</dt>
|
||||
<dt>–test</dt>
|
||||
<dd><p>for test purpose</p>
|
||||
</dd>
|
||||
<dt>dynamic-space-size=[size in MB]</dt>
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-asdf" "1" "January 2022" "" ""
|
||||
.hy
|
||||
|
|
@ -7,13 +7,13 @@
|
|||
ros\-asdf \-
|
||||
.SH SYNOPSIS
|
||||
.PP
|
||||
\f[B]ros [options] asdf [subcommand]\f[]
|
||||
\f[B]ros [options] asdf [subcommand]\f[R]
|
||||
.SH DESCRIPTION
|
||||
.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/).
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[I]ros\f[](1)
|
||||
\f[I]ros\f[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,16 +1,16 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-build" "1" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
ros\-build \- Shortcut to "ros dump executable" # synopsis
|
||||
ros\-build \- Shortcut to \[lq]ros dump executable\[rq] # synopsis
|
||||
.PP
|
||||
\f[B]ros [options] build\f[]
|
||||
\f[B]ros [options] build\f[R]
|
||||
.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 SEE ALSO
|
||||
.PP
|
||||
\f[I]ros\f[](1)
|
||||
\f[I]ros\f[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,16 +1,16 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-checkout" "1" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
ros\-checkout \- # synopsis
|
||||
.PP
|
||||
\f[B]ros [options] checkout\f[] args...
|
||||
\f[B]ros [options] checkout\f[R] args\&...
|
||||
.SH description
|
||||
.PP
|
||||
to enable this command ros install roswell/ql\-checkout is needed.
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[I]ros\f[](1)
|
||||
\f[I]ros\f[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-client" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,31 +6,25 @@
|
|||
ros\-client \- one\-shot connect to remote repl.
|
||||
.SH synopsis
|
||||
.PP
|
||||
\f[B]ros client\f[] protocol [options for the protocol ...] ...
|
||||
\f[B]ros client\f[R] protocol [options for the protocol \&...] \&...
|
||||
.SH description
|
||||
.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.
|
||||
.SH swank protocol options
|
||||
.TP
|
||||
.B \f[C]\-\-port\ port\f[]
|
||||
set server \f[C]port\f[] to connect.
|
||||
.B \f[C]\-\-port port\f[R]
|
||||
set server \f[C]port\f[R] to connect.
|
||||
default port 4005.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \f[C]\-\-interface\ interface\f[]
|
||||
.B \f[C]\-\-interface interface\f[R]
|
||||
interface for connect.
|
||||
default is \f[C]localhost\f[].
|
||||
.RS
|
||||
.RE
|
||||
default is \f[C]localhost\f[R].
|
||||
.TP
|
||||
.B \-e FORM \-\-eval FORM
|
||||
.B \-e FORM \[en]eval FORM
|
||||
Evaluate FORM while building
|
||||
.RS
|
||||
.RE
|
||||
.SH SEE ALSO
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,26 +1,22 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-config" "1" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
ros\-config \- get and set options # Synopsis
|
||||
.PP
|
||||
\f[B]ros [options] config\f[] [SUBCOMMAND ARGS...]
|
||||
\f[B]ros [options] config\f[R] [SUBCOMMAND ARGS\&...]
|
||||
.SH Description
|
||||
.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
|
||||
.B show TARGET
|
||||
show TARGET.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B set TARGET VALUE
|
||||
set the VALUE to the TARGET.
|
||||
.RS
|
||||
.RE
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[I]ros\f[](1)
|
||||
\f[I]ros\f[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,16 +1,16 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-delete" "1" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
ros\-delete \- # synopsis
|
||||
.PP
|
||||
\f[B]ros delete\f[] ARGS...
|
||||
\f[B]ros delete\f[R] ARGS\&...
|
||||
.PP
|
||||
Slightly complex arguments.
|
||||
.SS ros delete dump IMAGES...
|
||||
.SS ros delete dump IMAGES\&...
|
||||
.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.
|
||||
It then deletes the image with the given name, if it exists.
|
||||
.PP
|
||||
|
|
@ -18,20 +18,19 @@ 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
|
||||
\f[C]ros\ delete\ dump\ X\f[] removes sbcl\-bin/1.3.1/X only.
|
||||
.SS ros delete IMPLS...
|
||||
\f[C]ros delete dump X\f[R] removes sbcl\-bin/1.3.1/X only.
|
||||
.SS ros delete IMPLS\&...
|
||||
.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.
|
||||
.PP
|
||||
If a name of some implementation is given without version specifiers,
|
||||
e.g.
|
||||
sbcl\-bin, then it removes all instances (versions) of sbcl\-bin.
|
||||
e.g.\ sbcl\-bin, then it removes all instances (versions) of sbcl\-bin.
|
||||
.PP
|
||||
If a version is specified, then it removes only the specified instance.
|
||||
.SH description
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[I]ros\f[](1)
|
||||
\f[I]ros\f[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-dist" "1" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
ros\-dist \- # synopsis
|
||||
.PP
|
||||
\f[B]ros [options] dist\f[] args...
|
||||
\f[B]ros [options] dist\f[R] args\&...
|
||||
.SH description
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[I]ros\f[](1)
|
||||
\f[I]ros\f[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-dump" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,67 +6,65 @@
|
|||
ros\-dump \- make a dumped image of a roswell script
|
||||
.SH Synopsis
|
||||
.PP
|
||||
\f[B]ros [OPTIONS1...] dump [OPTIONS2...] MODE\f[] args...
|
||||
\f[B]ros [OPTIONS1\&...] dump [OPTIONS2\&...] MODE\f[R] args\&...
|
||||
.PP
|
||||
\f[C]OPTIONS1\f[] specify the standard roswell options such as
|
||||
\f[C]\-L\f[] or \f[C]\-m\ LISP\f[].
|
||||
\f[C]OPTIONS2\f[] specify the image reduction options we describe later.
|
||||
\f[C]MODE\f[] is either \f[C]output\f[] or \f[C]executable\f[].
|
||||
\f[C]OPTIONS1\f[R] specify the standard roswell options such as
|
||||
\f[C]\-L\f[R] or \f[C]\-m LISP\f[R].
|
||||
\f[C]OPTIONS2\f[R] specify the image reduction options we describe
|
||||
later.
|
||||
\f[C]MODE\f[R] is either \f[C]output\f[R] or \f[C]executable\f[R].
|
||||
.SH Description
|
||||
.PP
|
||||
\f[C]ros\-dump\f[] creates a dumped lisp image of the state after
|
||||
processing all options \f[C]OPTIONS1\f[].
|
||||
\f[C]ros\-dump\f[R] creates a dumped lisp image of the state after
|
||||
processing all options \f[C]OPTIONS1\f[R].
|
||||
.PP
|
||||
It has two modes \f[C]output\f[] and \f[C]executable\f[].
|
||||
In both modes, the global environment (e.g.
|
||||
global binding to special variables such as \f[C]*package*\f[]) of the
|
||||
state just after the restart is the environment which was effective when
|
||||
the script was dumped.
|
||||
It has two modes \f[C]output\f[R] and \f[C]executable\f[R].
|
||||
In both modes, the global environment (e.g.\ global binding to special
|
||||
variables such as \f[C]*package*\f[R]) of the state just after the
|
||||
restart is the environment which was effective when the script was
|
||||
dumped.
|
||||
.PP
|
||||
The dumped image is generally not compatible between the different
|
||||
implementations, and also between the versions.
|
||||
.SH Dump modes
|
||||
.SS output [\-f] [\-o OUTPUT] NAME
|
||||
.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.
|
||||
.PP
|
||||
The image file is by default written to an internal directory of roswell
|
||||
in an organized manner, i.e., somewhere under
|
||||
\f[C]$ROSWELL_INSTALL_DIR\f[] deduced by the current implementation, its
|
||||
version and the given NAME.
|
||||
\f[C]$ROSWELL_INSTALL_DIR\f[R] deduced by the current implementation,
|
||||
its version and the given NAME.
|
||||
.PP
|
||||
When the output file already exists, the command fails with an error
|
||||
code.
|
||||
.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
|
||||
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.
|
||||
.TP
|
||||
.B \f[C]\-o\ OUTPUT\f[]
|
||||
The image is written to \f[C]OUTPUT\f[] instead of the default location.
|
||||
.RS
|
||||
.RE
|
||||
.B \f[C]\-o OUTPUT\f[R]
|
||||
The image is written to \f[C]OUTPUT\f[R] instead of the default
|
||||
location.
|
||||
.TP
|
||||
.B \f[C]\-f\f[]
|
||||
.B \f[C]\-f\f[R]
|
||||
Force output when the output already exists.
|
||||
.RS
|
||||
.RE
|
||||
.SS executable NAME [\-o OUTPUT]
|
||||
.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
|
||||
\f[C]\-\-restart\ main\f[].
|
||||
\f[C]\-\-restart main\f[R].
|
||||
.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.
|
||||
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.
|
||||
On Windows and if \f[C]SCRIPT\f[] has \f[C]\&.ros\f[] extension, the
|
||||
filename will be \f[C]SCRIPT.exe\f[].
|
||||
On the other systems, the result will be \f[C]SCRIPT\f[] (without
|
||||
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[R].
|
||||
On the other systems, the result will be \f[C]SCRIPT\f[R] (without
|
||||
extension).
|
||||
.PP
|
||||
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
|
||||
conforming programs.
|
||||
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
|
||||
Reduction options are processed in the left\-to\-right manner.
|
||||
.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
|
||||
SBCL.
|
||||
Thus this option is meaningful only on SBCL.
|
||||
Compression is enabled by default.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-\-remove\-docstrings
|
||||
.B \[en]remove\-docstrings
|
||||
This option removes all docstrings from all symbols in the entire lisp
|
||||
image.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-\-delete\-package PKG
|
||||
.B \[en]delete\-package PKG
|
||||
This option can be specified multiple times.
|
||||
It uninterns the symbols in PACKAGE, calls \f[C]makeunbound\f[] and
|
||||
\f[C]fmakeunbound\f[] on each symbol and deletes the package.
|
||||
Package names are automatically string\-upcase\[aq]d.
|
||||
.RS
|
||||
.RE
|
||||
It uninterns the symbols in PACKAGE, calls \f[C]makeunbound\f[R] and
|
||||
\f[C]fmakeunbound\f[R] on each symbol and deletes the package.
|
||||
Package names are automatically string\-upcase\[cq]d.
|
||||
.TP
|
||||
.B \-\-delete\-all\-packages
|
||||
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).
|
||||
.RS
|
||||
.RE
|
||||
.B \[en]delete\-all\-packages
|
||||
This option applies \[en]delete\-package PKG on all packages, except
|
||||
some blacklisted packages (keyword, roswell, ROS.SCRIPT.DUMP, and the
|
||||
package of the main function symbol).
|
||||
.TP
|
||||
.B \-\-delete\-packages\-except PACKAGE
|
||||
.B \[en]delete\-packages\-except PACKAGE
|
||||
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\[aq]d.
|
||||
.RS
|
||||
.RE
|
||||
It is identical to \[en]delete\-all\-packages except that it adds
|
||||
PACKAGE to the blacklist.
|
||||
Package names are automatically string\-upcase\[cq]d.
|
||||
.TP
|
||||
.B \-\-destroy\-packages\-sbcl
|
||||
.B \[en]destroy\-packages\-sbcl
|
||||
This is an sbcl\-specific option which is even more aggressive than the
|
||||
above methods (>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.
|
||||
The blacklist is shared among \[en]delete\-all\-packages and
|
||||
\[en]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).
|
||||
.RS
|
||||
.RE
|
||||
last method (i.e.\ rightmost).
|
||||
.TP
|
||||
.B \-\-purify, \-\-no\-purify
|
||||
.B \[en]purify, \[en]no\-purify
|
||||
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.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-\-impurify, \-\-no\-impurify
|
||||
.B \[en]impurify, \[en]no\-impurify
|
||||
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\[aq]ed.
|
||||
This allows the static\-space objects to be GC\[cq]ed.
|
||||
When purification is enabled, it impurifies all objects before running
|
||||
the purifying GC.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-\-delete\-debug\-info
|
||||
.B \[en]delete\-debug\-info
|
||||
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).
|
||||
.RS
|
||||
.RE
|
||||
.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
|
||||
that no runtime compilation/interpretation of code will be performed.
|
||||
This option should be portable across implementations.
|
||||
It has ~2MB reduction on SBCL.
|
||||
.RS
|
||||
.RE
|
||||
It has \[ti]2MB reduction on SBCL.
|
||||
.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
|
||||
methods (~4MB reduction).
|
||||
methods (\[ti]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).
|
||||
.RS
|
||||
.RE
|
||||
.SH SEE ALSO
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-emacs" "1" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
ros\-emacs \- launch Emacs with Slime # Synopsis
|
||||
.PP
|
||||
\f[B]ros emacs\f[] [ARGS...]
|
||||
\f[B]ros emacs\f[R] [ARGS\&...]
|
||||
.SH Description
|
||||
.PP
|
||||
Launches Emacs with a Slime(https://common\-lisp.net/project/slime/)
|
||||
|
|
@ -14,6 +14,6 @@ of roswell.
|
|||
Additional arguments are passed to emacs.
|
||||
.SH SEE ALSO
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-help" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,12 +6,12 @@
|
|||
ros\-help \- Show Command help
|
||||
.SH Synopsis
|
||||
.PP
|
||||
\f[B]ros help\f[] [subcommand or topics]
|
||||
\f[B]ros help\f[R] [subcommand or topics]
|
||||
.SH Description
|
||||
.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
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-init" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,16 +6,16 @@
|
|||
ros\-init \- Create a roswell script (optionally based on a template)
|
||||
.SH Synopsis
|
||||
.PP
|
||||
\f[B]ros init [TEMPLATE] NAME [ARGS...]]\f[]
|
||||
\f[B]ros init [TEMPLATE] NAME [ARGS\&...]]\f[R]
|
||||
.TP
|
||||
.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.
|
||||
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
|
||||
the template.
|
||||
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
|
||||
.PP
|
||||
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
|
||||
.TP
|
||||
.B NAME
|
||||
Specify the output filename, or "\-" to indicate \f[I]stdout\f[].
|
||||
When \f[I]TEMPLATE\f[] is \f[I]default\f[], it automatically appends a
|
||||
file type ".ros".
|
||||
.RS
|
||||
.RE
|
||||
Specify the output filename, or \[lq]\-\[rq] to indicate
|
||||
\f[I]stdout\f[R].
|
||||
When \f[I]TEMPLATE\f[R] is \f[I]default\f[R], it automatically appends a
|
||||
file type \[lq].ros\[rq].
|
||||
.SH Description
|
||||
.PP
|
||||
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
|
||||
The default template is something like:
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
#!/bin/sh
|
||||
#|\-*\-\ mode:lisp\ \-*\-|#
|
||||
#|\ <Put\ a\ one\-line\ description\ here>
|
||||
exec\ ros\ \-Q\ \-\-\ $0\ "$\@"
|
||||
#|\-*\- mode:lisp \-*\-|#
|
||||
#| <Put a one\-line description here>
|
||||
exec ros \-Q \-\- $0 \[dq]$\[at]\[dq]
|
||||
|#
|
||||
(progn\ ;;init\ forms
|
||||
\ \ (ros:ensure\-asdf)
|
||||
\ \ ;;#+quicklisp\ (ql:quickload\ \[aq]()\ :silent\ t)
|
||||
\ \ )
|
||||
(progn ;;init forms
|
||||
(ros:ensure\-asdf)
|
||||
;;#+quicklisp (ql:quickload \[aq]() :silent t)
|
||||
)
|
||||
|
||||
(defpackage\ :ros.script.test.3703600390
|
||||
\ \ (:use\ :cl))
|
||||
(in\-package\ :ros.script.test.3703600390)
|
||||
(defpackage :ros.script.test.3703600390
|
||||
(:use :cl))
|
||||
(in\-package :ros.script.test.3703600390)
|
||||
|
||||
(defun\ main\ (&rest\ argv)
|
||||
\ \ (declare\ (ignorable\ argv)))
|
||||
;;;\ vim:\ set\ ft=lisp\ lisp:
|
||||
\f[]
|
||||
(defun main (&rest argv)
|
||||
(declare (ignorable argv)))
|
||||
;;; vim: set ft=lisp lisp:
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
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,
|
||||
reads the rest of the file as a Common Lisp program, and finally invokes
|
||||
a function main with command\-line arguments.
|
||||
.SH SEE ALSO
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-install" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,82 +6,78 @@
|
|||
ros\-install \- Install lisp implementations or quicklisp system
|
||||
.SH Synopsis
|
||||
.IP \[bu] 2
|
||||
\f[B]ros install\f[] system [system ...]
|
||||
\f[B]ros install\f[R] system [system \&...]
|
||||
.IP \[bu] 2
|
||||
\f[B]ros install\f[] impl[/version] [param ...]
|
||||
\f[B]ros install\f[R] impl[/version] [param \&...]
|
||||
.SH Description
|
||||
.TP
|
||||
.B system
|
||||
a name specifying a system.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B impl
|
||||
a name specifying a lisp implementation.
|
||||
.RS
|
||||
.RE
|
||||
.SH Installing a Lisp Implementation
|
||||
.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
|
||||
of the internal directory managed by roswell (~/.roswell, or
|
||||
\f[C]ROSWELL_INSTALL_DIR\f[]).
|
||||
of the internal directory managed by roswell (\[ti]/.roswell, or
|
||||
\f[C]ROSWELL_INSTALL_DIR\f[R]).
|
||||
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
|
||||
For example, the following command downloads the latest sbcl binary from
|
||||
sbcl.org.
|
||||
Note that this may be different from the default binary installed by
|
||||
roswell, called \f[C]sbcl\-bin\f[].
|
||||
\f[C]sbcl\-bin\f[] is a stable and well\-tested version of the sbcl
|
||||
roswell, called \f[C]sbcl\-bin\f[R].
|
||||
\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.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ install\ sbcl
|
||||
\f[]
|
||||
$ ros install sbcl
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
When invoked without a name, it prints the list of installable
|
||||
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.)
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
Usage:\ ros\ install\ impl\ [OPTIONS]
|
||||
Usage: ros install impl [OPTIONS]
|
||||
|
||||
For\ more\ details\ on\ impl\ specific\ options,\ type:
|
||||
ros\ help\ install\ impl
|
||||
For more details on impl specific options, type:
|
||||
ros help install impl
|
||||
|
||||
Candidates\ impls\ for\ installation\ are:
|
||||
Candidates impls for installation are:
|
||||
ecl
|
||||
sbcl
|
||||
clisp
|
||||
ccl\-bin
|
||||
sbcl\-bin
|
||||
\f[]
|
||||
\f[R]
|
||||
.fi
|
||||
.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.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ install\ sbcl/1.2.14
|
||||
\f[]
|
||||
$ ros install sbcl/1.2.14
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
There might be some \f[I]hidden\f[] implementation that are not listed
|
||||
here \-\-\- they are in the alpha quality, but try the one you like or
|
||||
There might be some \f[I]hidden\f[R] implementation that are not listed
|
||||
here \[em] they are in the alpha quality, but try the one you like or
|
||||
watch the website (https://github.com/roswell/roswell).
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ install\ ccl
|
||||
$\ ros\ install\ abcl
|
||||
$\ ...
|
||||
\f[]
|
||||
$ ros install ccl
|
||||
$ ros install abcl
|
||||
$ ...
|
||||
\f[R]
|
||||
.fi
|
||||
.SH Installing a quicklisp system and the bundled roswell scripts
|
||||
.PP
|
||||
|
|
@ -90,36 +86,36 @@ tries to find a quicklisp system of the given name.
|
|||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ install\ alexandria
|
||||
\f[]
|
||||
$ ros install alexandria
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
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.
|
||||
.PP
|
||||
When the system comes with a \f[B]roswell script\f[] created by
|
||||
\f[I]ros\-init\f[](1) in the subdirectory \f[C]roswell\f[], they are
|
||||
installed into \f[B]ROSWELL_INSTALL_DIR/bin\f[].
|
||||
When the system comes with a \f[B]roswell script\f[R] created by
|
||||
\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[R].
|
||||
Setting the path to this directory makes those scripts available from
|
||||
the shell command line.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ install\ qlot
|
||||
System\ \[aq]qlot\[aq]\ found.\ Loading\ the\ system..
|
||||
Processing\ build\-hook..
|
||||
Found\ 1\ scripts:\ qlot
|
||||
Attempting\ to\ install\ the\ scripts\ in\ roswell/\ subdirectory\ of\ the\ system...
|
||||
$ ros install qlot
|
||||
System \[aq]qlot\[aq] found. Loading the system..
|
||||
Processing build\-hook..
|
||||
Found 1 scripts: qlot
|
||||
Attempting to install the scripts in roswell/ subdirectory of the system...
|
||||
/home/user/.roswell/bin/qlot
|
||||
|
||||
$\ qlot
|
||||
Usage:\ qlot\ [install\ |\ update\ |\ bundle\ |\ exec\ shell\-args..]
|
||||
\f[]
|
||||
$ qlot
|
||||
Usage: qlot [install | update | bundle | exec shell\-args..]
|
||||
\f[R]
|
||||
.fi
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[I]sbcl\f[](1), \f[I]ros\f[](1), \f[I]ros\-list\f[](1),
|
||||
\f[I]ros\-init\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[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-list" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,35 +6,29 @@
|
|||
ros\-list \- list the materials installed by roswell
|
||||
.SH Synopsis
|
||||
.PP
|
||||
\f[B]ros list [type] [options]\f[]
|
||||
\f[B]ros list [type] [options]\f[R]
|
||||
.SH Description
|
||||
.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
|
||||
.B installed [ [ IMPL | IMPL/VERSION ]...]
|
||||
.B installed [ [ IMPL | IMPL/VERSION ]\&...]
|
||||
List the implementations that have been already installed.
|
||||
Optionally providing IMPL shows the installed versions of the
|
||||
implementation.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B dump [IMPL]
|
||||
List the internal dumped images that are compatible with IMPL.
|
||||
When IMPL is ommited, it is defaulted to the current lisp implementation
|
||||
in use.
|
||||
Images are in \f[C]$ROSWELL_INSTALL_DIR/impl/.../dump/\f[].
|
||||
.RS
|
||||
.RE
|
||||
Images are in \f[C]$ROSWELL_INSTALL_DIR/impl/.../dump/\f[R].
|
||||
.TP
|
||||
.B versions [IMPL]
|
||||
List the installable versions for IMPL.
|
||||
When IMPL is ommited, it is defaulted to the current lisp implementation
|
||||
in use.
|
||||
This feature is experimental.
|
||||
.RS
|
||||
.RE
|
||||
.SH SEE ALSO
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-run" "1" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
ros\-run \- start a REPL # Synopsis
|
||||
.PP
|
||||
\f[B]ros [options] run\f[]
|
||||
\f[B]ros [options] run\f[R]
|
||||
.SH Description
|
||||
.PP
|
||||
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
|
||||
.PP
|
||||
\f[I]ros\f[](1)
|
||||
\f[I]ros\f[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-serve" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,26 +6,22 @@
|
|||
ros\-serve \- start lisp server
|
||||
.SH Synopsis
|
||||
.PP
|
||||
\f[B]ros [options for roswell ... ] serve\f[] protocol [options for the
|
||||
protocol ...] ...
|
||||
\f[B]ros [options for roswell \&... ] serve\f[R] protocol [options for
|
||||
the protocol \&...] \&...
|
||||
.SH description
|
||||
.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.
|
||||
.SH swank protocol options
|
||||
.TP
|
||||
.B \f[C]\-\-port\ port\f[]
|
||||
Listen port would be \f[C]port\f[] instead of the default port 4005.
|
||||
.RS
|
||||
.RE
|
||||
.B \f[C]\-\-port port\f[R]
|
||||
Listen port would be \f[C]port\f[R] instead of the default port 4005.
|
||||
.TP
|
||||
.B \f[C]\-\-interface\ interface\f[]
|
||||
.B \f[C]\-\-interface interface\f[R]
|
||||
limit interface for listen.
|
||||
default is \f[C]localhost\f[] so there would be no limitation.
|
||||
.RS
|
||||
.RE
|
||||
default is \f[C]localhost\f[R] so there would be no limitation.
|
||||
.SH SEE ALSO
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-setup" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,22 +6,22 @@
|
|||
ros\-setup \- setup the backend of roswell
|
||||
.SH Synopsis
|
||||
.PP
|
||||
\f[B]ros setup\f[]
|
||||
\f[B]ros setup\f[R]
|
||||
.SH Description
|
||||
.PP
|
||||
\f[B]ros setup\f[] initializes roswell.
|
||||
\f[B]ros setup\f[R] initializes roswell.
|
||||
The process includes the following steps:
|
||||
.IP \[bu] 2
|
||||
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
|
||||
Installing quicklisp to \f[C]ROSWELL_INSTALL_DIR\f[].
|
||||
Installing quicklisp to \f[C]ROSWELL_INSTALL_DIR\f[R].
|
||||
.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
|
||||
Making the core image of roswell itself.
|
||||
.SH SEE ALSO
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-template" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,253 +6,223 @@
|
|||
ros\-template \- Edit template for ros\-init
|
||||
.SH synopsis
|
||||
.IP \[bu] 2
|
||||
\f[B]ros template\f[] command args...
|
||||
\f[B]ros template\f[R] command args\&...
|
||||
.SH Subcommands
|
||||
.TP
|
||||
.B init template\-name
|
||||
Create new template in local\-project directory.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B deinit template\-name
|
||||
Remove a template from local\-project directory.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B list
|
||||
Show file list and states of the files \f[I]type\f[] \f[I]chmod\f[]
|
||||
\f[I]rewrite\f[] in templates.
|
||||
.RS
|
||||
.RE
|
||||
Show file list and states of the files \f[I]type\f[R] \f[I]chmod\f[R]
|
||||
\f[I]rewrite\f[R] in templates.
|
||||
.TP
|
||||
.B checkout [template\-name]
|
||||
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.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B add [template\-name] [files ...]
|
||||
.B add [template\-name] [files \&...]
|
||||
Add files to current template.First parameter could taken as a
|
||||
template\-name when current template are \f[I]default\f[].
|
||||
.RS
|
||||
.RE
|
||||
template\-name when current template are \f[I]default\f[R].
|
||||
.TP
|
||||
.B cat [template\-name] [files ...]
|
||||
.B cat [template\-name] [files \&...]
|
||||
Show contents in the current template.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B edit [template\-name] [files ...]
|
||||
Edit content of files in template using \f[C]/usr/bin/editor\f[].
|
||||
.RS
|
||||
.RE
|
||||
.B edit [template\-name] [files \&...]
|
||||
Edit content of files in template using \f[C]/usr/bin/editor\f[R].
|
||||
.TP
|
||||
.B path [template\-name] [files ...]
|
||||
.B path [template\-name] [files \&...]
|
||||
Show native path of files in template.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B rm [template\-name] [files ...]
|
||||
.B rm [template\-name] [files \&...]
|
||||
Remove file form current template.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B type [template\-name] [type] [files ...]
|
||||
.B type [template\-name] [type] [files \&...]
|
||||
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
|
||||
in the template file.
|
||||
Withoug files, change default type.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B chmod [template\-name] [mode] [files ...]
|
||||
.B chmod [template\-name] [mode] [files \&...]
|
||||
Change file mode bits to generate.
|
||||
specify mode in octal format.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B rewrite [template\-name] file rewrite\-rule
|
||||
Change file name using djula template.Variables {{name}} {{author}}
|
||||
{{email}} {{universal_time}} are available for rewrite\-rule.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B export [template\-name] [directory]
|
||||
Export files in current template to current directory.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B import [directory]
|
||||
Import template in current directory
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B help
|
||||
Show the subcommand help.
|
||||
.RS
|
||||
.RE
|
||||
.SH Description
|
||||
.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
|
||||
.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
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ template\ init\ sample\-template
|
||||
\f[]
|
||||
$ ros template init sample\-template
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
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
|
||||
\f[C]sample\-template\f[].
|
||||
\f[C]sample\-template\f[R].
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ template\ checkout\ sample\-template
|
||||
\f[]
|
||||
$ ros template checkout sample\-template
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Next, the \f[C]add\f[] sub\-command adds local file[s] to template.
|
||||
Then, the \f[C]list\f[] sub\-command shows information of files in
|
||||
Next, the \f[C]add\f[R] sub\-command adds local file[s] to template.
|
||||
Then, the \f[C]list\f[R] sub\-command shows information of files in
|
||||
template.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ echo\ "Hello\ {{\ author\ }}!!"\ >\ sample.txt
|
||||
$\ ros\ template\ add\ sample.txt
|
||||
$\ ros\ template\ list
|
||||
\ \ \ \ \ \ copy\ \ sample.txt\
|
||||
\f[]
|
||||
$ echo \[dq]Hello {{ author }}!!\[dq] > sample.txt
|
||||
$ ros template add sample.txt
|
||||
$ ros template list
|
||||
copy sample.txt
|
||||
\f[R]
|
||||
.fi
|
||||
.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.
|
||||
.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
|
||||
\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/).
|
||||
.RS 2
|
||||
.IP \[bu] 2
|
||||
Available variables are explained later.
|
||||
.RE
|
||||
.PP
|
||||
The \f[C]type\f[] sub\-command changes it.
|
||||
In addition, default strategy (\f[I]copy\f[]) can be changed for each
|
||||
template by the \f[C]type\f[] sub\-command without file names (Ex.
|
||||
\f[C]ros\ template\ type\ djula\f[]).
|
||||
The \f[C]type\f[R] sub\-command changes it.
|
||||
In addition, default strategy (\f[I]copy\f[R]) can be changed for each
|
||||
template by the \f[C]type\f[R] sub\-command without file names (Ex.
|
||||
\f[C]ros template type djula\f[R]).
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ template\ type\ djula\ sample.txt
|
||||
$\ ros\ template\ list
|
||||
\ \ \ \ \ \ djula\ sample.txt\
|
||||
\f[]
|
||||
$ ros template type djula sample.txt
|
||||
$ ros template list
|
||||
djula sample.txt
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
The \f[C]sample.txt\f[] will be simply output as \f[C]sample.txt\f[] in
|
||||
default.
|
||||
But you can change it by the \f[C]rewrite\f[] sub\-command.
|
||||
The \f[C]sample.txt\f[R] will be simply output as \f[C]sample.txt\f[R]
|
||||
in default.
|
||||
But you can change it by the \f[C]rewrite\f[R] sub\-command.
|
||||
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
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ template\ rewrite\ sample.txt\ "sample\-{{\ name\ }}.txt"
|
||||
$\ ros\ template\ list
|
||||
\ \ \ \ \ \ djula\ sample.txt\ \->\ "sample\-{{\ name\ }}.txt"
|
||||
\f[]
|
||||
$ ros template rewrite sample.txt \[dq]sample\-{{ name }}.txt\[dq]
|
||||
$ ros template list
|
||||
djula sample.txt \-> \[dq]sample\-{{ name }}.txt\[dq]
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Note: Rewrite rules are always processed by Djula irrespective of
|
||||
strategy of the file.
|
||||
.SS Apply template
|
||||
.PP
|
||||
\f[I]ros\-init\f[](1) can specify a template.
|
||||
\f[I]ros\-init\f[R](1) can specify a template.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ mkdir\ temp\ ;\ cd\ temp
|
||||
$\ ros\ init\ sample\-template\ some\-project
|
||||
$\ ls
|
||||
$ mkdir temp ; cd temp
|
||||
$ ros init sample\-template some\-project
|
||||
$ ls
|
||||
sample\-some\-project.txt
|
||||
$\ cat\ sample\-some\-project.txt\ #\ Assume\ that\ "author"\ is\ "alien"
|
||||
Hello\ alien!!
|
||||
\f[]
|
||||
$ cat sample\-some\-project.txt # Assume that \[dq]author\[dq] is \[dq]alien\[dq]
|
||||
Hello alien!!
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
The file name and its content are processed by Djula as explained in the
|
||||
above.
|
||||
The following variables can be used in defaut.
|
||||
.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
|
||||
{{author}}: An author name extracted from config of Git or
|
||||
\f[C]whoami\f[]
|
||||
\f[C]whoami\f[R]
|
||||
.IP \[bu] 2
|
||||
{{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
|
||||
{{universal_time}}: A universal time created by
|
||||
\f[C]get\-universal\-time\f[] function
|
||||
\f[C]get\-universal\-time\f[R] function
|
||||
.PP
|
||||
In addition, you can use original variables as the followings.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ echo\ "Hello\ {{\ area\ }}!!"\ >\ sample.txt
|
||||
$\ ros\ template\ add\ sample.txt\ #\ Note:\ It\ overwrites\ existing
|
||||
$\ mkdir\ temp\ ;\ cd\ temp
|
||||
$\ ros\ init\ sample\-template\ roswell\ \-\-area\ 51
|
||||
$\ cat\ sample\-roswell.txt
|
||||
Hello\ 51!!
|
||||
\f[]
|
||||
$ echo \[dq]Hello {{ area }}!!\[dq] > sample.txt
|
||||
$ ros template add sample.txt # Note: It overwrites existing
|
||||
$ mkdir temp ; cd temp
|
||||
$ ros init sample\-template roswell \-\-area 51
|
||||
$ cat sample\-roswell.txt
|
||||
Hello 51!!
|
||||
\f[R]
|
||||
.fi
|
||||
.SS Export and import template
|
||||
.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.
|
||||
.PP
|
||||
However, if you want to, for example, manage it using Git in a local
|
||||
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
|
||||
First, the \f[C]export\f[] sub\-command exports added files and a
|
||||
setting file \f[C]roswell.init.<template\ name>.asd\f[] that is
|
||||
First, the \f[C]export\f[R] sub\-command exports added files and a
|
||||
setting file \f[C]roswell.init.<template name>.asd\f[R] that is
|
||||
internally created and editted.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ template\ export\ dir
|
||||
$\ ls\ dir
|
||||
roswell.init.sample\-template.asd\ \ sample.txt
|
||||
$\ cat\ dir/sample.txt
|
||||
Hello\ {{\ area\ }}!!
|
||||
\f[]
|
||||
$ ros template export dir
|
||||
$ ls dir
|
||||
roswell.init.sample\-template.asd sample.txt
|
||||
$ cat dir/sample.txt
|
||||
Hello {{ area }}!!
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Second, the \f[C]import\f[] sub\-command imports them.
|
||||
Second, the \f[C]import\f[R] sub\-command imports them.
|
||||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
#\ Assume\ that\ this\ is\ another\ machine...
|
||||
$\ ros\ template\ list\ sample\-template\ #\ nothing\ is\ output\
|
||||
$\ ls\ downloaded
|
||||
roswell.init.sample\-template.asd\ \ sample.txt
|
||||
$\ ros\ template\ import\ downloaded
|
||||
$\ ros\ template\ list\ sample\-template
|
||||
\ \ \ \ \ \ djula\ sample.txt\ \->\ "sample\-{{\ name\ }}.txt"
|
||||
\f[]
|
||||
# Assume that this is another machine...
|
||||
$ ros template list sample\-template # nothing is output
|
||||
$ ls downloaded
|
||||
roswell.init.sample\-template.asd sample.txt
|
||||
$ ros template import downloaded
|
||||
$ ros template list sample\-template
|
||||
djula sample.txt \-> \[dq]sample\-{{ name }}.txt\[dq]
|
||||
\f[R]
|
||||
.fi
|
||||
.PP
|
||||
Note: If there is a template whose name is same, it will be overwritten.
|
||||
.SH SEE ALSO
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-update" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,27 +6,23 @@
|
|||
ros\-update \- Update system installed from vcs
|
||||
.SH Synopsis
|
||||
.IP \[bu] 2
|
||||
\f[B]ros update\f[] system [system ...]
|
||||
\f[B]ros update\f[R] system [system \&...]
|
||||
.IP \[bu] 2
|
||||
\f[B]ros update\f[] method [params ...]
|
||||
\f[B]ros update\f[R] method [params \&...]
|
||||
.SH Description
|
||||
.TP
|
||||
.B system
|
||||
a name specifying a system.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B method
|
||||
currently supported method is \f[C]git\f[].
|
||||
.RS
|
||||
.RE
|
||||
currently supported method is \f[C]git\f[R].
|
||||
.SH Update system
|
||||
.PP
|
||||
When system are already installed and the system has \f[C]\&.git\f[] in
|
||||
the system directory it invoke \f[C]git\ pull\f[] and
|
||||
\f[C]ros\ install\f[] the system.
|
||||
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[R] and
|
||||
\f[C]ros install\f[R] the system.
|
||||
.SH SEE ALSO
|
||||
.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
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,36 +1,36 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-use" "1" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
ros\-use \- sets the default implementation used by roswell # synopsis
|
||||
.PP
|
||||
\f[B]ros [options] use\f[] impl[/version]
|
||||
\f[B]ros [options] use\f[R] impl[/version]
|
||||
.PP
|
||||
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
|
||||
\f[I]ros\-list\f[](1).
|
||||
\f[I]ros\-list\f[R](1).
|
||||
.PP
|
||||
version: : The version specifier.
|
||||
The string representation of the version (e.g.
|
||||
.) depends on each implementation and roswell generally follows the
|
||||
representation used by the implementation.
|
||||
In addition, \f[I]a special version name "system"\f[] tells roswell to
|
||||
use the implementation that is installed in your system, which should be
|
||||
in PATH.
|
||||
The string representation of the version (e.g.\ .) depends on each
|
||||
implementation and roswell generally follows the representation used by
|
||||
the implementation.
|
||||
In addition, \f[I]a special version name \[lq]system\[rq]\f[R] tells
|
||||
roswell to use the implementation that is installed in your system,
|
||||
which should be in PATH.
|
||||
.SH example
|
||||
.PP
|
||||
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
|
||||
but allows SLIME to jump to the implementation source code.
|
||||
.PP
|
||||
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.
|
||||
\f[C]sbcl\-bin\f[] 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\-bin\f[R] tends to be an older version compared to
|
||||
\f[C]sbcl\f[R], but surely newer than your \f[I]apt\-get\f[R] installed
|
||||
counterpart!
|
||||
.PP
|
||||
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.
|
||||
Same set of version specifiers as for SBCL can be applied.
|
||||
.PP
|
||||
Roswell also supports \f[I]abcl\f[], \f[I]acl\f[], \f[I]clisp\f[],
|
||||
\f[I]cmu\f[] and \f[I]ecl\f[].
|
||||
Roswell also supports \f[I]abcl\f[R], \f[I]acl\f[R], \f[I]clisp\f[R],
|
||||
\f[I]cmu\f[R] and \f[I]ecl\f[R].
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[I]sbcl\f[](1), \f[I]ros\f[](1), \f[I]ros\-install\f[](1),
|
||||
\f[I]ros\-list\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[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,11 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros-wait" "1" "" "" ""
|
||||
.hy
|
||||
.PP
|
||||
ros\-wait \- # synopsis
|
||||
.PP
|
||||
\f[B]ros [options] wait\f[]
|
||||
\f[B]ros [options] wait\f[R]
|
||||
.SH Description
|
||||
.PP
|
||||
Wait forever after processing the options.
|
||||
|
|
@ -19,11 +19,11 @@ from the client.
|
|||
.IP
|
||||
.nf
|
||||
\f[C]
|
||||
$\ ros\ \-sp\ clack\ \-l\ app.lisp\ \-e\ \[aq](clack:clackup)\[aq]\ wait
|
||||
\f[]
|
||||
$ ros \-sp clack \-l app.lisp \-e \[aq](clack:clackup)\[aq] wait
|
||||
\f[R]
|
||||
.fi
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[I]ros\f[](1)
|
||||
\f[I]ros\f[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
.\" Automatically generated by Pandoc 1.16.0.2
|
||||
.\" Automatically generated by Pandoc 2.5
|
||||
.\"
|
||||
.TH "ros" "1" "" "" ""
|
||||
.hy
|
||||
|
|
@ -6,11 +6,11 @@
|
|||
Roswell \- Common Lisp environment setup Utility
|
||||
.SH Synopsis
|
||||
.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
|
||||
\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
|
||||
\f[B]ros\f[] [\f[B]options\f[]] < script.ros
|
||||
\f[B]ros\f[R] [\f[B]options\f[R]] < script.ros
|
||||
.SH Description
|
||||
.PP
|
||||
Roswell is a command line tool for installing and managing Common Lisp
|
||||
|
|
@ -20,7 +20,7 @@ ROSWELL\-SCRIPTS written in Common Lisp.
|
|||
.PP
|
||||
Currently roswell supports sbcl, ccl, clisp and ecl as its supported
|
||||
lisp implementations.
|
||||
For further details see \f[I]ros\-install\f[](1).
|
||||
For further details see \f[I]ros\-install\f[R](1).
|
||||
.PP
|
||||
Scripts installed by roswell will be system wide if appropriate
|
||||
directory is included in PATH.
|
||||
|
|
@ -29,241 +29,157 @@ directory is included in PATH.
|
|||
In an order of utility/frequency.
|
||||
.TP
|
||||
.B install
|
||||
Install a given implementation (e.g.
|
||||
sbcl, ccl) or a system (e.g.
|
||||
alexandria) for roswell environment.
|
||||
See \f[I]ros\-install\f[](1).
|
||||
.RS
|
||||
.RE
|
||||
Install a given implementation (e.g.\ sbcl, ccl) or a system
|
||||
(e.g.\ alexandria) for roswell environment.
|
||||
See \f[I]ros\-install\f[R](1).
|
||||
.TP
|
||||
.B init [name[.ros]]
|
||||
Create a new ros script.
|
||||
\f[C]\&.ros\f[] is optional, and is added automaticaly.
|
||||
See \f[I]ros\-init\f[].
|
||||
.RS
|
||||
.RE
|
||||
\f[C].ros\f[R] is optional, and is added automaticaly.
|
||||
See \f[I]ros\-init\f[R].
|
||||
.TP
|
||||
.B dump [executable|output] [script]
|
||||
Dump an image of the script for the faster startup or to make an
|
||||
executable.
|
||||
See \f[I]ros\-dump\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-dump\f[R].
|
||||
.TP
|
||||
.B build
|
||||
Make an executable from the script.
|
||||
See \f[I]ros\-build\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-build\f[R].
|
||||
.TP
|
||||
.B run
|
||||
Initiate REPL.
|
||||
See \f[I]ros\-run\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-run\f[R].
|
||||
.TP
|
||||
.B use
|
||||
Change the default implementation used by roswell.
|
||||
See \f[I]ros\-use\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-use\f[R].
|
||||
.TP
|
||||
.B list
|
||||
List the various informations.
|
||||
See \f[I]ros\-list\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-list\f[R].
|
||||
.TP
|
||||
.B config
|
||||
Get and set the options.
|
||||
See \f[I]ros\-config\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-config\f[R].
|
||||
.TP
|
||||
.B setup
|
||||
Run the initial setup.
|
||||
See \f[I]ros\-setup\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-setup\f[R].
|
||||
.TP
|
||||
.B emacs
|
||||
Launch emacs with slime.
|
||||
See \f[I]ros\-emacs\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-emacs\f[R].
|
||||
.TP
|
||||
.B wait
|
||||
Wait forever, used for daemonizing the script.
|
||||
See \f[I]ros\-wait\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-wait\f[R].
|
||||
.TP
|
||||
.B delete
|
||||
Delete an installed implementation.
|
||||
See \f[I]ros\-delete\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-delete\f[R].
|
||||
.TP
|
||||
.B version
|
||||
Show the roswell version information.
|
||||
See \f[I]ros\-version\f[].
|
||||
.RS
|
||||
.RE
|
||||
See \f[I]ros\-version\f[R].
|
||||
.TP
|
||||
.B help
|
||||
Show the subcommand help.
|
||||
.RS
|
||||
.RE
|
||||
.SH Options
|
||||
.PP
|
||||
Options are processed in left\-to\-right order.
|
||||
.TP
|
||||
.B \-w CODE \-\-wrap CODE
|
||||
Run the script with a shell wrapper CODE, e.g.
|
||||
rlwrap
|
||||
.RS
|
||||
.RE
|
||||
.B \-w CODE \[en]wrap CODE
|
||||
Run the script with a shell wrapper CODE, e.g.\ rlwrap
|
||||
.TP
|
||||
.B \-m IMAGE \-\-image IMAGE
|
||||
.B \-m IMAGE \[en]image IMAGE
|
||||
Continue from Lisp image IMAGE
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-L NAME \-\-lisp NAME
|
||||
Run the script with a lisp impl NAME[/VERSION] if present, e.g.
|
||||
sbcl\-bin, sbcl/1.2.16.
|
||||
.B \-L NAME \[en]lisp NAME
|
||||
Run the script with a lisp impl NAME[/VERSION] if present,
|
||||
e.g.\ sbcl\-bin, sbcl/1.2.16.
|
||||
Fails otherwise.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-l FILE \-\-load FILE
|
||||
.B \-l FILE \[en]load FILE
|
||||
Load a lisp file FILE while building
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-S X \-\-source\-registry X
|
||||
.B \-S X \[en]source\-registry X
|
||||
Override the source registry of asdf systems.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-s SYSTEM \-\-system SYSTEM
|
||||
.B \-s SYSTEM \[en]system SYSTEM
|
||||
Load the asdf SYSTEM while building.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-\-load\-system SYSTEM
|
||||
.B \[en]load\-system SYSTEM
|
||||
Same as above (buildapp compatibility)
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-p PACKAGE \-\-package PACKAGE
|
||||
.B \-p PACKAGE \[en]package PACKAGE
|
||||
Change the current package to PACKAGE
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-sp SP \-\-system\-package SP
|
||||
.B \-sp SP \[en]system\-package SP
|
||||
Combination of \-s SP and \-p SP
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-e FORM \-\-eval FORM
|
||||
.B \-e FORM \[en]eval FORM
|
||||
Evaluate FORM while building
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-\-require MODULE
|
||||
.B \[en]require MODULE
|
||||
require MODULE while building
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-q \-\-quit
|
||||
.B \-q \[en]quit
|
||||
quit lisp here
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-r FUNC \-\-restart FUNC
|
||||
.B \-r FUNC \[en]restart FUNC
|
||||
the build image restarts from calling FUNC
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-E FUNC \-\-entry FUNC
|
||||
.B \-E FUNC \[en]entry FUNC
|
||||
the build image restarts from calling (FUNC argv).
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-i FORM \-\-init FORM
|
||||
.B \-i FORM \[en]init FORM
|
||||
evaluate FORM after the restart.
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-ip FORM \-\-print FORM
|
||||
.B \-ip FORM \[en]print FORM
|
||||
evaluate and princ FORM after the restart
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-iw FORM \-\-write FORM
|
||||
.B \-iw FORM \[en]write FORM
|
||||
evaluate and write FORM after the restart
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-F FORM \-\-final FORM
|
||||
.B \-F FORM \[en]final FORM
|
||||
evaluate FORM before dumping the IMAGE
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-R \-\-rc
|
||||
try to read /etc/rosrc, ~/.roswell/init.lisp
|
||||
.RS
|
||||
.RE
|
||||
.B \-R \[en]rc
|
||||
try to read /etc/rosrc, \[ti]/.roswell/init.lisp
|
||||
.TP
|
||||
.B +R \-\-no\-rc
|
||||
skip /etc/rosrc, ~/.roswell/init.lisp
|
||||
.RS
|
||||
.RE
|
||||
.B +R \[en]no\-rc
|
||||
skip /etc/rosrc, \[ti]/.roswell/init.lisp
|
||||
.TP
|
||||
.B \-Q \-\-quicklisp
|
||||
.B \-Q \[en]quicklisp
|
||||
load quicklisp (default)
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B +Q \-\-no\-quicklisp
|
||||
.B +Q \[en]no\-quicklisp
|
||||
do not load quicklisp
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-v \-\-verbose
|
||||
.B \-v \[en]verbose
|
||||
be quite verbose while building
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-\-quiet
|
||||
.B \[en]quiet
|
||||
suppress output while building (default)
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B \-\-test
|
||||
.B \[en]test
|
||||
for test purpose
|
||||
.RS
|
||||
.RE
|
||||
.TP
|
||||
.B dynamic\-space\-size=[size in MB]
|
||||
SBCL specific.
|
||||
The argument is passed to SBCL by \f[C]\-\-dynamic\-space\-size\f[]
|
||||
.RS
|
||||
.RE
|
||||
The argument is passed to SBCL by \f[C]\-\-dynamic\-space\-size\f[R]
|
||||
.SH Environmental Variables
|
||||
.TP
|
||||
.B ROSWELL_HOME
|
||||
Specifies the home directory of roswell, defaulted to $HOME on Unix
|
||||
platform .
|
||||
.RS
|
||||
.RE
|
||||
.SH Bugs
|
||||
.PP
|
||||
Check out issues list (https://github.com/roswell/roswell/issues)
|
||||
.SH SEE ALSO
|
||||
.PP
|
||||
\f[I]sbcl\f[](1) \f[I]ros\-dump\f[](1) \f[I]ros\-init\f[](1)
|
||||
\f[I]ros\-install\f[](1) \f[I]ros\-list\f[](1) \f[I]ros\-setup\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[R](1) \f[I]ros\-list\f[R](1) \f[I]ros\-setup\f[R](1)
|
||||
.SH AUTHORS
|
||||
Roswell Project Team.
|
||||
|
|
|
|||
Loading…
Reference in a new issue