Mercurial > hg > xemacs-beta

comparison README.packages @ 369:1d62742628b6 r21-1-14

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