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

updated the manual

Browse source
This commit is contained in:
Masataro Asai 2016-02-05 10:25:07 +09:00
parent 41f1c17f77
commit c714e5a376
2 changed files with 29 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
documents/ros-install.md
View file

@ -12,9 +12,9 @@ name
# Installing a Lisp Implementation
When the `name` matches to one of the supported implementations of roswell, it fetch and download the implementation. It is not automatically set as the default implementation to use. For setting the default lisp implementation, use _ros-use(1)_.
When the `name` matches to one of the supported implementations, it fetches, downloads and installs it to one of the internal directory managed by roswell (~/.roswell, or `ROSWELL_INSTALL_DIR`). In order to use the installed implementation, you have to run _ros-use(1)_.
For example, the following command download the latest sbcl binary from sbcl.com. Note that this may be different freom the default binary installed by roswell, called `sbcl-bin`. `sbcl-bin` is a stable and well-tested version of the sbcl binary which is supposed to be a little older than the latest sbcl.
For example, the following command downloads the latest sbcl binary from sbcl.com. Note that this may be different from the default binary installed by roswell, called `sbcl-bin`. `sbcl-bin` is a stable and well-tested version of the sbcl binary which is supposed to be a little older than the latest sbcl.
$ ros install sbcl
@ -32,7 +32,7 @@ When invoked without a name, it prints the list of installable implementations.
ccl-bin
sbcl-bin
The name can be a name of the implementation, or a version of the implementation prepended with the name separated by a slash (/). The ones ending with `-bin` ususally do not have these variants.
The name can be optionally followed by a slash `/` and a version of the implementation.
$ ros install sbcl/1.2.14
@ -54,7 +54,7 @@ If the specified name does not match any of the implementations, roswell tries t
After compiling and loading the system, it funcalls `ros:*build-hook*` special variable with no argument, if some function is set during the compilation/load.
When the system comes with a **roswell script** created by _ros-init_(1) in the subdirectory `roswell`, the scripts are installed into **ROSWELL_INSTALL_DIR/bin**. Setting the path to this directory makes those scripts available from the shell command line.
When the system comes with a **roswell script** created by _ros-init_(1) in the subdirectory `roswell`, they are installed into **ROSWELL_INSTALL_DIR/bin**. Setting the path to this directory makes those scripts available from the shell command line.
$ ros install qlot
System 'qlot' found. Loading the system..

31
documents/ros-use.md
View file

@ -12,7 +12,31 @@ impl
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.
generally follows the representation used by the implementation. In
addition, *a special version name "system"* tells roswell to use the
implementation that is installed in your system, which should be in PATH.
# example
ros use sbcl
: use the latest SBCL among several versions of SBCLs installed by _ros-install_. This is compiled from the source, which may take some time to install but allows SLIME to jump to the implementation source code.
ros use sbcl-bin
: use the latest stable SBCL binary downloaded from vendor's website. Roswell uses this by default. `sbcl-bin` tends to be an older version compared to `sbcl`, but surely newer than your _apt-get_ installed counterpart!
ros use sbcl/1.3.1
: use the compiled SBCL 1.3.1.
ros use sbcl-bin/1.3.1
: use the prebuilt SBCL 1.3.1.
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.
Roswell also supports _abcl_, _acl_, _clisp_, _cmu_ and _ecl_.
<!-- # subcommands -->
@ -20,11 +44,6 @@ version:
<!-- : description. end with a period. -->
# description
`ros use` sets the default implementation used by roswell. It is by default
`sbcl-bin`, which is a stable and well-tested version of sbcl.
<!-- # options -->
<!-- -->
<!-- # Environmental Variables -->