comparison man/xemacs/packages.texi @ 398:74fd4e045ea6 r21-2-29

Import from CVS: tag r21-2-29
author cvs
date Mon, 13 Aug 2007 11:13:30 +0200
parents bbff43aa5eb7
children de805c49cfc1
comparison
equal deleted inserted replaced
397:f4aeb21a5bad 398:74fd4e045ea6
4 @section Packages 4 @section Packages
5 @cindex packages 5 @cindex packages
6 6
7 The XEmacs 21 distribution comes only with a very basic set of 7 The XEmacs 21 distribution comes only with a very basic set of
8 built-in modes and packages. Most of the packages that were part of 8 built-in modes and packages. Most of the packages that were part of
9 the distribution of earlier versions of XEmacs are now separately 9 the distribution of earlier versions of XEmacs are now available
10 available. The installer as well as the user can choose which 10 separately. The installer as well as the user can choose which
11 packages to install; the actual installation process is easy. 11 packages to install; the actual installation process is easy.
12 This gives an installer the ability to tailor an XEmacs installation for 12 This gives an installer the ability to tailor an XEmacs installation for
13 local needs with safe removal of unnecessary code. 13 local needs with safe removal of unnecessary code.
14 14
15 @menu 15 @menu
89 The file @file{etc/PACKAGES} in the core distribution contains a list of 89 The file @file{etc/PACKAGES} in the core distribution contains a list of
90 the packages available at the time of the XEmacs release. Packages are 90 the packages available at the time of the XEmacs release. Packages are
91 also listed on the @code{Options} menu under: 91 also listed on the @code{Options} menu under:
92 92
93 @example 93 @example
94 Options->Customize->Emacs->Packages 94 Options->Customize->Emacs->Packages
95 @end example 95 @end example
96 96
97 However, don't select any of these menu picks unless you actually want 97 However, don't select any of these menu picks unless you actually want
98 to install the given package (and have properly configured your system 98 to install the given package (and have properly configured your system
99 to do so). 99 to do so).
101 You can also get a list of available packages, and whether or not they 101 You can also get a list of available packages, and whether or not they
102 are installed, using the visual package browser and installer. You can 102 are installed, using the visual package browser and installer. You can
103 access it via the menus: 103 access it via the menus:
104 104
105 @example 105 @example
106 Options->Manage Packages->List & Install 106 Options->Manage Packages->List & Install
107 @end example 107 @end example
108 108
109 Or, you can get to it via the keyboard: 109 Or, you can get to it via the keyboard:
110 110
111 @example 111 @example
113 @end example 113 @end example
114 114
115 Hint to system administrators of multi-user systems: it might be a good 115 Hint to system administrators of multi-user systems: it might be a good
116 idea to install all packages and not interfere with the wishes of your 116 idea to install all packages and not interfere with the wishes of your
117 users. 117 users.
118
119 If you can't find which package provides the feature you require, try
120 using the @code{package-get-package-provider} function. Eg., if you know
121 that you need @code{thingatpt}, type:
122
123 @example
124 M-x package-get-package-provider RET thingatpt
125 @end example
126
127 which will return something like (fsf-compat "1.06"). You can the use
128 one of the methods above for installing the package you want.
118 129
119 @subsection XEmacs and Installing Packages 130 @subsection XEmacs and Installing Packages
120 131
121 Normally, packages are installed over the network, using EFS 132 Normally, packages are installed over the network, using EFS
122 @ref{(EFS)}. However, you may not have network access, or you may 133 @ref{(EFS)}. However, you may not have network access, or you may
136 147
137 If you are installing from a temporary, one-time directory, you can also 148 If you are installing from a temporary, one-time directory, you can also
138 add these directory names to @code{package-get-remote} using: 149 add these directory names to @code{package-get-remote} using:
139 150
140 @example 151 @example
141 M-x pui-add-install-directory 152 M-x pui-add-install-directory
142 @end example 153 @end example
143 154
144 Note, however, that any directories added using this function are not 155 Note, however, that any directories added using this function are not
145 saved; this information will be lost when you quit XEmacs. 156 saved; this information will be lost when you quit XEmacs.
146 157
152 163
153 The easiest way to install a package is to use the visual package 164 The easiest way to install a package is to use the visual package
154 browser and installer, using the menu pick: 165 browser and installer, using the menu pick:
155 166
156 @example 167 @example
157 Options->Manage Packages->List & Install 168 Options->Manage Packages->List & Install
158 @end example 169 @end example
159 or 170 or
160 @example 171 @example
161 Options->Manage Packages->Using Custom->Select-> ... 172 Options->Manage Packages->Using Custom->Select-> ...
162 @end example 173 @end example
163 174
164 You can also access it using the keyboard: 175 You can also access it using the keyboard:
165 176
166 @example 177 @example
223 234
224 For an alternative package interface, you can select packages from the 235 For an alternative package interface, you can select packages from the
225 customize menus, under: 236 customize menus, under:
226 237
227 @example 238 @example
228 Options->Customize->Emacs->Packages-> ... 239 Options->Customize->Emacs->Packages-> ...
229 @end example 240 @end example
230 or 241 or
231 @example 242 @example
232 Options->Manage Packages->Using Custom->Select-> ... 243 Options->Manage Packages->Using Custom->Select-> ...
233 @end example 244 @end example
234 245
235 Set their state to on, and then do: 246 Set their state to on, and then do:
236 247
237 @example 248 @example
238 Options->Manage Packages->Using Custom->Update Packages 249 Options->Manage Packages->Using Custom->Update Packages
239 @end example 250 @end example
240 251
241 This will automatically retrieve the packages you have selected from the 252 This will automatically retrieve the packages you have selected from the
242 XEmacs ftp site or your local disk, and install them into 253 XEmacs ftp site or your local disk, and install them into
243 XEmacs. Additionally it will update any packages you already have 254 XEmacs. Additionally it will update any packages you already have
256 it depends upon. 267 it depends upon.
257 268
258 @subsection Manual Binary Package Installation 269 @subsection Manual Binary Package Installation
259 270
260 Pre-compiled, binary packages can be installed in either a system 271 Pre-compiled, binary packages can be installed in either a system
261 package directory (this is determined when XEmacs is compiled), or in a 272 package directory (this is determined when XEmacs is compiled), or in
262 subdirectory of your @file{$HOME} directory: 273 one of the following
263 274 subdirectories of your @file{$HOME} directory:
264 @example 275
265 ~/.xemacs/packages 276 @example
266 @end example 277 ~/.xemacs/mule-packages
278 ~/.xemacs/xemacs-packages
279 @end example
280
281 Packages in the former directory will only be found by a Mule-enabled
282 XEmacs.
267 283
268 XEmacs does not have to be running to install binary packages, although 284 XEmacs does not have to be running to install binary packages, although
269 XEmacs will not know about any newly-installed packages until you 285 XEmacs will not know about any newly-installed packages until you
270 restart XEmacs. Note, however, that installing a newer version of a 286 restart XEmacs. Note, however, that installing a newer version of a
271 package while XEmacs is running could cause strange errors in XEmacs; 287 package while XEmacs is running could cause strange errors in XEmacs;
277 @item 293 @item
278 Download the package(s) that you want to install. Each binary package 294 Download the package(s) that you want to install. Each binary package
279 will typically be a gzip'd tarball. 295 will typically be a gzip'd tarball.
280 296
281 @item 297 @item
282 Decide where to install the packages: in the system package directory, 298 Decide where to install the packages: in the system package
283 or in @file{~/.xemacs/packages}. If you want to install the 299 directory, or in @file{~/.xemacs/mule-packages} or
284 packages in the system package directory, make sure you can write into 300 @file{~/.xemacs/xemacs-packages}, respectively. If you want to install
285 that directory. If you want to install in your @file{$HOME} directory, 301 the packages in the system package directory, make sure you can write
286 create the directory, @file{~/.xemacs/packages}. 302 into that directory. If you want to install in your @file{$HOME}
303 directory, create the directory, @file{~/.xemacs/mule-packages} or
304 @file{~/.xemacs/xemacs-packages}, respectively.
287 305
288 @item 306 @item
289 Next, @code{cd} to the directory under which you want to install the 307 Next, @code{cd} to the directory under which you want to install the
290 package(s). 308 package(s).
291 309
293 From this directory, uncompress and extract each of the gzip'd tarballs 311 From this directory, uncompress and extract each of the gzip'd tarballs
294 that you downloaded in step 1. Unix and Cygnus cygwin users will 312 that you downloaded in step 1. Unix and Cygnus cygwin users will
295 typically do this using the commands: 313 typically do this using the commands:
296 314
297 @example 315 @example
298 gunzip < package.tar.gz | tar xvf - 316 gunzip < package.tar.gz | tar xvf -
299 @end example 317 @end example
300 318
301 Above, replace @file{package.tar.gz} with the filename of the 319 Above, replace @file{package.tar.gz} with the filename of the
302 package that you downloaded in step 1. 320 package that you downloaded in step 1.
303 321
304 Of course, if you use GNU @code{tar}, you could also use: 322 Of course, if you use GNU @code{tar}, you could also use:
305 323
306 @example 324 @example
307 tar xvzf package.tar.gz 325 tar xvzf package.tar.gz
308 @end example 326 @end example
309 327
310 @comment What about native MS Windows users??? 328 @comment What about native MS Windows users???
311 329
312 @item 330 @item