1 | @comment -*-texinfo-*- |
---|
2 | @comment $Id: INSTALL_win.texi,v 1.8 2000-06-13 11:37:27 obachman Exp $ |
---|
3 | @c FILE: INSTALL.texi |
---|
4 | @c PURPOSE: Installation instructions for Singular on MSWindows |
---|
5 | @c This file is displayed during installation and copied to |
---|
6 | @c /etc/INSTALL |
---|
7 | |
---|
8 | @ifclear VERSION |
---|
9 | @include version.texi |
---|
10 | @end ifclear |
---|
11 | |
---|
12 | @ifclear singularmanual |
---|
13 | @majorheading Installation instructions for Singular on MSWINDOWS. |
---|
14 | @end ifclear |
---|
15 | |
---|
16 | @heading For the impatient: |
---|
17 | @itemize |
---|
18 | @item |
---|
19 | If you run Windows NT/2K, make sure you are logged in as |
---|
20 | @code{Administrator}. |
---|
21 | @item |
---|
22 | If you have Cygwin already installed on your system, uninstall it. |
---|
23 | @item |
---|
24 | Execute the self-extracting installation archive and accept all default |
---|
25 | answers. |
---|
26 | @item |
---|
27 | In case of troubles, see the installed file @code{C:\etc\INSTALL}. |
---|
28 | @end itemize |
---|
29 | |
---|
30 | @heading Installation preliminaries |
---|
31 | |
---|
32 | To run @sc{Singular} on MSWINDOWS requires that the Cygwin DLL |
---|
33 | (dynamically linked library) version 1.0 or higher is installed on your |
---|
34 | system (see @uref{http://sourceware.cygnus.com/cygwin} for details about |
---|
35 | Cygwin). |
---|
36 | |
---|
37 | To run @sc{ESingular} (i.e. @sc{Singular} within its Emacs interface) on |
---|
38 | MSWINDOWS requires furthermore that the (X)Emacs editor is installed on |
---|
39 | your system. |
---|
40 | |
---|
41 | @cindex Windows installation, components |
---|
42 | @cindex Components of Windows installation |
---|
43 | |
---|
44 | Therefore, the @sc{Singular} installation is divided into the following |
---|
45 | components: |
---|
46 | @table @code |
---|
47 | @item Singular-@value{VERSION} |
---|
48 | Contains the @sc{Singular} program and all documentation and example |
---|
49 | files. |
---|
50 | @*All files of this component are installed under the directory |
---|
51 | @code{/usr/local/Singular/@value{VERSION}/} |
---|
52 | @item BasicCygwin |
---|
53 | Contains the Cygwin DLL and basic tools/programs (like @code{bash} or |
---|
54 | @code{info}) of the Cygwin environment. |
---|
55 | @*The Cygwin DLL and programs are installed in the directory |
---|
56 | @code{/bin}. Miscellaneous documentation and configuration files are |
---|
57 | installed into the directory @code{/etc}. |
---|
58 | @item Xemacs-21.10 |
---|
59 | Contains the Cygwin port of the Xemacs editor (see |
---|
60 | @url{http://www.xemacs.org} for more about XEmacs) version 21.10. |
---|
61 | @*All files of this component are installed under the directory |
---|
62 | @code{/usr/local}. |
---|
63 | @item AdditionalCygwin |
---|
64 | Contains additional Cygwin development tools (like @code{gcc}, |
---|
65 | @code{gdb}, @code{make}, @code{perl}, etc). Roughly speaking, together |
---|
66 | with the @code{BasicCygwin} component, this component contains the |
---|
67 | development environment we use to build/compile/develop @sc{Singular} |
---|
68 | under MSWINDOWS. |
---|
69 | @*Most of the programs of this component are installed into the |
---|
70 | directories @code{/bin} or @code{/usr/local/bin}. |
---|
71 | @end table |
---|
72 | |
---|
73 | @heading Downloading preliminaries |
---|
74 | |
---|
75 | To install @sc{Singular} on a PC running Windows 95/98/NT/2K, you need |
---|
76 | to download @emph{one} of the following three archive files: |
---|
77 | |
---|
78 | @table @code |
---|
79 | @item Singular-@value{VERSION}-Compact.exe |
---|
80 | Minimal archive to download. Contains the @code{BasicCygwin} and |
---|
81 | @code{Singular-@value{VERSION}} components. |
---|
82 | @item Singular-@value{VERSION}-Typical.exe |
---|
83 | Typical archive to download. Contains the @code{BasicCygwin}, |
---|
84 | @code{Singular-@value{VERSION}} and @code{XEmacs-21.10} components. |
---|
85 | @item Singular-@value{VERSION}-Custom.exe |
---|
86 | Maximal archive to download. Contains the @code{BasicCygwin}, |
---|
87 | @code{Singular-@value{VERSION}}, @code{XEmacs-21.10} and |
---|
88 | @code{AdditionalCygwin} components. |
---|
89 | @end table |
---|
90 | |
---|
91 | @ignore |
---|
92 | @c later, only Singular updates should be possible |
---|
93 | @item Singular-@value{VERSION}-Only.exe |
---|
94 | Minimal archive to download. Contains only the component. |
---|
95 | @end ignore |
---|
96 | |
---|
97 | You can obtain these (and other) archives from |
---|
98 | @display |
---|
99 | @uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/Development}. |
---|
100 | @end display |
---|
101 | |
---|
102 | @ifclear singularmanual |
---|
103 | @strong{Important:} Please see |
---|
104 | @ifhtml |
---|
105 | @uref{COPYING.html, COPYING} |
---|
106 | @end ifhtml |
---|
107 | @ifnothtml |
---|
108 | the file @code{/etc/COPYING} contained in the distribution |
---|
109 | @end ifnothtml |
---|
110 | for license |
---|
111 | information on @sc{Singular}. In particular, notice that we only grant you |
---|
112 | permission to use @sc{Singular} if you have registered yourself as a |
---|
113 | @sc{Singular} user by sending email to @email{singular@@mathematik.uni-kl.de} |
---|
114 | with the subject line (or, mail body) @code{register}. |
---|
115 | @end ifclear |
---|
116 | |
---|
117 | @heading To install SINGULAR |
---|
118 | |
---|
119 | @enumerate |
---|
120 | @item |
---|
121 | If you have Cygwin B19 or B20 installed on your |
---|
122 | system, then uninstall it. Especially make sure that you delete the |
---|
123 | @code{/} and @code{/bin} mount points (i.e., execute the commands @code{umount |
---|
124 | /} and @code{umount /bin} before deleting the installed Cygwin |
---|
125 | programs). |
---|
126 | @item |
---|
127 | If you are running Windows NT/2000, make sure that you are logged on as |
---|
128 | @code{Administrator}. |
---|
129 | @item |
---|
130 | Execute the self-extracting archive (e.g., double-click on it) and |
---|
131 | @strong{carefully} follow the instructions given there. |
---|
132 | @item |
---|
133 | When asked for the installation folder, you should simply choose a drive |
---|
134 | (you may choose a sub-folder, but this is not as convenient as a drive). |
---|
135 | @strong{Important:} If you have Cygwin already installed on your system, |
---|
136 | make sure that the folder you choose is mounted to the root of your |
---|
137 | (Cygwin) file system. |
---|
138 | @item |
---|
139 | When asked for the Setup Type, choose @code{Typical}, unless you know |
---|
140 | what you are doing. |
---|
141 | @* If you choose @code{Compact}, the XEmacs editor is |
---|
142 | excluded from the installation. |
---|
143 | @* If you choose @code{Custom} observe the following: |
---|
144 | @itemize |
---|
145 | @item |
---|
146 | Make sure that you do @emph{not} |
---|
147 | de-select the @code{BasicCygwin} component, unless you already have |
---|
148 | Cygwin version 1.0 (or higher) installed on your system. |
---|
149 | @item |
---|
150 | If you have the @emph{Cygwin} port of XEmacs version 21.1.10 (or higher) |
---|
151 | already installed on your system, you can safely de-select the |
---|
152 | @code{XEmacs} component. All other versions of Emacs (resp. XEmacs) have |
---|
153 | some quirks and do not work right together with @sc{Singular} (i.e., |
---|
154 | running @code{ESingular} results in problems). |
---|
155 | @item |
---|
156 | You only need to install the @code{AdditionalCygwin} component, if you |
---|
157 | plan on doing software-development with Cygwin. |
---|
158 | @end itemize |
---|
159 | @item |
---|
160 | At the end, you @emph{should} reboot your computer. Otherwise, the |
---|
161 | installed programs will @emph{not} work. |
---|
162 | @end enumerate |
---|
163 | |
---|
164 | The following step(s) are optional: |
---|
165 | @itemize |
---|
166 | @item |
---|
167 | To conveniently access all files on your computer, mount the drives of |
---|
168 | your disk(s): |
---|
169 | @enumerate |
---|
170 | @item |
---|
171 | Open a bash shell. |
---|
172 | @item |
---|
173 | For each drive (letter) issue the following command (the drive @code{C:} |
---|
174 | is used in the example): |
---|
175 | @example |
---|
176 | mount -f -s -t C: /C |
---|
177 | @end example |
---|
178 | @end enumerate |
---|
179 | After mounting the drive(s) this way, you can conveniently access the |
---|
180 | files on a drive from the bash and from Xemacs using the @code{/C/} |
---|
181 | prefix. |
---|
182 | |
---|
183 | @item |
---|
184 | Create your personal @code{HOME} directory. |
---|
185 | @*Various applications (e.g., @code{bash} or @code{XEmacs}) store |
---|
186 | user-specific configuration/customization files in the @code{HOME} |
---|
187 | directory of the current user. During the installation, the @code{HOME} |
---|
188 | directory is globally set for all users to @code{/home/Singular}. To |
---|
189 | create your individual @code{HOME} directory follow these steps: |
---|
190 | @enumerate |
---|
191 | @item |
---|
192 | Create a directory (folder), say, @code{C:\home\MyHome}. |
---|
193 | @item |
---|
194 | Copy all files from @code{/home/Singular} to @code{C:\home\MyHome}. |
---|
195 | @item |
---|
196 | Set the environment variable @code{HOME} to @code{C:\home\MyHome}: |
---|
197 | @*On Windows 95/98, edit the respective line the @code{AUTOEXEC.BAT} |
---|
198 | file. |
---|
199 | @*On Windows NT/2K add an entry in your @code{Environment} control |
---|
200 | panel. |
---|
201 | @item |
---|
202 | Restart your computer. |
---|
203 | @end enumerate |
---|
204 | You may furthermore examine the files copied into your @code{HOME} |
---|
205 | directory and adjust (i.e. edit) them to your personal |
---|
206 | preferences/needs. |
---|
207 | @end itemize |
---|
208 | |
---|
209 | |
---|
210 | |
---|
211 | @heading Uninstalling Singular |
---|
212 | |
---|
213 | You can uninstall individual or all installed components by opening the |
---|
214 | @code{Software} panel of the @code{System configuration} control |
---|
215 | panel. Simply double-click the @code{Singular-@value{VERSION}} item and |
---|
216 | follow the instructions given there. |
---|
217 | |
---|
218 | |
---|
219 | @heading Troubleshooting |
---|
220 | |
---|
221 | @table @strong |
---|
222 | @item On startup, the DLL @code{cygwin1.dll} can not be found. |
---|
223 | @itemize |
---|
224 | @item |
---|
225 | Make sure that (1) the @code{BasicCygwin} component was not de-selected |
---|
226 | during a custom installation; (2) the destination folder chosen during |
---|
227 | the installation does not contain folder names which are longer than 8 |
---|
228 | characters, or contain spaces or periods; (3) the installation did not |
---|
229 | generate any error messages; and (4) you have rebooted your machine after a |
---|
230 | successful installation. |
---|
231 | @item |
---|
232 | Make sure the DLL @code{cygwin1.dll} is installed on your |
---|
233 | system: Say, @code{C:\} is the folder which you have chosen as the |
---|
234 | destination folder during the installation, then the @code{cygwin1.dll} |
---|
235 | should be located at @code{C:\bin\cygwin1.dll}. |
---|
236 | @item |
---|
237 | If the problem pertains, please try to localize the source of the |
---|
238 | problem as explained below, and, in any event, @emph{please send} an email |
---|
239 | to @email{singular@@mathematik.uni-kl-de} with a description of your problem. |
---|
240 | @item |
---|
241 | Make sure the directories @code{C:\bin} and @code{C:\usr\local\bin}(if |
---|
242 | you have chosen another destination folder, substitute @code{C:} by |
---|
243 | this folder) are contained in your @code{PATH} environment variable. To |
---|
244 | check this, open an MS-DOS shell and type in @code{PATH}. If these |
---|
245 | directories are not contained in the listings of directories of the |
---|
246 | @code{PATH} variable, set them as follows and then @emph{restart} your |
---|
247 | computer: |
---|
248 | @*On Windows 95/98, add the following line to your @code{AUTOEXEC.BAT} |
---|
249 | file: |
---|
250 | @example |
---|
251 | SET PATH=C:\BIN;%PATH%;C:\USR\LOCAL\BIN |
---|
252 | @end example |
---|
253 | On Windows NT/2000 add a similar statements in your @code{Environment} |
---|
254 | control panel. |
---|
255 | @item |
---|
256 | Make sure your chosen destination folder is correctly mounted to the |
---|
257 | root of your (Cygwin) file system: Open an MS-DOS shell, @code{cd} |
---|
258 | (change directory) to your chosen destination folder, and type in |
---|
259 | @example |
---|
260 | mount |
---|
261 | @end example |
---|
262 | This should produce an output which looks like: |
---|
263 | @example |
---|
264 | Device Directory Type Flags |
---|
265 | C: / system textmode |
---|
266 | @end example |
---|
267 | If not, make sure that the @code{mount.exe} command is contained in this |
---|
268 | directory, and then type at the MS-DOS prompt: |
---|
269 | @example |
---|
270 | mount -s -f -t C:\ / |
---|
271 | @end example |
---|
272 | @end itemize |
---|
273 | |
---|
274 | @item During the installation, an error is displayed complaining that an environment variable can not be set. |
---|
275 | Repeat the installation, and make sure that: |
---|
276 | @*On Windows 95/98, the file @code{C:\AUTOEXEC.BAT} is not |
---|
277 | hidden and not write-protected. |
---|
278 | @* On Windows NT/2K, you are logged on as user |
---|
279 | @code{Administrator} during the installation. |
---|
280 | |
---|
281 | @item On start-up of @code{ESingular}, the @code{xemacs} editor can not be found. |
---|
282 | @*Make sure that (1) the folder @code{C:\usr\local\bin} is contained in your |
---|
283 | @code{PATH} (see above for details) and (2) that the file |
---|
284 | @code{C:\usr\local\bin\xemacs} exists (as above, substitute @code{C:\} |
---|
285 | by the destination folder chosen during the installation). |
---|
286 | @*Open a Bash shell and type in @code{/usr/local/bin/xemacs}. If this |
---|
287 | fails, make sure your root is correctly mounted (see above). |
---|
288 | |
---|
289 | @item On a Laptop which is not connected to the network, Xemacs hangs. |
---|
290 | Remove your network card and restart Xemacs. |
---|
291 | |
---|
292 | @item How do I cut and paste with the mouse? |
---|
293 | Under Windows, cutting and pasting does not work like it does under |
---|
294 | Unix. Nevertheless, you can copy and paste a region selected with the |
---|
295 | mouse using the @code{CTRL-Insert} (for copying) and @code{CTRL-Shift} |
---|
296 | (for paste) keys: this works both, within Xemacs, as well as within a |
---|
297 | Bash shell. |
---|
298 | @end table |
---|
299 | |
---|
300 | For any other troubles, |
---|
301 | please send an email to @email{singular@@mathematik.uni-kl.de} |
---|
302 | and include the header which is displayed by starting up @sc{Singular} |
---|
303 | with the @code{-v} option, and a description of your machine and |
---|
304 | operating system. |
---|
305 | |
---|
306 | |
---|
307 | @ifclear singularmanual |
---|
308 | @heading More information about @sc{Singular}: Comments, Questions, Bug Reports |
---|
309 | More and up-to-date information about @sc{Singular} is always available |
---|
310 | from |
---|
311 | @display |
---|
312 | @uref{http://www.singular.uni-kl.de}. |
---|
313 | @end display |
---|
314 | We very much welcome any comments, questions, and bug reports. Please |
---|
315 | contact us at |
---|
316 | @display |
---|
317 | @email{singular@@mathematik.uni-kl.de}. |
---|
318 | @end display |
---|
319 | |
---|
320 | GOOD LUCK and ENJOY! |
---|
321 | Your @sc{Singular} team. |
---|
322 | @end ifclear |
---|
323 | |
---|