Commit 4441d1da authored by adriana's avatar adriana

Import with [PATCH sourceforge] Initial HTML fixes, new PSGML site validation...

Import with [PATCH sourceforge] Initial HTML fixes, new PSGML site validation <uya31ubq5.fsf@ecf.teradyne.com>

--HG--
branch : adriana
parent 4d8b0d894faf
%title%
Documentation
%author%
john s jacobs anderson, using old content with no listed author
%main%
<h1>XEmacs Documentation</h1>
<p> The following documents are available in Postscript, DVI
and PDF (with permuted indices) formats for both US Letter and
A4 sized paper:
<table>
<tr>
<td>Programming in Emacs Lisp, an Introduction (emacs-lisp-intro)</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/letter/emacs-lisp-intro-letter.pdf.gz">
[Letter]</a>
</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/a4/emacs-lisp-intro-a4.pdf.gz">
[A4]</a>
</td>
</tr>
<tr>
<td>XEmacs Internals Manual (internals)</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/letter/internals-letter.pdf.gz">
[Letter]</a>
</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/a4/internals-a4.pdf.gz">
[A4]</a>
</td>
</tr>
<tr>
<td>XEmacs Lisp Reference Manual (lispref)</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/letter/lispref-letter.pdf.gz">
[Letter]</a>
</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/a4/lispref-a4.pdf.gz">
[A4]</a>
</td>
</tr>
<tr>
<td>Getting Started With XEmacs (new-users-guide)</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/letter/new-users-guide-letter.pdf.gz">
[Letter]</a>
</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/a4/new-users-guide-a4.pdf.gz">
[A4]</a>
</td>
</tr>
<tr>
<td>XEmacs Users Manual (xemacs)</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/letter/xemacs-letter.pdf.gz">
[Letter]</a>
</td>
<td><a href="ftp://ftp.xemacs.org/pub/xemacs/docs/a4/xemacs-a4.pdf.gz">
[A4]</a>
</td>
</tr>
</table>
<p> If you would like other formats than PDF for download, please
download them directly from
<a href="ftp://ftp.xemacs.org/pub/xemacs/docs/">&lt;ftp://ftp.xemacs.org/pub/xemacs/docs/&gt;</a>.
<h3>Additional documentation</h3>
<p>More recent material can be found in the <a href="FAQ/">FAQ</a>
or the <a href="News/">NEWS</a> files. The following might also be useful:
<ul>
<li><a href="http://www.emacs.org/FAQ/faq_toc.html">FSF/GNU Emacs FAQ</a>
<li><a href="http://www.ccs.neu.edu/software/contrib/gnus/">Gnus FAQ</a>
<li><a href="http://www.wonderworks.com/vm/FAQ.html">VM FAQ</a>
</ul>
<br><br>
%title%
Quickstart Package Guide
%author%
john s jacobs anderson using old content with no listed author
%main%
<h1>Quickstart Package Guide</h1>
<p> This text is intended to help you get started installing a
new XEmacs and its packages from start. For details see the
<b>'Startup Paths'</b> and <b>'Packages'</b> sections of the
XEmacs info manual.
<h2>Index</h2>
<table border="0" cellspacing="0" cellpadding="0">
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#realQuick">Real quick quickstart guide</a>
</td>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#A note of caution">A note of caution</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#Some Package Theory">Some Package Theory</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#Package hierarchies">Package hierarchies</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#Where to get the packages">
Where to get the packages</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#How to install the packages">
How to install the packages</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#The Sumo Tarball">The Sumo Tarball</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#Installing by Hand">Installing by Hand</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#Installing automatically">
Installing automatically</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#After Installation">After Installation</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#Note to MULE users">Note to MULE users</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#Which Packages to install?">
Which Packages to install?</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#Upgrading/Removing Package">
Upgrading/Removing Packages</a>
</td>
</tr>
<tr><td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#User Package directories">
User Package directories</a>
</td>
</tr>
<tr>
<td><img src="Images/blank.png" height="1" width="40"></td>
<td>
<a href="Documentation/packageGuide.html#Site lisp/Site start">
Site lisp/Site start</a>
</td>
</tr>
</table>
<a name="realQuick">
<h2>Real Real Quickstart FAQ</h2></a>
<p><b>Q:</b> Do I need to have the packages to compile
XEmacs?
<br>
<b>A:</b> No.
<p><b>Q:</b> I really liked the old way that packages were
bundled and do not want to mess with packages at
all.
<br>
<b>A:</b> You can grab all the packages at once like you
used to with old XEmacs versions, skip to the
<a href="Documentation/packageGuide.html#The Sumo Tarball">'Sumo Tarball'</a>
section below.
<a name="A note of caution">
<h2>A note of caution</h2></a>
<p>
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
set in stone. The XEmacs maintainers reserve the
right to sacrifice backwards compatibility as quirks
are worked out over the coming releases.
<a name="Some Package Theory">
<h2>Some Package Theory</h2></a>
<p>
In order to reduce the size and increase the
maintainability of XEmacs, the majority of the Elisp
that came with previous releases have been
unbundled. They have been replaced by the package
system. Each elisp add-on (or groups of them when
they are small) now comes in its own tarball that
contains a small search hierarchy.
<p>
You select just the ones you need. Install them by
untarring them into the right place. On startup
XEmacs will find them, set up the load path
correctly, install autoloads, etc, etc.
<a name="Package hierarchies">
<h2>Package hierarchies</h2></a>
<p>
On startup XEmacs looks for packages in so called
package hierarchies. These can be specified by the
<code>package-path</code> parameter to the
<code>configure</code> script. However by default there are
three system wide hierarchies.
<p>Local and 3rd party packages go here:
<code>$prefix/lib/xemacs/site-packages</code><br>
Only searched by MULE-enabled XEmacsen:
<code>$prefix/lib/xemacs/mule-packages</code><br>
Normal packages go here:
<code>$prefix/lib/xemacs/xemacs-packages</code>
<a name="Where to get the packages">
<h2>Where to get the packages</h2></a>
<p>Packages are available from
<a href="ftp://ftp.xemacs.org/pub/xemacs/packages">ftp://ftp.xemacs.org/pub/xemacs/packages</a>
and its mirrors. Some package descriptions and links to other
resources can be found on the
<a href="Download/elispPackages.html">Elisp Packages</a> page.
<a name="How to install the packages">
<h2>How to install the packages</h2></a>
<p>Choose one of the following options:
<ol>
<li>All at once, using the
<a href="Documentation/packageGuide.html#The Sumo Tarball">'Sumo Tarball'</a>.
<li><a href="Documentation/packageGuide.html#Installing by Hand">By hand</a>
<li><a href="Documentation/packageGuide.html#Installing automatically">Automatically</a>,
using the package tools from XEmacs.
</ol>
<a name="The Sumo Tarball">
<h2>The Sumo Tarball</h2></a>
<p>Those with little time, cheap connections and plenty of disk space
can install all packages at once using the sumo tarballs. Download
the file
<code>xemacs-sumo-&lt;date&gt;.tar.gz</code>
from the <a href="ftp://ftp.xemacs.org/pub/xemacs/packages">ftp site</a>
<p>For an XEmacs compiled with Mule you also need
<code>xemacs-mule-sumo-&lt;date&gt;.tar.gz</code>
<p><em>Note:</em> They are called
<a href="Documentation/packageGuide.html#The Sumo Tarball">'Sumo Tarballs'</a> for good
reason. They are currently about 15MB and 2.3MB
(gzipped) respectively.
<p>
Install them by
</p>
<code>
cd $prefix/lib/xemacs ; gunzip -c <tarballname> | tar xf -
</code>
<p>As the Sumo tarballs are not regenerated as often as the individual
packages, it is recommended that you use the
<a href="Documentation/packageGuide.html#Installing automatically">automatic package tools</a>
afterwards to pick up any recent updates.
<a name="Installing by Hand">
<h2>Installing by Hand</h2></a>
<p>Fetch the packages from the <a href="ftp://ftp.xemacs.org/pub/xemacs/packages">ftp site</a>,
CDROM whatever. The filenames
have the form <code>name-&lt;version&gt;-pkg.tar.gz</code> 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
<code>'xemacs-base'</code> package in version 1.27:
<br><br><code>
mkdir $prefix/lib/xemacs/xemacs-packages \ # if it does not exist yet<br>
cd $prefix/lib/xemacs/xemacs-packages<br>
gunzip -c ...../xemacs-base-1.27-pkg.tar.gz | tar xf -<br>
</code>
<p> For MULE related packages, it is best to untar in the
mule-packages hierarchy, i.e. for the mule-base package, version 1.25
<br><br><code>
mkdir $prefix/lib/xemacs/mule-packages # if it does not exist yet<br>
cd $prefix/lib/xemacs/mule-packages<br>
gunzip -c ...../mule-base-1.25-pkg.tar.gz | tar xf -<br>
</code>
<a name="Installing automatically">
<h2>Installing automatically</h2></a>
<p> 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.
<p> 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:
<table>
<tr>
<td align="right"><b>efs</b></td>
<td>To fetch the files from the ftp site or mirrors.</td>
</tr>
<tr>
<td align="right"><b>xemacs-base</b></td>
<td>Needed by efs.</td>
</tr>
<tr>
<td align="right" valign="top"><b>mailcrypt</b><br>(optional)</td>
<td valign="top">
If you have PGP installed and want to verify the
signature of the index file.
</td>
</tr>
<tr>
<td align="right" valign="top"><b>mule-base</b><br>(optional)</td>
<td valign="top">
Needed if you want to run XEmacs with MULE with
a non-English language environment.
</td>
</tr>
</table>
<p> 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.)
<ul>
<li>First you need to specify an FTP site to use. Use
<b>Options-&gt;Manage Packages-&gt;Add Download Site</b> in the
menubar or type <code>M-x customize-variable RET
package-get-remote RET</code>
<br>
Alternatively, if you already have the packages on a local disk
then you can specify this directly by typing <code>M-x
pui-add-install-directory</code>. Please make sure you also have
a corresponding copy of the package
index there.
<li>Invoke <b> Options-&gt;Manage Packages-&gt;List &amp; Install
</b> from the menubar or type <code>M-x pui-list-packages
RET</code>. XEmacs will now first try to fetch a new version of
the package index from the FTP site. Depending on whether you
are using <b>mailcrypt/PGP</b>, 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.
<li>XEmacs will show you a buffer named <code>*Packages*</code> with
an overview of available and installed packages, including a
short description. In this buffer you can select which packages
you want by using the mouse or typing <code>RET</code>.
<li>When you are finished choosing packages, invoke
<b>'Packages->Install/Remove Select'</b> from the menubar or
type <code>x</code> to begin installing packages.
</ul>
<a name="After Installation">
<h2>After Installation</h2></a>
<p> New packages can only be used by XEmacs after a restart.
<a name="Note to MULE users">
<h2>Note to MULE users</h2></a>
<p> It is a good idea to keep packages that are MULE-only separate by
putting them in the mule-packages hierarchy. Non-Mule XEmacsen will
ignore packages in mule-packages so it is safe to have that directory
in the package path of a Non-Mule XEmacs.
<a name="Which Packages to install?">
<h2>Which Packages to install?</h2></a>
<p> 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
everything. A good minimal set of packages for XEmacs-latin1 would be
<blockquote><code> 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</code></blockquote>
<p>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.
<p>See also <code>.../etc/PACKAGES'</code> for further descriptions of
the individual packages (currently outdated).
<a name="Upgrading/Removing Package">
<h2>Upgrading/Removing Packages</h2></a>
<p> As the exact files and their locations contained in a package may
change it is recommend to remove a package first before installing a
new version. In order to facilitate removal each package contains an
<code>pgkinfo/MANIFEST.pkgname</code> file which list all the files
belong to the package. The command <code>M-x
package-admin-delete-binary-package RET</code> can be used to remove a
package using this file.
<p> Note that the interactive package tools included with XEmacs
already do this for you.
<a name="User Package directories">
<h2>User Package directories</h2></a>
<p> In addition to the system wide packages, each user can have his
own packages installed in <code>~/.xemacs</code> (Note that this will
most likely change to <code>~/.xemacs/packages</code> in the near
future). If you want to install packages there using the interactive
tools, you need to set the variable
<code>'pui-package-install-dest-dir'</code> to <code>~/.xemacs</code>
<a name="Site lisp/Site start">
<h2>Site lisp/Site start</h2></a>
<p> The site-packages hierarchy replaces the old
<code>site-lisp</code> directory. XEmacs no longer looks into a
<code>site-lisp</code> directly by default. A good place to put
<code>site-start.el</code> would be in
<code>$prefix/lib/xemacs/site-packages/lisp/</code>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment