home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / elisp / packages / edb / README < prev    next >
Encoding:
Text File  |  1993-05-19  |  2.9 KB  |  88 lines
  1. This is the README file for EDB, a database program for GNU Emacs.
  2. The bulk of the EDB documentation is in the texinfo file database.texi.
  3. EDB was written by Michael Ernst <mernst@theory.lcs.mit.edu>.
  4. EDB is in beta test, but is reasonably stable.
  5.  
  6.  
  7. Files in EDB
  8. ============
  9.  
  10. (In lexographic order)
  11.  
  12. README        This file:  manifest and installation instructions
  13.  
  14. README-example    README file for the separate EDB examples distribution
  15.  
  16. backtracef.el    Fixes backtrace to work in the presence of circular data.
  17.  
  18. database.el    The main file; primarily loads other files
  19.  
  20. database.texi    texinfo documentation
  21.  
  22. db-convert.el    Changing database structure:  add and remove fields, etc.
  23.  
  24. db-file-io.el    Saving databases to disk, loading databases from disk
  25.  
  26. db-format.el    Displaying and editing a single database record
  27.  
  28. db-interfa.el    Keystroke bindings, wrapper functions
  29.  
  30. db-lucid.el    Support for Lucid GNU Emacs menus, fontification, etc.
  31.  
  32. db-rdb.el    Support for RDB databases
  33.  
  34. db-rep.el    Data abstractions and operations upon them
  35.  
  36. db-search.el    Searching and matching records
  37.  
  38. db-sort.el    Sorting records
  39.  
  40. db-summary.el    Summary buffer with limited info about every database record
  41.  
  42. db-tagged.el    Support for tagged database files
  43.  
  44. db-time.el    Definitions of time and date field types
  45.  
  46. db-two-dbs.el    Operations on two databases:  merging, comparing, etc.
  47.  
  48. db-types.el    Definitions of useful field types
  49.  
  50. util-clmde.el    Some Common Lisp functions missing from Elisp
  51.  
  52. util-mde.el    Useful non-EDB specific utility functions
  53.  
  54. See below for how to get pre-processed copies of the documentation.
  55.  
  56.  
  57. Installation
  58. ============
  59.  
  60. See the "Installation" section of database.texi for more complete and
  61. definitive instructions.
  62.  
  63. In short, place the .el files in your Emacs load path (probably in a
  64. directory of their own).  You can add a directory to your Emacs lisp load
  65. path by putting something similar to the following in your .emacs file:
  66.  
  67.     (setq load-path (cons (expand-file-name "~/emacs/edb") load-path))
  68.  
  69. In order to autoload EDB, put the following in your .emacs file:
  70.  
  71.     (autoload 'db-find-file "database" "EDB database package" t)
  72.  
  73. Use M-x db-find-file to start up EDB on a particular database file.
  74.  
  75. It is recommended that, lest it run very slowly, you byte-compile the code;
  76. use function byte-compile-database to do so.
  77.  
  78. The texinfo documentation uses version 2 of texinfo, which is available
  79. from prep.ai.mit.edu.  Earlier versions of texinfo will not properly format
  80. the manual, either for TeX or for info.  If you don't have a sufficiently
  81. up-to-date version of texinfo, you can simply get the files database.dvi
  82. (or database.ps) and database.info and database.info-[123456] (six files)
  83. from theory.lcs.mit.edu:/pub/emacs/edb/; these are versions of the
  84. documentation ready for printing and for use in info, respectively.
  85.  
  86. Sample databases can be found in the file examples.tar.Z or the directory
  87. examples, both in theory.lcs.mit.edu:/pub/emacs/edb/.
  88.