README

   1 This is Initz version 0.0.11
   2 ============================
   3
   4 What's the Initz?
   5 -----------------
   6
   7   Initz handles the switching of various startup initialization files
   8   of emacsen provided for various environment. According to the
   9   environment (maybe emacs version, OS type or OS versions) Initz
  10   reads appropriate init files provided by the user in several
  11   directories, one for one environment.
  12
  13 Features
  14 --------
  15
  16   * Init files for each emacs environment are separately stored in one
  17     directory for each. You also can provide a common directory whose
  18     init files are read in every environment.
  19
  20   * When there are init files which are updated, they are automatically
  21     compiled.
  22
  23   * You can load init files interactively.
  24
  25   * A major mode `initz-list' is included which supports browsing and
  26     editing init files.
  27
  28   * When an error occurred during compiling or loading init files,
  29     you can browse and/or edit the files immediately.
  30
  31   * By using the functions in `init-util.el', you can customize the
  32     handlings of init files dynamically.
  33
  34 Working Environments
  35 --------------------
  36
  37   The latest version of Initz are verified to work properly under
  38   following emacsen.
  39
  40   XEmacs 21.5 (beta5)
  41   Emacs 20.7.2
  42   Emacs 21.1.1
  43   Meadow 1.15pre1
  44
  45 Requirements
  46 ------------
  47
  48   You need following package:
  49
  50     * APEL (9.0 or later) - ftp://ftp.m17n.org/pub/mule/apel/
  51
  52 Directory tree
  53 --------------
  54
  55   This package contains following directories:
  56
  57     lisp/   - elisp files.
  58
  59     sample/ - sample init files.
  60
  61 Installation
  62 ------------
  63
  64   (Install APEL, then)
  65   % cd lisp
  66   % make
  67   % su
  68   # make install
  69
  70   Add following lines in your .emacs.
  71
  72   (require 'initz)
  73   (add-hook 'after-init-hook 'initz-startup)
  74
  75 How to use
  76 ----------
  77
  78   Provide init files for each environment in appropriate directories
  79   according to next section. Sample init files are provided in the
  80   directory `sample'.
  81   Supposing you need, you may be able to use the functions in
  82   `initz-util.el' conveniently.
  83
  84 Working directory tree
  85 ----------------------
  86
  87   ~/.initz -+- startup --+- miscellaneous init files
  88             |            +- argument - argument dependant init files
  89             |            +- flavor   - flavor dependant init files
  90             |            +- host     - host dependant init files
  91             |            +- system   - system dependant init files
  92             |
  93             +- (flavor) -+- compiled miscellaneous init files
  94                          +- argument - compiled argument dependant init files
  95                          +- flavor   - compiled flavor dependant init files
  96                          +- host     - compiled host dependant init files
  97                          +- system   - compiled system dependant init files
  98
  99   Compiled init files are created automatically.
 100
 101 Copying
 102 -------
 103
 104   Initz is copyrighted free software by OHASHI Akira <bg66@koka-in.org>.
 105   You can redistribute it and/or modify it under either the terms of
 106   the GPL (see the file `COPYING').
 107
 108 Information
 109 -----------
 110
 111   For more information, see the Initz web page at
 112
 113     http://www.koka-in.org/~bg66/index.cgi?cmd=view;name=Initz
 114
 115 Development
 116 -----------
 117
 118   Development of Initz uses CVS, Concurrent Versions System. Latest
 119   development version is available via CVS.
 120
 121   * cvs login (first time only)
 122
 123     % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root login
 124     (CVS password: [CR] # NULL string)
 125
 126   * checkout modules
 127
 128     % cvs -d :pserver:anonymous@cvs.m17n.org:/cvs/root checkout initz
 129
 130   Browsing the CVS tree gives you a great view into the current status of
 131   this project's code. You may also view the complete history of any file
 132   in the repository.
 133   Plase referer at <URL:http://cvs.m17n.org/cgi-bin/viewcvs/initz/>.
 134
 135   If you would like to join CVS based development, plase referer at
 136   <URL:http://cvs.m17n.org/>.
 137
 138 Bug reports
 139 -----------
 140
 141   If you have bug reports and/or suggestions for improvement, please send
 142   them to bg66@koka-in.org.
 143
 144 References
 145 ----------
 146
 147   * http://deisui.bug.org/cgi-bin/viewcvs.cgi/dot-xemacs/README?rev=HEAD
 148
 149   * http://triaez.kaisei.org/~kaoru/emacsen/startup/INSTALL.ja
 150
 151   * http://www.unixuser.org/~ysjj/emacs/
 152
 153   * http://www.sodan.org/~knagano/emacs/dotemacs.html