Mercurial > hg > xemacs-beta

comparison README.packages @ 1648:712931b4b71d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2003-08-27 18:06:54 by youngs] 2003-08-28 Steve Youngs <youngs@xemacs.org> * README.packages: Update. 2003-08-28 Steve Youngs <youngs@xemacs.org> * PACKAGES: Update. 2003-08-28 Steve Youngs <youngs@xemacs.org> * xemacs-faq.texi (Q2.0.2): Rewrite, mentioning the correct way to remove a package. (Q3.8.2): big-menubar is in the edit-utils package. (Q4.3.2): Add a comment about not needing TM for things like Gnus, MH-E and VM. (Q5.3.3): State correct location of ps-print.el. * xemacs/packages.texi (Packages): Remove "Creating Packages" menu entry. (Package Terminology): Whitespace clean up. (Installing Packages): Whitespace clean up and add some @code formatters. Re-organise the menu so that installation via PUI is first and Sumo is last. (Automatically): mule-base is no longer a requirement for using PUI. Mention optionally requiring mailcrypt. (Note): Removed. (Manually): Move to below the PUI installation method. (Sumo): Move to below the manual installation method. (Which Packages): Add mailcrypt. (Building Packages): Remove duplicated stuff that is in lispref/packaging.texi, xref to it instead. (Local.rules File): xref to the appropriate node in lispref/packaging.texi. (Available Packages): Update to current reality. (all): Removed. (srckit): Removed. (binkit): Removed. * xemacs/reading.texi (Reading Mail): Mention Gnus and MEW. * new-users-guide/custom2.texi (Init File): big-menubar.el is in the edit-utils package. * lispref/packaging.texi (Packaging): (The User View): (The Library Maintainer View): (Infrastructure): (Control Files): (Obtaining): (The Package Release Engineer View): (Package Terminology): (Building Packages): (Makefile Targets): (packages): New. (Local.rules File): (XEMACS_PACKAGES): Removed. (XEMACS_INSTALLED_PACKAGES_ROOT): New. (NONMULE_PACKAGES): New. (EXCLUDES): New. (Creating Packages): (BATCH): New. (VERSION): Removed. (AUTHOR_VERSION): Removed. (MAINTAINER): Removed. (PACKAGE): Removed. (PKG_TYPE): Removed. (REQUIRES): Removed. (CATEGORY): Removed. (ELS): Removed. (ELCS): Removed. (all): Removed. (srckit): Removed. (binkit): Removed. (are): New. (STANDARD_DOCS): New. (ELCS_1_DEST): New. (example): New. (PACKAGE_SUPPRESS): New. (EXPLICIT_DOCS): New. (DATA_DEST): New. (Documenting Packages): Not quite a total rewrite, but a fairly thorough audit nonetheless.
author youngs
date Wed, 27 Aug 2003 18:07:10 +0000
parents 6728e641994e
children ad56e5a6d09f
comparison
equal deleted inserted replaced
1647:d90ba01b5346 1648:712931b4b71d
112 112
113 * How to install the packages 113 * How to install the packages
114 ----------------------------- 114 -----------------------------
115 There are a few different ways to install packages: 115 There are a few different ways to install packages:
116 116
117 1. Manually, all at once, using the 'Sumo Tarball'. 117 1. Automatically, using the package tools from XEmacs.
118 2. Manually, using individual package tarballs. 118 2. Manually, using individual package tarballs.
119 3. Automatically, using the package tools from XEmacs. 119 3. Manually, all at once, using the 'Sumo Tarball'.
120 120
121 ** Manually, all at once, using the 'Sumo Tarball' 121 ** Automatically, using the package tools from XEmacs
122 -------------------------------------------------- 122 -----------------------------------------------------
123 123
124 Those with little time, cheap connections and plenty of disk space can 124 XEmacs comes with some tools to make the periodic updating and
125 install all the packages at once using the sumo tarballs. 125 installing easier. It will notice if new packages or versions are
126 Download the file: 126 available and will fetch them from the FTP site.
127 127
128 xemacs-sumo.tar.gz 128 Unfortunately this requires that a few packages are already in place.
129 129 You will have to install them by hand as above or use a SUMO tarball.
130 For an XEmacs compiled with Mule you also need: 130 This requirement will hopefully go away in the future. The packages
131 131 you need are:
132 xemacs-mule-sumo.tar.gz 132
133 133 efs - To fetch the files from the FTP site or mirrors.
134 N.B. They are called 'Sumo Tarballs' for good reason. They are 134 xemacs-base - Needed by efs.
135 currently about 19MB and 4.5MB (gzipped) respectively. 135
136 136 and optionally:
137 Install them by: 137
138 138 mailcrypt - For PGP verification of the package-index file.
139 cd $prefix/lib/xemacs ; gunzip -c <tarballname> | tar xvf - RET 139
140 140 After installing these by hand, fire up XEmacs and follow these
141 Or, if you have GNU tar: 141 steps.
142 142
143 cd $prefix/lib/xemacs ; tar zxvf /path/to/<tarballname> RET 143 (1) Choose a download site.
144 144 - via menu: Tools -> Packages -> Set Download Site
145 As the Sumo tarballs are not regenerated as often as the individual 145 - via keyb: M-x customize-variable RET package-get-remote RET
146 packages, it is recommended that you use the automatic package tools 146 (put in the details of remote host and directory)
147 afterwards to pick up any recent updates. 147
148 If the package tarballs _AND_ the package-index file are in a
149 local directory, you can: M-x pui-set-local-package-get-directory RET
150
151 (2) Obtain a list of packages and display the list in a buffer named
152 "*Packages*".
153 - menu: Tools -> Packages -> List & Install
154 - keyb: M-x pui-list-packages RET
155
156 XEmacs will now connect to the remote site and download the
157 latest package-index file.
158
159 The resulting buffer, "*Packages*" has brief instructions at the
160 end of the buffer.
161
162 (3) Choose the packages you wish to install.
163 - mouse: Click button 2 on the package name.
164 - keyb: RET on the package name
165
166 (4) Make sure you have everything you need.
167 - menu: Packages -> Add Required
168 - keyb: r
169
170 XEmacs will now search for packages that are required by the
171 ones that you have chosen to install and offer to select
172 those packages also.
173
174 For novices and gurus alike, this step can save your bacon.
175 It's easy to forget to install a critical package.
176
177 (5) Download and install the packages.
178 - menu: Packages -> Install/Remove Selected
179 - keyb: x
148 180
149 ** Manually, using individual package tarballs 181 ** Manually, using individual package tarballs
150 ---------------------------------------------- 182 ----------------------------------------------
151 183
152 Fetch the packages from the FTP site, CD-ROM whatever. The filenames 184 Fetch the packages from the FTP site, CD-ROM whatever. The filenames
178 Or if you have GNU tar, the last step can be: 210 Or if you have GNU tar, the last step can be:
179 211
180 tar zxvf /path/to/mule-base-1.37-pkg.tar.gz RET 212 tar zxvf /path/to/mule-base-1.37-pkg.tar.gz RET
181 213
182 214
183 ** Automatically, using the package tools from XEmacs 215 ** Manually, all at once, using the 'Sumo Tarball'
184 ----------------------------------------------------- 216 --------------------------------------------------
185 217
186 XEmacs comes with some tools to make the periodic updating and 218 Those with little time, cheap connections and plenty of disk space can
187 installing easier. It will notice if new packages or versions are 219 install all the packages at once using the sumo tarballs.
188 available and will fetch them from the FTP site. 220 Download the file:
189 221
190 Unfortunately this requires that a few packages are already in place. 222 xemacs-sumo.tar.gz
191 You will have to install them by hand as above or use a SUMO tarball. 223
192 This requirement will hopefully go away in the future. The packages 224 For an XEmacs compiled with Mule you also need:
193 you need are: 225
194 226 xemacs-mule-sumo.tar.gz
195 efs - To fetch the files from the FTP site or mirrors. 227
196 xemacs-base - Needed by efs. 228 N.B. They are called 'Sumo Tarballs' for good reason. They are
197 229 currently about 19MB and 4.5MB (gzipped) respectively.
198 and optionally: 230
199 231 Install them by:
200 mule-base - Needed if you want to use XEmacs with MULE. 232
201 233 cd $prefix/lib/xemacs ; gunzip -c <tarballname> | tar xvf - RET
202 After installing these by hand, fire up XEmacs and follow these 234
203 steps. 235 Or, if you have GNU tar:
204 236
205 Note: The menus in XEmacs 21.2.x and up have changed slightly, so 237 cd $prefix/lib/xemacs ; tar zxvf /path/to/<tarballname> RET
206 where I mention "Options -> Manage Packages", substitute "Tools -> 238
207 Packages". 239 As the Sumo tarballs are not regenerated as often as the individual
208 240 packages, it is recommended that you use the automatic package tools
209 (1) Choose a download site. 241 afterwards to pick up any recent updates.
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)
213
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
221
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
234
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.
242
243 For novices and gurus alike, this step can save your bacon.
244 It's easy to forget to install a critical package.
245
246 (5) Download and install the packages.
247 - menu: Packages -> Install/Remove Selected
248 - keyb: x
249 242
250 * After Installation 243 * After Installation
251 -------------------- 244 --------------------
252 245
253 New packages can only be used by XEmacs after a restart. 246 Updated packages can only be used by XEmacs after a restart.
254 247
255 * Which Packages to install? 248 * Which Packages to install?
256 ---------------------------- 249 ----------------------------
257 250
258 This is difficult to say. When in doubt install a package. If you 251 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 252 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 253 everything. A good minimal set of packages for XEmacs-latin1 would be
261 254
262 xemacs-base, xemacs-devel, c-support, cc-mode, debug, dired, efs, 255 xemacs-base, xemacs-devel, c-support, cc-mode, debug, dired, efs,
263 edit-utils, fsf-compat, mail-lib, net-utils, os-utils, prog-modes, 256 edit-utils, fsf-compat, mail-lib, net-utils, os-utils, prog-modes,
264 text-modes, time 257 text-modes, time, mailcrypt
265 258
266 If you are using the XEmacs package tools, don't forget to do: 259 If you are using the XEmacs package tools, don't forget to do:
267 260
268 Packages -> Add Required 261 Packages -> Add Required
269 262
288 281
289 * User Package directories 282 * User Package directories
290 -------------------------- 283 --------------------------
291 284
292 In addition to the system wide packages, each user can have his own 285 In addition to the system wide packages, each user can have his own
293 packages installed in "~/.xemacs/xemacs-packages". If you want to 286 packages installed under "~/.xemacs/". If you want to install packages
294 install packages there using the interactive tools, you need to set 287 there using the interactive tools, you need to set
295 'pui-package-install-dest-dir' to "~/.xemacs/xemacs-packages" 288 'package-get-install-to-user-init-directory' to 't'
296 289
297 * Site lisp/Site start 290 * Site lisp/Site start
298 ---------------------- 291 ----------------------
299 292
300 The site-packages hierarchy replaces the old 'site-lisp' directory. 293 The site-packages hierarchy replaces the old 'site-lisp' directory.