changeset 540:bbfb58bc8dde

[xemacs-hg @ 2001-05-15 06:48:40 by youngs] Update package docs
author youngs
date Tue, 15 May 2001 06:49:13 +0000
parents eec22eb29327
children 02261edd09de
files etc/PACKAGES man/ChangeLog man/xemacs/packages.texi
diffstat 3 files changed, 426 insertions(+), 469 deletions(-) [+]
line wrap: on
line diff
--- a/etc/PACKAGES	Mon May 14 10:00:08 2001 +0000
+++ b/etc/PACKAGES	Tue May 15 06:49:13 2001 +0000
@@ -7,22 +7,53 @@
 
 For general XEmacs navigation tips: Press C-h t
 
-Description of available packages by category
-=============================================
-This data is up-to-date as of January 17, 2001.
+Description of available packages
+=================================
+Up-to-date as of May 15, 2001.
 
-** Library Packages (libs)
-==========================
-These packages are required to build and support most of the rest of
-XEmacs.  By design, xemacs-base is a `regular' package.  Use restraint 
-when adding new files there as it is required by almost everything.
+** Normal Packages
+==================
+A very broad collection of elisp packages.
 
 *** Sun
 Support for Sparcworks.
 
+*** ada
+Ada language support.
+
 *** apel
 A Portable Emacs Library.  Used by XEmacs MIME support.
 
+*** auctex
+Basic TeX/LaTeX support.
+
+*** bbdb
+The Big Brother Data Base
+
+*** build
+Build XEmacs using custom widgets.
+
+*** c-support
+Basic single-file add-ons for editing C code.
+
+*** calc
+Emacs calculator.
+
+*** calendar
+Calendar and diary support.
+
+*** cc-mode
+C, C++ and Java language support.
+
+*** cookie
+Spook and Yow (Zippy quotes).
+
+*** crisp
+Crisp/Brief emulation.
+
+*** debug
+GUD, gdb, dbx debugging support.
+
 *** dired
 The DIRectory EDitor is for manipulating, and running commands on
 files in a directory.
@@ -30,27 +61,204 @@
 *** edebug
 A Lisp debugger.
 
+*** ediff
+Interface over patch.
+
+*** edit-utils
+Single file lisp packages for various XEmacs goodies.  Load this and
+weed out the junk you don't want.
+
+*** edt
+DEC EDIT/EDT emulation.
+
 *** efs
 Treat files on remote systems the same as local files.
 
+*** eicq
+ICQ Client developed and tested on Linux x86; 
+only supported on that platform
+
+*** eieio
+Enhanced Implementation of Emacs Interpreted Objects
+
 *** elib
 Portable Emacs Lisp utilities library.
 
+*** emerge
+Another interface over patch.
+
+*** eshell
+Command shell implemented entirely in Emacs Lisp.
+
+*** eterm
+Terminal emulator.
+
+*** eudc
+Emacs Unified Directory Client (LDAP, PH).
+
+*** footnote
+Footnoting in mail message editing modes.
+
+*** forms
+Forms editing support (obsolete, use the built-in Widget instead).
+
+*** frame-icon
+Provide a WM icon based on major mode.
+
 *** fsf-compat
 FSF Emacs compatibility files.
 
+*** games
+Tetris, Sokoban, and Snake.
+
+*** gnats
+XEmacs bug reports.
+
+*** gnus
+The Gnus Newsreader and Mailreader.
+
+*** hm--html-menus
+HTML editing.
+
+*** idlwave
+Editing and Shell mode for the Interactive Data Language.
+
+*** igrep
+Enhanced front-end for Grep.
+
+*** ilisp
+Front-end for Inferior Lisp.
+
+*** ispell
+Spell-checking with ispell.
+
+*** jde
+Java language and development support.
+
 *** mail-lib
 Fundamental lisp files for providing email support.
 
+*** mailcrypt
+Support for messaging encryption with PGP.
+
+*** mew
+Messaging in an Emacs World.
+
+*** mh-e
+Front end support for MH.
+
+*** mine
+Minehunt.
+
+*** misc-games
+Other amusements and diversions.
+
+*** net-utils
+Miscellaneous Networking Utilities.  This is a single-file package and 
+files may be deleted at will.
+
+*** os-utils
+Miscellaneous single-file O/S utilities, for printing, archiving,
+compression, remote shells, etc.
+
+*** pc
+PC style interface emulation.
+
+*** pcl-cvs
+CVS frontend.
+
+*** pcomplete
+Provides programmatic completion.
+
+*** prog-modes
+Miscellaneous single-file lisp files for various programming languages.
+
+*** ps-print-nomule
+Old, but no-Mule safe ps-print.
+
+*** psgml
+Validated HTML/SGML editing.
+
+*** reftex
+Emacs support for LaTeX cross-references, citations.
+
+*** rmail
+An obsolete Emacs mailer.  If you do not already use it don't start.
+
+*** scheme
+Front-end support for Inferior Scheme.
+
+*** semantic
+Semantic bovinator.
+
+*** sgml
+SGML/Linuxdoc-SGML editing.
+
+*** sh-script
+Support for editing shell scripts.
+
+*** slider
+User interface tool.
+
 *** sounds-au
 XEmacs Sun sound files.
 
 *** sounds-wav
 XEmacs Microsoft sound files.
 
+*** speedbar
+Provides a separate frame with convenient references.
+
+*** strokes
+Mouse enhancement utility.
+
+*** supercite
+An Emacs citation tool.  Useful with all Emacs Mailers and Newsreaders.
+
+*** texinfo
+XEmacs TeXinfo support.
+
+*** text-modes
+Various single file lisp packages for editing text files.
+
+*** textools
+Single-file TeX support.
+
+*** time
+Display time & date on the modeline.
+
+*** tm
+Emacs MIME support. Not needed for Gnus >= 5.8.0
+
 *** tooltalk
 Support for building with Tooltalk.
 
+*** tpu
+DEC EDIT/TPU support.
+
+*** vc
+Version Control for Free systems.
+
+*** vc-cc
+Version Control for ClearCase.  This package will shortly be
+replaced with clearcase.el
+
+*** vhdl
+Support for VHDL.
+
+*** view-process
+A Unix process browsing tool.
+
+*** viper
+VI emulation support.
+
+
+*** vm
+An Emacs mailer.
+
+*** w3
+A Web browser.
+
 *** xemacs-base
 Fundamental XEmacs support.  Install this unless you wish a totally
 naked XEmacs.
@@ -60,77 +268,13 @@
 supporting Lisp development.  It is a single-file package so it may be 
 tailored.
 
-** Communications Packages (comm)
-=================================
-These packages provide support for various communications, primarily
-email and usenet.
-
-*** bbdb
-The Big Brother Data Base
-
-*** eicq
-ICQ Client developed and tested on Linux x86; 
-only supported on that platform
-
-*** eudc
-Emacs Unified Directory Client (LDAP, PH).
-
-*** footnote
-Footnoting in mail message editing modes.
-
-*** gnats
-XEmacs bug reports.
-
-*** gnus
-The Gnus Newsreader and Mailreader.
-
-*** mailcrypt
-Support for messaging encryption with PGP.
-
-*** mew
-Messaging in an Emacs World.
-
-*** mh-e
-Front end support for MH.
-
-*** net-utils
-Miscellaneous Networking Utilities.  This is a single-file package and 
-files may be deleted at will.
-
-*** rmail
-An obsolete Emacs mailer.  If you do not already use it don't start.
-
-*** supercite
-An Emacs citation tool.  Useful with all Emacs Mailers and Newsreaders.
-
-*** tm
-Emacs MIME support. Not needed for Gnus >= 5.8.0
-
-*** vm
-An Emacs mailer.
-
-*** w3
-A Web browser.
+*** xslt-process
+A minor mode for (X)Emacs which allows running an XSLT processor on a
+buffer.
 
 *** zenirc
 ZENIRC IRC Client.
 
-** Games and Amusements (games)
-===============================
-All work and no play...
-
-*** cookie
-Spook and Yow (Zippy quotes).
-
-*** games
-Tetris, Sokoban, and Snake.
-
-*** mine
-Minehunt.
-
-*** misc-games
-Other amusements and diversions.
-
 ** Mule Support (mule)
 ======================
 MULti-lingual Enhancement.  Support for world scripts such as
@@ -162,163 +306,3 @@
 Another Japanese Language Input Method.  Can be used without a
 separate process running as a dictionary server.
 
-** Productivity Packages (oa)
-=============================
-Things to make life a little easier.
-
-*** calc
-Emacs calculator.
-
-*** calendar
-Calendar and diary support.
-
-*** edit-utils
-Single file lisp packages for various XEmacs goodies.  Load this and
-weed out the junk you don't want.
-
-*** forms
-Forms editing support (obsolete, use the built-in Widget instead).
-
-*** frame-icon
-Provide a WM icon based on major mode.
-
-*** hm--html-menus
-HTML editing.
-
-*** ispell
-Spell-checking with ispell.
-
-*** pc
-PC style interface emulation.
-
-*** psgml
-Validated HTML/SGML editing.
-
-*** sgml
-SGML/Linuxdoc-SGML editing.
-
-*** slider
-User interface tool.
-
-*** speedbar
-Provides a separate frame with convenient references.
-
-*** strokes
-Mouse enhancement utility.
-
-*** text-modes
-Various single file lisp packages for editing text files.
-
-*** time
-Display time & date on the modeline.
-
-** Operating System Utilities (os)
-==================================
-Tools for working with the operating system.
-
-*** eshell
-Command shell implemented entirely in Emacs Lisp.
-
-*** eterm
-Terminal emulator.
-
-*** igrep
-Enhanced front-end for Grep.
-
-*** ilisp
-Front-end for Inferior Lisp.
-
-*** os-utils
-Miscellaneous single-file O/S utilities, for printing, archiving,
-compression, remote shells, etc.
-
-*** pcomplete
-Provides programmatic completion.
-
-*** ps-print-nomule
-Old, but no-Mule safe ps-print.
-
-*** view-process
-A Unix process browsing tool.
-
-** Program Editing Support (prog)
-=================================
-XEmacs supports a multitude of programming languages.  These
-packages will help your coding.
-
-*** ada
-Ada language support.
-
-*** c-support
-Basic single-file add-ons for editing C code.
-
-*** cc-mode
-C, C++ and Java language support.
-
-*** debug
-GUD, gdb, dbx debugging support.
-
-*** ediff
-Interface over patch.
-
-*** emerge
-Another interface over patch.
-
-*** idlwave
-Editing and Shell mode for the Interactive Data Language.
-
-*** jde
-Java language and development support.
-
-*** pcl-cvs
-CVS frontend.
-
-*** prog-modes
-Miscellaneous single-file lisp files for various programming languages.
-
-*** scheme
-Front-end support for Inferior Scheme.
-
-*** semantic
-Semantic bovinator.
-
-*** sh-script
-Support for editing shell scripts.
-
-*** vc
-Version Control for Free systems.
-
-*** vc-cc
-Version Control for ClearCase.  This package will shortly be
-replaced with clearcase.el
-
-*** vhdl
-Support for VHDL.
-
-** Word Processing (wp)
-=======================
-Working with text.
-
-*** auctex
-Basic TeX/LaTeX support.
-
-*** crisp
-Crisp/Brief emulation.
-
-*** edt
-DEC EDIT/EDT emulation.
-
-*** reftex
-Emacs support for LaTeX cross-references, citations.
-
-*** texinfo
-XEmacs TeXinfo support.
-
-*** textools
-Single-file TeX support.
-
-*** tpu
-DEC EDIT/TPU support.
-
-*** viper
-VI emulation support.
--- a/man/ChangeLog	Mon May 14 10:00:08 2001 +0000
+++ b/man/ChangeLog	Tue May 15 06:49:13 2001 +0000
@@ -1,3 +1,9 @@
+2001-05-15  Steve Youngs  <youngs@xemacs.org>
+
+	* xemacs/packages.texi (Local.rules): Update to reflect new dir tree.
+	(Creating Packages): Ditto.
+	(Available Packages): Ditto.
+
 2001-05-09  Martin Buchholz <martin@xemacs.org>
 
 	* XEmacs 21.5.1 "anise" is released.
--- a/man/xemacs/packages.texi	Mon May 14 10:00:08 2001 +0000
+++ b/man/xemacs/packages.texi	Tue May 15 06:49:13 2001 +0000
@@ -490,7 +490,7 @@
 This is where you set the normal packages that you
 want to install. eg:
 @example
-      XEMACS_PACKAGES = libs/xemacs-base comm/bbdb
+      XEMACS_PACKAGES = xemacs-packages/xemacs-base xemacs-packages/bbdb
 @end example
 
 @item XEMACS_STAGING = $@{XEMACS_PACKAGES_BASE@}/../Packages
@@ -509,7 +509,7 @@
 Same as for 'XEMACS_PACKAGES' except you list the Mule
 packages you want to install here. eg:
 @example
-      MULE_PACKAGES = mule/mule-base mule/skk
+      MULE_PACKAGES = mule-packages/mule-base mule-packages/skk
 @end example
 
 @item MULE_STAGING = $@{XEMACS_PACKAGES_BASE@}/../Mule-Packages
@@ -608,10 +608,8 @@
 @code{AUTHOR_VERSION}, @code{MAINTAINER}, @code{PACKAGE},
 @code{PKG_TYPE}, @code{REQUIRES}, and @code{CATEGORY}.  All but one were
 described in the description of @file{package-info.in}.  The last is an
-administrative grouping.  Current categories include @code{comm},
-@code{games}, @code{libs}, @code{mule}, @code{oa}, @code{os},
-@code{prog}, and @code{wp}.  @ref{Available Packages}, for a list of
-categories.
+administrative grouping.  Current categories include @code{standard},
+and @code{mule}.
 
 Next, define the variable @code{ELCS}.  This contains the list of the
 byte-compiled Lisp files used by the package.  These files and their
@@ -672,21 +670,51 @@
 looking for isn't here, please send a message to the
 @email{xemacs-beta@@xemacs.org, XEmacs Beta list}.
 
-This data is up-to-date as of January 17, 2001.
-
-@subsection Library Packages (libs)
+This data is up-to-date as of May 15, 2001.
 
-These packages are required to build and support most of the rest of
-XEmacs.  By design, xemacs-base is a `regular' package.  Use restraint 
-when adding new files there as it is required by almost everything.
+@subsection Normal Packages
+A very broad selection of elisp packages.
 
 @table @file
 @item Sun
 Support for Sparcworks.
 
+@item ada
+Ada language support.
+
 @item apel
 A Portable Emacs Library.  Used by XEmacs MIME support.
 
+@item auctex
+Basic TeX/LaTeX support.
+
+@item bbdb
+The Big Brother Data Base
+
+@item build
+Build XEmacs using custom widgets.
+
+@item c-support
+Basic single-file add-ons for editing C code.
+
+@item calc
+Emacs calculator.
+
+@item calendar
+Calendar and diary support.
+
+@item cc-mode
+C, C++ and Java language support.
+
+@item cookie
+Spook and Yow (Zippy quotes).
+
+@item crisp
+Crisp/Brief emulation.
+
+@item debug
+GUD, gdb, dbx debugging support.
+
 @item dired
 The DIRectory EDitor is for manipulating, and running commands on
 files in a directory.
@@ -694,49 +722,37 @@
 @item edebug
 A Lisp debugger.
 
+@item ediff
+Interface over patch.
+
+@item edit-utils
+Single file lisp packages for various XEmacs goodies.  Load this and
+weed out the junk you don't want.
+
+@item edt
+DEC EDIT/EDT emulation.
+
 @item efs
 Treat files on remote systems the same as local files.
 
+@item eicq
+ICQ Client developed and tested on Linux x86; 
+only supported on that platform
+
+@item eieio
+Enhanced Implementation of Emacs Interpreted Objects.
+
 @item elib
 Portable Emacs Lisp utilities library.
 
-@item fsf-compat
-FSF Emacs compatibility files.
-
-@item mail-lib
-Fundamental lisp files for providing email support.
-
-@item sounds-au
-XEmacs Sun sound files.
-
-@item sounds-wav
-XEmacs Microsoft sound files.
-
-@item tooltalk
-Support for building with Tooltalk.
-
-@item xemacs-base
-Fundamental XEmacs support.  Install this unless you wish a totally
-naked XEmacs.
+@item emerge
+Another interface over patch.
 
-@item xemacs-devel
-XEmacs Lisp developer support.  This package contains utilities for
-supporting Lisp development.  It is a single-file package so it may be 
-tailored.
-@end table
-
-@subsection Communications Packages (comm)
+@item eshell
+Command shell implemented entirely in Emacs Lisp.
 
-These packages provide support for various communications, primarily
-email and usenet.
-
-@table @file
-@item bbdb
-The Big Brother Data Base
-
-@item eicq
-ICQ Client developed and tested on Linux x86; 
-only supported on that platform
+@item eterm
+Terminal emulator.
 
 @item eudc
 Emacs Unified Directory Client (LDAP, PH).
@@ -744,12 +760,45 @@
 @item footnote
 Footnoting in mail message editing modes.
 
+@item forms
+Forms editing support (obsolete, use the built-in Widget instead).
+
+@item frame-icon
+Provide a WM icon based on major mode.
+
+@item fsf-compat
+FSF Emacs compatibility files.
+
+@item games
+Tetris, Sokoban, and Snake.
+
 @item gnats
 XEmacs bug reports.
 
 @item gnus
 The Gnus Newsreader and Mailreader.
 
+@item hm--html-menus
+HTML editing.
+
+@item idlwave
+Editing and Shell mode for the Interactive Data Language.
+
+@item igrep
+Enhanced front-end for Grep.
+
+@item ilisp
+Front-end for Inferior Lisp.
+
+@item ispell
+Spell-checking with ispell.
+
+@item jde
+Java language and development support.
+
+@item mail-lib
+Fundamental lisp files for providing email support.
+
 @item mailcrypt
 Support for messaging encryption with PGP.
 
@@ -759,47 +808,134 @@
 @item mh-e
 Front end support for MH.
 
+@item mine
+Minehunt.
+
+@item misc-games
+Other amusements and diversions.
+
 @item net-utils
 Miscellaneous Networking Utilities.  This is a single-file package and 
 files may be deleted at will.
 
+@item os-utils
+Miscellaneous single-file O/S utilities, for printing, archiving,
+compression, remote shells, etc.
+
+@item pc
+PC style interface emulation.
+
+@item pcl-cvs
+CVS frontend.
+
+@item pcomplete
+Provides programmatic completion.
+
+@item prog-modes
+Miscellaneous single-file lisp files for various programming languages.
+
+@item ps-print-nomule
+Old, but no-Mule safe ps-print.
+
+@item psgml
+Validated HTML/SGML editing.
+
+@item reftex
+Emacs support for LaTeX cross-references, citations.
+
 @item rmail
 An obsolete Emacs mailer.  If you do not already use it don't start.
 
+@item scheme
+Front-end support for Inferior Scheme.
+
+@item semantic
+Semantic bovinator.
+
+@item sgml
+SGML/Linuxdoc-SGML editing.
+
+@item sh-script
+Support for editing shell scripts.
+
+@item slider
+User interface tool.
+
+@item sounds-au
+XEmacs Sun sound files.
+
+@item sounds-wav
+XEmacs Microsoft sound files.
+
+@item speedbar
+Provides a separate frame with convenient references.
+
+@item strokes
+Mouse enhancement utility.
+
 @item supercite
 An Emacs citation tool.  Useful with all Emacs Mailers and Newsreaders.
 
+@item texinfo
+XEmacs TeXinfo support.
+
+@item text-modes
+Various single file lisp packages for editing text files.
+
+@item textools
+Single-file TeX support.
+
+@item time
+Display time & date on the modeline.
+
 @item tm
 Emacs MIME support. Not needed for Gnus >= 5.8.0
 
+@item tooltalk
+Support for building with Tooltalk.
+
+@item tpu
+DEC EDIT/TPU support.
+
+@item vc
+Version Control for Free systems.
+
+@item vc-cc
+Version Control for ClearCase.  This package will shortly be
+replaced with clearcase.el
+
+@item vhdl
+Support for VHDL.
+
+@item view-process
+A Unix process browsing tool.
+
+@item viper
+VI emulation support.
+
 @item vm
 An Emacs mailer.
 
 @item w3
 A Web browser.
 
+@item xemacs-base
+Fundamental XEmacs support.  Install this unless you wish a totally
+naked XEmacs.
+
+@item xemacs-devel
+XEmacs Lisp developer support.  This package contains utilities for
+supporting Lisp development.  It is a single-file package so it may be 
+tailored.
+
+@item xslt-process
+A minor mode for (X)Emacs which allows running an XSLT processor on a
+buffer.
+
 @item zenirc
 ZENIRC IRC Client.
 @end table
 
-@subsection Games and Amusements (games)
-
-All work and no play...
-
-@table @file
-@item cookie
-Spook and Yow (Zippy quotes).
-
-@item games
-Tetris, Sokoban, and Snake.
-
-@item mine
-Minehunt.
-
-@item misc-games
-Other amusements and diversions.
-@end table
-
 @subsection Mule Support (mule)
 
 MULti-lingual Enhancement.  Support for world scripts such as
@@ -833,172 +969,3 @@
 separate process running as a dictionary server.
 @end table
 
-@subsection Productivity Packages (oa)
-
-Things to make life a little easier.
-
-@table @file
-@item calc
-Emacs calculator.
-
-@item calendar
-Calendar and diary support.
-
-@item edit-utils
-Single file lisp packages for various XEmacs goodies.  Load this and
-weed out the junk you don't want.
-
-@item forms
-Forms editing support (obsolete, use the built-in Widget instead).
-
-@item frame-icon
-Provide a WM icon based on major mode.
-
-@item hm--html-menus
-HTML editing.
-
-@item ispell
-Spell-checking with ispell.
-
-@item pc
-PC style interface emulation.
-
-@item psgml
-Validated HTML/SGML editing.
-
-@item sgml
-SGML/Linuxdoc-SGML editing.
-
-@item slider
-User interface tool.
-
-@item speedbar
-Provides a separate frame with convenient references.
-
-@item strokes
-Mouse enhancement utility.
-
-@item text-modes
-Various single file lisp packages for editing text files.
-
-@item time
-Display time & date on the modeline.
-@end table
-
-@subsection Operating System Utilities (os)
-
-Tools for working with the operating system.
-
-@table @file
-@item eshell
-Command shell implemented entirely in Emacs Lisp.
-
-@item eterm
-Terminal emulator.
-
-@item igrep
-Enhanced front-end for Grep.
-
-@item ilisp
-Front-end for Inferior Lisp.
-
-@item os-utils
-Miscellaneous single-file O/S utilities, for printing, archiving,
-compression, remote shells, etc.
-
-@item pcomplete
-Provides programmatic completion.
-
-@item ps-print-nomule
-Old, but no-Mule safe ps-print.
-
-@item view-process
-A Unix process browsing tool.
-@end table
-
-@subsection Program Editing Support (prog)
-
-XEmacs supports a multitude of programming languages.  These
-packages will help your coding.
-
-@table @file
-@item ada
-Ada language support.
-
-@item c-support
-Basic single-file add-ons for editing C code.
-
-@item cc-mode
-C, C++ and Java language support.
-
-@item debug
-GUD, gdb, dbx debugging support.
-
-@item ediff
-Interface over patch.
-
-@item emerge
-Another interface over patch.
-
-@item idlwave
-Editing and Shell mode for the Interactive Data Language.
-
-@item jde
-Java language and development support.
-
-@item pcl-cvs
-CVS frontend.
-
-@item prog-modes
-Miscellaneous single-file lisp files for various programming languages.
-
-@item scheme
-Front-end support for Inferior Scheme.
-
-@item semantic
-Semantic bovinator.
-
-@item sh-script
-Support for editing shell scripts.
-
-@item vc
-Version Control for Free systems.
-
-@item vc-cc
-Version Control for ClearCase.  This package will shortly be
-replaced with clearcase.el
-
-@item vhdl
-Support for VHDL.
-@end table
-
-@subsection Word Processing (wp)
-
-Working with text.
-
-@table @file
-@item auctex
-Basic TeX/LaTeX support.
-
-@item crisp
-Crisp/Brief emulation.
-
-@item edt
-DEC EDIT/EDT emulation.
-
-@item reftex
-Emacs support for LaTeX cross-references, citations.
-
-@item texinfo
-XEmacs TeXinfo support.
-
-@item textools
-Single-file TeX support.
-
-@item tpu
-DEC EDIT/TPU support.
-
-@item viper
-VI emulation support.
-@end table
-