crefal: a Refal-5 compiler.
Copyright (C): RefalScope Project, 2004-2023.

USE.TXT (crefal)
version 23.08.2023

THE USE OF crefal - Refal-5 compiler.

                        --   CONTENTS --
                        
                 1. A list of modules.
                 2. A list of used subdirectories.
                 3. The use. Step by step.

********************* 1. LIST OF FILES. ***********************************
======== Installation of the crefal compiler. =============================
    -1- INSTALL.TXT -- documentation how to install, step by step.
    -2- INSTALL.LST -- a file for installation. 
                       Please, do not touch this file at all.
    -3- install.ref -- installation itself.
    -4- install.rsl -- binary module of the installation.

======== The compiler consists of the following files: ===============

    -1- crefal.rsl  -- binary module of the Refal-5 compiler crefal.ref
    -2- crefal.bat -- a batch-file to call for the compiler under 
                      operating system Windows.
        or
        crefal     -- a batch-file to call for the compiler under 
                      operating system Linux.
        ONE OF THE FILES IS GENERATED AUTOMATICALLY BY INSTALLATION
        ACCORDING WITH THE OPERATING SYSTEM.

    -5- USE.TXT -- this file: documentation how to use the compiler. 
    -6- NEWS.TXT -- news.


******************* 2. A LIST OF USED SUBDIRECTORIES. ***********************
=============== The following subdirectories are used: ======================

-1- DOC -- documentation.

-2- TEST -- a directory for testing of the results of crefal-installation. 
    Here you can see how you can use the compiler CREFAL
    from any directory. Just use your directory in the same fashion
    as we are using the TEST-directory. 

******************* 3. THE USE. STEP BY STEP. ***************************
================ To use CREFAL do the following steps: =====================

0. Set _path_ (in your Oper. System) to the Refal-5 executable 
   modules and to the crefal batch-file or copy the files inside
   a directory that your Oper. System has an access to the directory
   by the aid of its environment variable PATH. 

   You should create a directory ( let it be c:\REFAL ),where put the binary and batch files, and add 
   c:\REFAL to your search path. Under Windows 95 you can accomplish this by editing your 
   autoexec.bat file and modifying ( or adding ) the line starting with "PATH".
   For example:
   PATH=c:\windows;\c:\REFAL

   Under Windows NT, the same change can done through the control panel. 

   Under Linux you should make this change in the initialization files of whatever 
   shell you use. 
   For example, 
    1) csh and tcsh users will want to make this change in their .cshrc file.
       The following line must be added:
       setenv PATH ($PATH /REFAL)
    2) bash users will want to make this change in their .bash_profile file.
       The following line must be added:
       PATH=$PATH:/REFAL; export PATH
    3) sh users will want to make this change in their .profile file.
       The change will looks like following:
       The following line must be added:
       PATH=$PATH:/REFAL; export PATH

   Please, pay attention to crefal module, if your oper. system is a unix
   and you use a shell which is differs from BASH, TCSH, CSH or SH.     


1. Put your Refal program to be translated in a file input-file.ref .

2. Run:
   Oper. System> crefal [options] input-file [rsl-output-file]

where
options ::= option*
option ::= 
   /h, /help print this help message
   /l, /list, /listing
             create a listing of the compiler messages in file 'input-file.lis'
   /v, /version print version of the Refal-5 compiler

   A rsl-output-file.rsl will be a result of the running.

3. Oper. System>refgo rsl-output-file
   or
   Oper. System>reftr rsl-output-file

================================== The End. =================================

