XEmacs 21.2.20 "Yoko".
[chise/xemacs-chise.git.1] / man / xemacs / packages.texi
index 3066210..b147f9a 100644 (file)
@@ -6,8 +6,8 @@
 
 The XEmacs 21 distribution comes only with a very basic set of
 built-in modes and packages.  Most of the packages that were part of
 
 The XEmacs 21 distribution comes only with a very basic set of
 built-in modes and packages.  Most of the packages that were part of
-the distribution of earlier versions of XEmacs are now separately
-available.  The installer as well as the user can choose which
+the distribution of earlier versions of XEmacs are now available
+separately.  The installer as well as the user can choose which
 packages to install; the actual installation process is easy.
 This gives an installer the ability to tailor an XEmacs installation for
 local needs with safe removal of unnecessary code.
 packages to install; the actual installation process is easy.
 This gives an installer the ability to tailor an XEmacs installation for
 local needs with safe removal of unnecessary code.
@@ -35,13 +35,13 @@ may not in general safely remove any of them.
 @cindex single-file packages
 A single-file package is an aggregate collection of thematically
 related but otherwise independent lisp files.  These files are bundled 
 @cindex single-file packages
 A single-file package is an aggregate collection of thematically
 related but otherwise independent lisp files.  These files are bundled 
-together for download convenience and individual files may deleted at
+together for download convenience and individual files may be deleted at
 will without any loss of functionality.
 @end itemize
 
 @subsection Package Distributions
 
 will without any loss of functionality.
 @end itemize
 
 @subsection Package Distributions
 
-XEmacs Lisp packages are distributed in two ways depending on the
+XEmacs Lisp packages are distributed in two ways, depending on the
 intended use.  Binary Packages are for installers and end-users and may
 be installed directly into an XEmacs package directory.  Source Packages
 are for developers and include all files necessary for rebuilding
 intended use.  Binary Packages are for installers and end-users and may
 be installed directly into an XEmacs package directory.  Source Packages
 are for developers and include all files necessary for rebuilding
@@ -56,7 +56,7 @@ hierarchy.
 @cindex source packages
 Source packages contain all of the Package author's (where appropriate
 in regular packages) source code plus all of the files necessary to
 @cindex source packages
 Source packages contain all of the Package author's (where appropriate
 in regular packages) source code plus all of the files necessary to
-build distribution tarballs (Unix Tar format files and gzipped for space
+build distribution tarballs (Unix Tar format files, gzipped for space
 savings).
 
 @node Using Packages, Building Packages, Package Terminology, Packages
 savings).
 
 @node Using Packages, Building Packages, Package Terminology, Packages
@@ -78,7 +78,7 @@ non-essential packages were made optional.
 @subsection Choosing the Packages You Need
 
 The available packages can currently be found in the same ftp directory
 @subsection Choosing the Packages You Need
 
 The available packages can currently be found in the same ftp directory
-where you grabbed the core distribition from, and are located in the
+where you grabbed the core distribution from, and are located in the
 subdirectory @file{packages/binary-packages}.  Package file names follow
 the naming convention @file{<package-name>-<version>-pkg.tar.gz}.
 
 subdirectory @file{packages/binary-packages}.  Package file names follow
 the naming convention @file{<package-name>-<version>-pkg.tar.gz}.
 
@@ -103,7 +103,7 @@ are installed, using the visual package browser and installer.  You can
 access it via the menus:
 
 @example
 access it via the menus:
 
 @example
-       Options->Customize->List Packages
+       Options->Manage Packages->List & Install
 @end example
 
 Or, you can get to it via the keyboard:
 @end example
 
 Or, you can get to it via the keyboard:
@@ -116,6 +116,17 @@ Hint to system administrators of multi-user systems: it might be a good
 idea to install all packages and not interfere with the wishes of your
 users.
 
 idea to install all packages and not interfere with the wishes of your
 users.
 
+If you can't find which package provides the feature you require, try
+using the @code{package-get-package-provider} function. Eg., if you know 
+that you need @code{thingatpt}, type:
+
+@example
+M-x package-get-package-provider RET thingatpt
+@end example
+
+which will return something like (fsf-compat "1.06"). You can the use
+one of the methods above for installing the package you want.
+
 @subsection XEmacs and Installing Packages
 
 Normally, packages are installed over the network, using EFS
 @subsection XEmacs and Installing Packages
 
 Normally, packages are installed over the network, using EFS
@@ -147,13 +158,18 @@ saved; this information will be lost when you quit XEmacs.
 If you're going to install over the network, you only have to insure
 that EFS @ref{(EFS)} works, and that it can get outside a firewall, if
 you happen to be behind one.  You shouldn't have to do anything else;
 If you're going to install over the network, you only have to insure
 that EFS @ref{(EFS)} works, and that it can get outside a firewall, if
 you happen to be behind one.  You shouldn't have to do anything else;
-XEmacs already knows where to go.
+XEmacs already knows where to go. However you can add your own mirrors
+to this list. See @code{package-get-remote}.
 
 The easiest way to install a package is to use the visual package
 browser and installer, using the menu pick:
 
 @example
 
 The easiest way to install a package is to use the visual package
 browser and installer, using the menu pick:
 
 @example
-       Options->Customize->List Packages
+       Options->Manage Packages->List & Install
+@end example
+or
+@example
+       Options->Manage Packages->Using Custom->Select-> ...
 @end example
 
 You can also access it using the keyboard:
 @end example
 
 You can also access it using the keyboard:
@@ -182,10 +198,12 @@ If there is no character in the first column, the package has been
 installed and is up-to-date.
 
 From here, you can select or unselect packages for installation using
 installed and is up-to-date.
 
 From here, you can select or unselect packages for installation using
-the @key{RET} key, or using the @kbd{Mouse-2} or @kbd{Mouse-3} buttons.
-Once you've finished selecting the packages, you can press the @kbd{x}
-key to actually install the packages.  Note that you will have to
-restart XEmacs for XEmacs to recognize any new packages.
+the @key{RET} key, the @kbd{Mouse-2} button or selecting "Select" from
+the (Popup) Menu.
+Once you've finished selecting the packages, you can
+press the @kbd{x} key (or use the menu) to actually install the
+packages. Note that you will have to restart XEmacs for XEmacs to
+recognize any new packages.
 
 Key summary:
 
 
 Key summary:
 
@@ -194,7 +212,6 @@ Key summary:
 Display simple help.
 @item @key{RET}
 @itemx @key{Mouse-2}
 Display simple help.
 @item @key{RET}
 @itemx @key{Mouse-2}
-@itemx @key{Mouse-3}
 Toggle between selecting and unselecting a package for installation.
 @item x
 Install selected packages.
 Toggle between selecting and unselecting a package for installation.
 @item x
 Install selected packages.
@@ -221,11 +238,15 @@ customize menus, under:
 @example
        Options->Customize->Emacs->Packages-> ...
 @end example
 @example
        Options->Customize->Emacs->Packages-> ...
 @end example
+or
+@example
+       Options->Manage Packages->Using Custom->Select-> ...
+@end example
 
 Set their state to on, and then do:
 
 @example
 
 Set their state to on, and then do:
 
 @example
-       Options->Customize->Update Packages
+       Options->Manage Packages->Using Custom->Update Packages
 @end example
 
 This will automatically retrieve the packages you have selected from the
 @end example
 
 This will automatically retrieve the packages you have selected from the
@@ -248,13 +269,18 @@ it depends upon.
 @subsection Manual Binary Package Installation
 
 Pre-compiled, binary packages can be installed in either a system
 @subsection Manual Binary Package Installation
 
 Pre-compiled, binary packages can be installed in either a system
-package directory (this is determined when XEmacs is compiled), or in a
-subdirectory off your @file{$HOME} directory:
+package directory (this is determined when XEmacs is compiled), or in
+one of the following
+subdirectories of your @file{$HOME} directory:
 
 @example
 
 @example
-~/.xemacs/packages
+~/.xemacs/mule-packages
+~/.xemacs/xemacs-packages
 @end example
 
 @end example
 
+Packages in the former directory will only be found by a Mule-enabled
+XEmacs.
+
 XEmacs does not have to be running to install binary packages, although
 XEmacs will not know about any newly-installed packages until you
 restart XEmacs.  Note, however, that installing a newer version of a
 XEmacs does not have to be running to install binary packages, although
 XEmacs will not know about any newly-installed packages until you
 restart XEmacs.  Note, however, that installing a newer version of a
@@ -269,11 +295,13 @@ Download the package(s) that you want to install.  Each binary package
 will typically be a gzip'd tarball.
 
 @item
 will typically be a gzip'd tarball.
 
 @item
-Decide where to install the packages: in the system package directory,
-or in @file{~/.xemacs/packages}.  If you want to install the
-packages in the system package directory, make sure you can write into
-that directory.  If you want to install in your @file{$HOME} directory,
-create the directory, @file{~/.xemacs/packages}.
+Decide where to install the packages: in the system package
+directory, or in @file{~/.xemacs/mule-packages} or
+@file{~/.xemacs/xemacs-packages}, respectively.  If you want to install
+the packages in the system package directory, make sure you can write
+into that directory.  If you want to install in your @file{$HOME}
+directory, create the directory, @file{~/.xemacs/mule-packages} or
+@file{~/.xemacs/xemacs-packages}, respectively.
 
 @item
 Next, @code{cd} to the directory under which you want to install the
 
 @item
 Next, @code{cd} to the directory under which you want to install the