Mercurial > hg > xemacs-beta

comparison man/xemacs/packages.texi @ 314:341dac730539 r21-0b55

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-0b55
author cvs
date Mon, 13 Aug 2007 10:44:22 +0200
parents 9ea74add5d37
children 512e409c26a2
comparison
equal deleted inserted replaced
313:2905de29931f 314:341dac730539
70 a file called 70 a file called
71 @file{xemacs-21.0.tar.gz}. (Replace the @t{21.0} by the current version 71 @file{xemacs-21.0.tar.gz}. (Replace the @t{21.0} by the current version
72 number.) The core distribution contains the sources of XEmacs and a 72 number.) The core distribution contains the sources of XEmacs and a
73 minimal set of Emacs Lisp files, which are in the subdirectory named 73 minimal set of Emacs Lisp files, which are in the subdirectory named
74 @file{lisp}. This subdirectory used to contain all Emacs Lisp files 74 @file{lisp}. This subdirectory used to contain all Emacs Lisp files
75 distributed with XEmacs. 75 distributed with XEmacs. Now, to conserve disk space, most
76 non-essential packages were made optional.
76 77
77 @subsection Choosing the Packages You Need 78 @subsection Choosing the Packages You Need
78 79
79 The available packages can currently be found in the same ftp directory 80 The available packages can currently be found in the same ftp directory
80 where you grabbed the core distribition from, and are located in the 81 where you grabbed the core distribition from, and are located in the
81 subdirectory @file{binary-packages}. Package file names follow the 82 subdirectory @file{packages/binary-packages}. Package file names follow
82 naming convention @file{<package-name>-<version>-pkg.tar.gz}. 83 the naming convention @file{<package-name>-<version>-pkg.tar.gz}.
84
85 If you have EFS @ref{(EFS)}, packages can be installed over the network.
86 Alternatively, if you have copies of the packages locally, you can
87 install packages from a local disk or CDROM.
83 88
84 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
85 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
86 also listed on the @code{Options} menu under: 91 also listed on the @code{Options} menu under:
87 92
88 @example 93 @example
89 Options->Customize->Emacs->Packages 94 Options->Customize->Emacs->Packages
90 @end example 95 @end example
91 96
92 If you have EFS @ref{(EFS)}, installed and configured packages can be 97 However, don't select any of these menu picks unless you actually want
93 installed completely from the menubar. 98 to install the given package (and have properly configured your system
99 to do so).
100
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
103 access it via the menus:
104
105 @example
106 Options->Customize->List Packages
107 @end example
108
109 Or, you can get to it via the keyboard:
110
111 @example
112 M-x pui-list-packages
113 @end example
94 114
95 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
96 idea to install all packages and not to interfer with the wishes of your 116 idea to install all packages and not interfere with the wishes of your
97 users. 117 users.
98 118
99 @subsection Installing packages and XEmacs 119 @subsection XEmacs and Installing Packages
100 120
101 The easiest and most correct way to install a package is to do: 121 Normally, packages are installed over the network, using EFS
102 122 @ref{(EFS)}. However, you may not have network access, or you may
103 @example 123 already have some or all of the packages on a local disk, such as a
104 M-x package-admin-add-binary-package <return> 124 CDROM. If you want to install from a local disk, you must first tell
105 @end example 125 XEmacs where to find the package binaries. This is done by adding a line
106 126 like the following to your @file{.emacs} file:
107 input the location of the package tarball and XEmacs will do the rest 127
108 for you. If you have the EFS package installed and configured you can 128 @example
109 select package from the customize menu, set their state to on and then 129 (setq package-get-remote (cons (list nil "/my/path/to/package/binaries")
110 do: 130 package-get-remote))
131 @end example
132
133 Here, you'd change @code{"/my/path/to/package/binaries"} to be the path
134 to your local package binaries. Next, restart XEmacs, and you're ready
135 to go (advanced users can just re-evaluate the sexp).
136
137 If you're going to install over the network, you only have to insure
138 that EFS @ref{(EFS)} works, and that it can get outside a firewall, if
139 you happen to be behind one. You shouldn't have to do anything else;
140 XEmacs already knows where to go.
141
142 The easiest way to install a package is to use the visual package
143 browser and installer, using the menu pick:
144
145 @example
146 Options->Customize->List Packages
147 @end example
148
149 You can also access it using the keyboard:
150
151 @example
152 M-x pui-list-packages
153 @end example
154
155 The visual package browser will then display a list of all packages.
156 Help information will be displayed at the very bottom of the buffer; you
157 may have to scroll down to see it. You can also press @kbd{?} to get
158 the same help. From this buffer, you can tell the package status by the
159 character in the first column:
160
161 @table @kbd
162 @item -
163 The package has not been installed.
164 @item *
165 The package has been installed, but a newer version is available. The
166 current version is out-of-date.
167 @item +
168 The package has been marked for installation/update.
169 @end table
170
171 If there is no character in the first column, the package has been
172 installed and is up-to-date.
173
174 From here, you can select or unselect packages for installation using
175 the @key{RET} key, or using the @kbd{Mouse-2} or @kbd{Mouse-3} buttons.
176 Once you've finished selecting the packages, you can press the @kbd{x}
177 key to actually install the packages. Note that you will have to
178 restart XEmacs for XEmacs to recognize any new packages.
179
180 Key summary:
181
182 @table @kbd
183 @item ?
184 Display simple help.
185 @item @key{RET}
186 @itemx @key{Mouse-2}
187 @itemx @key{Mouse-3}
188 Toggle between selecting and unselecting a package for installation.
189 @item x
190 Install selected packages.
191 @item @key{SPC}
192 View, in the minibuffer, additional information about the package, such
193 as the package date (not the build date) and the package author. Moving
194 the mouse over a package name will also do the same thing.
195 @item v
196 Toggle between verbose and non-verbose package display.
197 @item g
198 Refresh the package display.
199 @item q
200 Kill the package buffer.
201 @end table
202
203 Moving the mouse over a package will also cause additional information
204 about the package to be displayed in the minibuffer.
205
206 @subsection Other package installation interfaces
207
208 For an alternative package interface, you can select packages from the
209 customize menus, under:
210
211 @example
212 Options->Customize->Emacs->Packages-> ...
213 @end example
214
215 Set their state to on, and then do:
111 216
112 @example 217 @example
113 Options->Customize->Update Packages 218 Options->Customize->Update Packages
114 @end example 219 @end example
115 220
116 This will automatically retrieve the packages you have selected from the 221 This will automatically retrieve the packages you have selected from the
117 XEmacs ftp site and install them into XEmacs. Additionally it will 222 XEmacs ftp site or your local disk, and install them into
118 update any packages you already have installed to the newest version. 223 XEmacs. Additionally it will update any packages you already have
119 Note that if a package is newly installed you will have to restart 224 installed to the newest version. Note that if a package is newly
120 XEmacs for the change to take effect. 225 installed you will have to restart XEmacs for the change to take effect.
226
227 You can also install packages manually, using:
228
229 @example
230 M-x package-get-all <return>
231 @end example
232
233 Enter the name of the package (e.g., @code{prog-modes}), and XEmacs
234 will search for the latest version (as listed in the lisp file
235 @file{lisp/package-get-base.el}), and install it and any packages that
236 it depends upon.
121 237
122 @node Building Packages, , Using Packages, Packages 238 @node Building Packages, , Using Packages, Packages
123 @comment node-name, next, previous, up 239 @comment node-name, next, previous, up
124 240
125 Source packages are available from the @file{source-packages} 241 Source packages are available from the @file{packages/source-packages}
126 subdirectory of your favorite XEmacs distribution site. Alternatively, 242 subdirectory of your favorite XEmacs distribution site. Alternatively,
127 they are available via CVS from @file{cvs.xemacs.org}. Look at 243 they are available via CVS from @file{cvs.xemacs.org}. Look at
128 @file{http://cvs.xemacs.org} for instructions. 244 @file{http://cvs.xemacs.org} for instructions.
129 245
130 @subsection Prerequisites for Building Source Packages 246 @subsection Prerequisites for Building Source Packages