Permalink
Browse files

documentation updates

git-svn-id: https://svn.r-project.org/R/trunk@8379 00db46b3-68df-0310-9c12-caf00c1e9a41
  • Loading branch information...
1 parent a4d722b commit 799c96c547784dbdcc306d58201f2ddced3ea884 ripley committed Feb 27, 2000
Showing with 76 additions and 62 deletions.
  1. +1 −0 COPYRIGHTS
  2. +34 −20 INSTALL
  3. +6 −2 src/gnuwin32/COPYRIGHTS.win
  4. +15 −21 src/gnuwin32/INSTALL
  5. +20 −19 src/gnuwin32/readme
View
@@ -17,6 +17,7 @@ afm/*
doc/html/search/*.java
Copyright (C), 1998 Thomas Baier
+or Copyright (C), 1998-2000, Thomas Baier, R Core Development Team
src/library/base/R/mosaicplot.R
View
@@ -25,7 +25,7 @@ unpack them with
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
+least to have the "gzip" program installed. Then you can use
gzip -dc R-x.y.z.tgz | tar xvf -
@@ -45,7 +45,7 @@ previous version by changing to the top directory of it and
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
+Beware that this does not necessarily work if the older sources have
been modified (e.g., by building in their directories).
@@ -67,7 +67,7 @@ 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/share/R', see
+want to install the complete R tree to, e.g., `/usr/local/lib/R', see
section INSTALLATION below.
You do not necessarily have to build R in the top-level source directory
@@ -95,7 +95,7 @@ non-system directories, use the variables LIBS (for libraries) and
CPPFLAGS (for header files), respectively, to specify these locations.
If you find you need to alter configure variables, it is worth noting
-that some settings are cached in the file config.cache, and it is a
+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
@@ -107,24 +107,39 @@ 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 Reader. 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).
+(files FAQ or doc/html/faq.html or the latest version at
+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.
+MAKING THE MANUALS
+
+There is a set of manuals that can be built from the sources,
+
+ R-intro `An Introduction to R.
+ refman Printed versions of all the help pages.
+ R-exts `Writing R Extensions'.
+ R-FAQ R FAQ (which is already built for you).
+
+To make these, cd to the `doc/manual' directory and use
+
+ make dvi to create DVI versions
+ make pdf to create PDF versions
+ make info to create info files (not refman)
+
+You will not be able to build the info files unless you have makeinfo
+version 4 or later installed (and most Linux distributions have 3.2).
+
+The dvi versions can be previewed and printed using standard programs
+such as `xdvi' and `dvips'. The PDF versions can be viewed using
+Acrobat Reader or (recent versions of) ghostscript: they have
+hyperlinks that can be followed in Acrobat Reader. The info files are
+suitable for reading online with Emacs or the standalone GNU Info.
+
+
INSTALLATION
After
@@ -141,7 +156,7 @@ This will install to the following directories:
${prefix}/bin the front-end shell script
${prefix}/man/man1 the man page
- ${prefix}/share/R all the rest (libraries, on-line help
+ ${prefix}/lib/R all the rest (libraries, on-line help
system, ...)
where prefix is determined during configuration (typically `/usr/local')
@@ -174,7 +189,6 @@ MAKE=gmake ./configure (sh, bash)
env MAKE=gmake ./configure (csh)
-
USING FORTRAN
To compile R, you need a FORTRAN compiler or f2c, the FORTRAN-to-C
@@ -249,8 +263,8 @@ hardware/os platform.
models for floating point arithmetic. The POSIX and SVID models
provide no problems. The IEEE model however can be a pain. The
problem is that there is no agreement on how to set the signalling
- behavior; sgi/irix and linux require no special action, freebsd
- requires a call to (the macro) fpsetmask(0) and osf1v3.2 requires
+ behavior; sgi/irix and i386 linux require no special action, freebsd
+ requires a call to (the macro) fpsetmask(0) and osf1 requires
that computation be done with a -ieee_with_inexact flag etc...
On a new platform you must find out the magic recipe and add some
code to make it work. This can often be done via the file
@@ -52,8 +52,12 @@ Based on files which are
Copyright 1994-1999 The Downhill Project
http://www.ede.com/free/u2nt
-src/gnuwin32/bdx.[ch], rpr*
+src/gnuwin32/front-ends/rprx.c
Copyright (C) 1999 Thomas Baier
-distributed under LGPL.
+src/gnuwin32/front-ends/SC_proxy.h, bdx.[ch], rp*.[ch]
+
+ Copyright (C) 1999 Thomas Baier
+
+distributed under the LGPL.
View
@@ -2,44 +2,38 @@ R 1.0.0 for Windows 9x and NT
=============================
This distribution contains a binary distribution of R-1.0.0 to run on
-Windows 95, 98 and NT4 on Intel/clone chips. See README for fuller
+Windows 95, 98, NT4 and 2000 on Intel/clone chips. See README for fuller
details, including how to install the binary versions.
Building From Source
====================
-[Some further details, including how to debug, are given in the RW-FAQ.]
+[Some further details, including how to debug, are given in the rw-FAQ.]
First collect the tools that you need.
Building on Windows
-------------------
We recommend that you use the mingw32 port of gcc-2.95.2 by Mumit Khan
-from http://www.mingw.org/ or
-ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32. You will
-also need suitable versions of make, sh, rm, sed, awk, mkdir, echo, cp
-and cat; we have packaged a set at
-CRAN/bin/windows/windows-NT/base/etc/tools.zip extracted from the
-cygwin distribution (http://sourceware.cygnus.com/cygwin and several
-mirrors). To avoid past problems on some versions of Windows 95, we
-use the cygwin ld contained in that set, which must be before the
-mingw32 one in your path. (We believe this is solved in gcc-2.95.2,
-but have no way of testing this as we now use NT.)
-
-It is also possible to use earlier mingw32 compilers or cygwin-b20.1
-with the --no-cygwin flag, but we suggest you do so only if you have a
-working setup from building earlier versions of R. We have also
-successfully used the variant of mingw32 that uses the MSVCRT run-time
-system (under gcc-2.95.x but not earlier versions).
-Be aware that not all Windows machines have MSVCRT.DLL installed.
+from http://www.mingw.org/ or
+ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/mingw32. You will also
+need suitable versions of at least make, sh, rm, sed, awk, mkdir,
+echo, cp, cut, grep and cat; we use those from the cygwin distribution
+(http://sourceware.cygnus.com/cygwin and several mirrors).
+
+It is also possible to use cygwin-b20.1 with the --no-cygwin flag, but
+we suggest you do so only if you have a working setup from building
+earlier versions of R. We have also successfully used the variant of
+mingw32 that uses the MSVCRT run-time system. Be aware that not all
+Windows machines have MSVCRT.DLL installed.
(If you want to use cygwin, you will need to upgrade to gcc-2.95.2 by
installing the files gcc-2.95.2-cygb20.tar.gz and
gcc-2.95.2-mingw-extra.tar.gz from
ftp://ftp.xraylith.wisc.edu/pub/khan/gnu-win32/cygwin32. The basic
-distribution does not comtain a Fortran compiler, and that is needed
+distribution does not contain a Fortran compiler, and that is needed
to build R.)
perl5, available via http://www.perl.com/CPAN/ports/.
@@ -80,7 +74,7 @@ distribution, nor are the sources (it is the standard Info-Zip unzip
5.40, built with MSVC++4.2). You will need to copy it from a binary
distribution.
-The file rw1000\bin\Rchtml.dll is only built if chm help is specifed
+The file rw1000\bin\Rchtml.dll is only built if CHM help is specifed
in the main Makefile. Its source is the help directory, and you need
the HTML Help Workshop files to build it. It contains instructions
to build it under VC++6, and it is preferable to use that as the
View
@@ -1,11 +1,11 @@
-R 1.0.0 for Windows 9x and NT
-=============================
+R 1.0.0 for Windows
+===================
This distribution contains a binary distribution of R-1.0.0 to run on
-Windows 95, 98 and NT4 on Intel/clone chips. It is designed to
-be as close as possible to the implementation on Unix, but see the
-list of differences below. The port was by Guido Masarotto with
-many important contributions by Brian Ripley.
+Windows 95, 98 NT4 and 2000 on Intel/clone chips. It is designed to be
+as close as possible to the implementation on Unix, but see the list
+of differences below. The port was by Guido Masarotto and Brian
+Ripley.
See CHANGES for the new features of this version.
@@ -159,15 +159,15 @@ Environment variables can be set as NAME=value on the command line,
including in a short-cut. They can also be set (as NAME=value lines)
in the file .Renviron, or if that does not exist HOME\.Renviron.
-Many aspects of the console (size, appearance, font, colours) can be
-customized by editing the file etc\Rconsole, and a copy with a user's
-settings can be put in her HOME directory or in the working
-directory. (The exact sequence is to search the directory pointed to
-by the first found of the environment variables R_USER then HOME then
-{HOMEDRIVE}{HOMEPATH} then the working directory, finally R_HOME\etc.
-This applies to .Renviron and other uses of `HOME' in our documentation.)
-The file contains a description of the settings that can be
-altered. See also ?Rconsole.
+Many aspects of the console (size, appearance, font, font size,
+colours) can be customized by editing the file etc\Rconsole, and a
+copy with a user's settings can be put in her HOME directory or in the
+working directory. (The exact sequence is to search the directory
+pointed to by the first found of the environment variables R_USER then
+HOME then {HOMEDRIVE}{HOMEPATH} then the working directory, finally
+R_HOME\etc. This applies to .Renviron and other uses of `HOME' in our
+documentation.) The file contains a description of the settings that
+can be altered. See also ?Rconsole.
The mapping between Windows fonts and R font's number can be set by
editing the file etc\Rdevga, and a copy with a user's settings can be
@@ -214,15 +214,16 @@ use packages installed in directory R:\libraries\gm, set
R_LIBS=R:\libraries\gm
-in the environment or on the command line, or add the line
+in the environment or your .Renviron file or on the command line, or
+add the line
.lib.loc <- c("R:/libraries/gm", .lib.loc)
to your .Rprofile or at the end of R_HOME\etc\Rprofile.
To install a package from source code you need the source-package
-distribution rw1000sp.zip installed (but not the R source). This contains
-detailed instructions.
+distribution rw1000sp.zip installed (but not the R source). This
+contains detailed instructions.
Differences from Unix
@@ -239,7 +240,7 @@ Differences from Unix
always saved even if the workspace is not saved.
- The HTML function and package lists and search datasbase are not
- re-generated automatically by html.start(). Use link.html.help().
+ re-generated automatically by html.start(). Use link.html.help().
- Paths to files can be specified with "/" or "\\".

0 comments on commit 799c96c

Please sign in to comment.