diff README.packages @ 1648:712931b4b71d

[xemacs-hg @ 2003-08-27 18:06:54 by youngs] 2003-08-28 Steve Youngs <youngs@xemacs.org> * README.packages: Update. 2003-08-28 Steve Youngs <youngs@xemacs.org> * PACKAGES: Update. 2003-08-28 Steve Youngs <youngs@xemacs.org> * xemacs-faq.texi (Q2.0.2): Rewrite, mentioning the correct way to remove a package. (Q3.8.2): big-menubar is in the edit-utils package. (Q4.3.2): Add a comment about not needing TM for things like Gnus, MH-E and VM. (Q5.3.3): State correct location of ps-print.el. * xemacs/packages.texi (Packages): Remove "Creating Packages" menu entry. (Package Terminology): Whitespace clean up. (Installing Packages): Whitespace clean up and add some @code formatters. Re-organise the menu so that installation via PUI is first and Sumo is last. (Automatically): mule-base is no longer a requirement for using PUI. Mention optionally requiring mailcrypt. (Note): Removed. (Manually): Move to below the PUI installation method. (Sumo): Move to below the manual installation method. (Which Packages): Add mailcrypt. (Building Packages): Remove duplicated stuff that is in lispref/packaging.texi, xref to it instead. (Local.rules File): xref to the appropriate node in lispref/packaging.texi. (Available Packages): Update to current reality. (all): Removed. (srckit): Removed. (binkit): Removed. * xemacs/reading.texi (Reading Mail): Mention Gnus and MEW. * new-users-guide/custom2.texi (Init File): big-menubar.el is in the edit-utils package. * lispref/packaging.texi (Packaging): (The User View): (The Library Maintainer View): (Infrastructure): (Control Files): (Obtaining): (The Package Release Engineer View): (Package Terminology): (Building Packages): (Makefile Targets): (packages): New. (Local.rules File): (XEMACS_PACKAGES): Removed. (XEMACS_INSTALLED_PACKAGES_ROOT): New. (NONMULE_PACKAGES): New. (EXCLUDES): New. (Creating Packages): (BATCH): New. (VERSION): Removed. (AUTHOR_VERSION): Removed. (MAINTAINER): Removed. (PACKAGE): Removed. (PKG_TYPE): Removed. (REQUIRES): Removed. (CATEGORY): Removed. (ELS): Removed. (ELCS): Removed. (all): Removed. (srckit): Removed. (binkit): Removed. (are): New. (STANDARD_DOCS): New. (ELCS_1_DEST): New. (example): New. (PACKAGE_SUPPRESS): New. (EXPLICIT_DOCS): New. (DATA_DEST): New. (Documenting Packages): Not quite a total rewrite, but a fairly thorough audit nonetheless.
author youngs
date Wed, 27 Aug 2003 18:07:10 +0000
parents 6728e641994e
children ad56e5a6d09f
line wrap: on
line diff
--- a/README.packages	Wed Aug 27 17:18:26 2003 +0000
+++ b/README.packages	Wed Aug 27 18:07:10 2003 +0000
@@ -114,37 +114,69 @@
 -----------------------------
 There are a few different ways to install packages:
 
-	1. Manually, all at once, using the 'Sumo Tarball'.
+	1. Automatically, using the package tools from XEmacs.
 	2. Manually, using individual package tarballs.
-	3. Automatically, using the package tools from XEmacs.
+	3. Manually, all at once, using the 'Sumo Tarball'.
 
-** Manually, all at once, using the 'Sumo Tarball'
---------------------------------------------------
+** 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.
 
-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:
+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.
+   xemacs-base  - Needed by efs.
+
+and optionally:
 
-   xemacs-sumo.tar.gz
+   mailcrypt    - For PGP verification of the package-index file.
+
+After installing these by hand, fire up XEmacs and follow these
+steps.
 
-For an XEmacs compiled with Mule you also need:
+  (1) Choose a download site.
+      - via menu: Tools -> Packages -> Set Download Site 
+      - via keyb: M-x customize-variable RET package-get-remote RET
+        (put in the details of remote host and directory)
 
-   xemacs-mule-sumo.tar.gz
+      If the package tarballs _AND_ the package-index file are in a
+      local directory, you can: M-x pui-set-local-package-get-directory RET
 
-N.B. They are called 'Sumo Tarballs' for good reason. They are
-currently about 19MB and 4.5MB (gzipped) respectively.
+  (2) Obtain a list of packages and display the list in a buffer named
+      "*Packages*".
+      - menu: Tools -> Packages -> List & Install
+      - keyb: M-x pui-list-packages RET
 
-Install them by:
+      XEmacs will now connect to the remote site and download the
+      latest package-index file.
+
+      The resulting buffer, "*Packages*" has brief instructions at the
+      end of the buffer.
 
-   cd $prefix/lib/xemacs ; gunzip -c <tarballname> | tar xvf - RET
+  (3) Choose the packages you wish to install.
+      - mouse: Click button 2 on the package name.
+      -  keyb: RET on the package name
 
-Or, if you have GNU tar:
+  (4) Make sure you have everything you need.
+      - menu: Packages -> Add Required
+      - keyb: r
 
-   cd $prefix/lib/xemacs ; tar zxvf /path/to/<tarballname> RET
+      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.
 
-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.
+      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
 
 ** Manually, using individual package tarballs
 ----------------------------------------------
@@ -180,77 +212,38 @@
    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.
-
-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.
-   xemacs-base  - Needed by efs.
+** Manually, all at once, using the 'Sumo Tarball'
+--------------------------------------------------
 
-and optionally:
-
-   mule-base    - Needed if you want to use XEmacs with MULE.
-
-After installing these by hand, fire up XEmacs and follow these
-steps.
+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:
 
-Note: The menus in XEmacs 21.2.x and up have changed slightly, so
-where I mention "Options -> Manage Packages", substitute "Tools ->
-Packages".
+   xemacs-sumo.tar.gz
 
-  (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)
+For an XEmacs compiled with Mule you also need:
+
+   xemacs-mule-sumo.tar.gz
 
-      If the package tarballs _AND_ the package-index file are in a
-      local directory, you can: M-x pui-add-install-directory 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
+N.B. They are called 'Sumo Tarballs' for good reason. They are
+currently about 19MB and 4.5MB (gzipped) respectively.
 
-      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.
+Install them by:
 
-      The resulting buffer, "*Packages*" has brief instructions at the
-      end of the buffer.
+   cd $prefix/lib/xemacs ; gunzip -c <tarballname> | tar xvf - RET
 
-  (3) Choose the packages you wish to install.
-      - mouse: Click button 2 on the package name.
-      -  keyb: RET on the package name
+Or, if you have GNU tar:
 
-  (4) Make sure you have everything you need.
-      - menu: Packages -> Add Required
-      - keyb: r
+   cd $prefix/lib/xemacs ; tar zxvf /path/to/<tarballname> RET
 
-      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
+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.
 
 * After Installation
 --------------------
 
-New packages can only be used by XEmacs after a restart.
+Updated packages can only be used by XEmacs after a restart.
 
 * Which Packages to install?
 ----------------------------
@@ -261,7 +254,7 @@
 
 xemacs-base, xemacs-devel, c-support, cc-mode, debug, dired, efs,
 edit-utils, fsf-compat, mail-lib, net-utils, os-utils, prog-modes,
-text-modes, time
+text-modes, time, mailcrypt
 
 If you are using the XEmacs package tools, don't forget to do:
 
@@ -290,9 +283,9 @@
 --------------------------
 
 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"
+packages installed under "~/.xemacs/". If you want to install packages
+there using the interactive tools, you need to set
+'package-get-install-to-user-init-directory' to 't'
 
 * Site lisp/Site start
 ----------------------