

Welcome to vipsi.
-----------------

1. what is vipsi
2. install vipsi from a binary .tgz distribution
3. install vipsi from a source .tgz distribution
4. install vipsi from cvs
5. documentation
6. ported platforms
7. copyright & license



1. what is vipsi
----------------

vipsi - the VIP Script Interpreter

vipsi is intended as an easy-to-use shell and script language with a syntax
similar to C or Basic. vipsi uses unicode for text, double float for numbers
and handles lists and arrays alike. it comes with lots of predefined functions,
mathematical and for text manipulation and conversion, has powerful list
operators and of course all the basic stuff.

Copyright (c) 1990-2003 Guenter Woigk (Kio) - kio@little-bat.de.
vipsi comes with a license similar to the BSD license.

currently it's a command line tool for unix-like platforms.




2. install vipsi from a binary .tgz distribution
------------------------------------------------

	extract the compressed tar file at a convenient place, e.g. in your home directory,
	and copy vipsi into /usr/bin.

	bash$  tar -xzf vipsi-*.tgz
	bash$  cd vipsi-*
	bash$  su
	root$  ./install.me
	root$  exit




3. install vipsi from a source .tgz distribution
------------------------------------------------

	extract the compressed tar file at a convenient place, e.g. in your home directory,
	cd into vipsi/unix and run make and make install.

extract & compile source:

	bash$  tar -xzf vipsi-*.tgz
	bash$  cd vipsi/unix
	bash$  ./configure
	bash$  make

install vipsi:

	bash$  su
	root$  make install
	root$  exit




4. install vipsi from cvs
-------------------------

checkout source:

	you must checkout "vipsi" from the vipsi project and "libraries" from the
	lib-kio project. "libraries/" must be stored inside "vipsi/". you may also
	put "libraries/" where you like if you create a link in "vipsi/".

	YOUR_DEV_ROOT/
	YOUR_DEV_ROOT/vipsi/                  <-- from project vipsi
	YOUR_DEV_ROOT/vipsi/documentation/    <-- from project vipsi
	YOUR_DEV_ROOT/vipsi/libraries/        <-- from project lib-kio


	if you _have_ a developer login at sourceforge:
	(required if you want to commit changes!)

	bash$  cd YOUR_DEV_ROOT
	bash$  export CVS_RSH=ssh
	bash$  cvs -d:ext:YOU@cvs.vipsi.sourceforge.net:/cvsroot/vipsi checkout vipsi
	bash$  cd vipsi
	bash$  cvs -d:ext:YOU@cvs.vipsi.sourceforge.net:/cvsroot/vipsi checkout documentation
	bash$  cvs -d:ext:YOU@cvs.lib-kio.sourceforge.net:/cvsroot/lib-kio checkout libraries


	if you _don't_ have a developer login at sourceforge:
	(then this is only a read-only copy!)

	bash$  cd YOUR_DEV_ROOT
	bash$  cvs -d:pserver:anonymous@cvs.vipsi.sourceforge.net:/cvsroot/vipsi checkout vipsi
	bash$  cd vipsi
	bash$  cvs -d:pserver:anonymous@cvs.vipsi.sourceforge.net:/cvsroot/vipsi checkout documentation
	bash$  cvs -d:pserver:anonymous@cvs.lib-kio.sourceforge.net:/cvsroot/lib-kio checkout libraries


compile source:

	bash$  cd YOUR_DEV_ROOT/vipsi/unix
	bash$  chmod u+x configure            // executable bit gets lost sometimes
	bash$  ./configure
	bash$  make


install vipsi:

	bash$  su
	root$  make install
    root$  exit




5. documentation
----------------

	documentation is included in the source in "vipsi/documentation".

	in binary distributions there is a separate folder "documentation".
	rename it and move it to a convenient place.

	documentation is also available online at <http://vipsi.sourceforge.net>.

	to display a short help screen, start vipsi with argument "-h" or "--help".

	bash$  vipsi --help

	to get help in the shell mode, use the words "words" and "info".
	note the reminder printed when vipsi is started in interactive shell mode:

	bash$  vipsi                // start vipsi in interactive shell mode

	vipsi> words                // list all built-in words
	vipsi> info "WORD"          // show info for the built-in word "WORD"




6. ported platforms             // 2003-08-31  version 0.8.0
-------------------

ported:
	MacOS X            /PPC
	Linux 2.4-Redhat   /i386

	similar platforms may also work.

porting issues:
	alpha
	SPARC

not yet ported:
	Windows
	others




7. copyright & license
----------------------

vipsi - the VIP Script Interpreter

Copyright (c) Guenter Woigk 1990-2003
              kio@little-bat.de

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE.

Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that the
above copyright notice appear in all copies and that both that copyright notice
and this permission notice appear in supporting documentation, and that the
name of the copyright holder not be used in advertising or publicity pertaining
to distribution of the software without specific, written prior permission. The
copyright holder makes no representations about the suitability of this software
for any purpose. It is provided "as is" without express or implied warranty.

THE COPYRIGHT HOLDER DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT
SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.







