Renamed package to ion1, and made it conflict with package 'ion'.
[ion1.git] / README
blob14cb107b1988e5a1366a45634647279744ebbb75
3                                      Ion
4                  
5                    Copyright (c) Tuomo Valkonen 1999-2002.
6             
7                              <tuomov@cc.tut.fi>
8                   <http://www.students.tut.fi/~tuomov/ion/>
9           
10           
12 BUILDING AND INSTALLING
14 You will need a C-compiler, gnu make :-( and an editor.
16     1. Edit system.mk to suit your system. If heavy modifications
17        are required, you might want to save the file somewhere for
18        future use (and hope that I don't change the makefile-system...).
19     2. If you want to customize ion above what is possible with
20        ion.conf, edit config.h (this step is optional)
21     3. make depend && make. Note that 'make' here refers to gnu make
22        which is usually named 'gmake' on systems with their own version
23        of make.
24     4. make install (not required if you manually setup configuration
25        files).
28 NOTICE: ION WILL NOT WORK WITHOUT A PROPER CONFIGURATION FILE!
30 Without a configuration file no keys or mouse buttons will be bound to
31 any actions and you will get a  black and white color scheme.
32 Either personal ~/.ion/ion.conf or system-wide $(PREFIX)/etc/ion/ion.conf
33 must exist unless another specified on the command line.
34 $(PREFIX) is the path where you told to install Ion in the Makefile
35 and the default setting is /usr/local.
37 The scripts 'ion-edit' and 'ion-view' (F5 and F6 keys) expect the
38 program 'run-mailcap' to be found. This program opens a viewer/editor
39 for a file based on its mime-type. Most likely you don't have it, but
40 any other similar program (or just plain old text editor) will do as
41 well - just modify the scripts. Unless you don't want to use them,
42 of course. If you want to use run-mailcap, it can be found at
43 <http://www.debian.org/Packages/unstable/net/mime-support.html>
44 (as .tar.gz as well).
48 CONFIGURATION
50 Have a look at doc/config.txt and the default configuration files.
51 If you do nothing else, you may at least want to change term_font
52 from the default 7x13 to whatever font you use in xterm and such.
53 Ion takes the units by which it resizes frames from this font.
57 CREDITS
59 Ion was written by Tuomo Valkonen.
61 src/complete_file.c is based on editline, (c) 1992 Simmule Turner and
62 Rich Salz. See the file for details.
64 Various patches contributed by other individuals unlisted here have
65 also been used. (See the mailing list archives.)