README

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