README

   1
   2 Ion
   3
   4 Copyright (c) Tuomo Valkonen 1999-2005.
   5 <tuomov at iki.fi>
   6
   7 <http://iki.fi/tuomov/ion/>
   8
   9
  10 BUILDING AND INSTALLING
  11
  12 1. Make sure you have the following tools and libraries installed:
  13
  14     * GNU make
  15     * Lua 5.0.1 (see <http://www.lua.org/>).
  16
  17    Lua 5.0 has a stack management bug that manifests in Ion, resulting in
  18    broken .lc files and occasionally missing functions. Please do not use it.
  19
  20 2. a) Edit system.mk to suit your system. Most GNU/Linux users should
  21       need very little modifications to system.mk.
  22
  23    b) Alternatively, run ./configure. See README.autoconf for details,
  24       especially if you are using the Debian Lua packages. If you try this
  25       method and it fails for some reason, please make sure system-ac.mk
  26       does not exist before falling back to alternative a).
  27
  28 3. If you want to build some extra modules now or do not want to build
  29    some of the standard modules, edit modulelist.mk.
  30
  31 4. Run 'make'. Note that 'make' here refers to GNU make which is usually
  32    named 'gmake' on systems with some other implementation of make as
  33    default.
  34
  35 5. Run 'make install', as root if you set $PREFIX in system.mk to a
  36    directory that requires those privileges.
  37
  38    YOU SHOULD NOT SKIP THIS STEP unless you know what you are doing. Ion
  39    will refuse to start if it can not find all the necessary uncorrupt
  40    configuration files either in $PREFIX/etc/ion3/ or in ~/.ion3/.
  41
  42 6. How to best set up 'startx' or whatever to start Ion instead of your
  43    current window manager depends on your system's setup. A good guess
  44    is creating or modifying an executable shell script .xsession in your
  45    home directory to start Ion. This should usually (but not always) work
  46    if you're using some X display/login manager. If ~/.xsession does not
  47    help and you're not using a display manager, modifying ~/.xinitrc or
  48    creating one based on your system's xinitrc (wherever that may be;
  49    use locate) may be what you need to do. Note that unlike .xsession, a
  50    .xinitrc should usually do much more setup than simply start a few
  51    programs of your choice.
  52
  53
  54 Please see the file RELNOTES for additional release-specific installation
  55 and configuration notes.
  56
  57
  58 SOME OPTIONAL INSTALLATION STEPS
  59
  60 1. The scripts 'ion-edit' and 'ion-view' in $SHAREDIR and bound to the F5
  61    and F6 keys expect the program 'run-mailcap' to be found. This program
  62    opens a viewer/editor for a file based on its MIME type. Unless you are
  63    using Debian, most likely you don't have it, but any other similar
  64    program (or just plain old text editor) will do as well - just modify the
  65    scripts. Of course, if you don't want to use the feature at this time or
  66    never, you may simply skip this step. If you want to use run-mailcap, it
  67    can be found from the following address, as a source tarball as well:
  68
  69    <http://www.debian.org/Packages/unstable/net/mime-support.html>
  70
  71 2. Ion supports caching known man-pages in a file for faster man-page
  72    completion in the F1 man page query. To enable this feature, you must
  73    periodically run a cronjob to build this list. To create a system-wide
  74    man page cache, run 'crontab -e' (might vary depending on platform) as
  75    root and enter a line such as follows:
  76
  77 15 05 * * * $SHAREDIR/ion-completeman -mksyscache
  78
  79    Replace $SHAREDIR with the setting from system.mk (or system-ac.mk if you
  80    used autoconf). This example runs daily at 05:15, but you may modify the
  81    run times to your needs; see the crontab manual.
  82
  83    If you can't or do not want to build a system-wide man page cache, run
  84    'crontab -e' as your normal user and replace '-mksyscache' with
  85    '-mkusercache' above. The cache file will be ~/.ion3/mancache.
  86
  87    It may also be useful to run ion-completeman with the suitable
  88    '-mk*cache' argument once manually to build the initial cache.
  89
  90    If the MANPATH environment variable is not set on your system and it
  91     does not have the 'manpath' command (or it does not print anything
  92    sensible), you may also want to set the ION_MC_MANPATH environment
  93    variable to the list of paths where the system stores manual pages.
  94
  95
  96 CONFIGURATION
  97
  98 For help on modifying Ion's configuration files, PLEASE READ THE DOCUMENT
  99 "Ion: Configuring and extending with Lua" available from the Ion web page,
 100 listed at the top of this file.
 101
 102
 103 QUESTIONS, COMMENTS, PROBLEMS?
 104
 105 If the available documentation does not answer your question, please
 106 post it to the mailing list. Details can be found on the Ion web page
 107 listed at the top of this file.
 108
 109
 110 CREDITS
 111
 112 Ion was written by Tuomo Valkonen.
 113
 114 The autoconf script written by Tom Payne for the most part.
 115
 116 The dock module was written by Tom Payne and Per Olofsson.
 117
 118 share/ion-completefile/ion-completefile.c is based on editline, (c)
 119 1992 Simmule Turner and Rich Salz. See the file for details.
 120
 121 The code that de/fontset.c is based on was apparently originally written
 122 by Tomohiro Kubota; see
 123 <http://www.debian.org/doc/manuals/intro-i18n/ch-examples.en.html#s13.4.5>.
 124
 125 Various patches have been contributed by other individuals unlisted here.
 126 (See the mailing list archives.)
 127
 128 For translators see the individual .po files in po/.
 129
 130 See libtu/README for code by others integrated into libtu.