Skip to content
Browse files

Add info on compilation/installation of DVI, info and PDF manuals.

git-svn-id: https://svn.r-project.org/R/trunk@7637 00db46b3-68df-0310-9c12-caf00c1e9a41
  • Loading branch information...
1 parent e9c25f3 commit f9f3206aae71021777656eda4a6b0929a4aaca2b hornik committed Jan 18, 2000
Showing with 82 additions and 68 deletions.
  1. +82 −68 INSTALL
View
150 INSTALL
@@ -4,78 +4,78 @@
GENERALITIES
-This document concerns building and installing R from sources.
-Pre-made binaries are made available for some systems with varying
-regularity and can be obtained from CRAN (see the RESOURCES file).
+This document concerns building and installing R from sources. Pre-made
+binaries are made available for some systems with varying regularity and
+can be obtained from CRAN (see the RESOURCES file).
-R will configure and build under a number of common Unix-like
-platforms (including i386-freebsd, i386-linux, ppc-linux,
-mips-sgi-irix, alpha-linux, alpha-dec-osf4, rs6000-ibm-aix,
-hppa-hp-hpux, sparc-linux, and sparc-sun-solaris) and on Windows 9x/NT
-(see src/gnuwin32/readme). In general it is relatively easy to adapt
-R to new platforms. See the section on new platforms for details.
+R will configure and build under a number of common Unix-like platforms
+(including i386-freebsd, i386-linux, ppc-linux, mips-sgi-irix,
+alpha-linux, alpha-dec-osf4, rs6000-ibm-aix, hppa-hp-hpux, sparc-linux,
+and sparc-sun-solaris) and on Windows 9x/NT (see `src/gnuwin32/readme').
+In general it is relatively easy to adapt R to new platforms. See the
+section on new platforms for details.
GETTING AND UNPACKING THE SOURCES
-The simplest way is to download the most recent R-x.yy.z.tgz package,
-and unpack them with
+The simplest way is to download the most recent R-x.y.z.tgz package, and
+unpack them with
- tar xvfz R-x.yy.z.tgz
+ tar xvfz R-x.y.z.tgz
-on systems that have GNU tar installed. On other systems you need at
-least to have the "gzip" program installed. Then you can do
+on systems that have GNU tar installed. On other systems you need at
+least to have the "gzip" program installed. Then you can do
- gzip -dc R-x.yy.z.tgz | tar xvf -
+ gzip -dc R-x.y.z.tgz | tar xvf -
-If you need to transport the sources on floppy disks, you can download the
-R-x.yy.z.tgz-split.* files. and paste them together at the destination
+If you need to transport the sources on floppy disks, you can download
+the R-x.y.z.tgz-split.* files and paste them together at the destination
with
- cat R-x.yy.z.tgz-split.* > R-x.yy.z.tgz
+ cat R-x.y.z.tgz-split.* > R-x.y.z.tgz
and proceed as above.
-Finally, for minor-minor releases (x.yy.z with z != 0), a patch
-against the preceding release is made available in
-R-x.yy.{z-1}-x.yy.z.diff.gz (e.g. R-0.63.2-0.63.3.diff.gz), which is
-generally a much shorter file that the .tgz files. Such a file can be
-applied to the sources of the previous version by changing to the top
-directory of it and
+Finally, for minor-minor releases (x.y.z with z != 0), a patch against
+the preceding release is made available in R-x.y.{z-1}-x.y.z.diff.gz
+(e.g., R-0.63.2-0.63.3.diff.gz), which is generally a much shorter file
+that the .tgz files. Such a file can be applied to the sources of the
+previous version by changing to the top directory of it and
- gzip -dc /path/to/it/R-x.yy.{z-1}-x.yy.z.diff.gz | patch -E -p1
+ gzip -dc /path/to/it/R-x.y.{z-1}-x.y.z.diff.gz | patch -E -p1
Notice that this does not necessarily work if the older sources have
-been modified (e.g. by building in their directories).
+been modified (e.g., by building in their directories).
SIMPLE COMPILATION
Choose a place to install the R tree (R is not just a binary, but has
additional data sets, help files, font metrics etc). Let's call this
-place RHOME. Untar the source code. This should create directories
-src, etc, cmd, help and doc. Issue the following commands:
+place R_HOME. Untar the source code. This should create directories
+src, doc, and several more. Issue the following commands:
./configure
make
If these commands execute successfully, the R binary will be copied to
-the `$RHOME/bin' directory. In addition, a shell script font-end
+the `${R_HOME}/bin' directory. In addition, a shell script front-end
called "R" will be created and copied to the same directory. You can
copy this script to a place where users can invoke it, for example to
`/usr/local/bin/R'. You could also copy the man page `R.1' to a place
-where your man reader finds it, such as `/usr/local/man/man1'. If you
-want to install the complete R tree to, e.g., /usr/local/lib/R, see
+where your man reader finds it, such as `/usr/local/man/man1'. If you
+want to install the complete R tree to, e.g., `/usr/local/share/R', see
section INSTALLATION below.
-You do not necessarily have to build R in the top-level source
-directory (say, TOP_SRCDIR). To build in BUILDDIR, cd there and run
+You do not necessarily have to build R in the top-level source directory
+(say, TOP_SRCDIR). To build in BUILDDIR, cd there and run
TOP_SRCDIR/configure
make
and so on, as described further below. This has the advantage of always
-keeping your source tree `clean'. (You may need GNU make to allow this.)
+keeping your source tree `clean'. (You may need GNU make to allow
+this.)
If you need or want to set certain configure variables to something
other than their default, you can do that by either editing the file
@@ -87,7 +87,7 @@ other than their default, you can do that by either editing the file
One common variable to change is R_PAPERSIZE, which defaults to a4, not
letter.
-If you have libraries and header files, e.g. for GNU readline, in
+If you have libraries and header files, e.g., for GNU readline, in
non-system directories, use the variables LIBS (for libraries) and
CPPFLAGS (for header files), respectively, to specify these locations.
@@ -96,19 +96,30 @@ that some settings are cached in the file config.cache, and it is a
good idea to remove that file before re-configuring.
Make will also build plain text help pages as well as HTML and LaTeX
-versions of the documentation (the three kinds can also be generated
-separately using make help, make html and make latex). Note that you need
-Perl version 5, available via http://www.perl.com/CPAN/, to build the
-documentation.
-If this is not available on your system, you can obtain PDF versions
-of the documentation files via the Comprehensive R Archive Network
-(CRAN), see the file `RESOURCES' for information on CRAN.
-
-Now rehash if necessary, type `R' and reach for your S manuals ...
-And, read the R FAQ (http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html).
-
-The GNOME interface for R will only be built if you specify it:
-see the GNOME section below.
+versions of the R object documentation (the three kinds can also be
+generated separately using make help, make html and make latex). Note
+that you need Perl version 5, available via http://www.perl.com/CPAN/,
+to build this documentation. If this is not available on your system,
+you can obtain PDF versions of the documentation files via the
+Comprehensive R Archive Network (CRAN), see the file `RESOURCES' for
+information on CRAN.
+
+Use `make dvi' to create dvi versions of the R manuals, such as
+`refman.dvi' (an R object reference index) and `R-exts.dvi', the "R
+Extension Writers Guide", in the `doc/manual' subdirectory. These files
+can be previewed and printed using standard programs such as `xdvi' and
+`dvips'. You can also use `make pdf' to build PDF (Portable Document
+Format) version of the manuals, and view these using Acrobat. Manuals
+written in the GNU Texinfo system can also be converted to info files
+suitable for reading online with Emacs or standalone GNU Info; use `make
+info' to create these versions (note that this requires `makeinfo'
+version 4).
+
+Now rehash if necessary, type `R', and read the R manuals and the R FAQ
+(http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html).
+
+The GNOME interface for R will only be built if you specify it: see the
+GNOME section below.
INSTALLATION
@@ -125,19 +136,22 @@ to your system by typing
This will install to the following directories:
- $prefix/bin (some) executables
- $prefix/man/man1 man pages
- $prefix/lib/R all the rest (libraries, online help
+ ${prefix}/bin the front-end shell script
+ ${prefix}/man/man1 the man page
+ ${prefix}/share/R all the rest (libraries, on-line help
system, ...)
-where prefix is determined during configuration (typically /usr/local)
+where prefix is determined during configuration (typically `/usr/local')
and can be set by running configure with the option
./configure --prefix=/where/you/want/R/to/go
-Then the R executable will be installed in /where/you/want/R/to/go/bin,
-and so on. The prefix of the installation directories can also be seen
-in the status message that is displayed at the end of configure.
+This installs the R executable to `/where/you/want/R/to/go/bin', and so
+on. The prefix of the installation directories can also be seen in the
+status message that is displayed at the end of configure.
+
+To install dvi, info and PDF versions of the manuals, use `make
+install-dvi', `make install-info' and `make install-pdf', respectively.
USING MAKE
@@ -158,7 +172,7 @@ converter. The default is to search for f77, g77, fort77, f90, xlf,
cf77, and fc (in that order), and then for f2c, and use whichever is
found first; if none is found, R cannot be compiled. The search
mechanism can be changed using the `--with-g77', `--with-f77', and
-`--with-f2c' command line options to configure. If your FORTRAN
+`--with-f2c' command line options to configure. If your FORTRAN
compiler is in a non-standard location, you should set the enviroment
variable PATH accordingly before running configure.
@@ -168,7 +182,7 @@ path.
You must set whatever compilation flags (if any) are needed to ensure
that FORTRAN `integer' is equivalent to a C int pointer and FORTRAN
-`double precision' is equivalent to a C double pointer. This is checked
+`double precision' is equivalent to a C double pointer. This is checked
during the configuration process.
@@ -179,14 +193,14 @@ information on the GNOME interface and upcoming features, see
http://stat.auckland.ac.nz/~lyndon/roadmap.html.
The GNOME interface for R will only be built if you specify it by
-running configure with the --with-gnome option. For example, you
-might run
+running configure with the --with-gnome option. For example, you might
+run
./configure --with-gnome
-but please check you have all the requirements first. It is advisable to
-have reasonably-up-to-date versions of the gnome and gtk+ libraries
-(later than those in RedHat 6.0, for example). You can find the
+but please check you have all the requirements first. It is advisable
+to have reasonably-up-to-date versions of the gnome and gtk+ libraries
+(later than those in RedHat 6.0, for example). You can find the
versions you have by
gnome-config --version
@@ -206,14 +220,14 @@ installed:
You will need also libglade 0.5 or later for correct behaviour. For
more information on libglade and to download the source, see
-http://www.daa.com.au/~james/gnome/. The sources are also available
-from the GNOME ftp site (ftp.gnome.org and mirrors). RPMs are in
-RedHat 6.1 and are available from rawhide.redhat.com.
+http://www.daa.com.au/~james/gnome/. The sources are also available
+from the GNOME ftp site (ftp.gnome.org and mirrors). RPMs are in RedHat
+6.1 and are available from rawhide.redhat.com.
libglade needs libxml 1.4 or later, the source for which is available
-from the GNOME ftp site (ftp.gnome.org and mirrors). RPMs of
-libxml-1.4 and libxml-devel-1.4 are available from updates.redhat.com
-and mirrors, or ftp.gurulabs.com/pub/gnome/updates.
+from the GNOME ftp site (ftp.gnome.org and mirrors). RPMs of libxml-1.4
+and libxml-devel-1.4 are available from updates.redhat.com and mirrors,
+or ftp.gurulabs.com/pub/gnome/updates.
NEW PLATFORMS (Standards Hah!)

0 comments on commit f9f3206

Please sign in to comment.
Something went wrong with that request. Please try again.