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