X-Git-Url: http://git.chise.org/gitweb/?p=chise%2Fxemacs-chise.git.1;a=blobdiff_plain;f=man%2Fxemacs%2Fpackages.texi;h=32adac78e97527e92dbdaeecbdbb5a3c00f42113;hp=7ac72f4063025d87ba37e633e0e80140bc29678a;hb=de1ec4b272dfa3f9ef2c9ae28a9ba67170d24da5;hpb=3062d425fac0473eb5aa2efc0bb002f6ce0cb028 diff --git a/man/xemacs/packages.texi b/man/xemacs/packages.texi index 7ac72f4..32adac7 100644 --- a/man/xemacs/packages.texi +++ b/man/xemacs/packages.texi @@ -32,12 +32,14 @@ local needs with safe removal of unnecessary code. There are two main flavors of packages. @itemize @bullet -@item Regular Packages +@item +Regular Packages @cindex regular packages A regular package is one in which multiple files are involved and one may not in general safely remove any of them. -@item Single-File Packages +@item +Single-File Packages @cindex single-file packages A single-file package is an aggregate collection of thematically related but otherwise independent lisp files. These files are bundled @@ -93,28 +95,19 @@ where you grabbed the core distribution from, and are located in the subdirectory @file{packages}. Package file names follow the naming convention @file{--pkg.tar.gz}. -If you have EFS @ref{(EFS)}, packages can be installed over the network. +If you have @ref{(EFS)}, packages can be installed over the network. Alternatively, if you have copies of the packages locally, you can install packages from a local disk or CDROM. The file @file{etc/PACKAGES} in the core distribution contains a list of -the @ref{Available Packages} at the time of the XEmacs release. Packages are -also listed on the @code{Options} menu under: - -@example - Options->Customize->Emacs->Packages -@end example - -However, don't select any of these menu picks unless you actually want -to install the given package (and have properly configured your system -to do so). +the @ref{Available Packages} at the time of the XEmacs release. You can also get a list of available packages, and whether or not they are installed, using the visual package browser and installer. You can access it via the menus: @example - Options->Manage Packages->List & Install + Tools -> Packages -> List and Install @end example Or, you can get to it via the keyboard: @@ -242,22 +235,20 @@ and optionally: After installing these by hand, fire up XEmacs and follow these steps. -Note: The menus in XEmacs 21.2.x and up have changed slightly, so -where I mention "Options -> Manage Packages", substitute "Tools -> -Packages". - @enumerate 1 -@item Choose a download site. -via menu: Options -> Manages Packages -> Add Download Site +@item +Choose a download site. +via menu: Tools -> Packages -> Add Download Site via keyb: @code{M-x customize-variable RET package-get-remote RET} (put in the details of remote host and directory) If the package tarballs _AND_ the package-index file are in a local directory, you can: @code{M-x pui-add-install-directory RET} -@item Obtain a list of packages and display the list in a buffer named +@item +Obtain a list of packages and display the list in a buffer named @file{*Packages*}. -menu: Options -> Manage Packages -> List & Install +menu: Tools -> Packages -> List & Install keyb: @code{M-x pui-list-packages RET} XEmacs will now connect to the remote site and download the @@ -283,7 +274,7 @@ The package has been marked for installation/update. @end table If there is no character in the first column, the package has been -installed and is up-to-date. +installed and is up to date. From here, you can select or unselect packages for installation using the @key{RET} key, the @kbd{Mouse-2} button or selecting "Select" from @@ -319,11 +310,13 @@ Moving the mouse over a package will also cause additional information about the package to be displayed in the minibuffer. -@item Choose the packages you wish to install. +@item +Choose the packages you wish to install. mouse: Click button 2 on the package name. keyb: @kbd{RET} on the package name -@item Make sure you have everything you need. +@item +Make sure you have everything you need. menu: Packages -> Add Required keyb: @kbd{r} @@ -334,7 +327,8 @@ those packages also. For novices and gurus alike, this step can save your bacon. It's easy to forget to install a critical package. -@item Download and install the packages. +@item +Download and install the packages. menu: Packages -> Install/Remove Selected keyb: @kbd{x} @end enumerate @@ -385,7 +379,7 @@ to the package. No need to panic, you don't have to go through the @file{pkinfo/MANIFEST.pkgname} and manually delete the files. Instead, use -@code{M-x package-admin-delete-binary-package RET}. +@code{M-x package-get-delete-package RET}. Note that the interactive package tools included with XEmacs already do this for you. @@ -474,53 +468,63 @@ Remove all created files. @cindex local.rules @heading The Local.rules File: This file is used when building and installing packages from source. In -the top level of the CVS module, @file{xemacs-packages}, contains the +the top level of the CVS module, @file{packages}, contains the file, @file{Local.rules.template}. Simply copy that to @file{Local.rules} and edit it to suit your needs. These are the variables in 'Local.rules' that you will need to -address. +address. Items that have default settings have those defaults shown. @table @var +@item XEMACS = xemacs +If your XEmacs isn't in your path, change this. Native MS Windows users +should double quote this if the path has embedded spaces. + +@item BUILD_WITHOUT_MULE = +Building from CVS defaults to building the Mule +packages. Set this to 't' if you don't want/have Mule + +@item XEMACS_NATIVE_NT = +Set this to 't' if you are building on WinNT. NT users should note that +you still need the Cygwin environment to build the packages. + +@item XEMACS_INSTALLED_PACKAGES_ROOT = /usr/local/lib/xemacs +This is the directory tree under which the installed packages go. Under +this directory there would normally be @file{xemacs-packages/} for +standard (non-Mule) packages, @file{mule-packages/} for Mule packages +(if you built XEmacs with Mule), and possibly @file{site-packages/} for +3rd party packages that aren't distributed by XEmacs.org. + @item symlink = Set this to 't' if you want to do a "run in place". Setting this doesn't work well with 'make bindist' -@item XEMACS_PACKAGES = -This is where you set the normal packages that you -want to install. eg: -@example - XEMACS_PACKAGES = libs/xemacs-base comm/bbdb -@end example - -@item XEMACS_STAGING = $@{XEMACS_PACKAGES_BASE@}/../Packages -Set this to where you want normal packages to be -installed to. +@item NONMULE_INSTALLED_PACKAGES_ROOT = $@{XEMACS_INSTALLED_PACKAGES_ROOT@}/xemacs-packages +This is where the non-Mule packages are installed to. You probably +don't want to change this. -@item PACKAGE_INDEX = package-index -If you want the package-index file to have a different -name, change this. +@item MULE_INSTALLED_PACKAGES_ROOT = $@{XEMACS_INSTALLED_PACKAGES_ROOT@}/mule-packages +This is where the Mule packages are installed to. You probably don't +want to change this. Please note that @code{make bindist} does +@emph{not} use this variable. When doing a @code{make bindist} +@emph{everything} goes into @var{NONMULE_INSTALLED_PACKAGES_ROOT}. -@item BUILD_WITHOUT_MULE = -Building from CVS defaults to building the Mule -packages. Set this to 't' if you don't want/have Mule +@item NONMULE_PACKAGES = xemacs-packages +This is where you set the non-Mule packages that you want to install. eg: +@example + XEMACS_PACKAGES = xemacs-packages/xemacs-base xemacs-packages/bbdb +@end example -@item MULE_PACKAGES = +@item MULE_PACKAGES = mule-packages 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 -Set this to where you want Mule packages installed -to. Note: 'make bindist' does not use this variable. - -@item XEMACS = xemacs -If your XEmacs isn't in your path, change this. - -@item XEMACS_NATIVE_NT = -Set this to 't' if you are building on WinNT. +@item PACKAGE_INDEX = package-index +If you want the package-index file to have a different +name, change this. @item INSTALL = install -c The path to your BSD compatible install program. @@ -561,7 +565,7 @@ infrastructure. priority high category CATEGORY dump nil - description "description" ; a one-line description string + description "DESCRIPTION" ; one-line period-terminated string filename FILENAME md5sum MD5SUM size SIZE @@ -576,11 +580,13 @@ the name of your package as an unquoted symbol. Normally it is the name of the main Lisp file or principal feature provided. The allowed values for distribution are @code{xemacs} and @code{mule}. Write them as unquoted symbols. The @code{description} is a quoted Lisp string; use -the usual conventions. The value for @code{provides} is a list of -feature symbols (written unquoted). All of the features provided by -libraries in your package should be elements of this list. Implementing -an automatic method for generating the @file{provides} line is -desirable, but as yet undone. +the usual conventions. The first letter should be capitalized, and the +string should end in a period. It need not be a complete sentence +grammatically. The value for @code{provides} is a list of feature +symbols (written unquoted). All of the features provided by libraries +in your package should be elements of this list. Implementing an +automatic method for generating the @file{provides} line is desirable, +but as yet undone. The variables in upper-case are references to variables set in the @file{Makefile} or automatically generated. Do not change them; they @@ -608,10 +614,8 @@ The first few @code{make} variables defined are @code{VERSION}, @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,77 +676,122 @@ xemacs.org and it's mirrors. If a particular package that you are 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 September 22, 2002. -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: a rolodex-like database program. + +@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 clearcase +Support for the Clearcase version control system. + +@item cookie +"Fortune cookie"-style messages. Includes Spook (suspicious phrases) +and Yow (Zippy quotes). + +@item crisp +Crisp/Brief emulation. + +@item debug +GUD, gdb, dbx debugging support. + +@item dictionary +Interface to RFC2229 dictionary servers. + @item dired The DIRectory EDitor is for manipulating, and running commands on files in a directory. +@item docbookide +DocBook editing support. + +@item ecrypto +Crypto functionality in Emacs Lisp. + @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 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 emerge +Another interface over patch. -@item sounds-wav -XEmacs Microsoft sound files. +@item eshell +Command shell implemented entirely in Emacs Lisp. -@item tooltalk -Support for building with Tooltalk. +@item ess +ESS: Emacs Speaks Statistics. -@item xemacs-base -Fundamental XEmacs support. Install this unless you wish a totally -naked XEmacs. +@item eterm +Terminal emulator. -@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 +@item eudc +Emacs Unified Directory Client (LDAP, PH). -@subsection Communications Packages (comm) +@item footnote +Footnoting in mail message editing modes. -These packages provide support for various communications, primarily -email and usenet. +@item forms +Forms editing support (obsolete, use the built-in Widget instead). -@table @file -@item bbdb -The Big Brother Data Base +@item fortran-modes +Fortran language support. -@item eicq -ICQ Client developed and tested on Linux x86; -only supported on that platform +@item frame-icon +Provide a WM icon based on major mode. -@item eudc -Emacs Unified Directory Client (LDAP, PH). +@item fsf-compat +GNU Emacs compatibility files. -@item footnote -Footnoting in mail message editing modes. +@item games +Tetris, Sokoban, and Snake. @item gnats XEmacs bug reports. @@ -750,255 +799,248 @@ XEmacs bug reports. @item gnus The Gnus Newsreader and Mailreader. -@item mailcrypt -Support for messaging encryption with PGP. - -@item mew -Messaging in an Emacs World. +@item haskell-mode +Haskell language support. -@item mh-e -Front end support for MH. +@item hm--html-menus +HTML editing. -@item net-utils -Miscellaneous Networking Utilities. This is a single-file package and -files may be deleted at will. +@item ibuffer +Advanced replacement for buffer-menu. -@item rmail -An obsolete Emacs mailer. If you do not already use it don't start. +@item idlwave +Editing and Shell mode for the Interactive Data Language. -@item supercite -An Emacs citation tool. Useful with all Emacs Mailers and Newsreaders. +@item igrep +Enhanced front-end for Grep. -@item tm -Emacs MIME support. Not needed for Gnus >= 5.8.0 +@item ilisp +Front-end for interacting with Inferior Lisp (external lisps). -@item vm -An Emacs mailer. +@item ispell +Spell-checking with ispell. -@item w3 -A Web browser. +@item jde +Java language and development support. -@item zenirc -ZENIRC IRC Client. -@end table +@item liece +IRC (Internet Relay Chat) client for Emacs. -@subsection Games and Amusements (games) +@item mail-lib +Fundamental lisp files for providing email support. -All work and no play... +@item mailcrypt +Support for messaging encryption with PGP. -@table @file -@item cookie -Spook and Yow (Zippy quotes). +@item mew +Messaging in an Emacs World; a MIME-based email program. -@item games -Tetris, Sokoban, and Snake. +@item mh-e +Front end support for MH. @item mine -Minehunt. +Elisp implementation of the game 'Minehunt'. @item misc-games Other amusements and diversions. -@end table -@subsection Mule Support (mule) +@item mmm-mode +Support for Multiple Major Modes within a single buffer. -MULti-lingual Enhancement. Support for world scripts such as -Latin, Arabic, Cyrillic, Chinese, Japanese, Greek, Hebrew etc. -To use these packages your XEmacs must be compiled with Mule -support. - -@table @file -@item edict -Lisp Interface to EDICT, Kanji Dictionary. +@item net-utils +Miscellaneous Networking Utilities. This is a single-file package and +files may be deleted at will. -@item egg-its -Wnn (4.2 and 6) support. SJ3 support. Must be installed prior to -XEmacs build. +@item os-utils +Miscellaneous single-file O/S utilities, for printing, archiving, +compression, remote shells, etc. -@item leim -Quail. Used for everything other than English and Japanese. +@item ocaml +Objective Caml language support. -@item locale -Used for localized menubars (French and Japanese) and localized splash -screens (Japanese). +@item pc +PC style interface emulation. -@item lookup -Dictionary support. (This isn't an English dictionary program) +@item pcl-cvs +CVS frontend. -@item mule-base -Basic Mule support. Must be installed prior to building with Mule. +@item pcomplete +Provides programmatic completion. -@item skk -Another Japanese Language Input Method. Can be used without a -separate process running as a dictionary server. -@end table +@item perl-modes +Perl language support. -@subsection Productivity Packages (oa) +@item prog-modes +Miscellaneous single-file lisp files for various programming languages. -Things to make life a little easier. +@item ps-print +Print buffers to PostScript printers. -@table @file -@item calc -Emacs calculator. +@item psgml +Validated HTML/SGML editing. -@item calendar -Calendar and diary support. +@item psgml-dtds +A collection of DTDs for psgml. Note that this package is deprecated +and will be removed in the future, most likely Q2/2003. Instead of using +this, you should install needed DTDs yourself. -@item edit-utils -Single file lisp packages for various XEmacs goodies. Load this and -weed out the junk you don't want. +@item python-modes +Python language support. -@item forms -Forms editing support (obsolete, use the built-in Widget instead). +@item reftex +Emacs support for LaTeX cross-references, citations. -@item frame-icon -Provide a WM icon based on major mode. +@item rmail +An obsolete Emacs mailer. If you do not already use it don't start. -@item hm--html-menus -HTML editing. +@item ruby-modes +Ruby language support. -@item ispell -Spell-checking with ispell. +@item sasl +Simple Authentication and Security Layer (SASL) library. -@item pc -PC style interface emulation. +@item scheme +Front-end support for Inferior Scheme. -@item psgml -Validated HTML/SGML editing. +@item semantic +Semantic bovinator. @item sgml SGML/Linuxdoc-SGML editing. +@item sh-script +Support for editing shell scripts. + +@item sieve +Manage Sieve email filtering scripts. + @item slider User interface tool. +@item sml-mode +Standard ML editing support. + +@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. -@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 tm +Emacs MIME support. Not needed for Gnus >= 5.8.0 -@item eterm -Terminal emulator. +@item tooltalk +Support for building with Tooltalk. -@item igrep -Enhanced front-end for Grep. +@item tpu +DEC EDIT/TPU support. -@item ilisp -Front-end for Inferior Lisp. +@item tramp +Remote shell-based file editing. This is similar to EFS or Ange-FTP, +but works with rsh/ssh and rcp/scp. -@item os-utils -Miscellaneous single-file O/S utilities, for printing, archiving, -compression, remote shells, etc. +@item vc +Version Control for Free systems. -@item pcomplete -Provides programmatic completion. +@item vc-cc +Version Control for ClearCase. This package will shortly be +replaced with clearcase.el -@item ps-print-nomule -Old, but no-Mule safe ps-print. +@item vhdl +Support for VHDL. @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 viper +VI emulation support. -@item pcl-cvs -CVS frontend. +@item vm +An Emacs mailer. -@item prog-modes -Miscellaneous single-file lisp files for various programming languages. +@item w3 +A Web browser. -@item scheme -Front-end support for Inferior Scheme. +@item xemacs-base +Fundamental XEmacs support. Install this unless you wish a totally +naked XEmacs. -@item semantic -Semantic bovinator. +@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 sh-script -Support for editing shell scripts. +@item xslide +XSL editing support. -@item vc -Version Control for Free systems. +@item xslt-process +A minor mode for (X)Emacs which allows running an XSLT processor on a +buffer. -@item vc-cc -Version Control for ClearCase. This package will shortly be -replaced with clearcase.el - -@item vhdl -Support for VHDL. +@item zenirc +ZENIRC IRC Client. @end table -@subsection Word Processing (wp) +@subsection Mule Support (mule) -Working with text. +MULti-lingual Enhancement. Support for world scripts such as +Latin, Arabic, Cyrillic, Chinese, Japanese, Greek, Hebrew etc. +To use these packages your XEmacs must be compiled with Mule +support. @table @file -@item auctex -Basic TeX/LaTeX support. +@item edict +Lisp Interface to EDICT, Kanji Dictionary. -@item crisp -Crisp/Brief emulation. +@item egg-its +Wnn (4.2 and 6) support. SJ3 support. Must be installed prior to +XEmacs build. -@item edt -DEC EDIT/EDT emulation. +@item latin-unity +Unify character sets in a buffer. When characters belong to disjoint +character sets, this attempts to translate the characters so +that they belong to one character set. If the buffer coding system is +not sufficient, this suggests different coding systems. -@item reftex -Emacs support for LaTeX cross-references, citations. +@item leim +Quail. Used for everything other than English and Japanese. -@item texinfo -XEmacs TeXinfo support. +@item locale +Used for localized menubars (French and Japanese) and localized splash +screens (Japanese). -@item textools -Single-file TeX support. +@item lookup +Dictionary support. (This isn't an English dictionary program) -@item tpu -DEC EDIT/TPU support. +@item mule-base +Basic Mule support. Must be installed prior to building with Mule. -@item viper -VI emulation support. +@item mule-ucs +Extended coding systems (including Unicode) for XEmacs. + +@item skk +Another Japanese Language Input Method. Can be used without a +separate process running as a dictionary server. @end table