Dyalog APL V17.1 Issue 4: Installation READ ME FIRST

This document contains information that may affect the installation of Dyalog APL.

This file is setup_readme.htm and is included in the help directory in the Dyalog installation directory.

Table of Contents

Licence Types

From V17.1 onwards there is a single licence for Dyalog APL, covering both commercial and non-commerical usage.

Unregistered installations (those which do not have a valid serial number) are covered by the non-commercial licence.

Serial Number

From V17.1 onwards there is only one download image for each platform/version/width/edition of Dyalog APL; the serial number determines the type of licence that is associated with the installation.

On Microsoft Windows you can enter your serial number during the installation process; if you already have a copy of Dyalog APL installed on your machine then that will be used to pre-populate the serial number field.

On non-Windows platforms you can set DYALOG_SERIAL in any system configuration file (for example /etc/environment or /etc/profile) but you can also create the file $HOME/.dyalog/serial - the contents of this file will be used if DYALOG_SERIAL is not already a non-empty environment variable.

On all platforms you can use the Dyalog-supplied function Serial to set the serial number:

Full details of the serial number process can be found in the various Installation and Configuration Guides.

If you believe that your serial number is for the wrong licence, please contact sales@dyalog.com.

Installing or updating Dyalog APL under Microsoft Windows

To update an existing 17.1 installation you must first uninstall your current release, and reboot your machine. Then follow the instructions for installing that appear below. Note that this process will overwrite the contents of the Dyalog directory in your Documents folder - you may wish to take a copy of your session file (.dse), your log file (.dlf) and possibly your user command cache file (UserCommand20.cache) before you uninstall. You may also want to take a copy of the registry entries for your version of Dyalog APL so that you can restore them once you have uninstalled and reinstalled 17.1 The user command ]copyreg may be of use for this.

Dyalog V17.1 can be installed either with or without administrator rights. Dyalog Ltd strongly recommends that whenever possible, the installation is performed with administrator privileges.

An installation performed without administrator privileges has the following limitations:

Note: Dyalog strongly recommends that you include the VS2015 runtime packages when you install Dyalog APL; failure to do so may result in the failure of .NET-related code.

To install this version it will be necessary to uninstall any previously installed Version 17.1 images. Note that it is not necessary to uninstall and reinstall the IME. Note: You MUST reboot your PC between uninstalling any previous Version 17.1 and installing a newer one.

Note: the installation of Dyalog APL will require a reboot of the system to be fully effective !

Dyalog APL for Microsoft Windows requires Windows 7 or later.

To perform a default installation of Dyalog APL with administrator privileges:

  1. Extract the contents of the downloaded zip file into a temporary directory
  2. Double click on the newly extracted setup.exe (you are probably reading this having taken these two steps!).
  3. Select "Yes" to the question "Do you want to restart the installer with Administrator privileges?"
  4. Select "Yes" in the User Account Control pop up. Note that this Msgbox may hide behind other windows !
  5. Enter your serial number into the field on the setup form. Again note that this form may hide behind other windows.
  6. If installing the Unicode Edition, ensure that the Unicode IME is selected - it is optional for the Classic Edition.
  7. Click on Default Install.
  8. At the end of the installation process you will be prompted to reboot your PC; Dyalog APL will not be fully installed until the PC has been rebooted - it is recommended that you perform that reboot as soon as possible having installed Dyalog APL.
  9. Double click on the new Dyalog APL shortcut on your desktop; enjoy Dyalog APL!

To perform a default installation of Dyalog APL without administrator privileges:

  1. Double click on setup.exe (you are probably reading this having taken that step!).
  2. Select "No" to the question "Do you want to restart the installer with Administrator privileges?"
  3. Enter your serial number into the field on the setup form. Again note that this form may hide behind other windows.
  4. Click on Default Install.
  5. Click on Finish. No reboot is necessary.
  6. Double click on the new Dyalog APL shortcut on your desktop; enjoy Dyalog APL!

The newly-installed files will be put in a directory similar to c:\Users\andys\AppData\Local\Programs\Dyalog\Dyalog APL-64 17.1 Unicode.

Additional information about installing Dyalog APL can be found here on the Dyalog Forums.

If you have problems typing APL characters, it is worth taking a look at the links at the bottom of the Fonts and Keyboard page on the Dyalog website at www.dyalog.com/apl-font-keyboard.htm.

Installing or updating Dyalog APL under macOS

This release of 17.1 should install under macOS Catalina and Big Sur.

To update your existing installation of Dyalog APL on macOS, simply uninstall and reinstall. To uninstall drag the Dyalog 17.1 icon from Applications to the Dustbin.

To install:

Dyalog checks for the existence of the file ~/.dyalog/dyalog.config. If it does not exist, this file is created.
dyalog.config should be used to set non-default options for configuration parameters such as MAXWS or TRACE_ON_ERROR; this file is read each time APL is started, and these values used in preference to the default values. Dyalog recommends that this file is edited rather than the mapl startup script which will be overwritten whenever a later revision of the current version of Dyalog APL is installed.
Dyalog intends to improve the nature of the configuration file; future versions of this file will have a different structure, and will simply define name-value pairs.
All of the configuration parameters that are used by Dyalog under macOS can be found in the Dyalog for macOS Installation and Configuration Guide.

Note that from V15.0 onwards new macOS-specific keyboard mappings have been added to the product. However these are not currently selected; these can be selected in the preferences dialog box.

Once installed, if you have received a serial number you should enter it .. see Serial Number above.

Installing or updating Dyalog APL under AIX/Linux

Please follow the instructions in the Dyalog for UNIX Installation and Configuration Guide manual.
This can be found on https://docs.dyalog.com/17.1.

Under Linux (including the Raspberry Pi) if you install from your desktop you should find a Dyalog APL (TTY) icon in the start menus. If you subsequently install RIDE 4.1, a "Dyalog" icon is also added; this causes RIDE 4.1 to start and to start a Dyalog session.

Under Linux (including Pi) the script /usr/bin/dyalog is under the control of the update_alternatives system. If you have multiple versions of Dyalog APL installed on Linux and you wish to change the version which /usr/bin/dyalog starts, use sudo update_alternatives --config dyalog.
Dyalog recommends that you never edit /usr/bin/dyalog or $DYALOG/mapl, but rather either take a copy of the script and edit that, or write your own script which sets the environment and then calls the Dyalog-supplied script.

Dyalog checks for the existence of the file ~/.dyalog/dyalog.config. If it does not exist, this file is created.
dyalog.config should be used to set non-default options for configuration parameters such as MAXWS or TRACE_ON_ERROR; this file is read each time APL is started, and these values used in preference to the default values. Dyalog recommends that this file is edited rather than the mapl startup script which will be overwritten whenever a later revision of the current version of Dyalog APL is installed.
Dyalog intends to improve the nature of the configuration file; future versions of this file will have a different structure, and will simply define name-value pairs.

Once installed, if you have received a serial number you should enter it .. see Serial Number above.

Installing or updating Dyalog APL on Raspberry Pi

Instructions for installing or updating Dyalog APL on a Raspberry Pi can be found at https://packages.dyalog.com/.

To install and run on Raspberry Pi O/S Bookworm you must use 17.1.48479 or later, which is available on packages.dyalog.com.

Once installed, if you have received a serial number you should enter it .. see Serial Number above.

Dyalog checks for the existence of the file ~/.dyalog/dyalog.config. If it does not exist, this file is created.
dyalog.config should be used to set non-default options for configuration parameters such as MAXWS or TRACE_ON_ERROR; this file is read each time APL is started, and these values used in preference to the default values. Dyalog recommends that this file is edited rather than the mapl startup script which will be overwritten whenever a later revision of the current version of Dyalog APL is installed.
Dyalog intends to improve the nature of the configuration file; future versions of this file will have a different structure, and will simply define name-value pairs.

Microsoft Windows: Association of APL fonts with APL versions

If you have multiple versions of Dyalog APL installed on your PC, then uninstalling any version may result in the APL fonts being uninstalled. Dyalog has placed a zip file containing the APL fonts here so that you can download and reinstall them.

There are more details in the FAQ section of the Dyalog Forums.

Microsoft Windows: Association of APL files with APL versions

When a version of Dyalog APL is installed on Microsoft Windows, files such as workspaces are associated with that newly-installed version. The user command ]fileassociations can be used to change the association, but you will need to run APL as Administrator to make this change.