From fcf4e9d8b72cfd64aaf72be966d91527cfb835e1 Mon Sep 17 00:00:00 2001 From: Matt Birkholz Date: Sat, 24 Nov 2018 17:21:28 -0700 Subject: [PATCH] doc/user-manual/: Fix merge. --- doc/user-manual/user.texinfo | 266 +---------------------------------- 1 file changed, 6 insertions(+), 260 deletions(-) diff --git a/doc/user-manual/user.texinfo b/doc/user-manual/user.texinfo index 16b488726..d9a3bfe0e 100644 --- a/doc/user-manual/user.texinfo +++ b/doc/user-manual/user.texinfo @@ -121,263 +121,11 @@ To report bugs, send email to @uref{puck@@birchwood-abbey.net} @end example +@noindent Please include the output of the @code{identify-world} procedure (@pxref{Basics of Starting Scheme}), so Puck knows what versions you are using. -@node Installation -@chapter Installation - -This chapter describes how to install MIT/GNU Scheme. The release is -supported under various unix and Windows operating systems. Read the -section detailing the installation for the operating system that you are -using. - -@menu -* Unix Installation:: -* Windows Installation:: -* Portable C Installation:: -@end menu - -@node Unix Installation -@section Unix Installation - -We will use as an example the installation for GNU/Linux. The -installation for other unix systems is similar. There are several -references to @var{ARCH} below; these refer to the computer -architecture that Scheme is compiled for: either @samp{i386} -@samp{x86-64}, or @samp{svm1}. - -MIT/GNU Scheme is distributed as a compressed `tar' file. The tar -file contains both source and binary files; the binary files are -pre-compiled Scheme code for a particular computer architecture. The -source files are C programs that need to be compiled. - -@heading Requirements - -At a minimum, you will need a C compiler (e.g. @samp{gcc}) and a -@samp{make} program, and a ``curses'' library. For example, here are -the packages that must be installed on some popular systems: - -@itemize @bullet -@item -Debian-like systems: @code{gcc} @code{make} @code{libncurses-dev} -@item -CentOS-like systems: @code{gcc} @code{make} @code{ncurses-devel} -@item -macOS systems: @code{Xcode} -@end itemize - -Additionally, if you want support for X11 graphics, you'll need: - -@itemize @bullet -@item -Debian-like systems: @code{libx11-dev} -@item -CentOS-like systems: @code{libX11-devel} -@item -macOS systems: @code{XQuartz} (from @url{https://www.xquartz.org/}) -@end itemize - -@heading Steps - -In order to install the software, it's necessary to configure and -compile the C code, then to install the combined C and Scheme -binaries, with the following steps. - -@enumerate -@item -Unpack the tar file, -@file{mit-scheme-@var{VERSION}-@var{ARCH}.tar.gz}, into the directory -@file{mit-scheme-@var{VERSION}}. For example, - -@example -tar xzf mit-scheme-@var{VERSION}-i386.tar.gz -@end example - -will create a new directory @file{mit-scheme-@var{VERSION}}. - -@item -Move into the @file{src} subdirectory of the new directory: - -@example -cd mit-scheme-@var{VERSION}/src -@end example - -@item -Configure the software: - -@example -./configure -@end example - -By default, the software will be installed in @file{/usr/local}, in -the subdirectories @file{bin} and @file{lib}. If you want it -installed somewhere else, for example @file{/opt/mit-scheme}, pass the -@option{--prefix} option to the configure script, as in -@kbd{./configure --prefix=/opt/mit-scheme}. - -The configure script accepts all the normal arguments for such -scripts, and additionally accepts some that are specific to MIT/GNU -Scheme. To see all the possible arguments and their meanings, run the -command @kbd{./configure --help}. However, do not specify the -following options, which are all preconfigured to the right values; -doing so will probably cause the build to fail: - -@example ---enable-native-code ---enable-host-scheme-test ---enable-cross-compiling ---with-compiler-target ---with-default-target ---with-scheme-build -@end example - -@item -Build the software: - -@example -make -@end example - -@item -Install the software: - -@example -make install -@end example - -Depending on configuration options and file-system permissions, you -may need super-user privileges to do the installation steps. - -@item -Build the documentation: - -@example -cd ../doc -./configure -make -@end example - -@item -Install the documentation: - -@example -make install-info install-html install-pdf -@end example - -Depending on configuration options and file-system permissions, you -may need super-user privileges to do the installation step. -@end enumerate - -@heading Plugins - -After you have installed Scheme you may want to install several -@dfn{plugins}. Scheme no longer uses dynamically loaded microcode -modules installed with Scheme. The micromodules have been converted -into plugins: new subsystems that use the C/FFI to dynamically load -the same code. Instead you configure, build, and install additional -plugins after installing the core system. - -By default, the following plugins are built and installed: -@file{edwin}, @file{imail}, @file{x11}, and @file{x11-screen}. (The -latter two only if X11 libraries are installed on your system.) To -get all of the functionality previously available in version 9.2 you -will need to build and install the remaining plugins included in the -@file{src} subdirectory: @file{blowfish}, @file{gdbm}, @file{mcrypt}, -and @file{pgsql}. These plugins are all configured, built, and -installed in the GNU standard way. See the @file{README} file in each -plugin's source directory for complete details. - -@heading Cleanup - -After installing Scheme and your desired plugins, you can delete the -source directory: - -@example -cd ../.. -rm -rf mit-scheme-@var{VERSION} -@end example - -@node Windows Installation -@section Windows Installation - -This section describes how to install MIT/GNU Scheme on Windows 2000, -Windows XP, Windows Vista, or Windows 7. - -MIT/GNU Scheme is distributed as a self-installing executable. -Installation of the software is straightforward. Simply execute the -downloaded file and answer the installer's questions. The installer -will allow you to choose the directory in which MIT/GNU Scheme is -to be installed, and the name of the folder in which the shortcuts are -to be placed. - -To uninstall the software, open up the @code{Control Panel}, run -@samp{Add/Remove Programs}, and double-click on @samp{MIT/GNU Scheme}. - -@node Portable C Installation -@section Portable C Installation - -This section describes how to generate binaries from the portable C -distribution. These binaries should run with little or no trouble on most -modern architectures and operating systems. It will probably require -tweaking for systems that haven't been tested. - -When built this way, the system runs slower than when it is built -using the native-code compiler. For this reason, you will usually want -to use native-code binaries when running on a 32-bit Intel -architecture machine. However, the portable-code binaries can address -larger amounts of virtual memory than the native-code binaries, so it -is reasonable (and supported) to use both kinds on the same machine. - -@enumerate -@item -Unpack the tar file, -@file{mit-scheme-c-@var{VERSION}.tar.gz}, into the directory -@file{mit-scheme-c-@var{VERSION}}. For example, - -@example -tar xzf mit-scheme-c-@var{VERSION}.tar.gz -@end example - -will create a new directory @file{mit-scheme-c-@var{VERSION}}. - -@item -Move into the new directory: - -@example -cd mit-scheme-c-@var{VERSION}/src -@end example - -@item -Build the program: - -@example -./etc/make-liarc.sh -@end example - -This will take a long time; on fairly fast machines with lots of RAM -it takes about an hour. On older machines it will take longer or fail -altogether, at which point you should ask for help. Note that you can -pass configure options to the script. - -@example -./etc/make-liarc.sh --help -./etc/make-liarc.sh --prefix=/usr -@end example - -@item -Install the program: - -@example -make install -@end example - -Depending on configuration options and file-system permissions, you -may need super-user privileges to do the installation step. -@end enumerate ->>>>>>> aafa6ac04e1b39110227242465d9dc1b8ef2e85b - @node Running Scheme @chapter Running Scheme @@ -1887,7 +1635,7 @@ for a lot of output). @end example @node Replacement of Operators -@subsection Replacement of Operator +@subsection Replacement of Operators The @code{replace-operator} declaration is provided to inform the compiler that certain operators may be replaced by other operators @@ -4081,9 +3829,8 @@ Edwin's internal display data structures to get into an inconsistent state that prevents Edwin from running. @end deffn -@c A full @node spec is needed here to avoid a bogus warning? -@node Release Notes, Installation, Edwin, Top -@chapter Release Notes +@node Release Notes +@appendix Release Notes This experimental version of MIT/GNU Scheme got a new project name, MIT/GNU Scheme Pucked, and a new command name, @@ -4242,9 +3989,8 @@ The @code{cond-expand} feature @code{pucked} will be present, to keep your adaptations to this experiment separate from old code intended only for your stable worlds. -@c A full @node spec is needed here to avoid a bogus warning. -@node Installation, GNU Free Documentation License, Release Notes, Top -@chapter Installation +@node Installation +@appendix Installation MIT/GNU Scheme Pucked and its plugins are now available as packages for recent versions of Ubuntu on Intel@registeredsymbol{}64 and IA-32 -- 2.25.1