Mercurial > hg > xemacs-beta

comparison man/xemacs/packages.texi @ 412:697ef44129c6 r21-2-14

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-2-14
author cvs
date Mon, 13 Aug 2007 11:20:41 +0200
parents de805c49cfc1
children 41dbb7a9d5f2
comparison
equal deleted inserted replaced
411:12e008d41344 412:697ef44129c6
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 available 9 the distribution of earlier versions of XEmacs are now separately
10 separately. The installer as well as the user can choose which 10 available. 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.
129 118
130 @subsection XEmacs and Installing Packages 119 @subsection XEmacs and Installing Packages
131 120
132 Normally, packages are installed over the network, using EFS 121 Normally, packages are installed over the network, using EFS
133 @ref{(EFS)}. However, you may not have network access, or you may 122 @ref{(EFS)}. However, you may not have network access, or you may
134 already have some or all of the packages on a local disk, such as a 123 already have some or all of the packages on a local disk, such as a
135 CDROM. If you want to install from a local disk, you must first tell 124 CDROM. If you want to install from a local disk, you must first tell
136 XEmacs where to find the package binaries. This is done by adding a line 125 XEmacs where to find the package binaries. This is done by adding a line
137 like the following to your init file: 126 like the following to your @file{.emacs} file:
138 127
139 @example 128 @example
140 (setq package-get-remote (cons (list nil "/my/path/to/package/binaries") 129 (setq package-get-remote (cons (list nil "/my/path/to/package/binaries")
141 package-get-remote)) 130 package-get-remote))
142 @end example 131 @end example
143
144 @xref{Init File}.
145 132
146 Here, you'd change @file{/my/path/to/package/binaries} to be the path 133 Here, you'd change @file{/my/path/to/package/binaries} to be the path
147 to your local package binaries. Next, restart XEmacs, and you're ready 134 to your local package binaries. Next, restart XEmacs, and you're ready
148 to go (advanced users can just re-evaluate the sexp). 135 to go (advanced users can just re-evaluate the sexp).
149 136
150 If you are installing from a temporary, one-time directory, you can also 137 If you are installing from a temporary, one-time directory, you can also
151 add these directory names to @code{package-get-remote} using: 138 add these directory names to @code{package-get-remote} using:
152 139
153 @example 140 @example
154 M-x pui-add-install-directory 141 M-x pui-add-install-directory
155 @end example 142 @end example
156 143
157 Note, however, that any directories added using this function are not 144 Note, however, that any directories added using this function are not
158 saved; this information will be lost when you quit XEmacs. 145 saved; this information will be lost when you quit XEmacs.
159 146
165 152
166 The easiest way to install a package is to use the visual package 153 The easiest way to install a package is to use the visual package
167 browser and installer, using the menu pick: 154 browser and installer, using the menu pick:
168 155
169 @example 156 @example
170 Options->Manage Packages->List & Install 157 Options->Manage Packages->List & Install
171 @end example 158 @end example
172 or 159 or
173 @example 160 @example
174 Options->Manage Packages->Using Custom->Select-> ... 161 Options->Manage Packages->Using Custom->Select-> ...
175 @end example 162 @end example
176 163
177 You can also access it using the keyboard: 164 You can also access it using the keyboard:
178 165
179 @example 166 @example
236 223
237 For an alternative package interface, you can select packages from the 224 For an alternative package interface, you can select packages from the
238 customize menus, under: 225 customize menus, under:
239 226
240 @example 227 @example
241 Options->Customize->Emacs->Packages-> ... 228 Options->Customize->Emacs->Packages-> ...
242 @end example 229 @end example
243 or 230 or
244 @example 231 @example
245 Options->Manage Packages->Using Custom->Select-> ... 232 Options->Manage Packages->Using Custom->Select-> ...
246 @end example 233 @end example
247 234
248 Set their state to on, and then do: 235 Set their state to on, and then do:
249 236
250 @example 237 @example
251 Options->Manage Packages->Using Custom->Update Packages 238 Options->Manage Packages->Using Custom->Update Packages
252 @end example 239 @end example
253 240
254 This will automatically retrieve the packages you have selected from the 241 This will automatically retrieve the packages you have selected from the
255 XEmacs ftp site or your local disk, and install them into 242 XEmacs ftp site or your local disk, and install them into
256 XEmacs. Additionally it will update any packages you already have 243 XEmacs. Additionally it will update any packages you already have
269 it depends upon. 256 it depends upon.
270 257
271 @subsection Manual Binary Package Installation 258 @subsection Manual Binary Package Installation
272 259
273 Pre-compiled, binary packages can be installed in either a system 260 Pre-compiled, binary packages can be installed in either a system
274 package directory (this is determined when XEmacs is compiled), or in 261 package directory (this is determined when XEmacs is compiled), or in a
275 one of the following 262 subdirectory of your @file{$HOME} directory:
276 subdirectories of your @file{$HOME} directory: 263
277 264 @example
278 @example 265 ~/.xemacs/packages
279 ~/.xemacs/mule-packages 266 @end example
280 ~/.xemacs/xemacs-packages
281 @end example
282
283 Packages in the former directory will only be found by a Mule-enabled
284 XEmacs.
285 267
286 XEmacs does not have to be running to install binary packages, although 268 XEmacs does not have to be running to install binary packages, although
287 XEmacs will not know about any newly-installed packages until you 269 XEmacs will not know about any newly-installed packages until you
288 restart XEmacs. Note, however, that installing a newer version of a 270 restart XEmacs. Note, however, that installing a newer version of a
289 package while XEmacs is running could cause strange errors in XEmacs; 271 package while XEmacs is running could cause strange errors in XEmacs;
295 @item 277 @item
296 Download the package(s) that you want to install. Each binary package 278 Download the package(s) that you want to install. Each binary package
297 will typically be a gzip'd tarball. 279 will typically be a gzip'd tarball.
298 280
299 @item 281 @item
300 Decide where to install the packages: in the system package 282 Decide where to install the packages: in the system package directory,
301 directory, or in @file{~/.xemacs/mule-packages} or 283 or in @file{~/.xemacs/packages}. If you want to install the
302 @file{~/.xemacs/xemacs-packages}, respectively. If you want to install 284 packages in the system package directory, make sure you can write into
303 the packages in the system package directory, make sure you can write 285 that directory. If you want to install in your @file{$HOME} directory,
304 into that directory. If you want to install in your @file{$HOME} 286 create the directory, @file{~/.xemacs/packages}.
305 directory, create the directory, @file{~/.xemacs/mule-packages} or
306 @file{~/.xemacs/xemacs-packages}, respectively.
307 287
308 @item 288 @item
309 Next, @code{cd} to the directory under which you want to install the 289 Next, @code{cd} to the directory under which you want to install the
310 package(s). 290 package(s).
311 291
313 From this directory, uncompress and extract each of the gzip'd tarballs 293 From this directory, uncompress and extract each of the gzip'd tarballs
314 that you downloaded in step 1. Unix and Cygnus cygwin users will 294 that you downloaded in step 1. Unix and Cygnus cygwin users will
315 typically do this using the commands: 295 typically do this using the commands:
316 296
317 @example 297 @example
318 gunzip < package.tar.gz | tar xvf - 298 gunzip < package.tar.gz | tar xvf -
319 @end example 299 @end example
320 300
321 Above, replace @file{package.tar.gz} with the filename of the 301 Above, replace @file{package.tar.gz} with the filename of the
322 package that you downloaded in step 1. 302 package that you downloaded in step 1.
323 303
324 Of course, if you use GNU @code{tar}, you could also use: 304 Of course, if you use GNU @code{tar}, you could also use:
325 305
326 @example 306 @example
327 tar xvzf package.tar.gz 307 tar xvzf package.tar.gz
328 @end example 308 @end example
329 309
330 @comment What about native MS Windows users??? 310 @comment What about native MS Windows users???
331 311
332 @item 312 @item