This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
yap-6.3/Logtalk/INSTALL
pmoura 0018e82503 Logtalk 2.20.1 files.
git-svn-id: https://yap.svn.sf.net/svnroot/yap/trunk@1117 b08c6af1-5177-4d33-ba66-4b1c6b8b522a
2004-08-19 13:46:40 +00:00

88 lines
3.7 KiB
Plaintext

=================================================================
Logtalk - Object oriented extension to Prolog
Release 2.20.1
Copyright (c) 1998-2004 Paulo Moura. All Rights Reserved.
=================================================================
Installing Logtalk is just a matter of decompressing the downloaded
archive and copying the resulting directory to a suitable location.
The Logtalk directory can reside in any user accessible location.
This location depends on the working environment and on the number
of users. The "misc" sub-directory contains some shell scripts for
easy installation of Logtalk on Unix and Unix-like operating systems.
INSTALLING FOR A SINGLE USER
In the case of a single user, the Logtalk directory may simply be copied to
the user home directory.
INSTALLING FOR MULTIPLE USERS
In the case of multiple users, the Logtalk directory can be copied to any
location that its accessible by all the users (assuming that copying the
Logtalk directory to each user home directory is not feasible or desired).
Regarding directory and file permissions, it is advisable to make all files
read-only in order to avoid user tempering. However, the library and examples
sub-directories (and possibly the compiler sub-directory, depending on the
chosen Prolog compiler) must be user writable as compiling Logtalk source
files generates intermediate Prolog files, which are written to the same
location as the source files. However, making directories world-writable is a
security risk. One solution is to copy the Logtalk xml, examples, and library
directories to each user home directory (the "misc" sub-directory contains
some scripts which may be called by the end-users for making these copies).
ENVIRONMENT VARIABLES
It is recommended that you define an environment variable named LOGTALKHOME
pointing to the Logtalk installation directory for use with your Prolog
compilers. In addition, you may want to add the Logtalk sub-directory "xml",
which contains useful scripts for processing XML documenting files, to your
execution path.
* Unix and Unix-like systems:
If you use a csh shell, add the following line to your ~/.cshrc file:
setenv LOGTALKHOME /your/installation/directory/lgt2201
setenv PATH $PATH:$LOGTALKHOME/xml:$LOGTALKHOME/misc
If you use a bash shell, add the following lines to your ~/.profile file:
LOGTALKHOME=/your/installation/directory/lgt2201
export LOGTALKHOME
PATH=$PATH:$LOGTALKHOME/xml:$LOGTALKHOME/misc
export PATH
When using the provided shell script for installing Logtalk, a symbolic link
to the Logtalk installation directory is automatically created. The link is
named "logtalk". In this case, you may use this symbolic link to define the
environment variable in order to avoid breaking it when upgrading Logtalk.
* Windows systems:
In Windows 95/98/ME, environment variables are defined in the autoexec.bat
file (you will need to reboot after editing the file):
SET LOGTALKHOME=C:\your\installation\folder\
In Windows NT/2000/XP, environment variables are defined using the System
properties control panel (if you are a system administrator, you may define
LOGTALKHOME as a system variable, otherwise define it as a user variable).
CREATING NEW PROLOG TOP-LEVELS FOR AUTOMATIC LOADING OF LOGTALK
Most Prolog compilers allows the user to define an initialization file that
is automatically consulted at startup. This initialization file may contain
directives for loading other files, such as the Logtalk configuration file
and the Logtalk compiler. The "misc" sub-directory contains several scripts
for automating the creation of these initialization files for some Prolog
compilers. In addition, be sure to read the configs/NOTES file notes on the
Prolog compilers that you intend to use.