Mercurial > hg > xemacs-beta
annotate man/xemacs/packages.texi @ 5567:3bc58dc9d688
Replace #'flet by #'labels where appropriate, core code.
lisp/ChangeLog addition:
2011-09-07 Aidan Kehoe <kehoea@parhasard.net>
* simple.el (transpose-subr):
* specifier.el (let-specifier):
* specifier.el (derive-device-type-from-tag-set):
* test-harness.el (batch-test-emacs):
* x-compose.el (alias-colon-to-doublequote):
* mule/chinese.el (make-chinese-cns11643-charset):
* mule/mule-cmds.el (set-locale-for-language-environment):
* mule/mule-cmds.el (set-language-environment-coding-systems):
* mule/mule-x-init.el (x-use-halfwidth-roman-font):
* about.el (about-xemacs):
* about.el (about-hackers):
* diagnose.el (show-memory-usage):
* diagnose.el (show-object-memory-usage-stats):
* diagnose.el (show-mc-alloc-memory-usage):
* diagnose.el (show-gc-stats):
* dialog.el (make-dialog-box):
* faces.el:
* faces.el (Face-frob-property):
* faces.el (set-face-stipple):
* glyphs.el:
* glyphs.el (init-glyphs): Removed.
* help-macro.el (make-help-screen):
* info.el (Info-construct-menu):
* keymap.el (key-sequence-list-description):
* lisp-mode.el (construct-lisp-mode-menu):
* loadhist.el (unload-feature):
* minibuf.el (get-user-response):
* mouse.el (default-mouse-track-check-for-activation):
* mouse.el (mouse-track-insert-1):
Follow my own advice from the last commit and use #'labels instead
of #'flet in core code.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Wed, 07 Sep 2011 21:21:36 +0100 |
| parents | 40a52efbf3a3 |
| children | 9c17f7be0b92 |
| rev | line source |
|---|---|
| 444 | 1 @c This is part of the XEmacs manual. |
| 2 @c Copyright (C) 1985, 86, 87, 93, 94, 95, 1997 Free Software Foundation, Inc. | |
| 3 @c See file xemacs.texi for copying conditions. | |
| 4 @node Packages, Basic, Startup Paths, Top | |
| 428 | 5 @comment node-name, next, previous, up |
| 6 | |
| 7 @section Packages | |
| 8 @cindex packages | |
| 9 | |
| 10 The XEmacs 21 distribution comes only with a very basic set of | |
| 11 built-in modes and packages. Most of the packages that were part of | |
| 12 the distribution of earlier versions of XEmacs are now available | |
| 13 separately. The installer as well as the user can choose which | |
| 14 packages to install; the actual installation process is easy. | |
| 15 This gives an installer the ability to tailor an XEmacs installation for | |
| 16 local needs with safe removal of unnecessary code. | |
| 17 | |
| 2421 | 18 @emph{NOTE}: For detailed information about how the package |
| 19 hierarchies work, @xref{Package Overview,,,lispref, XEmacs Lisp Reference Manual}. | |
| 20 | |
| 428 | 21 @menu |
| 22 * Package Terminology:: Understanding different kinds of packages. | |
| 458 | 23 * Installing Packages:: How to install packages. |
| 24 * Building Packages:: Building packages from CVS sources. | |
| 462 | 25 * Local.rules File:: This is an important file that you must create. |
| 458 | 26 * Available Packages:: A brief directory of packaged LISP. |
| 428 | 27 @end menu |
| 28 | |
| 458 | 29 @node Package Terminology, Installing Packages, , Packages |
| 428 | 30 @comment node-name, next, previous, up |
| 458 | 31 @heading Package Terminology: |
| 428 | 32 @subsection Package Flavors |
| 33 | |
| 34 There are two main flavors of packages. | |
| 35 | |
| 36 @itemize @bullet | |
| 635 | 37 @item |
| 38 Regular Packages | |
| 428 | 39 @cindex regular packages |
| 40 A regular package is one in which multiple files are involved and one | |
| 41 may not in general safely remove any of them. | |
| 42 | |
| 635 | 43 @item |
| 44 Single-File Packages | |
| 428 | 45 @cindex single-file packages |
| 46 A single-file package is an aggregate collection of thematically | |
| 47 related but otherwise independent lisp files. These files are bundled | |
| 48 together for download convenience and individual files may be deleted at | |
| 458 | 49 will without any loss of functionality. However, we would recommend |
| 50 that you follow this rule of thumb: "When in doubt, don't delete". | |
| 428 | 51 @end itemize |
| 52 | |
| 53 @subsection Package Distributions | |
| 458 | 54 @cindex package distributions |
| 428 | 55 XEmacs Lisp packages are distributed in two ways, depending on the |
| 458 | 56 intended use. Binary Packages are for installers and end-users that can |
| 428 | 57 be installed directly into an XEmacs package directory. Source Packages |
| 58 are for developers and include all files necessary for rebuilding | |
| 59 bytecompiled lisp and creating tarballs for distribution. | |
| 60 | |
| 61 @subsection Binary Packages | |
| 62 @cindex binary packages | |
| 63 Binary packages may be installed directly into an XEmacs package | |
| 64 hierarchy. | |
| 65 | |
| 66 @subsection Source Packages | |
| 67 @cindex source packages | |
| 68 Source packages contain all of the Package author's (where appropriate | |
| 69 in regular packages) source code plus all of the files necessary to | |
| 70 build distribution tarballs (Unix Tar format files, gzipped for space | |
| 71 savings). | |
| 72 | |
| 458 | 73 Currently, source packages are only available via CVS. See |
| 74 @url{http://cvs.xemacs.org/} for details. | |
| 1648 | 75 |
| 458 | 76 @node Installing Packages, Building Packages, Package Terminology, Packages |
| 428 | 77 @comment node-name, next, previous, up |
| 458 | 78 @cindex installing packages |
| 79 @cindex install | |
| 80 @heading Installing Packages: | |
| 428 | 81 @subsection Getting Started |
| 82 | |
| 83 When you first download XEmacs 21, you will usually first grab the | |
| 84 @dfn{core distribution}, | |
| 85 @cindex core distribution | |
| 86 a file called | |
| 458 | 87 @file{xemacs-21.x.x.tar.gz}. (Replace the @t{21.x.x} by the current version |
| 428 | 88 number.) The core distribution contains the sources of XEmacs and a |
| 89 minimal set of Emacs Lisp files, which are in the subdirectory named | |
| 90 @file{lisp}. This subdirectory used to contain all Emacs Lisp files | |
| 91 distributed with XEmacs. Now, to conserve disk space, most | |
| 92 non-essential packages were made optional. | |
| 93 | |
| 94 @subsection Choosing the Packages You Need | |
| 458 | 95 @cindex choosing packages |
| 96 The @ref{Available Packages} can currently be found in the same ftp directory | |
| 428 | 97 where you grabbed the core distribution from, and are located in the |
| 458 | 98 subdirectory @file{packages}. Package file names follow |
| 428 | 99 the naming convention @file{<package-name>-<version>-pkg.tar.gz}. |
| 100 | |
| 966 | 101 If you have EFS @ref{(EFS)}, packages can be installed over the network. |
| 102 Alternatively, if you have copies of the packages locally, you can | |
| 103 install packages from a local disk or CDROM. | |
| 428 | 104 |
| 105 The file @file{etc/PACKAGES} in the core distribution contains a list of | |
| 824 | 106 the @ref{Available Packages} at the time of the XEmacs release. |
| 428 | 107 |
| 108 You can also get a list of available packages, and whether or not they | |
| 109 are installed, using the visual package browser and installer. You can | |
| 110 access it via the menus: | |
| 111 | |
| 112 @example | |
| 1648 | 113 Tools -> Packages -> List and Install |
| 428 | 114 @end example |
| 115 | |
| 116 Or, you can get to it via the keyboard: | |
| 117 | |
| 118 @example | |
| 1648 | 119 @code{M-x pui-list-packages} |
| 428 | 120 @end example |
| 121 | |
| 122 Hint to system administrators of multi-user systems: it might be a good | |
| 123 idea to install all packages and not interfere with the wishes of your | |
| 124 users. | |
| 125 | |
| 126 If you can't find which package provides the feature you require, try | |
| 127 using the @code{package-get-package-provider} function. Eg., if you know | |
| 128 that you need @code{thingatpt}, type: | |
| 129 | |
| 130 @example | |
| 1648 | 131 @code{M-x package-get-package-provider RET thingatpt} |
| 428 | 132 @end example |
| 133 | |
| 1648 | 134 which will return something like @samp{(fsf-compat "1.08")}. You can the use |
| 428 | 135 one of the methods above for installing the package you want. |
| 136 | |
| 137 @subsection XEmacs and Installing Packages | |
| 138 | |
| 458 | 139 There are three main ways to install packages: |
| 140 | |
| 141 @menu | |
| 1648 | 142 * Automatically:: Using the package tools from XEmacs. |
| 458 | 143 * Manually:: Using individual package tarballs. |
| 1648 | 144 * Sumo:: All at once, using the 'Sumo Tarball'. |
| 458 | 145 * Which Packages:: Which packages to install. |
| 146 * Removing Packages:: Removing packages. | |
| 147 @end menu | |
| 148 | |
| 149 But regardless of the method you use to install packages, they can only | |
| 1648 | 150 be used by XEmacs after a restart unless the package in question has not |
| 151 been previously installed. | |
| 458 | 152 |
| 1648 | 153 @node Automatically, Manually, ,Installing Packages |
| 458 | 154 @comment node-name, next, previous, up |
| 155 @cindex automatic package install | |
| 156 @cindex package tools | |
| 157 @heading Automatic Package Installation: | |
| 158 XEmacs comes with some tools to make the periodic updating and | |
| 159 installing easier. It will notice if new packages or versions are | |
| 160 available and will fetch them from the FTP site. | |
| 428 | 161 |
| 458 | 162 Unfortunately this requires that a few packages are already in place. |
| 163 You will have to install them by hand as above or use a SUMO tarball. | |
| 164 This requirement will hopefully go away in the future. The packages | |
| 165 you need are: | |
| 428 | 166 |
| 167 @example | |
| 458 | 168 efs - To fetch the files from the FTP site or mirrors. |
| 169 xemacs-base - Needed by efs. | |
| 170 | |
| 171 and optionally: | |
| 172 | |
| 1648 | 173 mailcrypt - To do PGP verification of the @file{package-index} |
| 174 file. | |
| 428 | 175 @end example |
| 176 | |
| 458 | 177 After installing these by hand, fire up XEmacs and follow these |
| 178 steps. | |
| 179 | |
| 180 @enumerate 1 | |
| 635 | 181 @item |
| 182 Choose a download site. | |
| 1648 | 183 via menu: Tools -> Packages -> Set Download Site |
| 458 | 184 via keyb: @code{M-x customize-variable RET package-get-remote RET} |
| 185 (put in the details of remote host and directory) | |
| 428 | 186 |
| 458 | 187 If the package tarballs _AND_ the package-index file are in a |
| 1366 | 188 local directory, you can: @code{M-x pui-set-local-package-get-directory RET} |
| 458 | 189 |
| 635 | 190 @item |
| 191 Obtain a list of packages and display the list in a buffer named | |
| 458 | 192 @file{*Packages*}. |
| 824 | 193 menu: Tools -> Packages -> List & Install |
| 458 | 194 keyb: @code{M-x pui-list-packages RET} |
| 195 | |
| 196 XEmacs will now connect to the remote site and download the | |
| 1366 | 197 latest package-index file. |
| 428 | 198 |
| 199 The visual package browser will then display a list of all packages. | |
| 200 Help information will be displayed at the very bottom of the buffer; you | |
| 201 may have to scroll down to see it. You can also press @kbd{?} to get | |
| 202 the same help. From this buffer, you can tell the package status by the | |
| 203 character in the first column: | |
| 204 | |
| 205 @table @kbd | |
| 206 @item - | |
| 207 The package has not been installed. | |
| 208 @item * | |
| 209 The package has been installed, but a newer version is available. The | |
| 210 current version is out-of-date. | |
| 211 @item + | |
| 212 The package has been marked for installation/update. | |
| 213 @end table | |
| 214 | |
| 215 If there is no character in the first column, the package has been | |
| 1030 | 216 installed and is up to date. |
| 428 | 217 |
| 218 From here, you can select or unselect packages for installation using | |
| 219 the @key{RET} key, the @kbd{Mouse-2} button or selecting "Select" from | |
| 1366 | 220 the Popup @kbd{Mouse-3} Menu. |
| 428 | 221 Once you've finished selecting the packages, you can |
| 222 press the @kbd{x} key (or use the menu) to actually install the | |
| 223 packages. Note that you will have to restart XEmacs for XEmacs to | |
| 224 recognize any new packages. | |
| 225 | |
| 226 Key summary: | |
| 227 | |
| 228 @table @kbd | |
| 229 @item ? | |
| 230 Display simple help. | |
| 231 @item @key{RET} | |
| 232 @itemx @key{Mouse-2} | |
| 233 Toggle between selecting and unselecting a package for installation. | |
| 234 @item x | |
| 235 Install selected packages. | |
| 236 @item @key{SPC} | |
| 237 View, in the minibuffer, additional information about the package, such | |
| 238 as the package date (not the build date) and the package author. Moving | |
| 239 the mouse over a package name will also do the same thing. | |
| 240 @item v | |
| 241 Toggle between verbose and non-verbose package display. | |
| 242 @item g | |
| 243 Refresh the package display. | |
| 244 @item q | |
| 245 Kill the package buffer. | |
| 246 @end table | |
| 247 | |
| 248 Moving the mouse over a package will also cause additional information | |
| 1366 | 249 about the package to be displayed in the minibuffer. If you have |
| 250 balloon-help enabled a balloon-help frame will pop up and display | |
| 251 additional package information also. | |
| 428 | 252 |
| 253 | |
| 635 | 254 @item |
| 255 Choose the packages you wish to install. | |
| 458 | 256 mouse: Click button 2 on the package name. |
| 257 keyb: @kbd{RET} on the package name | |
| 258 | |
| 635 | 259 @item |
| 260 Make sure you have everything you need. | |
| 458 | 261 menu: Packages -> Add Required |
| 262 keyb: @kbd{r} | |
| 428 | 263 |
| 458 | 264 XEmacs will now search for packages that are required by the |
| 265 ones that you have chosen to install and offer to select | |
| 266 those packages also. | |
| 428 | 267 |
| 458 | 268 For novices and gurus alike, this step can save your bacon. |
| 269 It's easy to forget to install a critical package. | |
| 428 | 270 |
| 635 | 271 @item |
| 272 Download and install the packages. | |
| 458 | 273 menu: Packages -> Install/Remove Selected |
| 274 keyb: @kbd{x} | |
| 275 @end enumerate | |
| 428 | 276 |
| 277 You can also install packages using a semi-manual interface: | |
| 278 | |
| 279 @example | |
| 280 M-x package-get-all <return> | |
| 281 @end example | |
| 282 | |
| 283 Enter the name of the package (e.g., @code{prog-modes}), and XEmacs | |
| 458 | 284 will search for the latest version and install it and any packages that |
| 428 | 285 it depends upon. |
| 286 | |
| 1366 | 287 @heading Keeping Packages Up To Date: |
| 288 Once you have the packages you want installed (using any of the above | |
| 289 methods) you'll want to keep them up to date. You can do this easily | |
| 290 from the menubar: | |
| 291 | |
| 292 @example | |
| 1648 | 293 Tools -> Packages -> Set Download Site |
| 1366 | 294 Tools -> Packages -> Update Installed Packages |
| 295 @end example | |
| 296 | |
| 297 | |
| 1648 | 298 @node Manually, Sumo, Automatically, Installing Packages |
| 299 @comment node-name, next, previous, up | |
| 300 @cindex manual package install | |
| 301 @heading Manual Package Installation: | |
| 302 Fetch the packages from the FTP site, CD-ROM whatever. The filenames | |
| 303 have the form @file{name-<version>-pkg.tar.gz} and are gzipped tar files. For | |
| 304 a fresh install it is sufficient to untar the file at the top of the | |
| 305 package hierarchy. | |
| 306 | |
| 2421 | 307 @emph{NOTE}: If you are upgrading packages already installed, it's best to |
| 1648 | 308 remove the old package first @ref{Removing Packages}. |
| 309 | |
| 310 For example if we are installing the @file{xemacs-base} | |
| 311 package (version 1.48): | |
| 312 | |
| 313 @example | |
|
5551
40a52efbf3a3
Reflect change of location of packages to share/
Mike Sperber <sperber@deinprogramm.de>
parents:
4488
diff
changeset
|
314 mkdir $prefix/share/xemacs/xemacs-packages RET # if it does not exist yet |
|
40a52efbf3a3
Reflect change of location of packages to share/
Mike Sperber <sperber@deinprogramm.de>
parents:
4488
diff
changeset
|
315 cd $prefix/share/xemacs/xemacs-packages RET |
| 1648 | 316 gunzip -c /path/to/xemacs-base-1.48-pkg.tar.gz | tar xvf - RET |
| 317 | |
| 318 Or if you have GNU tar, the last step can be: | |
| 319 | |
| 320 tar zxvf /path/to/xemacs-base-1.48-pkg.tar.gz RET | |
| 321 @end example | |
| 322 | |
| 323 For MULE related packages, it is best to untar into the mule-packages | |
| 324 hierarchy, i.e. for the @file{mule-base} package, version 1.37: | |
| 325 | |
| 326 @example | |
|
5551
40a52efbf3a3
Reflect change of location of packages to share/
Mike Sperber <sperber@deinprogramm.de>
parents:
4488
diff
changeset
|
327 mkdir $prefix/share/xemacs/mule-packages RET # if it does not exist yet |
|
40a52efbf3a3
Reflect change of location of packages to share/
Mike Sperber <sperber@deinprogramm.de>
parents:
4488
diff
changeset
|
328 cd $prefix/share/xemacs/mule-packages RET |
| 1648 | 329 gunzip -c /path/to/mule-base-1.37-pkg.tar.gz | tar xvf - RET |
| 330 | |
| 331 Or if you have GNU tar, the last step can be: | |
| 332 | |
| 333 tar zxvf /path/to/mule-base-1.37-pkg.tar.gz RET | |
| 334 @end example | |
| 335 | |
| 2421 | 336 @emph{NOTE}: For more detailed information about how the package |
| 337 hierarchies work, @xref{Package Overview,,,lispref, XEmacs Lisp Reference Manual}. | |
| 338 | |
| 1648 | 339 @node Sumo, Which Packages, Manually, Installing Packages |
| 340 @comment node-name, next, previous, up | |
| 341 @cindex sumo package install | |
| 342 @heading Installing the Sumo Packages: | |
| 343 Those with little time, cheap connections and plenty of disk space can | |
| 344 install all the packages at once using the sumo tarballs. | |
| 345 Download the file: @file{xemacs-sumo.tar.gz} | |
| 346 | |
| 347 For an XEmacs compiled with Mule you also need: @file{xemacs-mule-sumo.tar.gz} | |
| 348 | |
| 349 N.B. They are called 'Sumo Tarballs' for good reason. They are | |
| 350 currently about 19MB and 4.5MB (gzipped) respectively. | |
| 351 | |
| 352 Install them by: | |
| 353 | |
|
5551
40a52efbf3a3
Reflect change of location of packages to share/
Mike Sperber <sperber@deinprogramm.de>
parents:
4488
diff
changeset
|
354 @code{cd $prefix/share/xemacs ; gunzip -c <tarballname> | tar xvf - RET} |
| 1648 | 355 |
| 356 Or, if you have GNU tar: | |
| 357 | |
|
5551
40a52efbf3a3
Reflect change of location of packages to share/
Mike Sperber <sperber@deinprogramm.de>
parents:
4488
diff
changeset
|
358 @code{cd $prefix/share/xemacs ; tar zxvf /path/to/<tarballname> RET} |
| 1648 | 359 |
| 360 As the Sumo tarballs are not regenerated as often as the individual | |
| 361 packages, it is recommended that you use the automatic package tools | |
| 362 afterwards to pick up any recent updates. | |
| 363 | |
| 364 @node Which Packages, Removing Packages, Sumo, Installing Packages | |
| 458 | 365 @comment node-name, next, previous, up |
| 366 @cindex which packages | |
| 367 @cindex choosing packages | |
| 368 @heading Which Packages to Install: | |
| 369 This is difficult to say. When in doubt install a package. If you | |
| 370 administrate a big site it might be a good idea to just install | |
| 371 everything. A good minimal set of packages for XEmacs-latin1 would be | |
| 428 | 372 |
| 458 | 373 xemacs-base, xemacs-devel, c-support, cc-mode, debug, dired, efs, |
| 374 edit-utils, fsf-compat, mail-lib, net-utils, os-utils, prog-modes, | |
| 1648 | 375 text-modes, time, mailcrypt |
| 428 | 376 |
| 458 | 377 If you are using the XEmacs package tools, don't forget to do: |
| 428 | 378 |
| 458 | 379 Packages -> Add Required |
| 428 | 380 |
| 458 | 381 To make sure you have everything that the packages you have chosen to |
| 382 install need. | |
| 383 | |
| 384 See also @ref{Available Packages} for further descriptions of the individual | |
| 385 packages. | |
| 428 | 386 |
| 458 | 387 @node Removing Packages, ,Which Packages, Installing Packages |
| 388 @comment node-name, next, previous, up | |
| 389 @cindex removing packages | |
| 390 @cindex deleting packages | |
| 391 @heading Removing Packages: | |
| 392 Because the exact files and their locations contained in a package may | |
| 393 change it is recommended to remove a package first before installing a | |
| 394 new version. In order to facilitate removal each package contains an | |
| 4488 | 395 @file{pkginfo/MANIFEST.pkgname} file which lists all the files belonging |
| 458 | 396 to the package. |
| 428 | 397 |
| 458 | 398 No need to panic, you don't have to go through the |
| 4488 | 399 @file{pkginfo/MANIFEST.pkgname} and manually delete the files. Instead, use |
| 737 | 400 @code{M-x package-get-delete-package RET}. |
| 428 | 401 |
| 458 | 402 Note that the interactive package tools included with XEmacs already do |
| 403 this for you. | |
| 428 | 404 |
| 458 | 405 @node Building Packages, Local.rules File, Installing Packages, Packages |
| 428 | 406 @comment node-name, next, previous, up |
| 458 | 407 @cindex building packages |
| 408 @cindex package building | |
| 409 @heading Building Packages: | |
| 410 Currently, source packages are only available via anonymous CVS. See | |
| 411 @url{http://cvs.xemacs.org/} for details of checking out the | |
| 412 @file{xemacs-packages} module. | |
| 428 | 413 |
| 414 @subsection Prerequisites for Building Source Packages | |
| 415 | |
| 458 | 416 @table @code |
| 417 @item GNU cp | |
| 462 | 418 @item GNU install |
| 458 | 419 (or a BSD compatible install program). |
| 420 @item GNU make | |
| 421 (3.75 or later preferred). | |
| 422 @item makeinfo | |
| 1366 | 423 (4.2 from GNU texinfo 4.2 or later required). |
| 458 | 424 @item GNU tar |
| 425 (or equivalent). | |
| 426 @item GNU gzip | |
| 427 (or equivalent). | |
| 428 @item A properly configured @file{Local.rules} file. | |
| 429 @ref{Local.rules File}. | |
| 430 @end table | |
| 431 And of course, XEmacs 21.0 or higher. | |
| 428 | 432 |
| 433 @subsection What You Can Do With Source Packages | |
| 434 | |
| 458 | 435 The packages CVS sources are most useful for creating XEmacs package |
| 436 tarballs for installation into your own XEmacs installations or for | |
| 428 | 437 distributing to others. |
| 438 | |
| 1648 | 439 For a list and description of the different @file{Makefile} targets, |
| 2421 | 440 @xref{Makefile Targets,,,lispref, XEmacs Lisp Reference Manual}. |
| 428 | 441 |
| 1648 | 442 @node Local.rules File, Available Packages, Building Packages, Packages |
| 448 | 443 @comment node-name, next, previous, up |
| 458 | 444 @cindex local.rules |
| 445 @heading The Local.rules File: | |
| 446 This file is used when building and installing packages from source. In | |
| 1251 | 447 the top level of the CVS module, @file{packages}, contains the |
| 458 | 448 file, @file{Local.rules.template}. Simply copy that to |
| 449 @file{Local.rules} and edit it to suit your needs. | |
| 448 | 450 |
| 1648 | 451 For a complete discussion of the @file{Local.rules} file, |
| 2421 | 452 @xref{Local.rules File,,,lispref, XEmacs Lisp Reference Manual}. |
| 448 | 453 |
| 1648 | 454 @node Available Packages, , Local.rules File, Packages |
| 444 | 455 @comment node-name, next, previous, up |
| 458 | 456 @cindex available packages |
| 457 @cindex packages | |
| 458 @heading Available Packages: | |
| 459 This section lists the Lisp packages that are currently available from | |
| 460 xemacs.org and it's mirrors. If a particular package that you are | |
| 461 looking for isn't here, please send a message to the | |
| 462 @email{xemacs-beta@@xemacs.org, XEmacs Beta list}. | |
| 444 | 463 |
| 1648 | 464 This data is up to date as of June 27, 2003. |
| 444 | 465 |
| 540 | 466 @subsection Normal Packages |
| 467 A very broad selection of elisp packages. | |
| 444 | 468 |
| 469 @table @file | |
| 470 @item Sun | |
| 471 Support for Sparcworks. | |
| 472 | |
| 540 | 473 @item ada |
| 474 Ada language support. | |
| 475 | |
| 444 | 476 @item apel |
| 477 A Portable Emacs Library. Used by XEmacs MIME support. | |
| 478 | |
| 540 | 479 @item auctex |
| 480 Basic TeX/LaTeX support. | |
| 481 | |
| 482 @item bbdb | |
| 947 | 483 The Big Brother Data Base: a rolodex-like database program. |
| 540 | 484 |
| 485 @item build | |
| 486 Build XEmacs using custom widgets. | |
| 487 | |
| 488 @item c-support | |
| 489 Basic single-file add-ons for editing C code. | |
| 490 | |
| 491 @item calc | |
| 492 Emacs calculator. | |
| 493 | |
| 494 @item calendar | |
| 495 Calendar and diary support. | |
| 496 | |
| 497 @item cc-mode | |
| 498 C, C++ and Java language support. | |
| 499 | |
| 947 | 500 @item clearcase |
| 501 Support for the Clearcase version control system. | |
| 502 | |
| 540 | 503 @item cookie |
| 947 | 504 "Fortune cookie"-style messages. Includes Spook (suspicious phrases) |
| 505 and Yow (Zippy quotes). | |
| 540 | 506 |
| 507 @item crisp | |
| 508 Crisp/Brief emulation. | |
| 509 | |
| 510 @item debug | |
| 511 GUD, gdb, dbx debugging support. | |
| 512 | |
| 947 | 513 @item dictionary |
| 514 Interface to RFC2229 dictionary servers. | |
| 515 | |
| 444 | 516 @item dired |
| 517 The DIRectory EDitor is for manipulating, and running commands on | |
| 518 files in a directory. | |
| 519 | |
| 955 | 520 @item docbookide |
| 521 DocBook editing support. | |
| 522 | |
| 523 @item ecrypto | |
| 524 Crypto functionality in Emacs Lisp. | |
| 525 | |
| 458 | 526 @item edebug |
| 527 A Lisp debugger. | |
| 528 | |
| 540 | 529 @item ediff |
| 530 Interface over patch. | |
| 531 | |
| 532 @item edit-utils | |
| 533 Single file lisp packages for various XEmacs goodies. Load this and | |
| 534 weed out the junk you don't want. | |
| 535 | |
| 536 @item edt | |
| 537 DEC EDIT/EDT emulation. | |
| 538 | |
| 444 | 539 @item efs |
| 540 Treat files on remote systems the same as local files. | |
| 541 | |
| 540 | 542 @item eieio |
| 543 Enhanced Implementation of Emacs Interpreted Objects. | |
| 544 | |
| 458 | 545 @item elib |
| 546 Portable Emacs Lisp utilities library. | |
| 547 | |
| 540 | 548 @item emerge |
| 549 Another interface over patch. | |
| 444 | 550 |
| 540 | 551 @item eshell |
| 552 Command shell implemented entirely in Emacs Lisp. | |
| 444 | 553 |
| 947 | 554 @item ess |
| 555 ESS: Emacs Speaks Statistics. | |
| 556 | |
| 540 | 557 @item eterm |
| 558 Terminal emulator. | |
| 458 | 559 |
| 560 @item eudc | |
| 561 Emacs Unified Directory Client (LDAP, PH). | |
| 562 | |
| 444 | 563 @item footnote |
| 564 Footnoting in mail message editing modes. | |
| 565 | |
| 540 | 566 @item forms |
| 567 Forms editing support (obsolete, use the built-in Widget instead). | |
| 568 | |
| 1030 | 569 @item fortran-modes |
| 570 Fortran language support. | |
| 571 | |
| 540 | 572 @item frame-icon |
| 573 Provide a WM icon based on major mode. | |
| 574 | |
| 575 @item fsf-compat | |
| 1030 | 576 GNU Emacs compatibility files. |
| 540 | 577 |
| 578 @item games | |
| 579 Tetris, Sokoban, and Snake. | |
| 580 | |
| 1648 | 581 @item general-docs |
| 582 General documentation. Presently, empty. | |
| 583 | |
| 444 | 584 @item gnats |
| 585 XEmacs bug reports. | |
| 586 | |
| 587 @item gnus | |
| 588 The Gnus Newsreader and Mailreader. | |
| 589 | |
| 947 | 590 @item haskell-mode |
| 1030 | 591 Haskell language support. |
| 947 | 592 |
| 540 | 593 @item hm--html-menus |
| 594 HTML editing. | |
| 595 | |
| 947 | 596 @item ibuffer |
| 597 Advanced replacement for buffer-menu. | |
| 598 | |
| 540 | 599 @item idlwave |
| 600 Editing and Shell mode for the Interactive Data Language. | |
| 601 | |
| 602 @item igrep | |
| 603 Enhanced front-end for Grep. | |
| 604 | |
| 605 @item ilisp | |
| 947 | 606 Front-end for interacting with Inferior Lisp (external lisps). |
| 540 | 607 |
| 608 @item ispell | |
| 609 Spell-checking with ispell. | |
| 610 | |
| 611 @item jde | |
| 612 Java language and development support. | |
| 613 | |
| 947 | 614 @item liece |
| 615 IRC (Internet Relay Chat) client for Emacs. | |
| 616 | |
| 540 | 617 @item mail-lib |
| 618 Fundamental lisp files for providing email support. | |
| 619 | |
| 444 | 620 @item mailcrypt |
| 621 Support for messaging encryption with PGP. | |
| 622 | |
| 458 | 623 @item mew |
| 947 | 624 Messaging in an Emacs World; a MIME-based email program. |
| 458 | 625 |
| 444 | 626 @item mh-e |
| 627 Front end support for MH. | |
| 628 | |
| 540 | 629 @item mine |
| 947 | 630 Elisp implementation of the game 'Minehunt'. |
| 540 | 631 |
| 632 @item misc-games | |
| 633 Other amusements and diversions. | |
| 634 | |
| 947 | 635 @item mmm-mode |
| 636 Support for Multiple Major Modes within a single buffer. | |
| 637 | |
| 444 | 638 @item net-utils |
| 639 Miscellaneous Networking Utilities. This is a single-file package and | |
| 640 files may be deleted at will. | |
| 641 | |
| 1648 | 642 @item ocaml |
| 643 Objective Caml editing support. | |
| 644 | |
| 540 | 645 @item os-utils |
| 646 Miscellaneous single-file O/S utilities, for printing, archiving, | |
| 647 compression, remote shells, etc. | |
| 648 | |
| 649 @item pc | |
| 650 PC style interface emulation. | |
| 651 | |
| 652 @item pcl-cvs | |
| 653 CVS frontend. | |
| 654 | |
| 655 @item pcomplete | |
| 656 Provides programmatic completion. | |
| 657 | |
| 1030 | 658 @item perl-modes |
| 659 Perl language support. | |
| 660 | |
| 1648 | 661 @item pgg |
| 662 Emacs interface to various PGP implementations. | |
| 663 | |
| 540 | 664 @item prog-modes |
| 665 Miscellaneous single-file lisp files for various programming languages. | |
| 666 | |
| 947 | 667 @item ps-print |
| 668 Print buffers to PostScript printers. | |
| 540 | 669 |
| 670 @item psgml | |
| 671 Validated HTML/SGML editing. | |
| 672 | |
| 1030 | 673 @item psgml-dtds |
| 674 A collection of DTDs for psgml. Note that this package is deprecated | |
| 675 and will be removed in the future, most likely Q2/2003. Instead of using | |
| 676 this, you should install needed DTDs yourself. | |
| 677 | |
| 678 @item python-modes | |
| 679 Python language support. | |
| 680 | |
| 540 | 681 @item reftex |
| 682 Emacs support for LaTeX cross-references, citations. | |
| 683 | |
| 444 | 684 @item rmail |
| 685 An obsolete Emacs mailer. If you do not already use it don't start. | |
| 686 | |
| 1030 | 687 @item ruby-modes |
| 688 Ruby language support. | |
| 689 | |
| 955 | 690 @item sasl |
| 691 Simple Authentication and Security Layer (SASL) library. | |
| 692 | |
| 540 | 693 @item scheme |
| 694 Front-end support for Inferior Scheme. | |
| 695 | |
| 696 @item semantic | |
| 697 Semantic bovinator. | |
| 698 | |
| 699 @item sgml | |
| 700 SGML/Linuxdoc-SGML editing. | |
| 701 | |
| 702 @item sh-script | |
| 703 Support for editing shell scripts. | |
| 704 | |
| 947 | 705 @item sieve |
| 706 Manage Sieve email filtering scripts. | |
| 707 | |
| 540 | 708 @item slider |
| 709 User interface tool. | |
| 710 | |
| 955 | 711 @item sml-mode |
| 712 Standard ML editing support. | |
| 713 | |
| 540 | 714 @item sounds-au |
| 715 XEmacs Sun sound files. | |
| 716 | |
| 717 @item sounds-wav | |
| 718 XEmacs Microsoft sound files. | |
| 719 | |
| 720 @item speedbar | |
| 721 Provides a separate frame with convenient references. | |
| 722 | |
| 723 @item strokes | |
| 724 Mouse enhancement utility. | |
| 725 | |
| 444 | 726 @item supercite |
| 727 An Emacs citation tool. Useful with all Emacs Mailers and Newsreaders. | |
| 728 | |
| 540 | 729 @item texinfo |
| 730 XEmacs TeXinfo support. | |
| 731 | |
| 732 @item text-modes | |
| 733 Various single file lisp packages for editing text files. | |
| 734 | |
| 735 @item textools | |
| 736 Single-file TeX support. | |
| 737 | |
| 738 @item time | |
| 739 Display time & date on the modeline. | |
| 740 | |
| 444 | 741 @item tm |
| 458 | 742 Emacs MIME support. Not needed for Gnus >= 5.8.0 |
| 444 | 743 |
| 540 | 744 @item tooltalk |
| 745 Support for building with Tooltalk. | |
| 746 | |
| 747 @item tpu | |
| 748 DEC EDIT/TPU support. | |
| 749 | |
| 947 | 750 @item tramp |
| 751 Remote shell-based file editing. This is similar to EFS or Ange-FTP, | |
| 752 but works with rsh/ssh and rcp/scp. | |
| 753 | |
| 540 | 754 @item vc |
| 755 Version Control for Free systems. | |
| 756 | |
| 757 @item vc-cc | |
| 758 Version Control for ClearCase. This package will shortly be | |
| 759 replaced with clearcase.el | |
| 760 | |
| 761 @item vhdl | |
| 762 Support for VHDL. | |
| 763 | |
| 764 @item view-process | |
| 765 A Unix process browsing tool. | |
| 766 | |
| 767 @item viper | |
| 768 VI emulation support. | |
| 769 | |
| 444 | 770 @item vm |
| 771 An Emacs mailer. | |
| 772 | |
| 773 @item w3 | |
| 774 A Web browser. | |
| 458 | 775 |
| 1648 | 776 @item x-symbol |
| 777 Semi WYSIWYG for LaTeX, HTML, etc, using additional fonts. | |
| 778 | |
| 540 | 779 @item xemacs-base |
| 780 Fundamental XEmacs support. Install this unless you wish a totally | |
| 781 naked XEmacs. | |
| 782 | |
| 783 @item xemacs-devel | |
| 784 XEmacs Lisp developer support. This package contains utilities for | |
| 785 supporting Lisp development. It is a single-file package so it may be | |
| 786 tailored. | |
| 787 | |
| 947 | 788 @item xslide |
| 789 XSL editing support. | |
| 790 | |
| 540 | 791 @item xslt-process |
| 792 A minor mode for (X)Emacs which allows running an XSLT processor on a | |
| 793 buffer. | |
| 794 | |
| 458 | 795 @item zenirc |
| 796 ZENIRC IRC Client. | |
| 444 | 797 @end table |
| 798 | |
| 799 @subsection Mule Support (mule) | |
| 800 | |
| 458 | 801 MULti-lingual Enhancement. Support for world scripts such as |
| 802 Latin, Arabic, Cyrillic, Chinese, Japanese, Greek, Hebrew etc. | |
| 803 To use these packages your XEmacs must be compiled with Mule | |
| 804 support. | |
| 805 | |
| 444 | 806 @table @file |
| 458 | 807 @item edict |
| 808 Lisp Interface to EDICT, Kanji Dictionary. | |
| 809 | |
| 444 | 810 @item egg-its |
| 811 Wnn (4.2 and 6) support. SJ3 support. Must be installed prior to | |
| 812 XEmacs build. | |
| 813 | |
| 947 | 814 @item latin-unity |
| 815 Unify character sets in a buffer. When characters belong to disjoint | |
| 816 character sets, this attempts to translate the characters so | |
| 817 that they belong to one character set. If the buffer coding system is | |
| 818 not sufficient, this suggests different coding systems. | |
| 819 | |
| 444 | 820 @item leim |
| 821 Quail. Used for everything other than English and Japanese. | |
| 822 | |
| 823 @item locale | |
| 824 Used for localized menubars (French and Japanese) and localized splash | |
| 825 screens (Japanese). | |
| 826 | |
| 458 | 827 @item lookup |
| 828 Dictionary support. (This isn't an English dictionary program) | |
| 829 | |
| 444 | 830 @item mule-base |
| 831 Basic Mule support. Must be installed prior to building with Mule. | |
| 832 | |
| 947 | 833 @item mule-ucs |
| 834 Extended coding systems (including Unicode) for XEmacs. | |
| 835 | |
| 444 | 836 @item skk |
| 837 Another Japanese Language Input Method. Can be used without a | |
| 838 separate process running as a dictionary server. | |
| 839 @end table | |
| 840 |