source: git/doc/INSTALL_win.plural.texi @ 437efdf

fieker-DuValspielwiese
Last change on this file since 437efdf was 437efdf, checked in by Frank Seelisch <seelisch@…>, 15 years ago
last textual changes prior to 3-1-0 git-svn-id: file:///usr/local/Singular/svn/trunk@11711 2c84dea3-7e68-4137-9b89-c4e89433aadc
  • Property mode set to 100755
File size: 7.7 KB
Line 
1@comment -*-texinfo-*-
2@comment $Id: INSTALL_win.plural.texi,v 1.4 2009-04-15 10:41:14 seelisch Exp $
3@c FILE: INSTALL_unix.texi
4@c PURPOSE: Installation instruction for Singular on Unix
5@c
6
7@ifclear VERSION
8@include version.texi
9@end ifclear
10
11@ifclear singularmanual
12@majorheading Windows installation instructions for @sc{Singular::Plural} version @value{VERSION}
13@end ifclear
14
15@ifclear UNAME
16@set _UNAME ix86-Win
17@end ifclear
18
19@ifset UNAME
20@include uname.texi
21@end ifset
22
23To install @sc{Singular::Plural} on a Windows
24platform, you need the following two archives:
25@table @code
26@item SingularPlural-@value{VERSION}-share.tar.gz
27contains architecture independent data like documentation and libraries.
28@item SingularPlural-@value{VERSION}-@value{_UNAME}.tar.gz
29contains architecture dependent executables, like the @sc{Plural}
30program.
31@end table
32
33You can obtain these (and other) archives from
34@display
35@uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/non-commutative/Plural/}.
36@end display
37
38@include register.texi
39
40@heading To install SINGULAR::PLURAL
41
42Make sure that you have approximately 12MByte of free disk space and follow
43these steps.
44@enumerate
45@item
46Simply change to the directory in which you wish to install
47@sc{Singular::Plural}, for example, @code{C:\}.
48
49@sc{Singular::Plural} specific subdirectories will be created in such a way
50that multiple versions and multiple architecture dependent files
51of @sc{Singular} and @sc{Singular::Plural} can peaceably coexist under the same
52tree.
53
54@item
55Unpack the archives either with your own program or with @code{gzip}
56and @code{tar}:
57@smallexample
58gzip -dc <path_to>/SingularPlural-@value{VERSION}-@value{_UNAME}.tar.gz | tar -pxf -
59gzip -dc <path_to>/SingularPlural-@value{VERSION}-share.tar.gz | tar -pxf -
60@end smallexample
61
62This creates the directory @code{Plural/@value{VERSION}} with
63@multitable @columnfractions .36 .64
64@item (sub)directories
65@tab which contain
66@item @code{@value{_UNAME}}
67@tab @code{Plural} and @code{EPlural} executables
68@item @code{LIB}
69@tab @sc{Singular} and @sc{Singular::Plural} libraries (@code{*.lib} files)
70@item @code{emacs}
71@tab files for the @sc{Plural} Emacs user interface
72@item @code{info}
73@tab info files of @sc{Plural} manual (Warning: plural.hlp is not a help file for Windows help but for @code{info} program!)
74@item @code{html}
75@tab html files of @sc{Plural} manual
76@item @code{doc}
77@tab miscellaneous documentation files
78@c @item @code{examples}
79@c @tab @sc{Singular} examples (@code{*.sing} files)
80@end multitable
81
82For the executable to work, the directory layout must look pretty much
83like this; the executable will look for "sibling" directories at run-time
84to figure out where its @sc{Singular::Plural} libraries and on-line
85documentation files are. These constraints on the local directory layout
86are necessary to avoid having to hard-code pathnames into the
87executables, or require that environment variables be set before
88running the executable. In particular, you @strong{must not move or copy}
89the @sc{Plural} executables to another place, but use soft-links
90instead.
91@end enumerate
92
93The following steps are optional:
94
95@itemize @bullet
96@item
97Create a shortcut for @code{Plural}.
98
99Start a new shortcut wizard and pick
100@code{C:/Plural/@value{VERSION}/ix86-Win/Plural.exe} as the executable
101and type, for example, @code{C:/Plural/@value{VERSION}/ix86-Win/} in the field "Execute in".
102
103@item
104Arrange that typing @code{Plural} at the command prompt starts up the
105installed @sc{Plural} executable.
106
107Just append the directory @code{Plural/@value{VERSION}/ix86-Win} to your @code{PATH} environment variable.
108
109@strong{IMPORTANT:} Do @emph{never} move or copy the file
110@code{Plural/@value{VERSION}/@value{_UNAME}/Plural} to another
111place, but use shortcuts or soft-links instead.
112
113@item
114If you wish to use any of the following features of
115@sc{Plural}, make sure that the respective programs are installed on your system:
116
117@multitable @columnfractions .5 .5
118@item @strong{Feature} @tab @strong{Requires}
119@item running @code{EPlural}, or @code{Plural} within Emacs
120@tab @uref{http://www.gnu.org/software/emacs/emacs.html,,Emacs} version
12120 or higher, or, @uref{http://www.xemacs.org,,XEmacs} version 20.3 or
122higher
123@item on-line @code{html} help
124@tab @uref{http://www.netscape.com,,netscape} browser
125@item on-line @code{info} help
126@tab @uref{http://www.texinfo.org,,info}, or
127@uref{http://math-www.uni-paderborn.de/~axel/tkinfo/,,tkinfo} texinfo browser programs
128@c @item TAB completion and history mechanism of ASCII-terminal interface
129@c @tab shared @uref{ftp://ftp.de.uu.net/pub/gnu/readline/,,readline}
130@c library, i.e. @code{/usr/lib/libreadline.so}
131@c @item visualization of curves and surfaces
132@c @tab
133@c @uref{http://www.imaginary2008.de/surfer.php,,surfer}
134@c Setup executable for the visualization tool surfer.
135@end multitable
136
137@c You may download most of these programs from
138@c @display
139@c @uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/utils/}.
140@c @end display
141
142@item Customize the on-line help system:
143
144By default, on-line help is displayed in @code{html} format using
145the default Web browser on your system.
146
147However, this behavior can be customized in several ways
148using the @sc{Plural} commands @code{system("--browser",<browser>)}
149and @code{system("--allow-net", 1)} (or, by starting up @sc{Plural}
150with the respective command line options).
151
152@end itemize
153
154@c In particular, creating the file
155@c @code{Plural/@value{VERSION}/LIB/.singularrc} and putting the
156@c @sc{Plural} command
157@c @smallexample
158@c system("--allow-net", 1);
159@c @end smallexample
160@c in it, allows the on-line help system to fetch its @code{html} pages
161@c from @uref{http://www.singular.uni-kl.de, Singular's WWW
162@c home site}
163@c in case its local html pages are not found. That is, you may delete your
164@c local html pages, after setting this option.
165
166See also
167@ifset singularmanual
168@ref{The online help system}, @ref{Command line options}, and
169@ref{Startup sequence},
170@end ifset
171@ifclear singularmanual
172the sections @emph{The online help system}, @emph{Command line options}, and
173@emph{Startup sequence} in the @sc{Singular} manual
174@end ifclear
175for more details on customizing the on-line help system.
176
177@heading Troubleshooting
178
179@itemize @bullet
180@item General: @sc{Plural} cannot find its libraries or on-line help
181@enumerate
182@item
183Make sure that you have read and/or execute permission on the files and
184directories of the Plural distribution.
185@item
186Start up @sc{Plural}, and issue the command @code{system("Singular");}.
187If this does not return the correct and expanded location of the
188@sc{Plural} executable, then you found a bug in @sc{Plural}, which we
189ask you to report (see below).
190@item
191Check whether the directories containing the libraries and on-line help
192files can be found by @sc{Plural}: If @code{$bindir} denotes the
193directory where the @sc{Plural} executable resides, then @sc{Plural}
194looks for library files as follows:
195@* (0) the current directory
196@* (1) all dirs of the environment variable SINGULARPATH
197@* (2) @code{$bindir/LIB}
198@* (3) @code{$bindir/../LIB}
199@* (4) @code{/usr/local/Plural/@value{VERSION}/LIB}
200@* (4) @code{/usr/local/Plural/LIB}
201@* The on-line @code{info} files need to be at  @code{$bindir/../info} and the
202@code{html} pages at @code{$bindir/../html}.
203@end enumerate
204
205You can inspect the found library and @code{info}/@code{html}
206directories by starting up @sc{Plural} with the
207@code{--version} option, or by issuing the @sc{Plural} command
208@code{system("--version");}.
209
210@item For any other troubles:
211@*Please send an email to @email{singular@@mathematik.uni-kl.de}
212and include the header which is displayed by starting up @sc{Plural}
213with the @code{-v} option, and a description of your machine (issue the
214command @code{uname -a} on your shell) in your report.
215@end itemize
216
217@include info.texi
218
219@ifclear singularmanual
220GOOD LUCK and ENJOY!
221Your @sc{Singular::Plural} team.
222@end ifclear
223
Note: See TracBrowser for help on using the repository browser.