source: git/doc/INSTALL_win.plural.texi @ ba5e9e

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