README

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