~ubuntu-branches/ubuntu/edgy/ess/edgy

« back to all changes in this revision

Viewing changes to doc/inst_tar.texi

  • Committer: Bazaar Package Importer
  • Author(s): Camm Maguire
  • Date: 2005-11-22 23:13:20 UTC
  • mfrom: (1.2.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20051122231320-giy26j49ahtzw6l4
Tags: 5.2.11-1
* New upstream release
* Newer standards

Show diffs side-by-side

added added

removed removed

Lines of Context:
13
13
@enumerate
14
14
 
15
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.
 
16
@code{cd} to a directory where you want to install ESS, creating it if necessary.
 
17
This directory will be referred to below as @file{ESSDIR}.
18
18
@comment It will contain,
19
19
@comment at the end, the tar file @file{ess-VERSION.tar.gz}, and a directory for
20
20
@comment the ESS source, which will be termed "the ESS-VERSION source directory".
24
24
@item
25
25
Retrieve the latest version from
26
26
@uref{http://ess.r-project.org/downloads/ess, ESS downloads area}
27
 
to ESSDIR.
 
27
to @file{ESSDIR}.
28
28
 
29
29
@item
30
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
31
@display
36
 
(or: @code{gunzip < ess-VERSION.tar.gz | tar xvf -} ).
37
 
(or using GNU tar:  @code{tar zxvf ess-VERSION.tar.gz}).
 
32
Either, @code{gunzip < ess-VERSION.tar.gz | tar xf -},
 
33
or using GNU tar, @code{tar zxf ess-VERSION.tar.gz}.
38
34
@end display
39
35
 
40
 
The @code{tar} command will create the subdirectory ess-VERSION and unarchive
 
36
The @code{tar} command will create the subdirectory @file{ess-VERSION} and install
41
37
the files there.
42
38
 
43
39
@comment If you are using GNU Emacs 19.29, decompress/unarchive
60
56
@example
61
57
(load "ESSDIR/ess-VERSION/lisp/ess-site")
62
58
@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).
 
59
to your user or system installation file (GNU Emacs uses
 
60
@file{$HOME/.emacs} and XEmacs uses @file{$HOME/.xemacs/init.el} for the
 
61
user initialization file.  GNU Emacs uses @file{default.el} or
 
62
@file{site-init.el} and XEmacs uses @file{site-start.el} for the system
 
63
installation file).
67
64
 
68
 
Alternatively, if ess-site.el is in your current Lisp path, you can do:
 
65
Alternatively, if @file{ess-site.el} is in your current @code{load-path}, then:
69
66
@example
70
67
(require 'ess-site)
71
68
@end example
73
70
 
74
71
@item
75
72
That's it!  If you are installing just a local copy of ESS for yourself,
76
 
ESS is now ready to be used.  (The remaining step below is for
77
 
advanced installation.)  To edit statistical programs, load the files
78
 
with the requiste extensions (".sas" for SAS, ".S" for S-PLUS, ".R" for
79
 
R, and ".lsp" for XLispStat).  To start a statistical process within
80
 
Emacs, such as R, type @code{M-x R}.
 
73
ESS is now ready to be used.  (The remaining step below is for advanced
 
74
installation.)  To edit statistical programs, load the files with the
 
75
requiste extensions (@file{.sas} for SAS, @file{.S} for S-PLUS,
 
76
@file{.R} for R, and @file{.lsp} for XLispStat).  To start a statistical
 
77
process within emacs, such as R, type @code{M-x R}.
81
78
 
82
79
@c @item
83
80
@c (OPTIONAL) If you are running S-PLUS or R, you might consider
106
103
@item
107
104
@b{(OPTIONAL) READ THIS ITEM THOROUGHLY BEFORE STARTING}:
108
105
 
109
 
If you want to place the compiled files in other locations edit the LISPDIR and INFODIR
110
 
entries in @file{Makeconf} in the ESSDIR/ess-VERSION directory (if you are using XEmacs,
111
 
then you also need to edit the EMACS entry as follows:  EMACS=xemacs).
 
106
If you want to place the compiled files in other locations edit the
 
107
@code{LISPDIR}, @code{INFODIR} and @code{ETCDIR} entries in Section 1 of
 
108
@file{Makeconf} in the @file{ESSDIR/ess-VERSION} directory (if you are
 
109
using XEmacs, then see the XEmacs subsection in Section 1 of @file{Makeconf}).
112
110
 
113
111
You can compile those files by:
114
112
@example
120
118
make install
121
119
@end example
122
120
 
123
 
This will install the compiled info files and lisp files.  If you are an
124
 
XEmacs user, then you should be done.  If not, then you may have to
125
 
edit/create the file @file{dir} that is found in the directory specified
126
 
by @code{INFODIR}: see the sample @file{dir} in ESSDIR/ess-VERSION/doc/info.
127
 
If @file{dir} does not exist in @code{INFODIR}, then the sample
128
 
@file{dir} will be installed.
 
121
@c This will install the compiled info files and lisp files.  If you are an
 
122
@c XEmacs user, then you should be done.  If not, then you may have to
 
123
@c edit/create the file @file{dir} that is found in the directory specified
 
124
@c by @code{INFODIR}: see the sample @file{dir} in ESSDIR/ess-VERSION/doc/info.
 
125
@c If @file{dir} does not exist in @code{INFODIR}, then the sample
 
126
@c @file{dir} will be installed.
129
127
 
130
 
@emph{Note:} ESS can be installed for XEmacs as an XEmacs package
131
 
much more easily than what has been described anywhere above.  However,
132
 
the latest ESS version will not be available at the same time as an
133
 
XEmacs package; generally, it can take weeks or months to appear in the
134
 
latter format.  For more information on installing ESS as an XEmacs
135
 
package see @uref{http://www.xemacs.org/Documentation/packageGuide.html, Quickstart Package Guide}.
 
128
@emph{Note:} ESS is no longer available as an XEmacs package.  However,
 
129
ESS will work best if the XEmacs sumo tarball (all XEmacs packages combined)
 
130
has been installed.  For more information on installing XEmacs packages, see 
 
131
@uref{http://www.xemacs.org/Documentation/packageGuide.html, Quickstart Package Guide}.
136
132
 
137
133
@comment An alternative, if you are running XEmacs and have access to the
138
134
@comment XEmacs system directories, would be to place the directory in the
156
152
@enumerate
157
153
 
158
154
@item
159
 
cd to a directory where you keep emacs lisp files, or create a new
 
155
@code{cd} to a directory where you keep emacs lisp files, or create a new
160
156
directory (for example, @file{c:\emacs\}) to hold the distribution.  This
161
157
directory will be referred to below as "the ESS distribution
162
158
directory".  It will contain, at the end, either the tar file
186
182
into a subdirectory, @file{ess-VERSION}.
187
183
@example
188
184
gunzip ess-VERSION.tar.gz
189
 
tar xvf ess-VERSION.tar
190
 
(or: @code{gunzip < ess-VERSION.tar.gz | tar xvf -} ).
 
185
tar xf ess-VERSION.tar
 
186
(or: @code{gunzip < ess-VERSION.tar.gz | tar xf -} ).
191
187
(or: from the zip file: @code{unzip ess-VERSION.zip})
192
188
@end example
193
189
 
319
315
@comment in an @code{ESS[SAS]} buffer and than manually copy and paste them into
320
316
@comment an Editor window in the SAS Display Manager.
321
317
@comment
322
 
@comment For Windows, inferior SAS in an @code{iESS[SAS]} buffer does not work
 
318
@comment For Windows, inferior SAS in an @code{@iESS{[SAS]}} buffer does not work
323
319
@comment on the local machine.  It does work over a network connection to
324
320
@comment SAS running on a remote Unix computer.
325
321
@comment