diff --git a/.gitignore b/.gitignore index 8b10e4758..b41f2aa34 100644 --- a/.gitignore +++ b/.gitignore @@ -17,3 +17,4 @@ node_modules/ _gen/ .hugo_build.lock .idea +data/bibliography.json diff --git a/content/en/software/install-and-run/_index.md b/content/en/software/install-and-run/_index.md index 1eeaf7a7a..31dbcb406 100644 --- a/content/en/software/install-and-run/_index.md +++ b/content/en/software/install-and-run/_index.md @@ -1,4 +1,4 @@ ---- +--- title: Install and Run aliases: - /medley/using/build/ @@ -11,25 +11,9 @@ weight: 10 type: docs --- -You can install Medley on a variety of different computer systems. - - -### Download and install from a release - * [Running on Linux](./running-on-linux) - * Packages for .deb distributions and source to build for others - * [Running on Mac](./running-on-mac) - * for MacOS - * [Running on Windows](./running-on-win) - * [Running on Windows with WSL](./running-on-wsl) - - -Medley has a virtual machine architecture: there's a virtual machine implementation (called Maiko) and Lisp software that is compiled into instructions for it. The compiled code and memory images can be moved from one architecture to another -- only Maiko needs to be ported. Maiko has been substantially revised and modernized, so you can to run Medley on many different OSes and machine architectures. - -See the [Maiko README](https://github.com/Interlisp/maiko#readme) and [Medley README](https://github.com/Interlisp/medley#readme) in their respective GitHub repository pages for more details on how to build and run them. +Packaged releases of Medley are available for Linux (most recent distros), MacOS and Windows 10/11. Both x86_64 and Arm64 systems are supported (as well as Arm7 - e.g., Raspberry Pi - for Linux). Instructions for installing and running Medley on these platforms are linked below. -The current systems we've tested or for which we have confirmed reports can be found [in the Maiko github repository](https://github.com/Interlisp/maiko/tree/master/bin), including: -* OS: FreeBSD, Linux, MacOS, Solaris, Windows (using WSL or CygWin) -* CPU: arm7l, arm64, PowerPC, SPARC, i386, x86_64 +Medley is capable of running on a variety of other OSes including FreeBSD and Solaris as well as on other CPU architectures including i386, SPARC, PowerPC, and Risc-V. To install and run Medley on these platforms, you will need to build Medley (and its underlying virtual machine, *Maiko*) from the sources available in the Interlisp repos on github.com. Instructions for building Medley and Maiko can be be found on github in the [*readme* for Maiko](https://github.com/interlisp/maiko) and the [*readme* for Medley](https://github.com/interlisp/medley). diff --git a/content/en/software/install-and-run/linux/_index.md b/content/en/software/install-and-run/linux/_index.md new file mode 100644 index 000000000..6dd95cc4e --- /dev/null +++ b/content/en/software/install-and-run/linux/_index.md @@ -0,0 +1,119 @@ +--- +title: Install and Run on Linux +weight: 20 +aliases: + - /software/install-and-run/running-on-linux/ +type: docs +--- + + +*Note that these instructions do not apply to Linux distros running within Windows System For Linux (WSL). [Separate instructions are available for WSL here.](../windows/wsl).* + +Medley installs and runs on most recent Linux distros (Alpine Linux is one exception). All that is strictly required is that the distro include an X Windows server. Most of the testing for Medley has been done on Ubuntu 20.04 and 22.04. + +We also recommend that the Linux system have a web browser installed. A browser is not strictly necessary to run Medley, but several features of the system (e.g., displaying some user documentation) will not work without a browser installed. + +## **Install Medley** + +Medley can be installed on Linux in one of two configurations: *standard* and *local*. + +* Standard installation is available only for Debian-based distros (e.g., Debian, Ubuntu, MX Linux, Mint Linux, etc.). It will install Medley into system directories (i.e., /usr/local/interlisp) and automatically install any prerequisite packages. +* Local installation will install Medley into any user directory but any prerequisite packages must be installed manually. + +Standard installations are ideal for users who want to explore Medley (including its system code) or to develop applications built on top of Medley. Standard installations are not good for users who want to modify the Medley system code, since that code is installed in protected locations. + +### **Standard Installation (for Debian-based distros only)** + +1. Download the installation file (.deb) for the latest release from the [Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) from under the heading Linux/Standard/Linux. There are are separate .deb files for X86_64, Arm64 and Arm7 (e.g., Raspberry Pi) systems. Download the one that corresponds to your machine architecture. We will refer to the downloaded file as ***\*** + +
Medley Downloads Page

 

+ + > >Alternatively, you can download the .deb files for the current or any previous release from the Medley Releases page on the Interlisp GitHub site. [Instructions for this can be found here](./linux-standard-from-github). + +2. Into any Linux terminal, enter the following commands. This will install Medley and all prerequisite packages. + + ``` + ubuntu@oio:~$ sudo apt update + ubuntu@oio:~$ sudo apt install -y + ``` + +### **Local Installation** +1. Create a directory into which Medley will be installed. We will refer to this directory as ***\*** + +2. Download the release tar file (.tgz) for the latest release from the [Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) from under the heading Linux/Local/Linux. There are are separate .tgz files for X86_64, Arm64 , and Arm7 (e.g., Raspberry Pi) systems. Download the one that corresponds to your machine architecture. We will refer to the downloaded file as ***\*** + +
Medley Downloads Page

 

+ + > >Alternatively, you can download the .deb files for the current or any previous release from the Medley Releases page on the Interlisp GitHub site. [Instructions for this can be found here](./linux-local-from-github). + +3. Untar ****** using the following command: + ``` + ubuntu@oio:~$ tar -xz -C -f + ``` +4. Using the package manager for your distro (e.g., apt for Debian and Ubuntu distros), install the following packages: +a) man-db +b) xdg-utils +c) tigervnc +> ***Notes:*** + +> 4.1. If *xdg-utils* is not available for your Linux distro, then Medley will still run well, with the exception of a few sub-systems that require opening external (to Medley) files. + +> 4.2. On Debian-based systems (including Ubuntu), the *tigervnc* package is not available. Instead install both the *tigervnc-standalone-server package* and the *tigervnc-xorg-extension* package. + +## **Multiple Installations** +**Standard Installations** +Multiple standard installations are not possible. It is possible to have a single Standard installation alongside one or more Local installations. + +**Local Installations** +For local installations, you can install multiple copies of Medley (e.g. different releases). Simply place each installation into a separate ***install_dir***. And follow the install instructions above. + +Each Medley installation so installed will operate independently of other Medley installations. The Medley system code for each installation will remain separate. However, in general the installations will share a single file system. So care must be taken to coordinate access to the file system. + +## **Update Medley** +To update any given Medley installation (e.g., to install a new release), download the updated .deb or .tgz installer file as described above. Then (re)run the appropriate install procedure as described above. + +The chosen Medley installation will be updated. Any user files (i.e., files created by the user that are not part of the Medley distribution) in the Medley file system will remain intact. + +## **Run Medley** +Medley is started from any Linux terminal using the following commands. +##### **Standard Installations** +``` +medley +``` + Example: +Start Medley Standard + +##### **Local Installations** +``` +cd +./medley +``` + Example: +Start Medley Standard + +Documentation for the `` to the `medley` command can be found [here](https://online.interlisp.org/downloads/man_medley.html) + +For first-time users: `medley --vnc --apps --interlisp --noscroll` or, equivalently, `medley -v -a -e -n` is a good starting point. This will give you a fully populated Medley system, including the applications built on Medley such as Notecards and Rooms. + +This will bring up the Medley environment in a separate Window on your Windows desktop. The Medley desktop and windows will all be contained within this Window as shown below. + +![Medley window open on Windows desktop](./images/Medley-on-Linux.png) + + + +## **Use Medley** +Once Medley is up and running, see [here](../../using-medley/_index) for tips on how to navigate and use the Medley environment. + +By default, Medley will use (creating, if necessary) a directory called *$HOME/il*. This will be used by the Medley system as its *LOGINDIR* as follows: + + 1. Medley will start up with *LOGINDIR* as its current connected directory. + + 2. Medley will load any personal init file from *LOGINDIR*/INIT or *LOGINDIR*/INIT.LCOM. + + 3. Medley will use *LOGINDIR*/vmem/ to store its virtual memory file(s). + + The location of *LOGINDIR* can be changed using the `--logindir` option to `medley`. In particular, if you have multiple installations of Medley that you would like to keep completely separate, then you can use the `--logindir` option to ensure the *LOGINDIR* for each installation is unique. + +To exit Medley, type ```(IL:LOGOUT)``` at any Exec window prompt. + + diff --git a/content/en/software/install-and-run/linux/images/Medley-on-Linux.png b/content/en/software/install-and-run/linux/images/Medley-on-Linux.png new file mode 100644 index 000000000..ccef954ee Binary files /dev/null and b/content/en/software/install-and-run/linux/images/Medley-on-Linux.png differ diff --git a/content/en/software/install-and-run/linux/images/downloads-page-base.png b/content/en/software/install-and-run/linux/images/downloads-page-base.png new file mode 100644 index 000000000..4b6caa53f Binary files /dev/null and b/content/en/software/install-and-run/linux/images/downloads-page-base.png differ diff --git a/content/en/software/install-and-run/linux/images/downloads-page-linux-local.png b/content/en/software/install-and-run/linux/images/downloads-page-linux-local.png new file mode 100644 index 000000000..3ba093e5e Binary files /dev/null and b/content/en/software/install-and-run/linux/images/downloads-page-linux-local.png differ diff --git a/content/en/software/install-and-run/linux/images/downloads-page-linux-standard.png b/content/en/software/install-and-run/linux/images/downloads-page-linux-standard.png new file mode 100644 index 000000000..0d6926679 Binary files /dev/null and b/content/en/software/install-and-run/linux/images/downloads-page-linux-standard.png differ diff --git a/content/en/software/install-and-run/linux/images/linux-local.png b/content/en/software/install-and-run/linux/images/linux-local.png new file mode 100644 index 000000000..a9849a0ec Binary files /dev/null and b/content/en/software/install-and-run/linux/images/linux-local.png differ diff --git a/content/en/software/install-and-run/linux/images/linux-standard.png b/content/en/software/install-and-run/linux/images/linux-standard.png new file mode 100644 index 000000000..cb36a2541 Binary files /dev/null and b/content/en/software/install-and-run/linux/images/linux-standard.png differ diff --git a/content/en/software/install-and-run/linux/images/releases-page-assets-base.png b/content/en/software/install-and-run/linux/images/releases-page-assets-base.png new file mode 100644 index 000000000..fefda80e1 Binary files /dev/null and b/content/en/software/install-and-run/linux/images/releases-page-assets-base.png differ diff --git a/content/en/software/install-and-run/linux/images/releases-page-landing.png b/content/en/software/install-and-run/linux/images/releases-page-landing.png new file mode 100644 index 000000000..915b429af Binary files /dev/null and b/content/en/software/install-and-run/linux/images/releases-page-landing.png differ diff --git a/content/en/software/install-and-run/linux/images/releases-page-linux-local.png b/content/en/software/install-and-run/linux/images/releases-page-linux-local.png new file mode 100644 index 000000000..bf7d017c2 Binary files /dev/null and b/content/en/software/install-and-run/linux/images/releases-page-linux-local.png differ diff --git a/content/en/software/install-and-run/linux/images/releases-page-linux-standard.png b/content/en/software/install-and-run/linux/images/releases-page-linux-standard.png new file mode 100644 index 000000000..b0d2fa155 Binary files /dev/null and b/content/en/software/install-and-run/linux/images/releases-page-linux-standard.png differ diff --git a/content/en/software/install-and-run/linux/linux-local-from-github.md b/content/en/software/install-and-run/linux/linux-local-from-github.md new file mode 100644 index 000000000..616ca918e --- /dev/null +++ b/content/en/software/install-and-run/linux/linux-local-from-github.md @@ -0,0 +1,19 @@ +--- +title: Download WSL (Local Installation) Install Files from Github +weight: 40 +toc_hide: true +hide_summary: true +type: docs +--- + + +1. Go to the [Releases page for Interlisp/Medley on github.com](https://github.com/interlisp/medley/releases). Here you will see a list of releases in reverse chronological order. +
Github Releases Page

 

+ +3. Choose the release you are interested in (most likely the release marked ***Latest***) and click on the arrow next the word ***Assets*** to reveal the list of assets (i.e., installation files) for that release. + +4. To download the .tgz install file, click on the link that ends with ***.tgz*** and begins with either ***medley-full-linux-x86_64*** (if you are installing on an x86_64-based machine) or ***medley-full-linux-aarch64*** (if you are installing on an Arm64-based machine) or ***medley-full-linux-arm7l*** (if you are installing on an Arm7-based machine - e.g., a Raspberry Pi). +
Github Releases Page Assets

 

+ + + diff --git a/content/en/software/install-and-run/linux/linux-standard-from-github.md b/content/en/software/install-and-run/linux/linux-standard-from-github.md new file mode 100644 index 000000000..3a390e4b5 --- /dev/null +++ b/content/en/software/install-and-run/linux/linux-standard-from-github.md @@ -0,0 +1,19 @@ +--- +title: Download WSL (Standard Installation) Install Files from Github +weight: 40 +toc_hide: true +hide_summary: true +type: docs +--- + + +1. Go to the [Releases page for Interlisp/Medley on github.com](https://github.com/interlisp/medley/releases). Here you will see a list of releases in reverse chronological order. +
Github Releases Page

 

+ +3. Choose the release you are interested in (most likely the release marked ***Latest***) and click on the arrow next the word ***Assets*** to reveal the list of assets (i.e., installation files) for that release. + +4. To download the .tgz install file, click on the link that ends with ***.deb*** and begins with either ***medley-full-linux-x86_64*** (if you are installing on an x86_64-based machine) or ***medley-full-linux-aarch64*** (if you are installing on an Arm64-based machine) or ***medley-full-linux-arm7l*** (if you are installing on an Arm7-based machine - e.g., a Raspberry Pi). +
Github Releases Page Assets

 

+ + + diff --git a/content/en/software/install-and-run/macos/_index.md b/content/en/software/install-and-run/macos/_index.md new file mode 100644 index 000000000..4676a5972 --- /dev/null +++ b/content/en/software/install-and-run/macos/_index.md @@ -0,0 +1,110 @@ +--- +title: Install and Run on MacOS +weight: 30 +type: docs +aliases: + - /running/running-on-mac + - /software/install-and-run/running-on-mac/ +--- + + +## **Prerequisite: Install XQuartz** + +Before installing and running Medley on your Mac, you will need to download and install XQuartz - an open-source X11 Windows server for the Mac. You can download the latest XQuartz .pkg from [XQuartz.org](https://xquartz.org) and install it using the MacOS installer. + +If you do not have a three-button mouse on your Mac, you will need to set `Emulate three button mouse` in the XQuartz preferences. + +>To do so, start XQuartz (e.g., by double clicking the XQuartz icon within Launchpad). Select XQuartz->Preferences from the menu bar. In the Preferences dialog, select the Input tab and then check the *Emulate three button mouse* option. + +## **Install Medley** + +Medley releases on MacOS are distributed as a .zip file. The .zip file contains universal binaries so that the same file can be used for either Intel or Apple Silicon machines. + +To install Medley: + +1. Download the latest release .zip from the [Medley downloads page](https://online.interlisp.org/downloads/medley_downloads.html) , under the heading "MacOS ...". + +
Medley Downloads Page

 

+ +>> You can also download the installation .zip file for the latest as well as any prior releases from the Medley Releases page on the Interlisp GitHub site. [Instructions for this can be found here](./macos-from-github). + +2. Copy the downloaded *medley-full-macos-universal...zip* file (which MacOS treats as an unzipped folder) from the Downloads folder into any folder of your choosing. Optionally, rename the target folder of the copy from *medley-full-macos-universal...* to something more manageable - e.g., *medley-latest*. For the purposes of these instructions, we will call this (renamed) folder the *\*. + +3. In a Terminal window, you will need to remove the quarantine attributes from the executable files by executing the following command: + +``` + xattr -d com.apple.quarantine /maiko/darwin.universal/lde* +``` +For example (assuming *\* is *~/il/medley-latest*): + +``` + ssd@Mac-mini ~ % xattr -d com.apple.quarantine ~/il/medley-latest/maiko/darwin.universal/lde* +``` +## **Multiple Installations** +You can install multiple copies of Medley (e.g. different releases). Simply make sure the ** for each installation has a unique pathname and then follow the install instructions above. + +Each Medley installation so installed will operate independently of other Medley installations. The Medley system code for each installation will remain separate. However, in general the installations will share a single file system. So care must be taken to coordinate access to the file system. + +## **Update Medley** +To update any given Medley installation (e.g., to install a new release), download the updated .zip installer file as described above. + +The simplest update would be to delete the original *\* and install the updated zip file as described above. However, this will delete any files/folders added by the user to *\*. + +To preserve any user added files in *\*, you instead need to open a Terminal and execute the following command: +``` + cp -rp +``` + +For example (assuming that ***\*** is *~/il/medley2* and that the updated .zip folder is *~/Downloads/medley-full-macos-universal-240126-39ee2ecb_231112-42477318/*): +``` + ssd@mini ~ % cp -rp ~/Downloads/medley-full-macos-universal-240126-39ee2ecb_231112-42477318/* ~/il/medley2 +``` +The chosen Medley installation will be updated. Any user files (i.e., files created by the user that are not part of the Medley distribution) in the Medley file system will remain intact. + +## **Run Medley** + +On MacOS, Medley must be started from a Terminal window. + +At the Terminal prompt, you need to execute the following commands: +``` + cd /medley` + ./medley + ``` + +For example: +``` + ssd@Mac-mini ~ % cd ~/il/medley-latest/medley + ssd@Mac-mini medley % ./medley --apps --interlisp --noscroll +``` +Note that the first time you run it, Medley may take 10-15 seconds to start up as it starts the XQuartz X Windows server (assuming that it is not already running). +>You can optionally start the XQuartz server manually before starting Medley. It will take 10-15 seconds to start up and then display an Xterm window in the upper-left corner of the screen. You can just close this Xterm window. + +Documentation for the `` to the `medley` command can be found [here](https://online.interlisp.org/downloads/man_medley.html) + +For first-time users: `medley --vnc --apps --interlisp --noscroll` or, equivalently, `medley -v -a -e -n` is a good starting point. This will give you a fully populated Medley system, including the applications built on Medley such as Notecards and Rooms. It will also start with a Interlisp Exec window (instead of the default Xerox Common Lisp Exec window). + +This will bring up the Medley environment in a separate window on your desktop. The Medley desktop and windows will all be contained within this window as shown below. + +![Medley window open on MacOS desktop](./images/Medley-on-MacOS.png) + +## **Use Medley** +Once Medley is up and running, see [here](../../using-medley/_index) for tips on how to navigate and use the Medley environment. + +By default, Medley will use (creating, if necessary) a directory called *$HOME/il*. This will be used by the Medley +system as its *LOGINDIR* as follows: + + 1. Medley will start up with *LOGINDIR* as its current connected directory. + + 2. Medley will load any personal init file from *LOGINDIR*/INIT or *LOGINDIR*/INIT.LCOM. + + 3. Medley will use *LOGINDIR*/vmem/ to store its virtual memory file(s). + + The location of *LOGINDIR* can be changed using the `--logindir` option to `medley`. In particular, if you have multiple installations of Medley that you would like to keep completely separate, then you can use the `--logindir` option to ensure the *LOGINDIR* for each installation is unique. + +To exit Medley, type ```(IL:LOGOUT)``` at any Exec window prompt. + + + + + + diff --git a/content/en/software/install-and-run/macos/images/Medley-on-MacOS.png b/content/en/software/install-and-run/macos/images/Medley-on-MacOS.png new file mode 100644 index 000000000..d9ac0c47a Binary files /dev/null and b/content/en/software/install-and-run/macos/images/Medley-on-MacOS.png differ diff --git a/content/en/software/install-and-run/macos/images/downloads-page-base.png b/content/en/software/install-and-run/macos/images/downloads-page-base.png new file mode 100644 index 000000000..4b6caa53f Binary files /dev/null and b/content/en/software/install-and-run/macos/images/downloads-page-base.png differ diff --git a/content/en/software/install-and-run/macos/images/downloads-page-macos.png b/content/en/software/install-and-run/macos/images/downloads-page-macos.png new file mode 100644 index 000000000..74ccc11ba Binary files /dev/null and b/content/en/software/install-and-run/macos/images/downloads-page-macos.png differ diff --git a/content/en/software/install-and-run/macos/images/releases-page-assets-base.png b/content/en/software/install-and-run/macos/images/releases-page-assets-base.png new file mode 100644 index 000000000..fefda80e1 Binary files /dev/null and b/content/en/software/install-and-run/macos/images/releases-page-assets-base.png differ diff --git a/content/en/software/install-and-run/macos/images/releases-page-landing.png b/content/en/software/install-and-run/macos/images/releases-page-landing.png new file mode 100644 index 000000000..915b429af Binary files /dev/null and b/content/en/software/install-and-run/macos/images/releases-page-landing.png differ diff --git a/content/en/software/install-and-run/macos/images/releases-page-macos.png b/content/en/software/install-and-run/macos/images/releases-page-macos.png new file mode 100644 index 000000000..92ed8b5e6 Binary files /dev/null and b/content/en/software/install-and-run/macos/images/releases-page-macos.png differ diff --git a/content/en/software/install-and-run/macos/macos-from-github.md b/content/en/software/install-and-run/macos/macos-from-github.md new file mode 100644 index 000000000..faf7f0c92 --- /dev/null +++ b/content/en/software/install-and-run/macos/macos-from-github.md @@ -0,0 +1,19 @@ +--- +title: Download MacOS Install File from Github +weight: 40 +toc_hide: true +hide_summary: true +type: docs +--- + + +1. Go to the [Releases page for Interlisp/Medley on github.com](https://github.com/interlisp/medley/releases). Here you will see a list of releases in reverse chronological order. +
Github Releases Page

 

+ +3. Choose the release you are interested in (most likely the release marked ***Latest***) and click on the arrow next the word ***Assets*** to reveal the list of assets (i.e., installation files) for that release. + +4. To download the .zip install file, click on the link that begins with ***medley-full-macos-universal*** and ends with ***.zip***. +
Github Releases Page Assets

 

+ + + diff --git a/content/en/software/install-and-run/running-on-linux.md b/content/en/software/install-and-run/running-on-linux.md deleted file mode 100644 index 82b551b78..000000000 --- a/content/en/software/install-and-run/running-on-linux.md +++ /dev/null @@ -1,148 +0,0 @@ ---- -title: Install and Run on Linux -weight: 20 -type: docs ---- - -Medley runs on most any Linux system that includes X Windows. - -Note that for Windows users of System For Linux (WSL) on Windows 11 and Windows 10 Build 19044+, there are [separate instructions](./running-on-wsl). - -We recommend the Linux system have a web browser installed. -A browser is not strictly necessary to run Medley, but several features of the system (e.g., displaying some user documentation) will not work without an external browser installed. - -Medley can be installed on your Linux system in one of two configurations: *standard* and *local*. - -* Standard installation will install Medley into system directories and install any prerequisite packages. -* Local installation will install Medley into any user directory but any prerequisite packages must be installed manually. - -## **Standard Installation \(Debian-based systems only\)** - -We are currently only building standard installations for Debian-based systems (i.e., systems that support dpkg). - -In a standard Linux installation, Medley is installed in system directories -under /usr/local/interlisp. Man pages and (links to) the medley executable are also installed in standard system locations (e.g., /usr/local/man and /usr/local/bin). - -Standard installations are ideal for users who want to explore Medley (including its system code) or to develop applications built on top of Medley. Standard installations are not good for users who want to modify the Medley system code, since that code is installed in protected locations. - -Standard installation uses `apt` to install a .deb package downloaded from -the [Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html). -The .deb package will install Medley as well as any other packages needed for Medley to run. - -## Accessing Medley - -1. Use a browser to download from the .deb package for your platform (i.e., "standard" Linux or WSL) and your machine architecture (X86_64, ARM64, or ARMv7) to `` from [the Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) - -2. Enter the following in a terminal to install the download: - - ```bash - ubuntu@oio:~$ sudo apt update - ubuntu@oio:~$ sudo apt install -y - ``` - -3. Enter the following in a terminal to run medley: - - ```bash - ubuntu@oio:~$ medley - ``` - - There are many options to the `medley` command. For a brief overview, run `medley --help`. - For a more complete description, run `man medley` or `medley --man` or click - [here](https://online.interlisp.org/downloads/man_medley.html). - - For first-time users: `medley --apps` or for WSL `medley --apps --vnc` is a good starting - point. This will give you a fully populated Medley system, including the applications built on Medley such as Notecards and Rooms. - -4. To exit Medley execute `(IL:LOGOUT)` at the Lisp prompt. - -#### Notes: - -* By default, `medley` will create a directory in *$HOME/il*. This will be used by the Medley - system as its *LOGINDIR*. Medley will start up with *LOGINDIR* as its current connected directory. - It will load the personal init file (if any) from *LOGINDIR*/INIT or *LOGINDIR*/INIT.LCOM. Finally, - Medley will use *LOGINDIR*/vmem/ to store its virtual memory file(s). The location of *LOGINDIR* - can be changed using the `--logindir` option to `medley`. - -### **Local Installation** - -In a local installation, the Medley system is installed into any user directory from a .tar file. -Multiple "Medleys" can be installed in different directories on one machine without interference -(except see description of Medley *LOGINDIR* below). Local installation makes it easy (from a file -management p.o.v.) to modify the Medley system code. - -Local installation doesn't involve a package manager, so you are responsible for installing any -prerequisite packages onto your system before you install Medley. - -Also note that with local installations, `man medley` will not work. However, as indicated below, -`./medley --man` will show the medley man page. - -#### To install and run Medley locally: - -1. Install prerequite packages - - * For non-WSL installations, use your distro's package manager to install `xdg-utils`. - - * For WSL all installations, use your distro's package manager to install `wslu`. - - Note that some distros do not include `wslu` in their standard repos. See - [https://wslutiliti.es/wslu/install.html](https://wslutiliti.es/wslu/install.html) - for installation instructions if this is the case. - - Also note that `wslu v4.0` does not work with Medley, so you will need to install - either a version < v.40 or >= v4.1. - - - * For WSL installations where the VNC feature will be used, install the `tigervnc-standalone-server` and `tigervnc-xorg-extension` packages. - - When using the VNC feature Medley will display in a VNC Window instead of a standard X Window. - This is useful on high resolution displays since the VNC window will scale according to the - Windows Settings->Display->Scale setting, while the X Window on WSL will not so scale. - - Note that Medley will install and run even if none of these prerequite packages are installed. - However, some features (e.g., viewing documentation in an external browser) will be inoperable. - -2. Download - - Using a browser download from - [the Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) - the tar (.tgz) file for your platform (i.e., "standard" Linux or WSL) and your machine - architecture (X86_64, ARM64, or ARMv7) to ``. - - Note that on WSL, `` will depend on whether the browser was started in Windows or in WSL. If downloading to the standard Downloads folder, using a WSL-based browser `` will be in `~/Downloads`. If using a Windows-based browser, `` will be in `/mnt/c/Users//Downloads`. - - -3. Install Medley - - In a terminal: - - ``` - ubuntu@oio:~$ mkdir - ubuntu@oio:~$ tar -C -xzf - ``` - -4. Run Medley - - In a terminal: - - ``` - ubuntu@oio:~$ cd /medley - ubuntu@oio:~$ ./medley - ``` - - There are many options to the `medley` command. For a brief overview, run `./medley --help`. - For a more complete description, run `./medley --man` or click - [here](https://online.interlisp.org/downloads/man_medley.html). - - For first-time users: `./medley --apps` or for WSL (and you have installed the VNC prerequisites) - `./medley --apps --vnc` is a good starting point. This will give you a fully populated Medley system, - including the applications built on Medley such as Notecards and Rooms. - -#### Notes: - -* By default, `medley` will create a directory in *$HOME/il*. This will be used by the Medley - system as its *LOGINDIR*. Medley will start up *LOGINDIR* as its current connected directory. - It will load any personal init file from *LOGINDIR*/INIT or *LOGINDIR*/INIT.LCOM. Finally, - Medley will use *LOGINDIR*/vmem/ to store its virtual memory file(s). The location of *LOGINDIR* - can be changed using the `--logindir` option to `medley`. In particular, if you have multiple - installations of Medley that you would like to keep completely separate, then you can use the - `--logindir -` option, which will set *LOGINDIR* to \/logindir. diff --git a/content/en/software/install-and-run/running-on-mac.md b/content/en/software/install-and-run/running-on-mac.md deleted file mode 100644 index 764cb6cea..000000000 --- a/content/en/software/install-and-run/running-on-mac.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: Install and Run on MacOS -weight: 30 -type: docs -aliases: - - /running/running-on-mac ---- - - -## **Prerequisite: Install XQuartz** - -Before installing and running Medley on your Mac, you will need to download and install XQuartz - an open-source X11 Windows server for the Mac. You can download the latest XQuartz .pkg from [XQuartz.org](https://xquartz.org) and install it using the MacOS installer. - -If you do not have a three-button mouse on your Mac, you will need to set `Emulate three button mouse` in the XQuartz preferences. - ->To do so, start XQuartz (e.g., by double clicking the XQuartz icon within Launchpad). Select XQuartz->Preferences from the menu bar. In the Preferences dialog, select the Input tab and then check the *Emulate three button mouse* option. - -## **Install Medley** - -Medley releases on MacOS are distributed as a .zip file. The .zip file contains universal binaries so that the same file can be used for either Intel or Apple Silicon machines. - -To install Medley: - -1. Download the latest release .zip from the Medley latest releases page [(here)](https://online.interlisp.org/downloads/medley_downloads.html) , under the heading "MacOS ...". - - >You can also download the latest release .zip as well as any prior release .zips from the Medley GitHub site [(here)](https://github.com/Interlisp/medley/releases). In the Assets for any given release, the MacOS .zip file will be entitled *medley-full-macos-universal...zip* - -2. Drag the downloaded *medley-full-macos-universal...zip* file (which MacOS treats as an unzipped folder) from the Downloads folder into any folder of your choosing. For the purposes of these instructions, we will call this the *\*. And the file/folder just dragged into the \, we will call the *\*. - >You may also want to rename the \ from *medley-full-macos-universal...* to something more manageable - e.g., *medley-latest*. - -4. In a Terminal window, you will need to remove the quarantine attributes from the executable files by executing the following command: -`xattr -d com.apple.quarantine //maiko/darwin.universal/lde*` - - For example: -``` -ssd@Mac-mini ~ % xattr -d com.apple.quarantine ~/il/medley-latest/maiko/darwin.universal/lde* -``` - - -## **Run Medley** - -On MacOS, Medley must be started from a Terminal window. - -At the Terminal prompt, you need to execute the command `//medley/medley`. ->Note: it is usually easiest to first `cd \/\/medley` and then just execute `./medley` - -For example: -``` -ssd@Mac-mini ~ % cd ~/il/medley-latest/medley -ssd@Mac-mini medley % ./medley -a -e -n -``` - -Note that the first time you run it, Medley may take 10-15 seconds to start up as it starts the XQuartz X Windows server (assuming that it is not already running). ->You can optionally start the XQuartz server manually before starting Medley. It will take 10-15 seconds to start up and then display an Xterm window in the upper-left corner of the screen. You can just close this Xterm window. - -There are many options to the `medley` command. For a brief overview, run `./medley --help`. For a more complete description, run `./medley --man` or click - [here](https://online.interlisp.org/downloads/man_medley.html). - -For first-time users: `./medley -a -e -n` is a good starting point. This will give you a fully populated Medley system, including the applications built on Medley such as Notecards and Rooms. It will start with a Interlisp Exec window (instead of the Xerox Common Lisp Exec window). - -To exit Medley execute `(IL:LOGOUT)` at the Lisp prompt. - -#### Notes: - ->By default, `medley` will create a directory in *$HOME/il*. This will be used by the Medley system as its *LOGINDIR*. Medley will start up with *LOGINDIR* as its current connected directory. It will load the personal init file (if any) from *LOGINDIR*/INIT or *LOGINDIR*/INIT.LCOM. Finally, Medley will use *LOGINDIR*/vmem/ to store its virtual memory file(s). The location of *LOGINDIR* can be changed using the `--logindir` option to `medley`. - - - - - diff --git a/content/en/software/install-and-run/running-on-win.md b/content/en/software/install-and-run/running-on-win.md deleted file mode 100644 index 502720f7a..000000000 --- a/content/en/software/install-and-run/running-on-win.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Install and Run on Windows 10/11 -weight: 40 -type: docs -aliases: - - /hugo/running/running-on-win/ - - /medley/using/running/running-on-win ---- - -Running Medley on Windows can be done with some ease if you have WSL (Windows System for Linux). There's now also the possibility a "native" install. - -The two ways result in similar Medley experiences, but differ in how Medley is installed and run, how the Windows file system is seen, and possibly some unforeseen challenges (the "native" install is relatively new). - -Medley native works within the ordinary Windows environment. Installation uses standard Windows installer and you start Medley from a standard Command (or Powershell) window. Medley native is best for users who prefer to stay (almost) exclusively in the Windows environment. - -Medley on WSL and native Medley both require 64-bit Windows 10/11. - -### Running on Windows natively** - -When running on Windows natively, Medley will be installed into a directory (of your choice). This directory will contain an isolated copy of the Cygwin environment and a version of Medley that runs within that specific Cygwin environment. This complexity, however, is largely hidden from the user and Medley behaves as if it is a native Windows app. - -#### To install and run Medley natively - -1. Download the Medley Windows installer from under the Windows 10/11 heading [here](https://online.interlisp.org/downloads/medley_downloads.html). - -2. Start the Medley installation app (e.g., by double clicking on the .exe just downloaded). - -The installation app will ask for the directory in which to install Medley. Any directory that you have read/write access to will suffice. (We will refer to this directory as the Medley ***install_dir***.) - - The installation app will then copy the Medley files into the specified directory. It will also run the Cygwin installer to install Cygwin into the specified directory as well. - - **Note:** To run the installation app, you may have to bypass the Windows security protections against running .exe files downloaded from the web. For example, if the following dialog appears, you will need to select the `More info` link and then click on the `Run anyway` button that appears. - -
Windows Protection Dialog

 

- -3. *Run Medley:* Once it is installed, you can start Medley from either a Command window or a Powershell window. You cannot (currently) start Medley from the Start Menu or from an icon on the desktop. - - From a Command window, type: - ``` - cd - medley - ``` - - From a Powershell window, type: - ``` - cd - cmd /C medley - ``` - -4. To exit Medley execute `(IL:LOGOUT)` at the Lisp prompt. - -Documentation for the `` to the `medley` command can be found [here](https://online.interlisp.org/downloads/man_medley.html) - -For first-time users: `medley --apps --interlisp --noscroll` or, equivalently, `medley -a -e -n` is a good starting point. This will give you a fully populated Medley system, including the applications built on Medley such as Notecards and Rooms. - -#### Notes -1. One anomaly of the native Windows install is that the file system from within Medley does not map directly to the file system as seen from the Windows Explorer. Specifically, within Medley, the {DSK} and {UNIX} file system root (i.e., "{DSK}/" and "{UNIX}/") is mapped to [***install_dir***](#to-install-and-run-medley-native). Medley will find the Windows C: drive as {DSK}/c/ (or "{DSK}"). - -Your Medley LOGINDIR will be ***/home/<name>/il*** (or ***<install_dir>\home\\<name>\il*** from the Windows perspective), where ***<name>*** is your Windows username. Medley code is stored in ***/medley*** (or ***<install_dir>\medley*** from the Windows perspective). - -Also, from within Medley you can refer to any file in the Windows file system using ***/<drive letter>/<windows path using "/" instead of "\\">***. Example: ***C:\User\Frank\Downloads\foo*** in Windows will be ***/c/User/Frank/Downloads/foo*** in Medley. (Note that this means that within Medley, ***/medley/foo*** and ***/c/<install_dir>/medley/foo*** will be references to the same Windows file.) - -2. If you want to work with the Medley code using git, etc. You will probably find it easier to work with git within Cygwin rather than work with git in Windows. To work within the Medley-specific Cygwin, within a Powershell or Command window: - - ``` - cd - .\bin\bash -login - ``` - - This will get you a bash terminal running under the Medley-specific Cygwin - which means that the file mappings will be the same as in Medley. - -3. The Medley-specific Cygwin install is rather minimal, so if you find you need other Linux tools to work with the Medley code, the Cygwin setup tool (which also functions as its package manager) is available at ***<install_dir>\cygwin\setup_x86_64.exe*** (in Windows) or at ***/cygwin/setup_x86_64.exe*** (from within Cygwin bash). - diff --git a/content/en/software/install-and-run/running-on-wsl.md b/content/en/software/install-and-run/running-on-wsl.md deleted file mode 100644 index 1b2fbec9e..000000000 --- a/content/en/software/install-and-run/running-on-wsl.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Install and Run on Windows with WSL -weight: 20 -type: docs ---- - -Medley on WSL involves installing and maintaining the WSL subsystem within Windows. When installing and using Medley on WSL, you are working within Linux. Some familiarity with Linux and the Linux command line is helpful. - -Medley on WSL is best for users who are running WSL anyway and/or prefer working in a Linux environment. Medley sees the WSL file system, and Windows files appear under `/mnt/c/`, e.g., Windows download will be in `/mnt/c/Users/yourname/Downloads`. - -Medley will run on either WSL1 or WSL2. WSL2 is preferred, but for older machines that do not support virtualization (see -[here](https://learn.microsoft.com/en-us/virtualization/hyper-v-on-windows/reference/hyper-v-requirements)) -or Windows builds prior to Windows 10 Build 19041, WSL1 will work just fine although it will be limited to the VNC mode (see below). - -For WSL installations, the browser(s) on the Windows side will suffice. - -There are release configurations for Debian-based systems; i.e., systems that support dpkg), including Debian-based distros on WSL. - -In the [Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) get the release asset for WSL and your host machine type (X86_64, ARM64, ARMv7). - -The WSL packages differ only in -that they include an additional functionality to have Medley display in a VNC Window -instead of a standard X Window. This is useful on high resolution displays since -the VNC window will scale according to the Windows Settings->Display->Scale setting, -while the X Window on WSL will not so scale. The WSL packages also install the wslu -package, which is used by Medley to connect to external browsers as described above. -Aside from these two features, a non-WSL .deb package will install and run on WSL. - -To exit Medley execute `(IL:LOGOUT)` at the Lisp prompt. - -## Accessing Medley for WSL - -1. Use a browser to download from the .deb package for your platform (i.e., "standard" WSL) and your machine architecture (X86_64, ARM64, or ARMv7) to `` from [the Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) - `` will depend on whether the browser was started in Windows or in WSL: - -* If downloading to the standard Downloads folder, using a WSL-based browser `` will be in `~/Downloads`. - - * If using a Windows-based browser, `` will be in `/mnt/c/Users//Downloads`. diff --git a/content/en/software/install-and-run/windows/_index.md b/content/en/software/install-and-run/windows/_index.md new file mode 100644 index 000000000..5135f6623 --- /dev/null +++ b/content/en/software/install-and-run/windows/_index.md @@ -0,0 +1,21 @@ +--- +title: Install and Run on Windows +weight: 40 +type: docs +--- + +There are two ways to install and run Medley on Windows: + 1. Run Medley on Windows System for Linux (WSL) + 2. Run the 'native' Medley Windows app + +These two ways result in (nearly) identical Medley experiences, but differ in how Medley is installed and started. + +Medley on WSL requires the WSL subsystem to be installed on your Windows system. And when installing and using Medley on WSL you are working within a Linux environment. Some familiarity with Linux and the Linux command line is helpful. Medley on WSL is best for users who are running WSL anyway and/or prefer working in a Linux environment. + +Medley 'native' works within the ordinary Windows environment. Installation uses a standard Windows installer and you start Medley from a standard Command (or Powershell) window. Medley 'native' is best for users who prefer to stay (almost) exclusively in the Windows environment. + +Medley on WSL and 'native' Medley both require 64-bit Windows 10/11. + + + + diff --git a/content/en/software/install-and-run/windows/images/Medley-on-Windows.png b/content/en/software/install-and-run/windows/images/Medley-on-Windows.png new file mode 100644 index 000000000..a6b93fc7a Binary files /dev/null and b/content/en/software/install-and-run/windows/images/Medley-on-Windows.png differ diff --git a/content/en/software/install-and-run/windows/images/downloads-page-base.png b/content/en/software/install-and-run/windows/images/downloads-page-base.png new file mode 100644 index 000000000..4b6caa53f Binary files /dev/null and b/content/en/software/install-and-run/windows/images/downloads-page-base.png differ diff --git a/content/en/software/install-and-run/windows/images/downloads-page-windows-native.png b/content/en/software/install-and-run/windows/images/downloads-page-windows-native.png new file mode 100644 index 000000000..e532a3eac Binary files /dev/null and b/content/en/software/install-and-run/windows/images/downloads-page-windows-native.png differ diff --git a/content/en/software/install-and-run/windows/images/downloads-page-wsl-local.png b/content/en/software/install-and-run/windows/images/downloads-page-wsl-local.png new file mode 100644 index 000000000..0fbcdae1e Binary files /dev/null and b/content/en/software/install-and-run/windows/images/downloads-page-wsl-local.png differ diff --git a/content/en/software/install-and-run/windows/images/downloads-page-wsl-standard.png b/content/en/software/install-and-run/windows/images/downloads-page-wsl-standard.png new file mode 100644 index 000000000..8533e461c Binary files /dev/null and b/content/en/software/install-and-run/windows/images/downloads-page-wsl-standard.png differ diff --git a/content/en/software/install-and-run/windows/images/releases-page-assets-base.png b/content/en/software/install-and-run/windows/images/releases-page-assets-base.png new file mode 100644 index 000000000..fefda80e1 Binary files /dev/null and b/content/en/software/install-and-run/windows/images/releases-page-assets-base.png differ diff --git a/content/en/software/install-and-run/windows/images/releases-page-landing.png b/content/en/software/install-and-run/windows/images/releases-page-landing.png new file mode 100644 index 000000000..915b429af Binary files /dev/null and b/content/en/software/install-and-run/windows/images/releases-page-landing.png differ diff --git a/content/en/software/install-and-run/windows/images/releases-page-windows-native.png b/content/en/software/install-and-run/windows/images/releases-page-windows-native.png new file mode 100644 index 000000000..71c34d413 Binary files /dev/null and b/content/en/software/install-and-run/windows/images/releases-page-windows-native.png differ diff --git a/content/en/software/install-and-run/windows/images/releases-page-windows-wsl-local.png b/content/en/software/install-and-run/windows/images/releases-page-windows-wsl-local.png new file mode 100644 index 000000000..11c568198 Binary files /dev/null and b/content/en/software/install-and-run/windows/images/releases-page-windows-wsl-local.png differ diff --git a/content/en/software/install-and-run/windows/images/releases-page-windows-wsl-standard.png b/content/en/software/install-and-run/windows/images/releases-page-windows-wsl-standard.png new file mode 100644 index 000000000..925192030 Binary files /dev/null and b/content/en/software/install-and-run/windows/images/releases-page-windows-wsl-standard.png differ diff --git a/content/en/software/install-and-run/windows/images/windows-native-command.png b/content/en/software/install-and-run/windows/images/windows-native-command.png new file mode 100644 index 000000000..cdf82e901 Binary files /dev/null and b/content/en/software/install-and-run/windows/images/windows-native-command.png differ diff --git a/content/en/software/install-and-run/windows/images/windows-native-powershell.png b/content/en/software/install-and-run/windows/images/windows-native-powershell.png new file mode 100644 index 000000000..2ccf008b9 Binary files /dev/null and b/content/en/software/install-and-run/windows/images/windows-native-powershell.png differ diff --git a/content/en/software/install-and-run/windows/images/windows-protected.png b/content/en/software/install-and-run/windows/images/windows-protected.png new file mode 100644 index 000000000..e5b41a5b2 Binary files /dev/null and b/content/en/software/install-and-run/windows/images/windows-protected.png differ diff --git a/content/en/software/install-and-run/windows/images/windows-wsl-local.png b/content/en/software/install-and-run/windows/images/windows-wsl-local.png new file mode 100644 index 000000000..14e067b17 Binary files /dev/null and b/content/en/software/install-and-run/windows/images/windows-wsl-local.png differ diff --git a/content/en/software/install-and-run/windows/images/windows-wsl-standard.png b/content/en/software/install-and-run/windows/images/windows-wsl-standard.png new file mode 100644 index 000000000..43e71c661 Binary files /dev/null and b/content/en/software/install-and-run/windows/images/windows-wsl-standard.png differ diff --git a/content/en/software/install-and-run/windows/native/_index.md b/content/en/software/install-and-run/windows/native/_index.md new file mode 100644 index 000000000..fff29ffed --- /dev/null +++ b/content/en/software/install-and-run/windows/native/_index.md @@ -0,0 +1,100 @@ +--- +title: Install and Run on Windows "natively" +weight: 40 +type: docs +aliases: + - /software/install-and-run/running-on-win/ +--- + + +When running on Windows natively, Medley will be installed into a directory of your choice. This directory will contain an isolated copy of the Cygwin environment (an adaptation of Linux tools and apps to Windows) and a version of Medley that runs within that specific Cygwin environment. This presence of Cygwin, however, is largely hidden from the user and Medley behaves as if it is a native Windows app. + +## Install Medley + +1. Download the native Medley Windows installer for the latest release from under the Windows 10/11 heading on the [Medley downloads page](https://online.interlisp.org/downloads/medley_downloads.html). +
Medley Downloads Page

 

+ +  + + > >Alternatively, you can download the Medley Windows installer for the current or any previous release from the Medley Releases page on the Interlisp GitHub site. [Instructions for this can be found here](./windows-native-from-github). + + 2. Start the Medley installation app (e.g., by double clicking on the .exe just downloaded). + +>The installation app will ask for the directory in which to install Medley. Any directory that you have read/write access to will suffice. (We will refer to this directory as the Medley ***install_dir***.) + +> The installation app will then copy the Medley files into the specified directory. It will also run the Cygwin installer to install Cygwin into the specified directory as well. + +> **Note:** To run the installation app, you may have to bypass the Windows security protections against running .exe files downloaded from the web. For example, if the following dialog appears, you will need to select the `More info` link and then click on the `Run anyway` button that appears. + +
Windows Protection Dialog

 

+ +## Multiple Installations +You can install multiple copies of Medley (e.g. different releases) on a single Windows. Simply run the Medley installation app and choose a different ***install_dir*** than any previous Medley installation. + +Each Medley installation so installed will operate independently of other Medley installations, including having a separate Medley file system. + +## Update Medley +To update any given Medley installation (e.g., to install a new release), download the updated native Medley Windows installer as per Step 1 in the **Install Medley** section above. + +Run the installer app just downloaded and select the ***install_dir*** for the Medley installation you are updating. + +The chosen Medley installation will be updated. Any user files (i.e., files created by the user that are not part of the Medley distribution) in the Medley file system will remain intact. + +## Run Medley +Once it is installed, you can start Medley from either a Command window or a Powershell window. You cannot (currently) start Medley from the Start Menu or from an icon on the desktop. + + From a Command window, type: + ``` + cd + medley + ``` + + Example: +Start from Command Window + + From a Powershell window, type: + ``` + cd + cmd /C medley + ``` + +Example: +Start from Powershell Window + +Documentation for the `` to the `medley` command can be found [here](https://online.interlisp.org/downloads/man_medley.html) + +For first-time users: `medley --apps --interlisp --noscroll` or, equivalently, `medley -a -e -n` is a good starting point. This will give you a fully populated Medley system, including the applications built on Medley such as Notecards and Rooms. + +This will bring up the Medley environment in a separate Window on your Windows desktop. The Medley desktop and windows will all be contained within this Window as shown below. + +![Medley window open on Windows desktop](../images/Medley-on-Windows.png) + + + + +## Use Medley +Once Medley is up and running, see [here](../../using-medley/_index) for tips on how to navigate and use the Medley environment. + +To exit Medley, type ```(IL:LOGOUT)``` at any Exec window prompt. + +## Important Notes +1. The file system from Medley's perspective differs somewhat from the file system from Window's perspective. Specifically, within Medley, the file system root (i.e., "{DSK}/" or "{UNIX}/") is mapped to the ***install_dir*** in the Windows file system. For example, if ***install_dir*** is ***C:\Users\Frank\Medley1***, then the Medley file known as ***{DSK}\testfile.txt*** will be located in the Windows file system at ***C:\Users\Frank\Medley1\testdir\testfile.txt*** + +2. Also, from Medley you can refer to any file on a Windows drive using the reference ***{DSK}/[drive letter]/*** (or equivalently ***{DSK}<[drive letter]>***). For example, ***C:\User\Frank\Downloads\testfile.txt*** in Windows will be ***{DSK}/c/User/Frank/Downloads/testfile.txt*** in Medley. + +3. Your Medley LOGINDIR will be ***/home/<name>/il*** (or ***<install_dir>\home\\<name>\il*** from the Windows perspective), where ***<name>*** is your Windows username. +4. Medley code is stored in ***/medley*** (or ***<install_dir>\medley*** from the Windows perspective). +5. If you want to work with the Medley code using git, etc. You will probably find it easier to work with git within Cygwin rather than work with git in Windows. To work within the Medley-specific Cygwin, within a Powershell or Command window: + + ``` + PS C:\Users\Frank> cd + PS C:\Users\Frank> .\bin\bash -login + $ git clone https://github.com/Interlisp/medley.git gmedley + $ cd gmedley + $ git status + ``` + + This will get you a bash terminal running under the Medley-specific Cygwin - which means that the file names will be the same as in Medley. + +6. The Medley-specific Cygwin install is rather minimal, so if you find you need other Linux tools to work with the Medley code, the Cygwin setup tool (which also functions as its package manager) is available at ***<install_dir>\cygwin\setup_x86_64.exe*** (in Windows) or at ***/cygwin/setup_x86_64.exe*** (from within Cygwin bash). + diff --git a/content/en/software/install-and-run/windows/native/windows-native-from-github.md b/content/en/software/install-and-run/windows/native/windows-native-from-github.md new file mode 100644 index 000000000..4b68b7a58 --- /dev/null +++ b/content/en/software/install-and-run/windows/native/windows-native-from-github.md @@ -0,0 +1,19 @@ +--- +title: Download Windows 'native' Installer from Github +weight: 40 +toc_hide: true +hide_summary: true +type: docs +--- + + +1. Go to the [Releases page for Interlisp/Medley on github.com](https://github.com/interlisp/medley/releases). Here you will see a list of releases in reverse chronological order. +
Github Releases Page

 

+ +3. Choose the release you are interested in (most likely the release marked ***Latest***) and click on the arrow next the word ***Assets*** to reveal the list of assets (i.e., installation files) for that release. + +4. Click on the link that begins with ***medley-full-cygwin-X86_64*** to download the Windows Installer. +
Github Releases Page Assets

 

+ + + diff --git a/content/en/software/install-and-run/windows/wsl/_index.md b/content/en/software/install-and-run/windows/wsl/_index.md new file mode 100644 index 000000000..51847714e --- /dev/null +++ b/content/en/software/install-and-run/windows/wsl/_index.md @@ -0,0 +1,131 @@ +--- +title: Install and Run on Windows using WSL +weight: 20 +type: docs +aliases: + - /software/install-and-run/running-on-wsl/ +--- + + + +## **Prerequisite: Install WSL** +Medley can be installed and run on either WSL1 or WSL2. WSL2 is preferred, but for older machines that do not support virtualization (see +[here](https://learn.microsoft.com/en-us/virtualization/hyper-v-on-windows/reference/hyper-v-requirements)) +or Windows builds prior to Windows 10 Build 19041, WSL1 will work just fine although it will be limited to the VNC mode (see below). + +To install/activate WSL on Windows, see [How to install Linux on Windows with WSL](https://learn.microsoft.com/en-us/windows/wsl/install). + +To use WSL, you must install one or more Linux "distros" on top of WSL. Medley has been tested most extensively on the Ubuntu (20.04 and later) distros. But Medley can be installed and run on (almost) any of the Linux distros available for WSL (Alpine Linux, is one known exception). + +## **Install Medley** + +Medley can be installed on WSL in one of two configurations: *standard* and *local*. + +* Standard installation is available only for Debian-based distros (e.g., Debian, Ubuntu, MX Linux, Mint Linux, etc.). It will install Medley into system directories (i.e., /usr/local/interlisp) and automatically install any prerequisite packages. +* Local installation will install Medley into any user directory but any prerequisite packages must be installed manually. + +Standard installations are ideal for users who want to explore Medley (including its system code) or to develop applications built on top of Medley. Standard installations are not good for users who want to modify the Medley system code, since that code is installed in protected locations. + +### **Standard Installation (for Debian-based distros only)** + +1. Download the installation file (.deb) for the latest release from the [Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) from under the heading Linux/Standard/WSL. There are are separate .deb files for X86_64 and ARM64 systems. Download the one that corresponds to your machine architecture. We will refer to the downloaded file as ***\*** + +
Medley Downloads Page

 

+ + > >Alternatively, you can download the .deb files for the current or any previous release from the Medley Releases page on the Interlisp GitHub site. [Instructions for this can be found here](./windows-wsl-standard-from-github). + +> ***Note***: under WSL, you can download the file either using a Windows browser into the Windows file system or using a Linux browser into the Linux file system. If you download into the Windows file system, you will need to copy the file from the Windows file system into the Linux file system for your distro. See [Copy files from Windows to your WSL instance](https://megamorf.gitlab.io/2021/08/11/copy-files-from-windows-to-your-wsl-instance/). + +> In these instructions, ***\*** refers to a file in the Linux file system. +2. Into a WSL terminal, enter the following commands. This will install Medley and all prerequisite packages. + + ``` + ubuntu@oio:~$ sudo apt update + ubuntu@oio:~$ sudo apt install -y + ``` + +### **Local Installation** +1. In the WSL file system for your distro, create a directory into which Medley will be installed. We will refer to this directory as ***\*** + +2. Download the release tar file (.tgz) for the latest release from the [Medley downloads site](https://online.interlisp.org/downloads/medley_downloads.html) from under the heading Linux/Local/WSL. There are are separate .tgz files for X86_64 and ARM64 systems. Download the one that corresponds to your machine architecture. We will refer to the downloaded file as ***\*** + +
Medley Downloads Page

 

+ + > >Alternatively, you can download the .deb files for the current or any previous release from the Medley Releases page on the Interlisp GitHub site. [Instructions for this can be found here](./windows-wsl-local-from-github). + +> ***Note***: Under WSL, you can download the .tgz file either using a Windows browser into the Windows file system or using a Linux browser into the Linux file system. If you download into the Windows file system, you will need to copy the file from the Windows file system into the Linux file system for your distro. See [Copy files from Windows to your WSL instance](https://megamorf.gitlab.io/2021/08/11/copy-files-from-windows-to-your-wsl-instance/). + +> In these instructions, ***\*** refers to a file in the Linux file system. + +3. Untar ****** using the following command: + ``` + ubuntu@oio:~$ tar -xz -C -f + ``` +4. Using the package manager for your distro (e.g., apt for Debian and Ubuntu distros), install the following packages: +a) man-db +b) wslu +c) tigervnc +> ***Notes:*** +> 4.1. If *wslu* is not available via the standard package repos for your WSL distro, then see [the wslu wiki](https://wslutiliti.es/wslu/install.html). If *wslu* is still not available, then try installing the *xdg-utils* package instead. If *xdg-utils* is not available either, then Medley will still run well, with the exception of a few sub-systems that require opening external (to Medley) files. + +> 4.2. On Debian-based systems (including Ubuntu), the tigervnc package is not available. Instead install both the *tigervnc-standalone-server package* and the *tigervnc-xorg-extension* package. + +## Multiple Installations +**Standard Installations** +Multiple standard installations are not possible on a single WSL distro. It is possible to have a single Standard installation alongside one or more Local installations on a single WSL distro. + +**Local Installations** +For local installations, you can install multiple copies of Medley (e.g. different releases) on a single WSL distro. Simply place each installation into a separate ***install_dir***. And follow the install instructions above. + +Each Medley installation so installed will operate independently of other Medley installations. The Medley system code for each installation will remain separate. However, in general the installations will share a single file system (which is the WSL file system for the distro). So care must be taken to coordinate access to the file system. + +## Update Medley +To update any given Medley installation (e.g., to install a new release), download the updated .deb or .tgz installer file as described above. Then (re)run the appropriate install procedure as described above. + +The chosen Medley installation will be updated. Any user files (i.e., files created by the user that are not part of the Medley distribution) in the Medley file system will remain intact. + +## Run Medley +Medley is started from the WSL terminal for your distro using the following commands. +##### **Standard Installations** +``` +medley +``` + Example: +Start Medley Standard + +##### **Local Installations** +``` +cd +./medley +``` + Example: +Start Medley Standard + +Documentation for the `` to the `medley` command can be found [here](https://online.interlisp.org/downloads/man_medley.html) + +For first-time users: `medley --vnc --apps --interlisp --noscroll` or, equivalently, `medley -v -a -e -n` is a good starting point. This will give you a fully populated Medley system, including the applications built on Medley such as Notecards and Rooms. + +This will bring up the Medley environment in a separate Window on your Windows desktop. The Medley desktop and windows will all be contained within this Window as shown below. + +![Medley window open on Windows desktop](../images/Medley-on-Windows.png) + + + +#### X-Windows mode versus VNC mode +On WSL2, Medley will normally run using the X-Windows built into WSL to display the Medley window on the Windows desktop. This works well as long a you do not have a hi-dpi monitor. But X-Windows on WSL2 does not scale well and ignores the Windows display scaling settings. On hi-dpi monitors, this often results in the Medley window being to small to use effectively. + +By using the --vnc (or -v) option to the *medley* command, you can instruct Medley to display into a VNC viewer contained in a standard Windows window. The VNC viewer window scales effectively on the Windows desktop and follows the Windows display scale settings. The result is a much more useable Medley window on hi-dpi displays. + +Aside from this scaling issue, running in VNC mode is no different from running in the default X-Windows mode on WSL2. + +For WSL1, X-Windows mode is not available - Medley is always run in VNC mode. + +## Use Medley +Once Medley is up and running, see [here](../../using-medley/_index) for tips on how to navigate and use the Medley environment. + +To exit Medley, type ```(IL:LOGOUT)``` at any Exec window prompt. + +## Important Notes +1. The file system from Medley's perspective corresponds to the file system from the Linux distro perspective. Note that this differs somewhat from the file systems as seen from the Windows perspective. See [Working across Windows and Linux file systems](https://learn.microsoft.com/en-us/windows/wsl/filesystems) for more information. +2. Your Medley LOGINDIR will be ***/home/<name>/il*** in the Linux file system, where ***<name>*** is your login name for the WSL distro. + diff --git a/content/en/software/install-and-run/windows/wsl/windows-wsl-local-from-github.md b/content/en/software/install-and-run/windows/wsl/windows-wsl-local-from-github.md new file mode 100644 index 000000000..6fb7bffaf --- /dev/null +++ b/content/en/software/install-and-run/windows/wsl/windows-wsl-local-from-github.md @@ -0,0 +1,19 @@ +--- +title: Download WSL (Local Installation) Install Files from Github +weight: 40 +toc_hide: true +hide_summary: true +type: docs +--- + + +1. Go to the [Releases page for Interlisp/Medley on github.com](https://github.com/interlisp/medley/releases). Here you will see a list of releases in reverse chronological order. +
Github Releases Page

 

+ +3. Choose the release you are interested in (most likely the release marked ***Latest***) and click on the arrow next the word ***Assets*** to reveal the list of assets (i.e., installation files) for that release. + +4. Click on the link that ends with ***.tgz*** and begins with either ***medley-full-wsl-x86_64*** (if you are installing on an x86_64-based machine) or ***medley-full-wsl-aarch64***(if you are installing on an Arm64-based machine) to download the .tgz install file. +
Github Releases Page Assets

 

+ + + diff --git a/content/en/software/install-and-run/windows/wsl/windows-wsl-standard-from-github.md b/content/en/software/install-and-run/windows/wsl/windows-wsl-standard-from-github.md new file mode 100644 index 000000000..fac38b012 --- /dev/null +++ b/content/en/software/install-and-run/windows/wsl/windows-wsl-standard-from-github.md @@ -0,0 +1,19 @@ +--- +title: Download WSL (Standard Installation) Install Files from Github +weight: 40 +toc_hide: true +hide_summary: true +type: docs +--- + + +1. Go to the [Releases page for Interlisp/Medley on github.com](https://github.com/interlisp/medley/releases). Here you will see a list of releases in reverse chronological order. +
Github Releases Page

 

+ +3. Choose the release you are interested in (most likely the release marked ***Latest***) and click on the arrow next the word ***Assets*** to reveal the list of assets (i.e., installation files) for that release. + +4. Click on the link that ends with ***.deb*** and begins with either ***medley-full-wsl-x86_64*** (if you are installing on an x86_64-based machine) or ***medley-full-wsl-aarch64***(if you are installing on an Arm64-based machine) to download the .tgz install file. +
Github Releases Page Assets

 

+ + +