.\" Automatically generated by Pandoc 2.5
.\"
.TH "ros" "1" "" "" ""
.hy
.PP
Roswell \- Common Lisp environment setup Utility
.SH Synopsis
.IP \[bu] 2
\f[B]ros\f[R] [\f[B]options\f[R]] \f[C][command [args...]\f[R]
.IP \[bu] 2
\f[B]ros\f[R] [\f[B]options\f[R]] \f[C][\-\-]script [args...]\f[R]
.IP \[bu] 2
\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
implementations, as well as a scripting infrastructure for templating,
writing, executing, compiling, distributing, downloading and installing
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[R](1).
.PP
Scripts installed by roswell will be system wide if appropriate
directory is included in PATH.
.SH Subcommands
.PP
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[R](1).
.TP
.B init [name[.ros]]
Create a new ros script.
\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[R].
.TP
.B build
Make an executable from the script.
See \f[I]ros\-build\f[R].
.TP
.B run
Initiate REPL.
See \f[I]ros\-run\f[R].
.TP
.B use
Change the default implementation used by roswell.
See \f[I]ros\-use\f[R].
.TP
.B list
List the various informations.
See \f[I]ros\-list\f[R].
.TP
.B config
Get and set the options.
See \f[I]ros\-config\f[R].
.TP
.B setup
Run the initial setup.
See \f[I]ros\-setup\f[R].
.TP
.B emacs
Launch emacs with slime.
See \f[I]ros\-emacs\f[R].
.TP
.B wait
Wait forever, used for daemonizing the script.
See \f[I]ros\-wait\f[R].
.TP
.B delete
Delete an installed implementation.
See \f[I]ros\-delete\f[R].
.TP
.B version
Show the roswell version information.
See \f[I]ros\-version\f[R].
.TP
.B help
Show the subcommand help.
.SH Options
.PP
Options are processed in left\-to\-right order.
.TP
.B \-w CODE \[en]wrap CODE
Run the script with a shell wrapper CODE, e.g.\ rlwrap
.TP
.B \-m IMAGE \[en]image IMAGE
Continue from Lisp image IMAGE
.TP
.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.
.TP
.B \-l FILE \[en]load FILE
Load a lisp file FILE while building
.TP
.B \-S X \[en]source\-registry X
Override the source registry of asdf systems.
.TP
.B \-s SYSTEM \[en]system SYSTEM
Load the asdf SYSTEM while building.
.TP
.B \[en]load\-system SYSTEM
Same as above (buildapp compatibility)
.TP
.B \-p PACKAGE \[en]package PACKAGE
Change the current package to PACKAGE
.TP
.B \-sp SP \[en]system\-package SP
Combination of \-s SP and \-p SP
.TP
.B \-e FORM \[en]eval FORM
Evaluate FORM while building
.TP
.B \[en]require MODULE
require MODULE while building
.TP
.B \-q \[en]quit
quit lisp here
.TP
.B \-r FUNC \[en]restart FUNC
the build image restarts from calling FUNC
.TP
.B \-E FUNC \[en]entry FUNC
the build image restarts from calling (FUNC argv).
.TP
.B \-i FORM \[en]init FORM
evaluate FORM after the restart.
.TP
.B \-ip FORM \[en]print FORM
evaluate and princ FORM after the restart
.TP
.B \-iw FORM \[en]write FORM
evaluate and write FORM after the restart
.TP
.B \-F FORM \[en]final FORM
evaluate FORM before dumping the IMAGE
.TP
.B \-R \[en]rc
try to read /etc/rosrc, \[ti]/.roswell/init.lisp
.TP
.B +R \[en]no\-rc
skip /etc/rosrc, \[ti]/.roswell/init.lisp
.TP
.B \-Q \[en]quicklisp
load quicklisp (default)
.TP
.B +Q \[en]no\-quicklisp
do not load quicklisp
.TP
.B \-v \[en]verbose
be quite verbose while building
.TP
.B \[en]quiet
suppress output while building (default)
.TP
.B \[en]test
for test purpose
.TP
.B dynamic\-space\-size=[size in MB]
SBCL specific.
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 .
.SH Bugs
.PP
Check out issues list (https://github.com/roswell/roswell/issues)
.SH SEE ALSO
.PP
\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.