XEmacs / README.packages

Diff from to

README.packages

+                                                            -*- Outline -*-
+This file is in Outline mode.  It is best viewed under XEmacs.
+
+Press C-c C-o (Ctrl+c Ctrl+o) now to see a list of headings.
+  To expand a heading:  Put the cursor on the heading and press C-c C-s
+To collapse a heading:  Press C-c C-d
+
+For general XEmacs navigation tips: Press C-h t
+
 The XEmacs Packages Quick Start Guide
 -------------------------------------
 
 and its packages from start.  For details see the 'Startup Paths' and
 'Packages' sections of the XEmacs info manual.
 
-Real Real Quickstart FAQ
-------------------------
+* Real Real Quickstart FAQ
+--------------------------
 
 Q. Do I need to have the packages to compile XEmacs?
 A. No, XEmacs will build and install just fine without any packages
    you.  You can either track it down and install it, or install the
    `Sumo Tarball' (see the second FAQ).
 
-A note of caution
------------------
+* A note of caution
+-------------------
 
 The XEmacs package system is still in its infancy. Please expect a few
 minor hurdles on the way. Also neither the interface nor the structure is
 backwards compatibility as quirks are worked out over the coming
 releases.
 
-Some Package Theory
--------------------
+* Some Package Theory
+---------------------
 
 In order to reduce the size and increase the maintainability of XEmacs,
 the majority of the Elisp packages that came with previous releases
 the right place. On startup XEmacs will find them, set up the load
 path correctly, install autoloads, etc, etc.
 
-Package hierarchies
--------------------
+* Package hierarchies
+---------------------
 
 On Startup XEmacs looks for packages in so called package hierarchies.
 These can be specified by the 'package-path' parameter to the
 'configure' script. However by default there are three system wide
-hierarchies.
-
-$prefix/lib/xemacs/site-packages
-     Local and 3rd party packages go here.
-
-$prefix/lib/xemacs/mule-packages
-     Only searched by MULE-enabled XEmacsen.
+hierarchies. ("$prefix" defaults to "/usr/local")
 
 $prefix/lib/xemacs/xemacs-packages
      Normal packages go here.
 
-Where to get the packages
--------------------------
+$prefix/lib/xemacs/mule-packages
+     Mule packages go here and are only searched by MULE-enabled XEmacsen.
+
+$prefix/lib/xemacs/site-packages/
+     Local and 3rd party packages go here.
+
+
+* Where to get the packages
+---------------------------
 
 Packages are available from ftp://ftp.xemacs.org/pub/xemacs/packages
 and its mirrors.
 
-How to install the packages
----------------------------
+* How to install the packages
+-----------------------------
+There are a few different ways to install packages:
 
-1. All at once, using the 'Sumo Tarball'.
-2. By hand.
-3. Automatically, using the package tools from XEmacs.
+	1. Manually, all at once, using the 'Sumo Tarball'.
+	2. Manually, using individual package tarballs.
+	3. Automatically, using the package tools from XEmacs.
 
-The Sumo Tarball
-----------------
+** Manually, all at once, using the 'Sumo Tarball'
+--------------------------------------------------
 
 Those with little time, cheap connections and plenty of disk space can
 install all the packages at once using the sumo tarballs.
-Download the file
+Download the file:
 
-xemacs-sumo.tar.gz
+   xemacs-sumo.tar.gz
 
-For an XEmacs compiled with Mule you also need
+For an XEmacs compiled with Mule you also need:
 
-xemacs-mule-sumo.tar.gz
+   xemacs-mule-sumo.tar.gz
 
 N.B. They are called 'Sumo Tarballs' for good reason. They are
-currently about 15MB and 2.3MB (gzipped) respectively.
+currently about 19MB and 4.5MB (gzipped) respectively.
 
-Install them by
+Install them by:
 
-cd $prefix/lib/xemacs ; gunzip -c <tarballname> | tar xf -
+   cd $prefix/lib/xemacs ; gunzip -c <tarballname> | tar xvf - RET
+
+Or, if you have GNU tar:
+
+   cd $prefix/lib/xemacs ; tar zxvf /path/to/<tarballname> RET
 
 As the Sumo tarballs are not regenerated as often as the individual
 packages, it is recommended that you use the automatic package tools
 afterwards to pick up any recent updates.
 
-Installing by Hand
-------------------
+** Manually, using individual package tarballs
+----------------------------------------------
 
-Fetch the packages from the ftp site, CDROM whatever. The filenames
+Fetch the packages from the FTP site, CD-ROM whatever. The filenames
 have the form name-<version>-pkg.tar.gz and are gzipped tar files. For
 a fresh install it is sufficient to untar the file at the top of the
-package hierarchy. For example if we are installing the 'xemacs-base'
-package in version 1.27:
+package hierarchy. 
 
-mkdir $prefix/lib/xemacs/xemacs-packages # if it does not exist yet
-cd $prefix/lib/xemacs/xemacs-packages
-gunzip -c ...../xemacs-base-1.27-pkg.tar.gz | tar xf -
+Note: If you are upgrading packages already installed, it's best to
+remove the old package first (see 'Upgrading/Removing Packages' below).
 
-For MULE related packages, it is best to untar in the mule-packages
-hierarchy, i.e. for the mule-base package, version 1.25
+For example if we are installing the 'xemacs-base'
+package (version 1.48):
 
-mkdir $prefix/lib/xemacs/mule-packages # if it does not exist yet
-cd $prefix/lib/xemacs/mule-packages
-gunzip -c ...../mule-base-1.25-pkg.tar.gz | tar xf -
+   mkdir $prefix/lib/xemacs/xemacs-packages RET # if it does not exist yet
+   cd $prefix/lib/xemacs/xemacs-packages RET
+   gunzip -c /path/to/xemacs-base-1.48-pkg.tar.gz | tar xvf - RET
 
-Installing automatically
-------------------------
+Or if you have GNU tar, the last step can be:
+
+   tar zxvf /path/to/xemacs-base-1.48-pkg.tar.gz RET
+
+For MULE related packages, it is best to untar into the mule-packages
+hierarchy, i.e. for the mule-base package, version 1.37:
+
+   mkdir $prefix/lib/xemacs/mule-packages RET # if it does not exist yet
+   cd $prefix/lib/xemacs/mule-packages RET
+   gunzip -c /path/to/mule-base-1.37-pkg.tar.gz | tar xvf - RET
+
+Or if you have GNU tar, the last step can be:
+
+   tar zxvf /path/to/mule-base-1.37-pkg.tar.gz RET
+
+
+** Automatically, using the package tools from XEmacs
+-----------------------------------------------------
 
 XEmacs comes with some tools to make the periodic updating and
 installing easier. It will notice if new packages or versions are
-available and will fetch them from the ftp site.
+available and will fetch them from the FTP site.
 
 Unfortunately this requires that a few packages are already in place.
 You will have to install them by hand as above or use a SUMO tarball.
 This requirement will hopefully go away in the future. The packages
 you need are:
 
-   efs          - To fetch the files from the ftp site or mirrors.
+   efs          - To fetch the files from the FTP site or mirrors.
    xemacs-base  - Needed by efs.
 
 and optionally:
 
-   mailcrypt    - If you have PGP installed and want to verify the
-                  signature of the index file.
    mule-base    - Needed if you want to use XEmacs with MULE.
 
-After installing these by hand, you can start XEmacs. (It is a good
-idea to use 'xemacs -vanilla' here as your startup files might need
-things now moved to packages.)
+After installing these by hand, fire up XEmacs and follow these
+steps.
 
- - First you need to specify an FTP site to use.
-      Use Options->Manage Packages->Add Download Site
-       or M-x customize-variable RET package-get-remote RET
+Note: The menus in XEmacs 21.2.x and up have changed slightly, so
+where I mention "Options -> Manage Packages", substitute "Tools ->
+Packages".
 
-   Alternatively, if you already have the packages on a local disk
-   then you can specify this directly using 'M-x
-   pui-add-install-directory'. Please make sure you also have a
-   corresponding copy of the package index there.
+  (1) Choose a download site.
+      - via menu: Options -> Manages Packages -> Add Download Site 
+      - via keyb: M-x customize-variable RET package-get-remote RET
+        (put in the details of remote host and directory)
 
- - Invoke Options->Manage Packages->List & Install
-      or M-x pui-list-packages RET
-   XEmacs will now first try to fetch a new version of the package
-   index from the FTP site. Depending on whether you are using
-   'mailcrypt/PGP', you will get some question about keys to fetch or
-   whether to use the index without verifying the signature. If the
-   new index was different from the one already on disk, XEmacs will
-   offer you to overwrite the old index.
+      If the package tarballs _AND_ the package-index file are in a
+      local directory, you can: M-x pui-add-install-directory RET
 
--  XEmacs will show you a buffer named "*Packages*" with an overview
-   of available and installed packages, including a short description.
-   In this buffer you can select which packages you want using the
-   mouse or using RET.
+  (2) Obtain a list of packages and display the list in a buffer named
+      "*Packages*".
+      - menu: Options -> Manage Packages -> List & Install
+      - keyb: M-x pui-list-packages RET
 
--  When you are finished choosing packages, invoke
-   'Packages->Install/Remove Select' from the menu or type 'x' to
-   begin installing packages.
+      XEmacs will now connect to the remote site and download the
+      latest package-index file.  If you see an error about the
+      package-index entries not being PGP signed, you can safely
+      ignore this because PGP has not been integrated into the XEmacs
+      package tools yet.
 
-After Installation
-------------------
+      The resulting buffer, "*Packages*" has brief instructions at the
+      end of the buffer.
+
+  (3) Choose the packages you wish to install.
+      - mouse: Click button 2 on the package name.
+      -  keyb: RET on the package name
+
+  (4) Make sure you have everything you need.
+      - menu: Packages -> Add Required
+      - keyb: r
+
+      XEmacs will now search for packages that are required by the
+      ones that you have chosen to install and offer to select
+      those packages also.
+
+      For novices and gurus alike, this step can save your bacon.
+      It's easy to forget to install a critical package.
+
+  (5) Download and install the packages.
+      - menu: Packages -> Install/Remove Selected
+      - keyb: x
+
+* After Installation
+--------------------
 
 New packages can only be used by XEmacs after a restart.
 
-Note to MULE users
-------------------
-
-Unlike all other packages the mule-base package is used at build/dump
-time. This means that you need this available before compiling XEmacs
-with MULE. Also it is a good idea to keep packages that are
-MULE-only separate by putting them in the mule-packages hierarchy.
-
-Which Packages to install?
---------------------------
+* Which Packages to install?
+----------------------------
 
 This is difficult to say. When in doubt install a package. If you
 administrate a big site it might be a good idea to just install
 edit-utils, fsf-compat, mail-lib, net-utils, os-utils, prog-modes,
 text-modes, time
 
-Unfortunately the package system currently provides neither
-dependencies nor conflicts. This will be a future enhancement. The
-above set includes most packages that are used by others.
+If you are using the XEmacs package tools, don't forget to do:
+
+	Packages -> Add Required
+
+To make sure you have everything that the packages you have chosen to
+install need.
 
 See also '.../etc/PACKAGES' for further descriptions of the individual
-packages (currently outdated).
+packages.
 
-Upgrading/Removing Packages
----------------------------
+* Upgrading/Removing Packages
+-----------------------------
 
 As the exact files and their locations contained in a package may
 change it is recommended to remove a package first before installing a
 Note that the interactive package tools included with XEmacs already do
 this for you.
 
-User Package directories
-------------------------
+* User Package directories
+--------------------------
 
 In addition to the system wide packages, each user can have his own
 packages installed in "~/.xemacs/xemacs-packages". If you want to
 install packages there using the interactive tools, you need to set
 'pui-package-install-dest-dir' to "~/.xemacs/xemacs-packages"
 
-Site lisp/Site start
---------------------
+* Site lisp/Site start
+----------------------
 
 The site-packages hierarchy replaces the old 'site-lisp' directory.
 XEmacs no longer looks into a 'site-lisp' directly by default.
 A good place to put 'site-start.el' would be in
 $prefix/lib/xemacs/site-packages/lisp/
 
-Finding the right packages
---------------------------
+* Finding the right packages
+----------------------------
 
 If you want to find out which package contains the functionality you
 are looking for, use M-x package-get-package-provider, and give it a
-symbol that is likely to be in that package.  For example, if some
-code you want to use has a (require 'thingatpt) in it, try doing
-M-x package-get-package-provider RET thingatpt , which will return
-something like: (fsf-compat "1.06").
+symbol that is likely to be in that package.  
+
+For example, if some code you want to use has a (require 'thingatpt)
+in it:
+
+	M-x package-get-package-provider RET thingatpt RET
+
+which will return something like: (fsf-compat "1.08").
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.