source: git/doc/INSTALL_unix.texi @ 85bcd6

fieker-DuValspielwiese
Last change on this file since 85bcd6 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 100644
File size: 11.9 KB
Line 
1@comment -*-texinfo-*-
2@c FILE: INSTALL_unix.texi
3@c PURPOSE: Installation instruction for Singular on Unix
4@c
5
6@c @ifclear VERSION
7@include version.texi
8@c @end ifclear
9
10@ifclear singularmanual
11@majorheading Unix installation instructions for @sc{Singular} version @value{VERSION}
12@end ifclear
13
14@ifclear UNAME
15@set _UNAME uname
16@end ifclear
17
18@ifset UNAME
19@include uname.texi
20@end ifset
21
22The possibilities for installing @sc{Singular} on a Unix or Linux system range from
23a purely manual installation over a convenient installation of RPM or DEB
24packages up to a completely automated installation via a package tool like
25apt or yum.
26
27For a Linux system with RPM (like Redhat/Fedora, Mandrake/Mandriva, SuSE etc.),
28or with DEB (like Debian, Ubuntu etc.) one should follow
29the intructions at @url{http://www.singular.uni-kl.de/UNIX/}.
30
31The manual installation (for all other Unix systems) is described below:
32
33To install @sc{Singular} on a
34@ifset UNAME
35@value{_UNAME}
36@end ifset
37@ifclear UNAME
38Unix
39@end ifclear
40platform, you need the following two
41archives:
42@table @code
43@item a:
44Singular-@value{VERSION}-share.tar.gz
45contains architecture independent data like documentation and libraries.
46@item b:
47Singular-@value{VERSION}-@value{_UNAME}.tar.gz
48contains architecture dependent executables, like the @sc{Singular}
49program.
50@end table
51@ifclear UNAME
52@*
53@code{@value{_UNAME}} is a description of the processor and operating system
54for which @sc{Singular} is compiled (e.g, @code{ix86-Linux}). Please contact us if
55you cannot find an appropriate architecture dependent archive.
56@end ifclear
57
58You can obtain these (and other) archives from
59@display
60@uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/UNIX/}.
61@end display
62
63@include register.texi
64
65@heading To install SINGULAR
66
67Make sure that you have approximately 20 MByte of free disk space and follow
68these steps.
69@enumerate
70@item
71Simply change to the directory in which you wish to install
72@sc{Singular} (usually wherever you install 3rd-party software), for example:
73@smallexample
74cd /usr/local
75or
76mkdir install;cd install
77(you do not need root privileges in this case)
78@end smallexample
79
80@sc{Singular} specific subdirectories will be created in such a way
81that multiple versions and multiple architecture dependent files
82of @sc{Singular} can peaceably coexist under the same @code{/usr/local}
83tree.
84
85@item
86Unpack the archives:
87@smallexample
88gzip -dc <path_to>/Singular-@value{VERSION}-@value{_UNAME}.tar.gz | tar -pxf -
89gzip -dc <path_to>/Singular-@value{VERSION}-share.tar.gz | tar -pxf -
90@end smallexample
91
92This creates the directory Singular/@value{VERSION} with
93@multitable @columnfractions .36 .64
94@item (sub)directories
95@tab  which contain
96@item @code{@value{_UNAME}}
97@tab @code{Singular} and @code{ESingular} executables
98@item @code{LIB}
99@tab @sc{Singular} libraries (@code{*.lib} files)
100@item @code{emacs}
101@tab files for the @sc{Singular} Emacs user interface
102@item @code{info}
103@tab info files of @sc{Singular} manual
104@item @code{html}
105@tab html files of @sc{Singular} manual
106@item @code{doc}
107@tab miscellaneous documentation files
108@item @code{examples}
109@tab @sc{Singular} examples (@code{*.sing} files)
110@end multitable
111
112For the executable to work, the directory layout must look pretty much
113like this; the executable will look for "sibling" directories at run-time
114to figure out where its @sc{Singular} libraries and on-line
115documentation files are. These constraints on the local directory layout
116are necessary to avoid having to hard-code pathnames into the
117executables, or require that environment variables be set before
118running the executable. In particular, you @strong{must not move or copy}
119the @sc{Singular} executables to another place, but use soft-links
120instead.
121@end enumerate
122
123The following steps are optional:
124
125@itemize @bullet
126@item
127Arrange that typing @code{Singular} at the shell prompt starts up the
128installed @sc{Singular} executable.
129
130If you have root permission, do:
131@smallexample
132ln -s `pwd`/Singular/@value{VERSION}/@value{_UNAME}/Singular  /usr/local/bin/Singular-@value{VERSION}
133ln -s `pwd`/Singular/@value{VERSION}/@value{_UNAME}/ESingular  /usr/local/bin/ESingular-@value{VERSION}
134ln -s /usr/local/bin/Singular-@value{VERSION} /usr/local/bin/Singular
135ln -s /usr/local/bin/ESingular-@value{VERSION} /usr/local/bin/ESingular
136@end smallexample
137       
138Otherwise, append the directory
139@code{`pwd`/Singular/@value{VERSION}/@value{_UNAME}/} to your @code{$PATH}
140environment variable. For the @code{csh} (or, @code{tcsh}) shell do:
141@smallexample
142set path=(`pwd`/Singular/@value{VERSION}/@value{_UNAME} $path)
143@end smallexample
144For the @code{bash} (or, @code{ksh}) shell do:
145@smallexample
146export PATH=`pwd`/Singular/@value{VERSION}/@value{_UNAME}/:$PATH
147@end smallexample
148
149You also might want to adjust your personal start-up files
150(@code{~/.cshrc} for @code{csh}, @code{~/.tcshrc} for @code{tcsh}, or
151@code{~/.profile} for @code{bash}) accordingly,
152so that the @code{$PATH} variable is set automatically each time you login.
153
154@strong{IMPORTANT:} Do @emph{never} move or copy the file
155@code{Singular/@value{VERSION}/@value{_UNAME}/Singular} to another
156place, but use soft-links instead.
157
158@item
159If you wish to use any of the following features of
160@sc{Singular}, make sure that the respective programs are installed on your system:
161
162@multitable @columnfractions .5 .5
163@item @strong{Feature} @tab @strong{Requires}
164@item running @code{ESingular}, or @code{Singular} within Emacs
165@tab @uref{http://www.gnu.org/software/emacs/emacs.html,,Emacs} version
16620 or higher, or, @uref{http://www.xemacs.org,,XEmacs} version 20.3 or
167higher (ESingular is only included in the Linux distribution.
168On other Unix platforms you can download the
169@uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/src/,,
170@sc{Singular} emacs lisp files} but we give no warranties for specific platforms).
171@item on-line @code{html} help
172@tab any web browser
173@item on-line @code{info} help
174@tab @uref{http://www.texinfo.org,,info}, or
175@uref{http://math-www.uni-paderborn.de/~axel/tkinfo/,,tkinfo} texinfo browser programs
176@item TAB completion and history mechanism of ASCII-terminal interface
177@tab shared @uref{ftp://ftp.de.uu.net/pub/gnu/readline/,,readline}
178library, i.e. @code{/usr/lib/libreadline.so}
179@item visualization of curves and surfaces
180@tab
181@uref{http://www.imaginary2008.de/surfer.php,,surfer}
182Setup executable for the visualization tool surfer.
183@end multitable
184
185You may download most of these programs from
186@display
187@uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/utils/}.
188@end display
189
190@item Customize the on-line help system:
191
192By default, on-line help is displayed in @code{html} format using
193the @code{netscape} program.
194
195However, this behavior can be customized in several ways
196using the @sc{Singular} commands @code{system("--browser",<browser>)}
197and @code{system("--allow-net", 1)} (or, by starting up @sc{Singular}
198with the respective command line options).
199
200In particular, creating the file
201@code{Singular/@value{VERSION}/LIB/.singularrc} and putting the
202@sc{Singular} command
203@smallexample
204system("--allow-net", 1);
205@end smallexample
206in it, allows the on-line help system to fetch its @code{html} pages
207from @uref{http://www.singular.uni-kl.de, Singular's WWW
208home site}
209in case its local html pages are not found. That is, you may delete your
210local html pages, after setting this option.
211
212See also
213@ifset singularmanual
214@ref{The online help system}, @ref{Command line options}, and
215@ref{Startup sequence},
216@end ifset
217@ifclear singularmanual
218the sections @emph{The online help system}, @emph{Command line options}, and
219@emph{Startup sequence} in the @sc{Singular} manual
220@end ifclear
221for more details on customizing the on-line help system.
222
223@item
224Add the line
225@smallexample
226* Singular:(singular.hlp).     A system for polynomial computations
227@end smallexample
228to your system-wide @code{dir} file (usually @code{/usr/info/dir} or
229@code{/usr/local/info/dir} and  copy or soft-link the file
230@code{Singular/@value{VERSION}/info/singular.hlp}
231to the directory of your @code{dir} file.
232@*This assures that the
233@sc{Singular} manual can be  accessed from stand-alone texinfo
234browser programs such as @code{info} or @code{Emacs}.
235(This is not a prerequisite for using the help system from within @code{Singular}.)
236@end itemize
237
238@heading Troubleshooting
239
240@itemize @bullet
241@item General: @sc{Singular} cannot find its libraries or on-line help
242@enumerate
243@item
244Make sure that you have read and/or execute permission the files and
245directories of the @sc{Singular} distribution. If in doubt, @code{cd} to the
246directory where you unpacked @sc{Singular}, and do (as root, if
247necessary):
248@smallexample
249chmod -R a+rX Singular
250@end smallexample
251
252@item
253Start up @sc{Singular}, and issue the command @code{system("Singular");}.
254If this does not return the correct and expanded location of the
255@sc{Singular} executable, then you found a bug in @sc{Singular}, which we
256ask you to report (see below).
257@item
258Check whether the directories containing the libraries and on-line help
259files can be found by @sc{Singular}: If @code{$bindir} denotes the
260directory where the @sc{Singular} executable resides, then @sc{Singular}
261looks for library files as follows:
262@* (0) the current directory
263@* (1) all dirs of the environment variable SINGULARPATH
264@* (2) @code{$bindir/LIB}
265@* (3) @code{$bindir/../LIB}
266@* (4) @code{/usr/local/Singular/@value{VERSION}/LIB}
267@* (4) @code{/usr/local/Singular/LIB}
268@* The on-line @code{info} files need to be at  @code{$bindir/../info} and the
269@code{html} pages at @code{$bindir/../html}.
270@end enumerate
271
272You can inspect the found library and @code{info}/@code{html}
273directories by starting up @sc{Singular} with the
274@code{--version} option, or by issuing the @sc{Singular} command
275@code{system("--version");}.
276
277@item Under previous SuSE-Linux releases, @sc{ESingular} did not display a prompt:
278@cindex SuSE, ESingular bug
279@cindex ESingular, no prompt
280@cindex bug, ESingular
281This is due to the very restrictive access rights of @code{/dev/pty*} of
282the standard @uref{http://www.suse.de,SuSE} distribution (starting from
283version 6.3 on). The problem may still be present when working with the latest SuSE-Linux release.
284As root, do one of the following: Either
285@example
286chmod 666 /dev/pty*
287@end example
288or,
289@example
290chmod g+s $(which emacs)
291chgrp tty $(which emacs)
292chmod g+s $(which xemacs)
293chgrp tty $(which xemacs)
294@end example
295
296@c @item For @code{HPUX} systems:
297@c @*The /etc/termcap files which are pre-installed on these systems are
298@c broken which leads to messages like
299@c @example
300@c Name collision between 9826 9836
301@c @end example
302@c when @sc{Singular} is started. To fix this, you can get fixed termcap
303@c files from @uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/utils}
304@c by downloading the files termcap-<uname-description> and either
305@c replace your /etc/termcap file by the file found there, or view, and
306@c redo the respective changes by @code{diff}'ing the downloaded and the
307@c original file.
308
309@item For @code{ix86-Linux} systems:
310@*Due to some incompatibilities of shared libraries, the start-up of
311@sc{Singular} might fail with messages like
312@example
313  Can not find shared library ...
314@end example
315For DEBIAN systems, try to do
316@code{ln -s /usr/lib/libncurses.so /usr/lib/libncurses.so.4}.
317@*If this fails (and on other systems)
318download and install
319@code{Singular-@value{VERSION}-ix86-Linux-static.tar.gz}.
320
321@item For @code{AIX} systems:
322@*The default @code{info} program of the system is not GNU's texinfo
323browser which is used to display the on-line documentation in the
324@code{info} format. Therefore, the distribution of the AIX executable
325already contains the @code{info} browser program.
326If you remove this program, make sure that the GNU
327@code{info} program is executed if you call '@code{info}' from your shell.
328
329@item For any other troubles:
330@*Please send an email to @email{singular@@mathematik.uni-kl.de}
331and include the header which is displayed by starting up @sc{Singular}
332with the @code{-v} option, and a description of your machine (issue the
333command @code{uname -a} on your shell) in your report.
334@end itemize
335
336@include info.texi
337
338@ifclear singularmanual
339GOOD LUCK and ENJOY!
340Your @sc{Singular} team.
341@end ifclear
342
Note: See TracBrowser for help on using the repository browser.