Ion

Copyright (c) Tuomo Valkonen 1999-2004.
<tuomov at iki.fi>

<http://iki.fi/tuomov/ion/>
          

BUILDING AND INSTALLING

1. Make sure you have the following tools and libraries installed:

    * GNU make
    * Libtool and libltdl, version 1.4.3 or newer
    * Lua 5.0.1 (see <http://www.lua.org/>). 
    
   Lua 5.0 has a stack management bug that manifests in Ion, resulting in
   broken .lc files and occasionally missing functions. Please do not use it.

2. a) Run ./configure; see README.autoconf for details, especially if
      you are using the Debian Lua packages.
   b) Alternatively, edit system.mk to suit your system. If the autoconf
      script failed for some reason and you are falling back to this choice
      because of that, remove system-ac.mk. Most GNU/Linux users should
      need very little modifications to system.mk.

3. If you want to build some extra modules now or do not want to build
   some of the standard modules, edit modulelist.mk.
   
4. Run 'make'. Note that 'make' here refers to GNU make which is usually
   named 'gmake' on systems with some other implementation of make as 
   default.
   
5. Run 'make install', as root if you set $PREFIX in system.mk to a directory
   that requires those privileges.
   
   YOU SHOULD NOT SKIP THIS STEP unless you know what you are doing. Ion
   will refuse to start if it can not find all the necessary uncorrupt
   configuration files either in $PREFIX/etc/ion/ or in ~/.ion2/.

6. How to best set up 'startx' or whatever to start Ion instead of your
   current window manager depends on your system's setup. A good guess
   is creating or modifying an executable shell script .xsession in your
   home directory to start Ion. This should usually (but not always) work
   if you're using some X display/login manager. If ~/.xsession does not 
   help and you're not using a display manager, modifying ~/.xinitrc or 
   creating one based on your system's xinitrc (wherever that may be; 
   use locate) may be what you need to do.

7. The scripts 'ion-edit' and 'ion-view' in $SHAREDIR and bound to the
   F5 and F6 keys expect the program 'run-mailcap' to be found. This 
   program opens a viewer/editor for a file based on its MIME type. 
   Unless you are using Debian, most likely you don't have it, but any
   other similar program (or just plain old text editor) will do as
   well - just modify the scripts. Of course, if you don't want to use
   the feature at this time or never, you may simply skip this step. 
   If you want to use run-mailcap, it can be found from the address
   <http://www.debian.org/Packages/unstable/net/mime-support.html>
   as tarball as well.


CONFIGURATION

For help on modifying Ion's configuration files, PLEASE READ THE DOCUMENT
"Ion: Configuring and extending with Lua" available from the Ion web page,
listed at the top of this file.


QUESTIONS, COMMENTS, PROBLEMS?

If the available documentation does not answer your question, please
post it to the mailing list. Details can be found on the Ion web page
listed at the top of this file.


CREDITS

Ion was written by Tuomo Valkonen.

The autoconf script written by Tom Payne for the most part.

The dock module was written by Tom Payne and Per Olofsson.

share/ion-completefile/ion-completefile.c is based on editline, (c)
1992 Simmule Turner and Rich Salz. See the file for details.

libtu/snprintf_2.2/ was written by Mark Martinec, see the README there
or <http://www.ijs.si/software/snprintf/> for more. I made some minor
modifications. 

The code that de/fontset.c is based on was apparently originally written 
by Tomohiro Kubota; see
<http://www.debian.org/doc/manuals/intro-i18n/ch-examples.en.html#s13.4.5>.

Various patches have been contributed by other individuals unlisted here.
(See the mailing list archives.)