« back to all changes in this revision
Viewing changes to doc/inst_tar.texi
- browse files at revision 3
- compare with another revision
- download diff
- download tarball
- view history from revision 3
- Committer: Bazaar Package Importer
- Author(s): Camm Maguire
- Date: 2004-02-15 20:08:31 UTC
- mfrom: (1.1.1 upstream)
- Revision ID: james.westby@ubuntu.com-20040215200831-7b1g2z10hylgz809
Tags: 5.1.24-6
* Newer standards
* Bug fix: "Half-broken dependency on emacs20", thanks to Martin
Michlmayr (Closes: #232757). replace with emacs21
* Bug fix: "Half-broken dependency on emacs20", thanks to Martin
Michlmayr (Closes: #232757). replace with emacs21
- files added:
- doc/ediff-sas.gif
- doc/html
- info
- xemacs
- files removed:
- doc/ess.info
- files modified:
- ANNOUNCE
added
removed
doc/inst_tar.texi
1
1
2
We now discuss installation, which might happen under Unix or
2
3
Microsoft Windows. First, we discuss Unix installation.
3
4
@xref{Unix installation}.
5
6
For Microsoft Windows Installation please skip to the
6
7
@xref{Microsoft Windows installation}.
7
8
8
@node Unix installation, Microsoft Windows installation, , Top
9
@node Unix installation, Microsoft Windows installation, , Installation
9
10
@comment node-name, next, previous, up
10
11
@section Unix installation
12
11
13
@enumerate
12
@item
13
cd to a directory where you keep emacs lisp files, or create a new
14
directory to hold the distribution. This directory will be referred
15
to below as "the ESS distribution directory". It will contain,
16
at the end, the tar file @file{ess-5.1.20.tar.gz}, and a directory for
17
the ESS source, which will be termed "the ESS-5.1.20 source directory".
18
19
Note that the .elc files may be installed elsewhere (as specified in the
20
Makefile) if desired.
21
@item
22
Retrieve the gzipped tar file or zipped file from
23
http://software.biostat.washington.edu/statsoft/ess/essDL
24
@item
25
Copy @file{ess-5.1.20.tar.gz} to the location where you want the
26
ESS-5.1.20 directory, and cd there. Extract the files from the
27
distribution, which will unpack into a subdirectory, ess-5.1.20.
28
@example
29
gunzip ess-5.1.20.tar.gz
30
tar vxf ess-5.1.20.tar
31
@end example
32
(or: @code{gunzip < ess-5.1.20.tar.gz | tar vxf -} ).
33
(or using GNU tar: @code{tar zvxf ess-5.1.20.tar.gz}).
34
35
36
The @code{tar} command will extract files into the current directory.
37
Do not create ess-5.1.20 yourself, or you will get an extra level of
38
depth to your directory structure.
39
40
Note if you have a very ancient version of GNU emacs (@emph{and} really
41
can not upgrade to Emacs 20 or higher!) you can unpack the
42
@file{lisp/19.29.tar.gz} file, read the ensuing @file{lisp/19.29/README}
43
and you may succeed...
44
45
@item
46
Edit the file @file{lisp/ess-site.el} as explained in the comments
47
section of that file. Installations that are using ESS only for S-Plus
48
6.x will probably not need to make any changes. Installations that also
49
have one or more of (S+5 S4 S+4 S+3 R SAS XLispStat Stata)
50
may need to uncomment corresponding lines in @file{ess-site.el}.
51
@item
52
@b{READ THIS ITEM THOROUGHLY BEFORE STARTING}:
53
54
In the ess-5.1.20 directory, edit the file @file{Makeconf} (only if you
55
want to place the executables in other locations; see LISPDIR and
56
INFODIR) and then type:
57
@example
58
make
59
@end example
60
61
If this works, then you might try:
62
@example
63
make install
64
@end example
65
Note that the latter does the former as well, so if you are feeling
66
lucky, you might want to skip it.
67
68
This will install the info files (and the lisp files, if they are to go
69
in another directory). Don't forget to edit the file @file{dir} in the
70
info directory specified by @code{INFODIR} in @file{doc/Makefile}. See
71
the sample @file{dir} file for an example of the line to add.
72
73
If you are using XEmacs, you might do:
74
@example
75
make EMACS=xemacs
76
@end example
77
78
and then
79
@example
80
make EMACS=xemacs install
81
@end example
82
instead of editing the Makefile.
83
84
@emph{Note} that you might need to use @b{GNU make} for everything to
85
work properly
86
87
An alternative, if you are running XEmacs and have access to the
88
XEmacs system directories, would be to place the directory in the
89
site-lisp directory, and simply type @code{make} (and copy the
90
documentation as appropriate).
91
92
For Emacs, you would still have to move the files into the top level
93
site-lisp directory.
94
@item
95
Add the line
96
@example
97
(load "/PATH/ess-site")
98
@end example
99
to your .emacs file (or default.el or site-init.el, for a site-wide
100
installation). Replace `/PATH' above with the value of
101
ess-lisp-directory as defined in ess-site.el.
102
103
Alternatively, if ess-site.el is in your current Lisp path, you can
104
do:
105
@example
106
(require 'ess-site)
107
@end example
108
to configure Emacs for ESS.
109
@item
110
(OPTIONAL) If you are running S-PLUS or R, you might consider
111
installing the database files. From within (X)Emacs, @code{C-x d} to the
112
directory containing ESS. Now:
113
@example
114
M-x S+6
115
@end example
116
(or @code{M-x S+5}: get running. once you have reached the SPLUS
117
prompt, do:)
118
@example
119
M-x ess-create-object-name-db
120
@end example
121
(this will create the file @file{ess-s+6-namedb.el}; if it isn't in the
122
ESS directory, move it there).
123
124
Then, completions will be autoloaded and will not be regenerated for
125
every session.
126
127
For R, do the same, using
128
@example
129
M-x R
130
@end example
131
and then @code{M-x ess-create-object-name-db} creating
132
@file{ess-r-namedb.el}; if it isn't in the ESS directory, move it there).
133
@item
134
For more information on using ESS in your daily work, see the files
135
README.S, README.SAS, and README.XLispStat.
136
137
For the impatient, the quick version of usage follows:
138
@item
139
To edit statistical programs, load the files with the requiste
140
extensions (".sas" for SAS, ".S" for S-PLUS, ".R" for R, and ".lsp"
141
for XLispStat).
142
@item
143
To run statistical processes under (X)Emacs:
144
145
Run S-PLUS 6.x with:
146
@example
147
M-x S+6
148
@end example
149
(or M-x S using backwards compatibility). You will then be asked
150
for a pathname ("S starting data directory?"), from which to start
151
the process. Similarly for S-PLUS 5.x.
152
153
If you wish to run R, you can start it with:
154
@example
155
M-x R
156
@end example
157
158
XLispStat can be run with
159
@example
160
M-x XLS
161
@end example
162
163
An interactive SAS can be run in an @code{iESS[SAS]} buffer with:
164
@example
165
M-x SAS
166
@end example
167
This works when SAS is running on a Unix machine, either the local
168
machine or over a network connection. M-x SAS does not work when
169
SAS is running on a Windows machine.
170
171
@item
172
That's it!
14
15
@item
16
cd to a directory where you want to install ESS, creating it if necessary.
17
This directory will be referred to below as ESSDIR.
18
@comment It will contain,
19
@comment at the end, the tar file @file{ess-VERSION.tar.gz}, and a directory for
20
@comment the ESS source, which will be termed "the ESS-VERSION source directory".
21
@comment Note that the .elc files may be installed elsewhere (as specified in the
22
@comment Makefile) if desired.
23
24
@item
25
Retrieve the latest version from
26
@uref{http://software.biostat.washington.edu/ess/ess-VERSION.tar.gz, gzipped tar file }
27
to ESSDIR.
28
29
@item
30
Decompress/unarchive the files from the disribution.
31
@example
32
gunzip ess-VERSION.tar.gz
33
tar xvf ess-VERSION.tar
34
@end example
35
@display
36
(or: @code{gunzip < ess-VERSION.tar.gz | tar xvf -} ).
37
(or using GNU tar: @code{tar zxvf ess-VERSION.tar.gz}).
38
@end display
39
40
The @code{tar} command will create the subdirectory ess-VERSION and unarchive
41
the files there.
42
43
If you are using GNU Emacs 19.29, decompress/unarchive
44
@file{ESSDIR/ess-VERSION/lisp/19.29.tar.gz},
45
read @file{ESSDIR/ess-VERSION/lisp/19.29/README}, follow the instructions
46
and you might be able to get ESS to work.
47
@emph{Please note that GNU Emacs 19.29 is no longer supported}.
48
For a list of supported versions of emacs, see @xref{Requirements}.
49
50
@item
51
Edit the file @file{ESSDIR/ess-VERSION/lisp/ess-site.el} as explained in the
52
comments section of that file.
53
@comment Installations that are using ESS only for S-Plus
54
@comment 6.x will probably not need to make any changes. Installations that also
55
@comment have one or more of (S4, S+3/4/5, R, SAS, BUGS, XLispStat, Stata)
56
@comment may need to uncomment corresponding lines in @file{ESSDIR/ess-VERSION/lisp/ess-site.el}.
57
58
@item
59
Add the line
60
@example
61
(load "ESSDIR/ess-VERSION/lisp/ess-site")
62
@end example
63
to your user or system installation file
64
(GNU Emacs uses @file{$HOME/.emacs} and XEmacs uses @file{$HOME/.xemacs/init.el}
65
for the user initialization file. GNU Emacs uses default.el or site-init.el and
66
XEmacs uses site-start.el for the system installation file).
67
68
Alternatively, if ess-site.el is in your current Lisp path, you can do:
69
@example
70
(require 'ess-site)
71
@end example
72
to configure emacs for ESS.
73
74
@item
75
That's it! To edit statistical programs, load the files with the requiste
76
extensions (".sas" for SAS, ".S" for S-PLUS, ".R" for R, and ".lsp"
77
for XLispStat).
78
79
@item
80
(OPTIONAL) If you are running S-PLUS or R, you might consider
81
installing the database files. From within emacs, @code{C-x d} to the
82
directory containing ESS. Now:
83
@example
84
M-x S+6
85
@end example
86
get running. once you have reached the SPLUS
87
prompt, do:
88
@example
89
M-x ess-create-object-name-db
90
@end example
91
(this will create the file @file{ess-s+6-namedb.el}; if it isn't in the
92
ESS directory, move it there).
93
94
Then, completions will be autoloaded and will not be regenerated for
95
every session.
96
97
For R, do the same, using
98
@example
99
M-x R
100
@end example
101
and then @code{M-x ess-create-object-name-db} creating
102
@file{ess-r-namedb.el}; if it isn't in the ESS directory, move it there).
103
104
@item
105
@b{(OPTIONAL) READ THIS ITEM THOROUGHLY BEFORE STARTING}:
106
107
In the ESSDIR/ess-VERSION directory, edit the file @file{Makeconf} if you
108
want to place the compiled files in other locations; see LISPDIR and INFODIR.
109
110
Then type:
111
@example
112
make all
113
@end example
114
115
If this works, then you might try:
116
@example
117
make install
118
@end example
119
120
This will install the info files (and the lisp files, if they are to go
121
in another directory). Don't forget to edit the file @file{dir} in the
122
info directory specified by @code{INFODIR} in @file{doc/Makefile}. See
123
the sample @file{dir} file for an example of the line to add.
124
125
If you are using XEmacs, you might do:
126
@example
127
make EMACS=xemacs all
128
@end example
129
130
and then
131
@example
132
make EMACS=xemacs install
133
@end example
134
instead of editing the Makefile.
135
136
@emph{Note} that you might need to use @b{GNU make} for everything to
137
work properly
138
139
An alternative, if you are running XEmacs and have access to the
140
XEmacs system directories, would be to place the directory in the
141
site-lisp directory, and simply type @code{make all} (and copy the
142
documentation as appropriate).
143
144
For GNU Emacs, you would still have to move the files into the top level
145
site-lisp directory.
146
173
147
@end enumerate
174
148
175
@node Microsoft Windows installation, , Unix installation, Top
149
@node Microsoft Windows installation, Requirements, Unix installation, Installation
176
150
@comment node-name, next, previous, up
177
151
@section Microsoft Windows installation
178
152
182
156
@enumerate
183
157
184
158
@item
185
186
cd to a directory where you keep emacs lisp files, or create a new
187
directory (for example, @file{c:\emacs\}) to hold the distribution. This
188
directory will be referred to below as "the ESS distribution
189
directory". It will contain, at the end, either the tar file
190
@file{ess-5.1.20.tar.gz} or the zip file @file{ess-5.1.20.zip}, and a
191
directory
192
for the ESS source, which will be termed "the ESS-5.1.20 source
193
directory".
194
195
@item
196
197
Retrieve the compressed tar file @file{ess-5.1.20.tar.gz} or the
198
zipped file @file{ess-5.1.20.zip} from one of the FTP or WWW
199
archive sites
200
via FTP (or HTTP). Be aware that http browsers on Windows
201
frequently change the "." and "-" characters in filenames to other
202
punctuation. Please change the names back to their original form.
203
204
@item
205
206
Copy @file{ess-5.1.20.tar.gz} to the location where you want the
207
ess-5.1.20 directory, for example to
208
@file{c:\emacs\ess-5.1.20.tar.gz}, and cd there. For example,
209
210
@example
211
cd c:\emacs
212
@end example
213
214
Extract the files from the distribution, which will unpack
215
into a subdirectory, @file{ess-5.1.20}.
216
@example
217
gunzip ess-5.1.20.tar.gz
218
tar vxf ess-5.1.20.tar
219
@end example
220
(or: @code{gunzip < ess-5.1.20.tar.gz | tar vxf -} ).
221
(or: from the zip file: @code{unzip ess-5.1.20.zip})
222
223
The @code{tar} command will extract files into the current directory.
224
225
Do not create @file{ess-5.1.20} yourself, or you will get an extra level
226
of depth to your directory structure.
227
228
@item
229
Windows users will usually be able to use the `lisp/ess-site.el'
230
as distributed. Only rarely will changes be needed.
231
@item
232
233
Windows users will need to make sure that the directories for the
234
software they will be using is in the PATH environment variable. On
235
Windows 9x, add lines similar to the following to your
236
@file{c:\autoexec.bat}
237
file:
238
@example
239
path=%PATH%;c:\progra~1\spls2000\cmd
240
@end example
241
On Windows NT/2000, add the directories to the PATH using the
242
MyComputer menu. Note that the directory containing the program is
243
added to the PATH, not the program itself. One such line is needed
244
for each software program. Be sure to use the abbreviation
245
@code{progra~1} and not the long version with embedded blanks. Use
246
backslashes "\".
247
248
@item
249
250
Add the line
251
@example
252
(load "/PATH/ess-site")
253
@end example
254
to your .emacs (or _emacs) file (or default.el or site-init.el, for
255
a site-wide installation). Replace @code{/PATH} above with the
256
value of ess-lisp-directory as defined in @file{ess-site.el}. Use
257
forwardslashes @code{/}.
258
259
@item
260
261
(OPTIONAL) If you are running Sqpe or R, you might consider
262
installing the database files. From within (X)Emacs, @code{C-x d} to
263
the directory containing ESS. Now:
264
@example
265
M-x Sqpe+6
266
@end example
267
(get running. once you have reached the SPLUS prompt, do:)
268
@example
269
M-x ess-create-object-name-db
270
@end example
271
(this will create the file @file{ess-s+6-namedb.el}; if it isn't in the
272
ESS directory, move it there).
273
274
Then, completions will be autoloaded and will not be regenerated
275
for every session.
276
277
For R, do the same, using
278
@example
279
M-x R
280
@end example
281
and then @code{M-x ess-create-object-name-db} creating
282
@file{ess-r-namedb.el}; if it isn't in the ESS directory, move it
283
there).
284
285
@item
286
287
For more information on using ESS in your daily work, see the
288
files doc/README.SPLUS4WIN, doc/README.S, doc/README.SAS, and
289
doc/README.XLispStat.
290
291
For the impatient, the quick version of usage follows:
292
@item
293
294
To edit statistical programs, load the files with the requisite
295
extensions (".sas" for SAS, ".S" or "s" or "q" or "Q" for S-PLUS,
296
".r" or ".R" for R, and ".lsp" for XLispStat).
297
@item
298
299
To run statistical processes under (X)Emacs:
300
301
Run S-PLUS 6.x or 2000 with:
302
@example
303
M-x S+6
304
@end example
305
(or @code{M-x S}). You will then be
306
asked for a pathname ("S starting data directory?"), from which to
307
start the process. The prompt will propose your current directory
308
as the default. Similarly for S-PLUS 6.x. Send lines or regions
309
from the emacs buffer containing your S program (for example,
310
@file{myfile.s}) to the S-Plus Commands Window with the
311
@code{C-c C-n} or @code{C-c C-r} keys.
312
313
Run S-PLUS 6.x or 2000 inside an emacs buffer
314
@example
315
M-x Sqpe+6
316
@end example
317
You will then be asked for a pathname ("S starting data
318
directory?"), from which to start the process. The prompt will
319
propose your current directory as the default. Similarly for S-PLUS
320
6.x. Send lines or regions from the emacs buffer containing your S
321
program (for example, @file{myfile.s}) to the *S+6* buffer with the
322
@code{C-c C-n} or @code{C-c C-r} keys. You do not have access to
323
interactive graphics in
324
this mode. You get Unix-like behavior, in particular the entire
325
transcript is available for emacs-style search commands.
326
327
If you wish to run R, you can start it with:
328
@example
329
M-x R
330
@end example
331
332
XLispStat can not currently be run with
333
@example
334
M-x XLS
335
@end example
336
Hopefully, this will change. However, you can still edit with
337
Emacs, and cut and paste the results into the XLispStat
338
*Listener* Window under Microsoft Windows.
339
340
SAS for Windows uses the batch access with function keys that is
341
described in @file{doc/README.SAS}. The user can also edit SAS files
342
in an @code{ESS[SAS]} buffer and than manually copy and paste them into
343
an Editor window in the SAS Display Manager.
344
345
For Windows, inferior SAS in an @code{iESS[SAS]} buffer does not work
346
on the local machine. It does work over a network connection to
347
SAS running on a remote Unix computer.
348
349
Reason: we use ddeclient to interface with programs and SAS doesn't
350
provide the corresponding ddeserver capability.
159
cd to a directory where you keep emacs lisp files, or create a new
160
directory (for example, @file{c:\emacs\}) to hold the distribution. This
161
directory will be referred to below as "the ESS distribution
162
directory". It will contain, at the end, either the tar file
163
@file{ess-VERSION.tar.gz} or the zip file @file{ess-VERSION.zip}, and a
164
directory
165
for the ESS source, which will be termed "the ESS-VERSION source
166
directory".
167
168
@item
169
Retrieve the compressed tar file @file{ess-VERSION.tar.gz} or the
170
zipped file @file{ess-VERSION.zip} from one of the FTP or WWW
171
archive sites
172
via FTP (or HTTP). Be aware that http browsers on Windows
173
frequently change the "." and "-" characters in filenames to other
174
punctuation. Please change the names back to their original form.
175
176
@item
177
Copy @file{ess-VERSION.tar.gz} to the location where you want the
178
ess-VERSION directory, for example to
179
@file{c:\emacs\ess-VERSION.tar.gz}, and cd there. For example,
180
181
@example
182
cd c:\emacs
183
@end example
184
185
Extract the files from the distribution, which will unpack
186
into a subdirectory, @file{ess-VERSION}.
187
@example
188
gunzip ess-VERSION.tar.gz
189
tar xvf ess-VERSION.tar
190
(or: @code{gunzip < ess-VERSION.tar.gz | tar xvf -} ).
191
(or: from the zip file: @code{unzip ess-VERSION.zip})
192
@end example
193
194
The @code{tar} command will extract files into the current directory.
195
196
Do not create @file{ess-VERSION} yourself, or you will get an extra level
197
of depth to your directory structure.
198
199
@item
200
Windows users will usually be able to use the `lisp/ess-site.el'
201
as distributed. Only rarely will changes be needed.
202
203
@item
204
Windows users will need to make sure that the directories for the
205
software they will be using is in the PATH environment variable. On
206
Windows 9x, add lines similar to the following to your
207
@file{c:\autoexec.bat}
208
file:
209
@example
210
path=%PATH%;c:\progra~1\spls2000\cmd
211
@end example
212
On Windows NT/2000, add the directories to the PATH using the
213
MyComputer menu. Note that the directory containing the program is
214
added to the PATH, not the program itself. One such line is needed
215
for each software program. Be sure to use the abbreviation
216
@code{progra~1} and not the long version with embedded blanks. Use
217
backslashes "\".
218
219
@item
220
Add the line
221
@example
222
(load "/PATH/ess-site")
223
@end example
224
to your .emacs (or _emacs) file (or default.el or site-init.el, for
225
a site-wide installation). Replace @code{/PATH} above with the
226
value of ess-lisp-directory as defined in @file{ess-site.el}. Use
227
forwardslashes @code{/}.
228
(GNU Emacs uses the filename @file{%HOME%/.emacs} and
229
XEmacs uses the filename @file{%HOME%/.xemacs/init.el}
230
for the initialization file.)
231
232
@item
233
To edit statistical programs, load the files with the requisite
234
extensions (".sas" for SAS, ".S" or "s" or "q" or "Q" for S-PLUS,
235
".r" or ".R" for R, and ".lsp" for XLispStat).
236
237
@item
238
To run statistical processes under emacs:
239
240
Run S-PLUS 6.x or 2000 with:
241
@example
242
M-x S+6
243
(or @code{M-x S}).
244
@end example
245
You will then be
246
asked for a pathname ("S starting data directory?"), from which to
247
start the process. The prompt will propose your current directory
248
as the default. Similarly for S-PLUS 6.x. Send lines or regions
249
from the emacs buffer containing your S program (for example,
250
@file{myfile.s}) to the S-Plus Commands Window with the
251
@code{C-c C-n} or @code{C-c C-r} keys.
252
253
Run S-PLUS 6.x or 2000 inside an emacs buffer
254
@example
255
M-x Sqpe+6
256
@end example
257
You will then be asked for a pathname ("S starting data
258
directory?"), from which to start the process. The prompt will
259
propose your current directory as the default. Similarly for S-PLUS
260
6.x. Send lines or regions from the emacs buffer containing your S
261
program (for example, @file{myfile.s}) to the *S+6* buffer with the
262
@code{C-c C-n} or @code{C-c C-r} keys. You do not have access to
263
interactive graphics in
264
this mode. You get Unix-like behavior, in particular the entire
265
transcript is available for emacs-style search commands.
266
267
If you wish to run R, you can start it with:
268
@example
269
M-x R
270
@end example
271
272
XLispStat can not currently be run with
273
@example
274
M-x XLS
275
@end example
276
Hopefully, this will change. However, you can still edit with
277
emacs, and cut and paste the results into the XLispStat
278
*Listener* Window under Microsoft Windows.
279
280
SAS for Windows uses the batch access with function keys that is
281
described in @file{doc/README.SAS}. The user can also edit SAS files
282
in an @code{ESS[SAS]} buffer and than manually copy and paste them into
283
an Editor window in the SAS Display Manager.
284
285
For Windows, inferior SAS in an @code{iESS[SAS]} buffer does not work
286
on the local machine. It does work over a network connection to
287
SAS running on a remote Unix computer.
288
289
Reason: we use ddeclient to interface with programs and SAS doesn't
290
provide the corresponding ddeserver capability.
291
292
@item
293
(OPTIONAL) If you are running Sqpe or R, you might consider
294
installing the database files. From within emacs, @code{C-x d} to
295
the directory containing ESS. Now:
296
@example
297
M-x Sqpe+6
298
@end example
299
(get running. once you have reached the SPLUS prompt, do:)
300
@example
301
M-x ess-create-object-name-db
302
@end example
303
(this will create the file @file{ess-s+6-namedb.el}; if it isn't in the
304
ESS directory, move it there).
305
306
Then, completions will be autoloaded and will not be regenerated
307
for every session.
308
309
For R, do the same, using
310
@example
311
M-x R
312
@end example
313
and then @code{M-x ess-create-object-name-db} creating
314
@file{ess-r-namedb.el}; if it isn't in the ESS directory, move it
315
there).
351
316
352
317
@item That's it!
353
318
354
319
@end enumerate
320
321
@node Requirements, , Microsoft Windows installation, Installation
322
@comment node-name, next, previous, up
323
@section Requirements
324
@include requires.texi
Loggerhead is a web-based interface for Breezy
Version: 2.0.1