Mercurial > hg > xemacs-beta

comparison man/xemacs/packages.texi @ 306:9ea74add5d37 r21-0b51

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r21-0b51
author cvs
date Mon, 13 Aug 2007 10:41:58 +0200
parents 5a79be0ef6a8
children 341dac730539
comparison
equal deleted inserted replaced
305:18920a7e9a86 306:9ea74add5d37
1 @node Packages, Abbrevs, Running, Top 1 @node Packages, Abbrevs, Running, Top
2 @comment node-name, next, previous, up 2 @comment node-name, next, previous, up
3 3
4 @section Introduction to XEmacs 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 separately
10 available. 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
16 * Package Terminology:: Understanding different kinds of packages.
17 * Using Packages:: How to install and use packages.
18 * Building Packages:: Building packages from sources.
19 @end menu
20
21 @node Package Terminology, Using Packages, , Packages
22 @comment node-name, next, previous, up
23
15 @subsection Package Flavors 24 @subsection Package Flavors
16 25
17 There are two main flavors of packages. 26 There are two main flavors of packages.
18 27
19 @itemize @emph 28 @itemize @bullet
20 @item Regular Packages 29 @item Regular Packages
30 @cindex regular packages
21 A regular package is one in which multiple files are involved and one 31 A regular package is one in which multiple files are involved and one
22 may not in general safely remove any of them. 32 may not in general safely remove any of them.
23 33
24 @item Single-File Packages 34 @item Single-File Packages
35 @cindex single-file packages
25 A single-file package is an aggregate collection of thematically 36 A single-file package is an aggregate collection of thematically
26 related but otherwise independent lisp files. These files are bundled 37 related but otherwise independent lisp files. These files are bundled
27 together for download convenience and individual files may deleted at 38 together for download convenience and individual files may deleted at
28 will without any loss of functionality. 39 will without any loss of functionality.
29 @end itemize 40 @end itemize
35 be installed directly into an XEmacs package directory. Source Packages 46 be installed directly into an XEmacs package directory. Source Packages
36 are for developers and include all files necessary for rebuilding 47 are for developers and include all files necessary for rebuilding
37 bytecompiled lisp and creating tarballs for distribution. 48 bytecompiled lisp and creating tarballs for distribution.
38 49
39 @subsection Binary Packages 50 @subsection Binary Packages
51 @cindex binary packages
40 Binary packages may be installed directly into an XEmacs package 52 Binary packages may be installed directly into an XEmacs package
41 hierarchy. 53 hierarchy.
42 54
43 @subsection Source Packages 55 @subsection Source Packages
44 56 @cindex source packages
45 Source packages contain all of the Package author's (where appropriate 57 Source packages contain all of the Package author's (where appropriate
46 in regular packages) source code plus all of the files necessary to 58 in regular packages) source code plus all of the files necessary to
47 build distribution tarballs (Unix Tar format files and gzipped for space 59 build distribution tarballs (Unix Tar format files and gzipped for space
48 savings). 60 savings).
49 61
50 @subsection Prerequisites for building Source Packages 62 @node Using Packages, Building Packages, Package Terminology, Packages
63 @comment node-name, next, previous, up
64
65 @subsection Getting Started
66
67 When you first download XEmacs 21, you will usually first grab the
68 @dfn{core distribution},
69 @cindex core distribution
70 a file called
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
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
75 distributed with XEmacs.
76
77 @subsection Choosing the Packages You Need
78
79 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 subdirectory @file{binary-packages}. Package file names follow the
82 naming convention @file{<package-name>-<version>-pkg.tar.gz}.
83
84 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
86 also listed on the @code{Options} menu under:
87
88 @example
89 Options->Customize->Emacs->Packages
90 @end example
91
92 If you have EFS @ref{(EFS)}, installed and configured packages can be
93 installed completely from the menubar.
94
95 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
97 users.
98
99 @subsection Installing packages and XEmacs
100
101 The easiest and most correct way to install a package is to do:
102
103 @example
104 M-x package-admin-add-binary-package <return>
105 @end example
106
107 input the location of the package tarball and XEmacs will do the rest
108 for you. If you have the EFS package installed and configured you can
109 select package from the customize menu, set their state to on and then
110 do:
111
112 @example
113 Options->Customize->Update Packages
114 @end example
115
116 This will automatically retrieve the packages you have selected from the
117 XEmacs ftp site and install them into XEmacs. Additionally it will
118 update any packages you already have installed to the newest version.
119 Note that if a package is newly installed you will have to restart
120 XEmacs for the change to take effect.
121
122 @node Building Packages, , Using Packages, Packages
123 @comment node-name, next, previous, up
124
125 Source packages are available from the @file{source-packages}
126 subdirectory of your favorite XEmacs distribution site. Alternatively,
127 they are available via CVS from @file{cvs.xemacs.org}. Look at
128 @file{http://cvs.xemacs.org} for instructions.
129
130 @subsection Prerequisites for Building Source Packages
51 131
52 You must have GNU @code{cp}, GNU @code{install} (or a BSD compatible 132 You must have GNU @code{cp}, GNU @code{install} (or a BSD compatible
53 @code{install} program) GNU @code{make} (3.75 or later preferred), 133 @code{install} program) GNU @code{make} (3.75 or later preferred),
54 @code{makeinfo} (1.68 from @code{texinfo-3.11} or later required), GNU 134 @code{makeinfo} (1.68 from @code{texinfo-3.11} or later required), GNU
55 @code{tar} and XEmacs 21.0. The source packages will untar into a 135 @code{tar} and XEmacs 21.0. The source packages will untar into a
56 correct directory structure. At the top level you must have 136 correct directory structure. At the top level you must have
57 @file{XEmacs.rules} and @file{package-compile.el}. These files are 137 @file{XEmacs.rules} and @file{package-compile.el}. These files are
58 available from the XEmacs FTP site from the same place you obtained your 138 available from the XEmacs FTP site from the same place you obtained your
59 source package distributions. 139 source package distributions.
60 140
61 @subsection What you can do with Source Packages 141 @subsection What You Can Do With Source Packages
62 142
63 NB: A global build operation doesn't exist yet as of 13 January 1998. 143 NB: A global build operation doesn't exist yet as of 13 January 1998.
64 144
65 Source packages are most useful for creating XEmacs package tarballs 145 Source packages are most useful for creating XEmacs package tarballs
66 for installation into your own XEmacs installations or for 146 for installation into your own XEmacs installations or for
67 distributing to others. 147 distributing to others.
68 148
69 Supported operations from Make are: 149 Supported operations from @file{make} are:
70 150
71 @table @code 151 @table @code
72 @item clean 152 @item clean
73 Remove all built files except @file{auto-autoloads.el} and @file{custom-load.el}. 153 Remove all built files except @file{auto-autoloads.el} and @file{custom-load.el}.
74 154