Mercurial > hg > xemacs-beta
diff etc/PACKAGES @ 296:5a79be0ef6a8 r21-0b46
Import from CVS: tag r21-0b46
author | cvs |
---|---|
date | Mon, 13 Aug 2007 10:38:46 +0200 |
parents | 6330739388db |
children | 4f79e16b1112 |
line wrap: on
line diff
--- a/etc/PACKAGES Mon Aug 13 10:38:02 2007 +0200 +++ b/etc/PACKAGES Mon Aug 13 10:38:46 2007 +0200 @@ -1,149 +1,3 @@ - -*- mode:outline -*- -* Introduction to XEmacs Packages -================================= - -As of XEmacs 21.0, XEmacs is no longer distributed in a large -monolithic distribution. The distribution has been broken up into -separate units called packages. In the general case, one may install -and uninstall various packages freely without having to modify the -XEmacs binary. This gives an installer the ability to tailor an -XEmacs installation for local needs with safe removal of unnecessary -code. - -There are two main flavors of packages. - -** Regular Packages -=================== - -A regular package is one in which multiple files are involved and one -may not in general safely remove any of them. - -** Single-File Packages -======================= - -A single-file package is an aggregate collection of thematically -related but otherwise independent lisp files. These files are bundled -together for download convenience and individual files may deleted at -will without any loss of functionality. - -* Package mechanics -=================== - -This section describes how package hierarchy directories are put -together and how they may be configured into XEmacs. - -** Package Path -=============== - -For backwards compatibility and for ease of transition to XEmacs 21, it -is possible to use previous XEmacs installations as package directories. -Specify something like ---package-path="~/.xemacs::/somewhere-newpackages::/usr/local/lib/xemacs-20.4" -to configure when building. You will have extra messages at dump -time relating to lisp shadows which you may ignore. The first -magical null directory `::' is a marker indicating what packages -should only be searched at run-time. The second magical null -directory is used to indicate where Lisp bundled with the running -XEmacs gets put at the back of load path. By specifing the older -directories after the current one, the newer lisp overrides the -older lisp. - -** The anatomy of an XEmacs Package hierarchy -============================================= - -An XEmacs package is laid out just like a normal installed XEmacs lisp -directory. It may have lisp, etc, info, and lib-src subdirectories. -These directories get added at XEmacs startup to whatever directories -it was already using. - -There may be any number of Package hierarchy directories. - -* Package Distributions -======================= - -XEmacs lisp packages are distributed in two ways depending on the -intended use. Binary Packages are for installers and end-users and -may be installed directly into an XEmacs package directory. Source -Packages are for developers and include all files necessary for -rebuilding bytecompiled lisp and creating tarballs for distribution. - -** Binary Packages -================== - -Binary packages may be installed directly into an XEmacs package -directory. XEmacs package directories are determined at the time -XEmacs is configured for building. The default is -${prefix}/lib/xemacs/packages. `prefix' defaults to /usr/local unless -changed by the XEmacs configurer. This may be changed by specifying a -path of the form --package-path=directory:directory:directory... (all -directories separated by colons). There is no restriction on the -number of directories. There may be no package directories, but -XEmacs won't be very useful. - -** Source Packages -================== - -Source packages contain all of the Package author's (where appropriate -in regular packages) source code plus all of the files necessary to -build distribution tarballs (Unix Tar format files and gzipped for -space savings). - -*** Prerequisites for building Source Packages - -You must have GNU cp, GNU ginstall (or a BSD compatible install -program) GNU make (3.75 or later preferred), makeinfo (1.68 from -texinfo-3.11 or later required), GNU tar and XEmacs 21.0 :-). The -source packages will untar into a correct directory structure. At -the top level you must have XEmacs.rules and package-compile.el. -These files are available from the XEmacs FTP site from the same -place you obtained your source package distributions. - -*** What you can do with Source Packages - -NB: A global build operation doesn't exist yet as of 13 January 1998. - -Source packages are most useful for creating XEmacs package tarballs -for installation into your own XEmacs installations or for -distributing to others. - -Supported operations from Make are: - -**** clean - -Remove all built files except auto-autoloads.el and custom-load.el. - -**** distclean - -Remove XEmacs backups as well as the files deleted by `make clean'. - -**** all - -Byte compile all files, build and bytecompile byproduct files like -auto-autoloads.el and custom-load.el. Create info version of TeXinfo -documentation if present. - -**** srckit - -Usually aliased to `make srckit-std'. This does a `make distclean' -and creates a Package source tarball in the staging directory. This -is generally only of use for package maintainers. - -**** binkit - -May be aliased to binkit-sourceonly, binkit-sourceinfo, -binkit-sourcedata, or binkit-sourcedatainfo. `sourceonly' indicates -there is nothing to install in a data directory or info directory. -`sourceinfo' indicates that source and info files are to be -installed. `sourcedata' indicates that source and etc (data) files -are to be installed. `sourcedatainfo' indicates source, etc (data), -and info files are to be installed. A few packages have needs beyond -the basic templates so this is not yet complete. - -**** dist - -Runs the rules `srckit' followed by `binkit'. This is primarily of -use by XEmacs maintainers producing files for distribution. - * Description of available packages by category =============================================== @@ -169,10 +23,14 @@ A Lisp debugger. +*** dired + +The DIRectory EDitor is for manipulating, and running commands on +files in a directory. + *** efs -Treat files on remote systems the same as local files. Also contains -dired. +Treat files on remote systems the same as local files. *** mail-lib