source: git/doc/INSTALL_unix.texi @ c1cd11

spielwiese
Last change on this file since c1cd11 was 18daf9e, checked in by Olaf Bachmann <obachman@…>, 24 years ago
* last touches befor alpha-release git-svn-id: file:///usr/local/Singular/svn/trunk@3981 2c84dea3-7e68-4137-9b89-c4e89433aadc
  • Property mode set to 100644
File size: 11.4 KB
Line 
1@comment -*-texinfo-*-
2@comment $Id: INSTALL_unix.texi,v 1.8 1999-12-08 17:00:39 obachman 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 Unix installation instructions for @sc{SINGULAR} version @value{VERSION}
13@end ifclear
14
15@ifclear UNAME
16@set _UNAME <uname>
17@end ifclear
18
19@ifset UNAME
20@include uname.texi
21@end ifset
22
23To install @sc{Singular} on a
24@ifset UNAME
25@value{_UNAME}
26@end ifset
27@ifclear UNAME
28Unix
29@end ifclear
30platform, you need the following two
31archives:
32@table @code
33@item Singular-@value{VERSION}-share.tgz
34contains architecture independent data like documentation and libraries
35(alternatively, you may also download
36@code{Singular-@value{VERSION}-share.zip}).
37@item Singular-@value{VERSION}-@value{_UNAME}.tgz
38contains architecture dependent executables, like the @sc{Singular}
39program.
40@ifclear UNAME
41@code{@value{_UNAME}} is a description of the processor and operating system
42for which @sc{Singular} is compiled (e.g, @code{ix86-Linux}). Please contact us if
43you can not find an appropriate architecture dependent archive.
44@end ifclear
45@end table
46
47You can obtain these (and other) archives from
48@display
49@uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/Development}.
50@end display
51
52@ifclear singularmanual
53@strong{Important:} Please see
54@ifhtml
55@uref{COPYING.html, COPYING}
56@end ifhtml
57@ifnothtml
58the file COPYING contained in the distribution
59@end ifnothtml
60for license
61information on @sc{Singular}. In particular, notice that we only grant you
62permission to use @sc{Singular} if you have registered yourself as a
63@sc{Singular} user by sending email to @email{singular@@mathematik.uni-kl.de}
64with the subject line (or, mail body) @code{register}.
65@end ifclear
66
67@heading To install SINGULAR
68
69Make sure that you have approximately 12MByte of free disk space and follow
70these steps.
71@enumerate
72@item
73Simply change to the directory in which you wish to install
74@sc{Singular} (usually wherever you install 3rd-party software):
75@smallexample
76cd /usr/local/ 
77@end smallexample
78
79@sc{Singular} specific subdirectories will be created in such a way
80that multiple versions and multiple architecture dependent files
81of @sc{Singular} can peaceably coexist under the same @code{/usr/local/}
82tree.
83
84
85@item
86Unpack the archives:
87@smallexample
88gzip -dc Singular-@value{VERSION}-@value{_UNAME}.tgz | tar -pxf -
89gzip -dc Singular-@value{VERSION}-share.tgz | tar -pxf -
90@end smallexample
91If you have downloaded @code{Singular-@value{VERSION}-share.zip},
92unpack with
93@smallexample
94unzip -u Singular-@value{VERSION}-share.zip
95@end smallexample
96
97This creates the following
98@multitable @columnfractions .36 .64
99@item (sub)directories
100@tab  which contain
101@item @code{Singular/@value{VERSION}/@value{_UNAME}}
102@tab @code{Singular} and @code{ESingular} programs
103@item @code{Singular/@value{VERSION}/LIB}
104@tab @sc{Singular} libraries (@code{*.lib} files)
105@item @code{Singular/@value{VERSION}/emacs}
106@tab files for the @sc{Singular} Emacs user interface
107@item @code{Singular/@value{VERSION}/info}
108@tab info files of @sc{Singular} manual
109@item @code{Singular/@value{VERSION}/html}
110@tab html files of @sc{Singular} manual
111@item @code{Singular/@value{VERSION}/doc}
112@tab miscellaneous documentation files
113@item @code{Singular/@value{VERSION}/examples}
114@tab @sc{Singular} examples (@code{*.sing} files)
115@end multitable
116
117For the executable to work, the directory layout must look pretty much
118like this; the executable looks for "sibling" directories at run-time
119to figure out where its @sc{Singular} libraries and on-line
120documentation files are.  These constraints on the local directory layout
121are necessary to avoid having to hard-code pathnames into the
122executables, or require that environment variables be set before
123running the executable. In particular, you should not move or copy
124the @sc{Singular} executables to another place, but use soft-links
125instead.
126@end enumerate
127
128The following steps are optional:
129
130@itemize @bullet
131@item
132Arrange that typing @code{Singular} at the shell prompt starts up the
133installed @sc{Singular} executable.
134
135If you have root permission, do:
136@smallexample     
137ln -s `pwd`/Singular/@value{VERSION}/@value{_UNAME}/Singular  /usr/local/bin/Singular-@value{VERSION}
138ln -s `pwd`/Singular/@value{VERSION}/@value{_UNAME}/ESingular  /usr/local/bin/ESingular-@value{VERSION}
139ln -s /usr/local/bin/Singular-@value{VERSION} /usr/local/bin/Singular
140ln -s /usr/local/bin/ESingular-@value{VERSION} /usr/local/bin/ESingular
141@end smallexample
142       
143Otherwise, append the directory
144@code{`pwd`/Singular/@value{VERSION}/@value{_UNAME}/} to your @code{$PATH}
145environment variable. For the @code{csh} (or, @code{tcsh}) shell do:
146@smallexample
147set path=(`pwd`/Singular/@value{VERSION}/@value{_UNAME} $path)
148@end smallexample
149For the @code{bash} (or, @code{ksh}) shell do:
150@smallexample 
151export PATH=`pwd`/Singular/@value{VERSION}/@value{_UNAME}/:$PATH
152@end smallexample
153
154You also might want to adjust your personal start-up files
155(@code{~/.cshrc} for @code{csh}, @code{~/.tcshrc} for @code{tcsh}, or
156@code{~/.profile} for @code{bash}) accordingly,
157so that the @code{$PATH} variable is set automatically each time you login.
158
159@strong{IMPORTANT:} Do @emph{never} move or copy the file
160@code{Singular/@value{VERSION}/@value{_UNAME}/Singular} to another
161place, but use soft-links instead.
162
163@item
164If you wish to use any of following features of
165@sc{Singular}, make sure that the respective programs are installed on your system:
166
167@multitable @columnfractions .5 .5
168@item @strong{Feature} @tab @strong{Requires}
169@item running @code{ESingular}, or @code{Singular} within Emacs
170@tab @uref{http://www.fsf.org/software/emacs/emacs.html,,Emacs} version
17120 or higher, or, @uref{http://www.xemacs.org,,Xemacs} version 20 or
172higher
173
174@item on-line @code{html} help
175@tab @uref{http://www.netscape.com,,netscape} browser
176@item on-line @code{info} help
177@tab @uref{http://www.texinfo.org,,info}, or
178@uref{http://math-www.uni-paderborn.de/~axel/tkinfo/,,tkinfo} texinfo browser programs
179@item TAB completion and history mechanism of ASCII-terminal interface
180@tab shared @uref{ftp://ftp.de.uu.net/pub/gnu/readline/,,readline}
181library, i.e. @code{/usr/lib/libreadline.so}
182@item visualization of curves and surfaces
183@tab
184@uref{http://www.mathematik.uni-mainz.de/AlgebraischeGeometrie/surf/surf.shtml,,surf}
185version 0.9 or higher (only available for Linux and Solaris).
186@end multitable
187
188You may download most of these programs from
189@display
190@uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/utils/}.
191@end display
192
193@item Customize the on-line help system:
194
195By default, on-line help is displayed in the @code{html} format using
196the @code{netscape} program.
197
198However, this behavior can be customized in several ways
199using the @sc{Singular} commands @code{system("--browser",<browser>)}
200and @code{system("--allow-net", 1)} (or, by starting up @sc{Singular}
201with the respective command line options).
202
203In particular, creating the file
204@code{Singular/@value{VERSION}/LIB/.singularrc} and putting the
205@sc{Singular} command
206@smallexample
207system("--allow-net", 1);
208@end smallexample
209in it, allows the on-line help system to fetch its @code{html} pages
210from @uref{http://www.mathemtaik.uni-kl.de/~zca/Singular, Singular's WWW
211home site}
212in case its local html pages are not found. That is, you may delete your
213local html pages, after setting this option.
214
215See also
216@ifset singularmanual
217@ref{The online help system}, @ref{Command line options}, and
218@ref{Startup sequence},
219@end ifset
220@ifclear singularmanual
221the sections @emph{The online help system}, @emph{Command line options}, and
222@emph{Startup sequence} in the @sc{Singular} manual
223@end ifclear
224for more details on customizing the on-line help system.
225
226@item
227Add the line
228@smallexample
229* Singular:(singular.hlp).     A system for polynomial computations
230@end smallexample
231to your system-wide @code{dir} file (usually @code{/usr/info/dir} or
232@code{/usr/local/info/dir} and  copy or soft-link the file
233@code{Singular/@value{VERSION}/info/singular.hlp}
234to the directory of your @code{dir} file.
235@*This assures that the
236@sc{Singular} manual can be  accessed from stand-alone texinfo
237browser programs such as @code{info} or @code{Emacs}.
238@end itemize
239
240@heading Troubleshooting
241
242@itemize @bullet
243@item General: @sc{Singular} can not find its libraries or on-line help
244@enumerate
245@item
246Start up @sc{Singular}, and issue the command @code{system("Singular");}.
247If this does not return the correct and expanded location of the
248@sc{Singular} executable, then you found a bug in @sc{Singular}, which we
249ask you to report (see below).
250@item
251Check whether the directories containing the libraries and on-line help
252files can be found by @sc{Singular}: If @code{$bindir} denotes the
253directory where the @sc{Singular} executable resides, then @sc{Singular}
254looks for library files as follows:   
255@* (0) the current directory     
256@* (1) all dirs of the environment variable SINGULARPATH
257@* (2) @code{$bindir/LIB}
258@* (3) @code{$bindir/../LIB}
259@* (4) @code{/usr/local/Singular/@value{VERSION}/LIB}
260@* (4) @code{/usr/local/Singular/LIB}
261@* The on-line @code{info} files need to be at  @code{$bindir/../info} and the
262@code{html} pages at @code{$bindir/../html}.
263@end enumerate
264
265You can inspect the found library and @code{info}/@code{html}
266directories by starting up @sc{Singular} with the
267@code{--version} option, or by issuing the @sc{Singular} command
268@code{system("--version");}.
269
270@item For @code{HPUX} systems:
271@*The /etc/termcap files which are pre-installed on these systems are
272broken which leads to messages like
273@example
274Name collision between 9826 9836
275@end example
276when @sc{Singular} is started. To fix this, you can get fixed termcap
277files from @uref{ftp://www.mathematik.uni-kl.de/pub/Math/Singular/utils}
278by downloading the files termcap-<uname-description> and either
279replace your /etc/termcap file by the file found there, or view, and
280redo the respective changes by @code{diff}'ing the downloaded and the
281original file.
282
283@item For @code{ix86-Linux} systems:
284@*Due to some incompatibilities of shared libraries, the start-up of
285@sc{Singular} might fail with messages like
286@example
287  Can not find shared library ...
288@end example
289To fix this, download and install
290@code{Singular-@value{VERSION}-ix86-Linux-static.tgz}.
291
292@item For @code{AIX} systems:
293@*The default @code{info} program of the system is not GNU's texinfo
294browser which is used to display the on-line documentation in the
295@code{info} format. Therefore, the distribution of the AIX executable
296already contains the @code{info} browser program.
297If you remove this program, make sure that the GNU
298@code{info} program is executed if you call '@code{info}' from your shell.
299
300@item For any other troubles:
301@*Please send an email to @email{singular@@mathematik.uni-kl.de}
302and include the header which is displayed by starting up @sc{Singular}
303with the @code{-v} option, and a description of your machine (issue the
304command @code{uname -a} on your shell) in your report.
305@end itemize
306
307
308@heading More information about @sc{Singular}: Comments, Questions, Bug Reports
309More and up-to-date information about @sc{Singular} is always available
310from
311@display
312@uref{http://www.mathematik.uni-kl.de/~zca/Singular}.
313@end display
314We very much welcome any comments, questions, and bug reports. Please
315contact us at
316@display
317@email{singular@@mathematik.uni-kl.de}.
318@end display
319
320@ifclear singularmanual
321GOOD LUCK and ENJOY!                         
322Your @sc{Singular} team.
323@end ifclear
324
Note: See TracBrowser for help on using the repository browser.