README

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