File: foo,  Node: Using Packages,  Next: Building Packages,  Prev: Package Terminology,  Up: Packages

Getting Started
---------------

   When you first download XEmacs 21, you will usually first grab the
"core distribution", a file called `xemacs-21.0.tar.gz'. (Replace the
21.0 by the current version number.)  The core distribution contains
the sources of XEmacs and a minimal set of Emacs Lisp files, which are
in the subdirectory named `lisp'.  This subdirectory used to contain
all Emacs Lisp files distributed with XEmacs.  Now, to conserve disk
space, most non-essential packages were made optional.

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 subdirectory `packages/binary-packages'.  Package file names
follow the naming convention `<package-name>-<version>-pkg.tar.gz'.

   If you have EFS *Note (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 `etc/PACKAGES' in the core distribution contains a list of
the packages available at the time of the XEmacs release.  Packages are
also listed on the `Options' menu under:

     	Options->Customize->Emacs->Packages

   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).

   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:

     	Options->Customize->List Packages

   Or, you can get to it via the keyboard:

     M-x pui-list-packages

   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.

Installing packages and XEmacs
------------------------------

   Normally, packages are installed over the network, using EFS *Note
(EFS)::.  However, you may not have network access, or you may already
have some or all of the packages on a local disk, such as a CDROM.  If
you want to install from a local disk, you must first tell XEmacs where
to find the package binaries.  This is done by adding a line like the
following to your `.emacs' file:

     (setq package-get-remote (cons (list nil "/my/path/to/package/binaries")
                                    package-get-remote))

   Here, you'd change `"/my/path/to/package/binaries"' to be the path
to your local package binaries.  Next, restart XEmacs, and you're ready
to go (advanced users can just re-evaluate the sexp).

   If you're going to install over the network, you only have to insure
that EFS *Note (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.

   The easiest way to install a package is to use the visual package
browser and installer, using the menu pick:

     	Options->Customize->List Packages

   You can also access it using the keyboard:

     M-x pui-list-packages

   The visual package browser will then display a list of all packages.
Help information will be displayed at the very bottom of the buffer; you
may have to scroll down to see it.  You can also press `?' to get the
same help.  From this buffer, you can tell the package status by the
character in the first column:

`-'
     The package has not been installed.

`*'
     The package has been installed, but a newer version is available.
     The current version is out-of-date.

`+'
     The package has been marked for installation/update.

   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
the <RET> key, or using the `Mouse-2' or `Mouse-3' buttons.  Once
you've finished selecting the packages, you can press the `x' key to
actually install the packages.  Note that you will have to restart
XEmacs for XEmacs to recognize any new packages.

   Key summary:

`?'
     Display simple help.

`<RET>'
`<Mouse-2>'
`<Mouse-3>'
     Toggle between selecting and unselecting a package for
     installation.

`x'
     Install selected packages.

`<SPC>'
     View, in the minibuffer, additional information about the package,
     such as the package date (not the build date) and the package
     author.  Moving the mouse over a package name will also do the
     same thing.

`v'
     Toggle between verbose and non-verbose package display.

`g'
     Refresh the package display.

`q'
     Kill the package buffer.

   Moving the mouse over a package will also cause additional
information about the package to be displayed in the minibuffer.

Other package installation interfaces
-------------------------------------

   For an alternative package interface, you can select packages from
the customize menus, under:

     	Options->Customize->Emacs->Packages-> ...

   Set their state to on, and then do:

     	Options->Customize->Update Packages

   This will automatically retrieve the packages you have selected from
the XEmacs ftp site or your local disk, and install them into XEmacs.
Additionally it will update any packages you already have installed to
the newest version.  Note that if a package is newly installed you will
have to restart XEmacs for the change to take effect.

   You can also install packages manually, using:

     M-x package-get-all <return>

   Enter the name of the package (e.g., `prog-modes'), and XEmacs will
search for the latest version (as listed in the lisp file
`lisp/package-get-base.el'), and install it and any packages that it
depends upon.