ros-install(1)

💖 NAME 💖

okay bestie, this is the ros-install(1) page — the glow-up manual for installing lisp implementations or a quicklisp system. It’s giving “make your lisp setup cute and functional” energy, and we’re gonna read every bit. 💅✨

🌸 SYNOPSIS 🌸

Here’s the whole vibe in two lines, no cap:

• ros install system [system ...]
• ros install impl[/version] [param ...]

🎀 DESCRIPTION 🎀

• system — a name specifying a system. 💖
• impl — a name specifying a lisp implementation. ✨

🔥 INSTALLING A LISP IMPLEMENTATION 🔥

When the impl or system matches one of the supported implementations, roswell fetches, downloads, and installs it into one of the internal directories managed by roswell (~/.roswell, or ROSWELL_INSTALL_DIR). In order to use the installed implementation, you have to run ros-use(1). 🫶

For example, this next command downloads the latest sbcl binary from sbcl.org. Heads up though: this may be different from the default binary installed by roswell, called sbcl-bin. And 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. So yes, bestie, there’s a whole distinction there. 😭

$ ros install sbcl

When invoked without a name, it prints the list of installable implementations. Do not confuse this with ros list installed, which shows the implementations already installed. Periodt. 💀

Usage: ros install impl [OPTIONS]

For more details on impl specific options, type:
ros help install impl

Candidates impls for installation are:
ecl
sbcl
clisp
ccl-bin
sbcl-bin

The name can be optionally followed by a slash / and a version of the implementation. Like:

$ ros install sbcl/1.2.14

There might be some hidden 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). Try stuff, bestie:

$ ros install ccl
$ ros install abcl
$ ...

🦋 INSTALLING A QUICKLISP SYSTEM AND THE BUNDLED ROSWELL SCRIPTS 🦋

If the specified name does not match any of the implementations, roswell tries to find a quicklisp system of the given name. Cute, right?

$ ros install alexandria

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. That’s the little hook moment. ⭐

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. Slay. 🎀

$ ros install qlot
System 'qlot' 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..]

🌈 SEE ALSO 🌈

Go peek at these other pages, bestie: sbcl(1), ros(1), ros-list(1), ros-init(1). 💖

👑 AUTHORS 👑

Roswell Project Team. They ate. 👑

Final sign-off: the footer is simply ros-install(1) — no separate source/version or date line here, just the manual name — so bye bestie, go install something iconic 💋✨