|
456
|
1 -*- Outline -*-
|
|
|
2 This file is in Outline mode. It is best viewed under XEmacs.
|
|
|
3
|
|
|
4 Press C-c C-o (Ctrl+c Ctrl+o) now to see a list of headings.
|
|
|
5 To expand a heading: Put the cursor on the heading and press C-c C-s
|
|
|
6 To collapse a heading: Press C-c C-d
|
|
|
7
|
|
|
8 For general XEmacs navigation tips: Press C-h t
|
|
|
9
|
|
331
|
10 The XEmacs Packages Quick Start Guide
|
|
|
11 -------------------------------------
|
|
|
12
|
|
826
|
13 This text is intended to help you get started installing a new XEmacs and
|
|
|
14 its packages. For more details see the 'Startup Paths' and 'Packages'
|
|
|
15 sections of the XEmacs info manual.
|
|
331
|
16
|
|
456
|
17 * Real Real Quickstart FAQ
|
|
|
18 --------------------------
|
|
331
|
19
|
|
|
20 Q. Do I need to have the packages to compile XEmacs?
|
|
826
|
21
|
|
|
22 A. Theoretically, no -- XEmacs will build and install just fine without any
|
|
|
23 packages installed. However, only the most basic editing functions will
|
|
|
24 be available with no packages installed, so installing packages is an
|
|
438
|
25 essential part of making your installed XEmacs _useful_.
|
|
331
|
26
|
|
|
27 Q. I really liked the old way that packages were bundled and do not
|
|
|
28 want to mess with packages at all.
|
|
826
|
29
|
|
331
|
30 A. You can grab all the packages at once like you used to with old
|
|
|
31 XEmacs versions, skip to the 'Sumo Tarball' section below.
|
|
|
32
|
|
826
|
33 Q. How do I tell XEmacs where to find the packages?
|
|
|
34
|
|
|
35 A. Normally, you put the packages under $prefix/lib/packages, where
|
|
|
36 $prefix is specified using the `--prefix' parameter to `configure'.
|
|
|
37 (See `Package hierarchies' below). However, if you have the packages
|
|
|
38 somewhere else (e.g. you're a developer and are compiling the packages
|
|
|
39 yourself, and want your own private copy of everything), use the
|
|
|
40 `--package-path' parameter, something like this:
|
|
|
41
|
|
|
42 configure --package-path="~/.xemacs::/src/xemacs/site-packages:/src/xemacs/xemacs-packages:/src/xemacs/mule-packages" ...
|
|
|
43
|
|
444
|
44 Q. After installing, I want XEmacs to do `foo', but when I invoke it
|
|
|
45 (or click the toolbar button or select the menu item), nothing (or
|
|
|
46 an error) happens, and it used to work.
|
|
826
|
47
|
|
444
|
48 A. See the first FAQ; you may be missing a package that is essential to
|
|
|
49 you. You can either track it down and install it, or install the
|
|
|
50 `Sumo Tarball' (see the second FAQ).
|
|
|
51
|
|
456
|
52 * A note of caution
|
|
|
53 -------------------
|
|
331
|
54
|
|
438
|
55 The XEmacs package system is still in its infancy. Please expect a few
|
|
|
56 minor hurdles on the way. Also neither the interface nor the structure is
|
|
331
|
57 set in stone. The XEmacs maintainers reserve the right to sacrifice
|
|
|
58 backwards compatibility as quirks are worked out over the coming
|
|
438
|
59 releases.
|
|
331
|
60
|
|
826
|
61 * Some package theory
|
|
456
|
62 ---------------------
|
|
331
|
63
|
|
|
64 In order to reduce the size and increase the maintainability of XEmacs,
|
|
|
65 the majority of the Elisp packages that came with previous releases
|
|
|
66 have been unbundled. They have been replaced by the package system.
|
|
|
67 Each elisp add-on (or groups of them when they are small) now comes
|
|
|
68 in its own tarball that contains a small search hierarchy.
|
|
|
69
|
|
438
|
70 You select just the ones you need. Install them by untarring them into
|
|
331
|
71 the right place. On startup XEmacs will find them, set up the load
|
|
|
72 path correctly, install autoloads, etc, etc.
|
|
|
73
|
|
456
|
74 * Package hierarchies
|
|
|
75 ---------------------
|
|
331
|
76
|
|
826
|
77 On Startup XEmacs looks for packages in so-called package hierarchies.
|
|
|
78 Normally, there are three system wide hierarchies, like this:
|
|
331
|
79
|
|
826
|
80 $prefix/lib/xemacs/xemacs-packages/
|
|
331
|
81 Normal packages go here.
|
|
|
82
|
|
826
|
83 $prefix/lib/xemacs/mule-packages/
|
|
456
|
84 Mule packages go here and are only searched by MULE-enabled XEmacsen.
|
|
|
85
|
|
|
86 $prefix/lib/xemacs/site-packages/
|
|
|
87 Local and 3rd party packages go here.
|
|
|
88
|
|
826
|
89 This is what you get when you untar the SUMO tarballs under
|
|
|
90 $prefix/lib/xemacs.
|
|
|
91
|
|
|
92 $prefix is specified using the `--prefix' parameter to `configure', and
|
|
|
93 defaults to `usr/local'.
|
|
|
94
|
|
|
95 If your packages are located in the above directories, XEmacs will
|
|
|
96 automatically find them at startup; however, if you have your packages
|
|
|
97 somewhere else (e.g. you're a developer and are compiling the packages
|
|
|
98 yourself, and want your own private copy of everything), you can tell
|
|
|
99 XEmacs specifically where to look for the packages by using the
|
|
|
100 `--package-path' parameter to the 'configure' script. Normally, it looks
|
|
|
101 like this:
|
|
|
102
|
|
|
103 configure --package-path="~/.xemacs::/src/xemacs/site-packages:/src/xemacs/xemacs-packages:/src/xemacs/mule-packages" ...
|
|
|
104
|
|
|
105 See `configure.usage' for more info about the format of this parameter.
|
|
456
|
106
|
|
|
107 * Where to get the packages
|
|
|
108 ---------------------------
|
|
331
|
109
|
|
|
110 Packages are available from ftp://ftp.xemacs.org/pub/xemacs/packages
|
|
438
|
111 and its mirrors.
|
|
331
|
112
|
|
456
|
113 * How to install the packages
|
|
|
114 -----------------------------
|
|
|
115 There are a few different ways to install packages:
|
|
331
|
116
|
|
456
|
117 1. Manually, all at once, using the 'Sumo Tarball'.
|
|
|
118 2. Manually, using individual package tarballs.
|
|
|
119 3. Automatically, using the package tools from XEmacs.
|
|
331
|
120
|
|
456
|
121 ** Manually, all at once, using the 'Sumo Tarball'
|
|
|
122 --------------------------------------------------
|
|
331
|
123
|
|
|
124 Those with little time, cheap connections and plenty of disk space can
|
|
438
|
125 install all the packages at once using the sumo tarballs.
|
|
456
|
126 Download the file:
|
|
331
|
127
|
|
456
|
128 xemacs-sumo.tar.gz
|
|
331
|
129
|
|
456
|
130 For an XEmacs compiled with Mule you also need:
|
|
331
|
131
|
|
456
|
132 xemacs-mule-sumo.tar.gz
|
|
331
|
133
|
|
333
|
134 N.B. They are called 'Sumo Tarballs' for good reason. They are
|
|
456
|
135 currently about 19MB and 4.5MB (gzipped) respectively.
|
|
|
136
|
|
|
137 Install them by:
|
|
331
|
138
|
|
456
|
139 cd $prefix/lib/xemacs ; gunzip -c <tarballname> | tar xvf - RET
|
|
331
|
140
|
|
456
|
141 Or, if you have GNU tar:
|
|
|
142
|
|
|
143 cd $prefix/lib/xemacs ; tar zxvf /path/to/<tarballname> RET
|
|
331
|
144
|
|
|
145 As the Sumo tarballs are not regenerated as often as the individual
|
|
|
146 packages, it is recommended that you use the automatic package tools
|
|
|
147 afterwards to pick up any recent updates.
|
|
|
148
|
|
456
|
149 ** Manually, using individual package tarballs
|
|
|
150 ----------------------------------------------
|
|
331
|
151
|
|
456
|
152 Fetch the packages from the FTP site, CD-ROM whatever. The filenames
|
|
331
|
153 have the form name-<version>-pkg.tar.gz and are gzipped tar files. For
|
|
|
154 a fresh install it is sufficient to untar the file at the top of the
|
|
456
|
155 package hierarchy.
|
|
|
156
|
|
|
157 Note: If you are upgrading packages already installed, it's best to
|
|
|
158 remove the old package first (see 'Upgrading/Removing Packages' below).
|
|
331
|
159
|
|
456
|
160 For example if we are installing the 'xemacs-base'
|
|
|
161 package (version 1.48):
|
|
|
162
|
|
|
163 mkdir $prefix/lib/xemacs/xemacs-packages RET # if it does not exist yet
|
|
|
164 cd $prefix/lib/xemacs/xemacs-packages RET
|
|
|
165 gunzip -c /path/to/xemacs-base-1.48-pkg.tar.gz | tar xvf - RET
|
|
|
166
|
|
|
167 Or if you have GNU tar, the last step can be:
|
|
331
|
168
|
|
456
|
169 tar zxvf /path/to/xemacs-base-1.48-pkg.tar.gz RET
|
|
|
170
|
|
|
171 For MULE related packages, it is best to untar into the mule-packages
|
|
|
172 hierarchy, i.e. for the mule-base package, version 1.37:
|
|
331
|
173
|
|
456
|
174 mkdir $prefix/lib/xemacs/mule-packages RET # if it does not exist yet
|
|
|
175 cd $prefix/lib/xemacs/mule-packages RET
|
|
|
176 gunzip -c /path/to/mule-base-1.37-pkg.tar.gz | tar xvf - RET
|
|
|
177
|
|
|
178 Or if you have GNU tar, the last step can be:
|
|
331
|
179
|
|
456
|
180 tar zxvf /path/to/mule-base-1.37-pkg.tar.gz RET
|
|
|
181
|
|
|
182
|
|
|
183 ** Automatically, using the package tools from XEmacs
|
|
|
184 -----------------------------------------------------
|
|
331
|
185
|
|
|
186 XEmacs comes with some tools to make the periodic updating and
|
|
|
187 installing easier. It will notice if new packages or versions are
|
|
456
|
188 available and will fetch them from the FTP site.
|
|
331
|
189
|
|
438
|
190 Unfortunately this requires that a few packages are already in place.
|
|
|
191 You will have to install them by hand as above or use a SUMO tarball.
|
|
331
|
192 This requirement will hopefully go away in the future. The packages
|
|
|
193 you need are:
|
|
|
194
|
|
456
|
195 efs - To fetch the files from the FTP site or mirrors.
|
|
331
|
196 xemacs-base - Needed by efs.
|
|
|
197
|
|
|
198 and optionally:
|
|
|
199
|
|
438
|
200 mule-base - Needed if you want to use XEmacs with MULE.
|
|
331
|
201
|
|
456
|
202 After installing these by hand, fire up XEmacs and follow these
|
|
|
203 steps.
|
|
|
204
|
|
|
205 Note: The menus in XEmacs 21.2.x and up have changed slightly, so
|
|
|
206 where I mention "Options -> Manage Packages", substitute "Tools ->
|
|
|
207 Packages".
|
|
331
|
208
|
|
456
|
209 (1) Choose a download site.
|
|
|
210 - via menu: Options -> Manages Packages -> Add Download Site
|
|
|
211 - via keyb: M-x customize-variable RET package-get-remote RET
|
|
|
212 (put in the details of remote host and directory)
|
|
331
|
213
|
|
456
|
214 If the package tarballs _AND_ the package-index file are in a
|
|
|
215 local directory, you can: M-x pui-add-install-directory RET
|
|
|
216
|
|
|
217 (2) Obtain a list of packages and display the list in a buffer named
|
|
|
218 "*Packages*".
|
|
|
219 - menu: Options -> Manage Packages -> List & Install
|
|
|
220 - keyb: M-x pui-list-packages RET
|
|
331
|
221
|
|
456
|
222 XEmacs will now connect to the remote site and download the
|
|
|
223 latest package-index file. If you see an error about the
|
|
|
224 package-index entries not being PGP signed, you can safely
|
|
|
225 ignore this because PGP has not been integrated into the XEmacs
|
|
|
226 package tools yet.
|
|
|
227
|
|
|
228 The resulting buffer, "*Packages*" has brief instructions at the
|
|
|
229 end of the buffer.
|
|
|
230
|
|
|
231 (3) Choose the packages you wish to install.
|
|
|
232 - mouse: Click button 2 on the package name.
|
|
|
233 - keyb: RET on the package name
|
|
331
|
234
|
|
456
|
235 (4) Make sure you have everything you need.
|
|
|
236 - menu: Packages -> Add Required
|
|
|
237 - keyb: r
|
|
|
238
|
|
|
239 XEmacs will now search for packages that are required by the
|
|
|
240 ones that you have chosen to install and offer to select
|
|
|
241 those packages also.
|
|
331
|
242
|
|
456
|
243 For novices and gurus alike, this step can save your bacon.
|
|
|
244 It's easy to forget to install a critical package.
|
|
438
|
245
|
|
456
|
246 (5) Download and install the packages.
|
|
|
247 - menu: Packages -> Install/Remove Selected
|
|
|
248 - keyb: x
|
|
|
249
|
|
|
250 * After Installation
|
|
|
251 --------------------
|
|
331
|
252
|
|
|
253 New packages can only be used by XEmacs after a restart.
|
|
|
254
|
|
456
|
255 * Which Packages to install?
|
|
|
256 ----------------------------
|
|
331
|
257
|
|
|
258 This is difficult to say. When in doubt install a package. If you
|
|
|
259 administrate a big site it might be a good idea to just install
|
|
|
260 everything. A good minimal set of packages for XEmacs-latin1 would be
|
|
|
261
|
|
|
262 xemacs-base, xemacs-devel, c-support, cc-mode, debug, dired, efs,
|
|
|
263 edit-utils, fsf-compat, mail-lib, net-utils, os-utils, prog-modes,
|
|
|
264 text-modes, time
|
|
|
265
|
|
456
|
266 If you are using the XEmacs package tools, don't forget to do:
|
|
|
267
|
|
|
268 Packages -> Add Required
|
|
|
269
|
|
|
270 To make sure you have everything that the packages you have chosen to
|
|
|
271 install need.
|
|
331
|
272
|
|
|
273 See also '.../etc/PACKAGES' for further descriptions of the individual
|
|
456
|
274 packages.
|
|
331
|
275
|
|
456
|
276 * Upgrading/Removing Packages
|
|
|
277 -----------------------------
|
|
331
|
278
|
|
|
279 As the exact files and their locations contained in a package may
|
|
438
|
280 change it is recommended to remove a package first before installing a
|
|
331
|
281 new version. In order to facilitate removal each package contains an
|
|
|
282 pgkinfo/MANIFEST.pkgname file which list all the files belong to the
|
|
|
283 package. M-x package-admin-delete-binary-package RET can be used to
|
|
|
284 remove a package using this file.
|
|
|
285
|
|
|
286 Note that the interactive package tools included with XEmacs already do
|
|
|
287 this for you.
|
|
|
288
|
|
456
|
289 * User Package directories
|
|
|
290 --------------------------
|
|
331
|
291
|
|
|
292 In addition to the system wide packages, each user can have his own
|
|
420
|
293 packages installed in "~/.xemacs/xemacs-packages". If you want to
|
|
331
|
294 install packages there using the interactive tools, you need to set
|
|
420
|
295 'pui-package-install-dest-dir' to "~/.xemacs/xemacs-packages"
|
|
331
|
296
|
|
456
|
297 * Site lisp/Site start
|
|
|
298 ----------------------
|
|
331
|
299
|
|
|
300 The site-packages hierarchy replaces the old 'site-lisp' directory.
|
|
|
301 XEmacs no longer looks into a 'site-lisp' directly by default.
|
|
|
302 A good place to put 'site-start.el' would be in
|
|
|
303 $prefix/lib/xemacs/site-packages/lisp/
|
|
424
|
304
|
|
456
|
305 * Finding the right packages
|
|
|
306 ----------------------------
|
|
424
|
307
|
|
|
308 If you want to find out which package contains the functionality you
|
|
|
309 are looking for, use M-x package-get-package-provider, and give it a
|
|
456
|
310 symbol that is likely to be in that package.
|
|
|
311
|
|
|
312 For example, if some code you want to use has a (require 'thingatpt)
|
|
|
313 in it:
|
|
|
314
|
|
|
315 M-x package-get-package-provider RET thingatpt RET
|
|
|
316
|
|
|
317 which will return something like: (fsf-compat "1.08").
|
