OpenEuphoria

2.1 Installation

To install Euphoria, consult the instructions below for your particular operating system.

2.1.1 Windows

All versions other than Windows 95 work without problems. To use Windows 95, it must have Internet Explorer version 4 or higher installed (included in service pack 2.5). To use the new socket functions you will also Windows 2000 or later. To use all of the new standard library functions you will need at least Windows XP or later.

EUPHORIA is frequently tested on versions Windows XP, Vista, 7.

To install Euphoria on Windows, visit the following URL:

The "Standard" version is a complete Euphoria installation, with Interpreter, Binder, Translator. Included are demo programs and documentation.

The "Open Watcom" version has the contents of the "Standard" version, plus a bundled compiler. This is a convenient way of producing compiled executables from Euphoria programs.

Download the latest Windows installer found under the Binary Releases heading of the Current version of Euphoria. Run the program and follow the prompts to get Euphoria installed.

The installer copies the required files; adds the binary subdirectory to your path, if you leave 'update environment' checked; and if you leave 'Associate file extensions' checked, it associates icons and various actions to EUPHORIA file extensions. Please do not open 'Euphoria Console Files' from Explorer; they are meant to be run from the command line.

The installer does not set the environment variable EUDIR to the Euphoria directory even though many third-party programs expect that to be set. This is so an older version of EUPHORIA can also still work on the same system. To set this variable please see the section "How to manually edit your environment in Windows" below.

2.1.1.1 Possible problems ...

• On Windows XP/2000, be careful that your PATH and EUDIR do not conflict with autoexec.nt, which can also be used to set environment variables.
• On WinME/98/95 if the install program fails to edit your autoexec.bat file, you will have to do it yourself. Follow the manual procedure described below.
• Euphoria cannot be run under Windows 3.1 and some unpatched versions of Windows 95 will not be able to run EUPHORIA 4.0.
• You have two EUPHORIA installs and you want to change the environment to use another EUPHORIA.

2.1.1.2 How to manually modify the environment in Windows

Your EUPHORIA installation directory by default will be C:\Euphoria. It is possible to install to %PROGRAMFILES%\Euphoria, or anywhere you wish. Careful when using the %ProgramFiles% special location (C:\Program Files on most systems in English). The %ProgramFiles% directory invariably contains spaces by default. It is a good idea to use the short 8.3 version of the name, or surround with double quotes. Ofcourse, you'll just have to substitute your real installation directory for the C:\EUPHORIA examples below.

How to manually modify the environment in Windows (Windows NT/2000/XP)

On Windows XP select: Start Menu -> Control Panel -> Performance &Maintenance -> System -> Advanced then click the "Environment Variables" button. Click the top "New..." button then enter EUDIR as the Variable Name and c:\euphoria (or whatever is correct) for the value, then click OK. Find PATH in the list of your variables, select it, then click "Edit...". Add ;c:\euphoria\bin at the end and click OK.

On Windows Vista, You'll find the environment variables available at Start Menu -> Control Panel -> "System and Maintenance" -> "System" -> "Advanced system settings" -> "Environment Variables" (button)

Other versions of Windows will have the environment variables somewhere in the control panel.

How to manually modify the environment in Windows (ME/98/95/3.1)

1. In the file c:\autoexec.bat add C:\EUPHORIA\BIN to the list of directories in your PATH command. You might use the MS-DOS Edit command, Windows Notepad or any other text editor to do this.
   
   You can also go to the Start Menu, select Run, type in sysedit and press Enter. autoexec.bat should appear as one of the system files that you can edit and save.
2. In the same autoexec.bat file add a new line:
   SET EUDIR=C:\EUPHORIA
   The EUDIR environment variable indicates the full path to the main Euphoria directory.
3. Reboot (restart) your machine. This will define your new PATH and EUDIR environment variables.
   
   Some systems, such as Windows ME, have an autoexec.bat file, but it's a hidden file that might not show up in a directory listing. Nevertheless it's there, and you can view it and edit it if necessary by typing, for example: notepad c:\autoexec.bat in a DOS window.

More on editing environment variables

• set EUDIR to the location of your Euphoria installation directory.
• In PATH you need to include %EUDIR%\BIN.
• There is another, optional, environment variable used by some experienced users of Euphoria. It is called EUINC (see the include statement ). It determines a search path for included files and this variable is used by new and older versions of EUPHORIA. However, for 4.0 and above we now have a "configuration file" for adding include paths and other settings.

2.1.1.3 Modifying the Registry

Updating the environment is not enough, your old installation will still be called when you open a Euphoria program in explorer or invoke the Euphoria program on the command line without typing in the interpreter (eui euiw). Do not type in the single quotes.

You can set these in regedit (replace C:\EUPHORIA with your Euphoria installation directory):

HKEY_CLASSES_ROOT\.exw\(Default) => 'EUWinApp'
HKEY_CLASSES_ROOT\EuWinApp\(Default) => 'Euphoria Windows App'
HKEY_CLASSES_ROOT\EUWinApp\shell\open\command\(Default) => 'C:\EUPHORIA\BIN\euiw.exe "%1"'
HKEY_CLASSES_ROOT\EUWinApp\shell\translate\command\(Default) => 'C:\EUPHORIA\BIN\euc.exe "%1"'

HKEY_CLASSES_ROOT\.ex\(Default) => 'EUConsoleApp'
HKEY_CLASSES_ROOT\EUConsoleApp\(Default) => 'Euphoria Console App'
HKEY_CLASSES_ROOT\EUConsoleApp\shell\open\command\(Default) => 'C:\EUPHORIA\BIN\eui.exe "%1"'
HKEY_CLASSES_ROOT\EUConsoleApp\shell\translate\command\(Default) => 'C:\EUPHORIA\BIN\euc.exe -con "%1"'

HKEY_CLASSES_ROOT\.e\(Default) => 'EUInc'
HKEY_CLASSES_ROOT\EUInc\(Default) => 'Euphoria Include File'
HKEY_CLASSES_ROOT\.ew\(Default) => 'EUInc'

You can also set an editor for your EUPHORIA programs this way:

HKEY_CLASSES_ROOT\EUWinApp\shell\edit\command"\(Default) => 'C:\EUPHORIA\BIN\euiw.exe C:\EUPHORIA\BIN\ed.ex "%1"'
HKEY_CLASSES_ROOT\EUConsoleApp\shell\edit\command"\(Default) => 'C:\EUPHORIA\BIN\euiw.exe C:\EUPHORIA\BIN\ed.ex "%1"'
HKEY_CLASSES_ROOT\EUInc\shell\edit\command"\(Default) => 'C:\EUPHORIA\BIN\euiw.exe C:\EUPHORIA\BIN\ed.ex "%1"'

You can setup to allow the supplied editor program open to the line where the last failure occured in ex.err files:

HKEY_CLASSES_ROOT\.err\(Default) => 'EUError'
HKEY_CLASSES_ROOT\EUError\(Default) => 'Error File'
HKEY_CLASSES_ROOT\EUError\shell\debug => 'Debug what created this error file'
HKEY_CLASSES_ROOT\EUError\shell\debug\command\(Default) => 'C:\EUPHORIA\BIN\eui.exe C:\EUPHORIA\BIN\ed.ex'
HKEY_CLASSES_ROOT\EUError\DefaultIcon\(Default) => 'C:\Windows\system32\shell32.dll,78'

2.1.2 Linux and FreeBSD

Euphoria may be installed using either a Unix archive ( .tar.gz or .tar.bz2 ) or, a distribution specific package, if available.

The Unix tarball "Archive" is laid out similarly to the Windows directory structure. This may be convenient if working cross-platform between Windows and Unix. The files at ~SourceForge are also in this form, making it convenient if you wish to use updates directly from the SVN depository.

To install this version you must manually unarchive the tarball. Then copy the files to a suitable directory.

You'll need to manually edit:

• /etc/profile so the PATH contains
  • euphoria/bin, and either create
    • an eu.cfg file or
    • set up EUDIR and EUINC. See the include statement.

The "Packaged" version installs Euphoria in a more Unix-like way, putting the executables into

• /usr/bin,
• /usr/share/euphoria and
• /usr/share/doc/euphoria.
• Man pages for eui, euc, eub, shroud and bind are also installed.
• It will also create /etc/euphoria/eu.cfg, which will point to the standard euphoria include directory in /usr/share/euphoria/include.

Other Unix based installations can be compiled from "Source Releases".

2.1.3 OS X

Look for an installation package for Apple installations.

2.1.4 DOS

There is DOS support only up to Euphoria 3.1. DOS developers are invited to contribute their skills.

2.2 Post Install

The directory maps will help you locate the Euphoria executables, documentation, and sample programs.

The default for the Windows installation, and optional for a Unix installation:

|
|__ euphoria
|     file_id.diz
|     License.txt
|
|__ bin 
|     Interpreter (eui.exe and euiw.exe,  if on Windows)
|                 (eui, if on Unix)
|     Binder      (eubind, with eub)
|     Translator  (euc.exe, if on Windows)
|                 (euc, if on Unix)
|     Utilities   (bugreport.ex, bench.ex, ed.ex, ...)
|
|__ include 
|   |             (original include files)
|   |
|   |__ std       (standard Euphoria library: io.e, sequence.e, ...)
|   |
|   |__ euphoria  (Euphoria specific)
|
|
|__ docs          (html and pdf documentation files)
|
|__ tutorial      (small tutorial programs to help you learn Euphoria)
|
|__ demo          (generic demo programs that run on all platforms)
|   |
|   |__ win32     (Windows specific demo programs (optional) )
|   |__ unix      (Linux/FreeBSD/OS X specific demo programs (optional))
|   |__ langwar   (language war game for Linux/FreeBSD/OS X )
|   |__ bench     (benchmark program )
|
|__ source        (the complete source code for: interpreter, translator)
|
|__ tests         (unit tests for Euphoria)
|
|__ packaging     (software for making installation packages)

The Linux subdirectory is not included in the Windows distribution, and the win32 subdirectories are not included in the Linux/FreeBSD distribution. In this manual, directory names are shown using backslash (\). Linux/FreeBSD users should substitute forward slash (/).

The "Debian Package" installs Euphoria into these directories:

|
|__ /usr/bin                       (executables: eui, euc, ... )
|       
|__ /usr/share/euphoria     
|                     |   
|                     |__ bin      (utility programs)
|                     |__ demo     (general demonstration programs)
|                     |__ include  (standard library)
|                     |__ source   (source-code for Euphoria)
|                     |__ tutorial (tutorial programs for learning Euphoria)
|
|__ /usr/share/doc/euphoria        (html and pdf documentation)
|
|__ /etc/euphoria                  ( eu.cfg )

Additionally, installing from source on a Unix-like OS will install in the same pattern, by default using /usr/local/ instead of /usr/. You can change /usr/local to something else by running:

$ ./configure --prefix /some/other/location

The "include", "demo" and "tutorial" directories are the same in Windows and Unix.