[ci skip] documents update

This commit is contained in:
Travis-CI 2019-04-11 05:30:27 +00:00
parent cea7aaea04
commit b97ed5c034
37 changed files with 80 additions and 123 deletions

View file

@ -21,17 +21,13 @@
<p>ros-asdf - # synopsis</p>
<p><strong>ros [options] asdf [subcommand]</strong></p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- : description. end with a period. -->
<h1 id="description">description</h1>
<p><strong>ros asdf</strong> install and manage ASDF(https://common-lisp.net/project/asdf/)</p>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1) _</p>
</body>

View file

@ -22,16 +22,12 @@
<p><strong>ros [options] build</strong> <file></p>
<p>Equivalent to calling <code>ros dump executable &lt;file&gt;</code>.</p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- : description. end with a period. -->
<h1 id="description">description</h1>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1) _</p>
</body>

View file

@ -21,17 +21,13 @@
<p>ros-checkout - # synopsis</p>
<p><strong>ros [options] checkout</strong> args...</p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- : description. end with a period. -->
<h1 id="description">description</h1>
<p>to enable this command ros install roswell/ql-checkout is needed.</p>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1) _</p>
</body>

View file

@ -33,7 +33,6 @@
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1) _</p>
</body>

View file

@ -29,14 +29,11 @@
<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. -->
<h1 id="description">description</h1>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1) _</p>
</body>

View file

@ -21,16 +21,12 @@
<p>ros-dist - # synopsis</p>
<p><strong>ros [options] dist</strong> args...</p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- : description. end with a period. -->
<h1 id="description">description</h1>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1) _</p>
</body>

View file

@ -28,7 +28,6 @@
<!-- 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. -->
<p>The dumped image is generally not compatible between the different implementations, and also between the versions.</p>
<h1 id="dump-modes">Dump modes</h1>
<h2 id="output--f--o-output-name">output [-f] [-o OUTPUT] NAME</h2>
@ -54,11 +53,8 @@
<p>Reduction options are processed in the left-to-right manner.</p>
<dl>
<dt>--disable-compression, --enable-compression, -c</dt>
<dd>These options disable/enable/enable the core compression feature in SBCL. Thus this option is meaningful
<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>
</dl>
<p>only on SBCL. Compression is enabled by default.</p>
<dl>
<dt>--remove-docstrings</dt>
<dd><p>This option removes all docstrings from all symbols in the entire lisp image.</p>
</dd>
@ -75,17 +71,11 @@
<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>
<dt>--purify, --no-purify</dt>
<dd>This is common to CCL, SBCL, CMUCL. Moves all objects to the static space
<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>
</dl>
<p>where GC does not scan, for the later performance of GC. Purification is enabled by default.</p>
<dl>
<dt>--impurify, --no-impurify</dt>
<dd>This is an CCL-specific option (enabled by default).
<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>
</dl>
<p>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>
<dl>
<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>
@ -99,7 +89,6 @@
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em>sbcl</em>(1) <em><a href="ros.html">ros</a></em>(1) <em><a href="ros-init.html">ros-init</a></em>(1) _</p>
</body>

View file

@ -21,17 +21,13 @@
<p>ros-emacs - launch Emacs with Slime # Synopsis</p>
<p><strong>ros emacs</strong> [ARGS...]</p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- : description. end with a period. -->
<h1 id="description">Description</h1>
<p>Launches Emacs with a Slime(https://common-lisp.net/project/slime/) buffer opened, which is connected to the back-end lisp implementation of roswell. Additional arguments are passed to emacs.</p>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1), <em>emacs</em>(1) _</p>
</body>

View file

@ -22,16 +22,13 @@
<h1 id="synopsis">Synopsis</h1>
<p><strong>ros help</strong> [subcommand or topics]</p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- :description. end with a period. -->
<h1 id="description">Description</h1>
<p><strong>ros help</strong> shows description of subcommand or topics</p>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em>sbcl</em>(1), <em><a href="ros.html">ros</a></em>(1)</p>
<p>_</p>

View file

@ -31,7 +31,6 @@
</dd>
</dl>
<!-- # subcommands -->
<h1 id="description">Description</h1>
<p>Initialises a roswell file based on a template. User-specified templates can be added by <em><a href="ros-template.html">ros-template</a></em>(1).</p>
<p>The default template is something like:</p>
@ -56,7 +55,6 @@ exec ros -Q -- $0 &quot;$@&quot;
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em>sbcl</em>(1) <em><a href="ros.html">ros</a></em>(1) <em><a href="ros-template.html">ros-template</a></em>(1)</p>
<p>_</p>

View file

@ -34,7 +34,6 @@
</dd>
</dl>
<!-- # subcommands -->
<h1 id="installing-a-lisp-implementation">Installing a Lisp Implementation</h1>
<p>When the <code>impl</code> or <code>system</code> matches to one of the supported implementations, it fetches, downloads and installs it to one of the internal directory managed by roswell (~/.roswell, or <code>ROSWELL_INSTALL_DIR</code>). In order to use the installed implementation, you have to run <em>ros-use(1)</em>.</p>
<p>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 <code>sbcl-bin</code>. <code>sbcl-bin</code> is a stable and well-tested version of the sbcl binary which is supposed to be a little older than the latest sbcl.</p>
@ -60,7 +59,6 @@ $ ...</code></pre>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="installing-a-quicklisp-system-and-the-bundled-roswell-scripts">Installing a quicklisp system and the bundled roswell scripts</h1>
<p>If the specified name does not match any of the implementations, roswell tries to find a quicklisp system of the given name.</p>
<pre><code>$ ros install alexandria</code></pre>

View file

@ -22,34 +22,24 @@
<h1 id="synopsis">Synopsis</h1>
<p><strong>ros list [type] [options]</strong></p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- :description. end with a period. -->
<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>
<dd>List the implementations that have been already installed. Optionally
<dd><p>List the implementations that have been already installed. Optionally providing IMPL shows the installed versions of the implementation.</p>
</dd>
</dl>
<p>providing IMPL shows the installed versions of the implementation.</p>
<dl>
<dt>dump [IMPL]</dt>
<dd>List the internal dumped images that are compatible with IMPL. When
<dd><p>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 <code>$ROSWELL_INSTALL_DIR/impl/.../dump/</code>.</p>
</dd>
</dl>
<p>IMPL is ommited, it is defaulted to the current lisp implementation in use. Images are in <code>$ROSWELL_INSTALL_DIR/impl/.../dump/</code>.</p>
<dl>
<dt>versions [IMPL]</dt>
<dd>List the installable versions for IMPL. When IMPL is ommited, it is
<dd><p>List the installable versions for IMPL. When IMPL is ommited, it is defaulted to the current lisp implementation in use. This feature is experimental.</p>
</dd>
</dl>
<p>defaulted to the current lisp implementation in use. This feature is experimental.</p>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em>sbcl</em>(1) <em><a href="ros.html">ros</a></em>(1)</p>
<p>_</p>

View file

@ -21,17 +21,13 @@
<p>ros-run - start a REPL # Synopsis</p>
<p><strong>ros [options] run</strong></p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- : description. end with a period. -->
<h1 id="description">Description</h1>
<p>Processes the given options and start a REPL using the currently effective lisp implementation set by <em><a href="ros-use.html">ros-use</a></em>(1).</p>
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1) _</p>
</body>

View file

@ -22,10 +22,8 @@
<h1 id="synopsis">Synopsis</h1>
<p><strong>ros setup</strong></p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- :description. end with a period. -->
<h1 id="description">Description</h1>
<p><strong>ros setup</strong> initializes roswell. The process includes the following steps:</p>
<ul>
@ -37,7 +35,6 @@
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em>sbcl</em>(1), <em><a href="ros.html">ros</a></em>(1), section Environmental Variables</p>
<p>_</p>

View file

@ -69,9 +69,7 @@
</dd>
</dl>
<!-- somecommand -->
<!-- : description. end with a period. -->
<h1 id="description">Description</h1>
<p>The <em><a href="ros-template.html">ros-template</a></em>(1) command manages templates of projects.</p>
<h2 id="create-template">Create template</h2>
@ -144,7 +142,6 @@ $ ros template list sample-template
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1) <em><a href="ros-init.html">ros-init</a></em>(1) _</p>
</body>

View file

@ -31,15 +31,11 @@
<p>ros use ccl : use the CCL compiled from the source. Same set of version specifiers as for SBCL can be applied.</p>
<p>Roswell also supports <em>abcl</em>, <em>acl</em>, <em>clisp</em>, <em>cmu</em> and <em>ecl</em>.</p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- : description. end with a period. -->
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em>sbcl</em>(1), <em><a href="ros.html">ros</a></em>(1), <em><a href="ros-install.html">ros-install</a></em>(1), <em><a href="ros-list.html">ros-list</a></em>(1) _</p>
</body>

View file

@ -21,11 +21,8 @@
<p>ros-wait - # synopsis</p>
<p><strong>ros [options] wait</strong></p>
<!-- # subcommands -->
<!-- somecommand -->
<!-- : description. end with a period. -->
<h1 id="description">Description</h1>
<p>Wait forever after processing the options.</p>
<p>Useful when the application should work as a background/daemonized application.</p>
@ -35,7 +32,6 @@
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->
<h1 id="see-also">SEE ALSO</h1>
<p><em><a href="ros.html">ros</a></em>(1) _</p>
</body>

View file

@ -160,14 +160,12 @@
<h1 id="environmental-variables">Environmental Variables</h1>
<dl>
<dt>ROSWELL_HOME</dt>
<dd>Specifies the home directory of roswell, defaulted to $HOME on Unix platform .
<dd><p>Specifies the home directory of roswell, defaulted to $HOME on Unix platform .</p>
</dd>
</dl>
<!-- ROSWELL_HTML_TEST -->
<!-- -->
<!-- : -->
<h1 id="bugs">Bugs</h1>
<p>Check out issues list (https://github.com/roswell/roswell/issues)</p>
<h1 id="see-also">SEE ALSO</h1>

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-asdf" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-asdf \- # synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-build" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-build \- Shortcut to "ros dump executable" # synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-checkout" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-checkout \- # synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-config" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-config \- get and set options # Synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-delete" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-delete \- # synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-dist" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-dist \- # synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-dump" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-dump \- make a dumped image of a roswell script
.SH Synopsis
@ -85,12 +87,10 @@ Reduction options are processed in the left\-to\-right manner.
.B \-\-disable\-compression, \-\-enable\-compression, \-c
These options disable/enable/enable the core compression feature in
SBCL.
Thus this option is meaningful
Thus this option is meaningful only on SBCL.
Compression is enabled by default.
.RS
.RE
.PP
only on SBCL.
Compression is enabled by default.
.TP
.B \-\-remove\-docstrings
This option removes all docstrings from all symbols in the entire lisp
@ -138,22 +138,20 @@ rightmost).
.TP
.B \-\-purify, \-\-no\-purify
This is common to CCL, SBCL, CMUCL.
Moves all objects to the static space
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
.PP
where GC does not scan, for the later performance of GC.
Purification is enabled by default.
.TP
.B \-\-impurify, \-\-no\-impurify
This is an CCL\-specific option (enabled by default).
.RS
.RE
.PP
It moves all objects to the dynamic space before saving the image.
This allows the static\-space objects to be GC\[aq]ed.
When purification is enabled, it impurifies all objects before running
the purifying GC.
.RS
.RE
.TP
.B \-\-delete\-debug\-info
This removes the debug infomation of functions (used to show the stack
@ -164,8 +162,7 @@ This option has a large effect (+10MB reduction).
.RS
.RE
.TP
.B \-\-delete\-macro\-definitions,
\-\-delete\-compiler\-macro\-definitions
.B \-\-delete\-macro\-definitions, \-\-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.

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-emacs" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-emacs \- launch Emacs with Slime # Synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-help" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-help \- Show Command help
.SH Synopsis

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-init" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-init \- Create a roswell script (optionally based on a template)
.SH Synopsis

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-install" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-install \- Install lisp implementations or quicklisp system
.SH Synopsis

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-list" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-list \- list the materials installed by roswell
.SH Synopsis
@ -11,30 +13,26 @@ ros\-list \- list the materials installed by roswell
.TP
.B installed [ [ IMPL | IMPL/VERSION ]...]
List the implementations that have been already installed.
Optionally
Optionally providing IMPL shows the installed versions of the
implementation.
.RS
.RE
.PP
providing IMPL shows the installed versions of the implementation.
.TP
.B dump [IMPL]
List the internal dumped images that are compatible with IMPL.
When
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
.PP
IMPL is ommited, it is defaulted to the current lisp implementation in
use.
Images are in \f[C]$ROSWELL_INSTALL_DIR/impl/.../dump/\f[].
.TP
.B versions [IMPL]
List the installable versions for IMPL.
When IMPL is ommited, it is
When IMPL is ommited, it is defaulted to the current lisp implementation
in use.
This feature is experimental.
.RS
.RE
.PP
defaulted to the current lisp implementation in use.
This feature is experimental.
.SH SEE ALSO
.PP
\f[I]sbcl\f[](1) \f[I]ros\f[](1)

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-run" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-run \- start a REPL # Synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-setup" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-setup \- setup the backend of roswell
.SH Synopsis

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-template" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-template \- Edit template for ros\-init
.SH synopsis

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-update" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-update \- Update system installed from vcs
.SH Synopsis

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-use" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-use \- sets the default implementation used by roswell # synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros-wait" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
ros\-wait \- # synopsis
.PP

View file

@ -1,5 +1,7 @@
.\" Automatically generated by Pandoc 1.16.0.2
.\"
.TH "ros" "1" "" "" ""
.nh \" Turn off hyphenation by default.
.hy
.PP
Roswell \- Common Lisp environment setup Utility
.SH Synopsis