source: git/doc/README_src.texi @ 6ce030f

jengelh-datetimespielwiese
Last change on this file since 6ce030f was 6ce030f, checked in by Oleksandr Motsak <motsak@…>, 10 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: 4.3 KB
Line 
1@comment -*-texinfo-*-
2@c FILE: README_src.texi
3@c PURPOSE: This should reside as README file in the src directory of the
4@c          Singular ftp site.
5
6@ifclear VERSION
7@include version.texi
8@end ifclear
9
10
11@majorheading Welcome to the Development FTP site of SINGULAR
12
13@sc{Singular} is a Computer Algebra system for polynomial computations
14with special emphasize on the needs of commutative algebra, algebraic
15geometry, singularity theory and polynomial system solving. For a more
16detailed overview of
17@sc{Singular}, see
18@display
19@uref{http://www.singular.uni-kl.de/Overview/}
20@end display
21
22So far, there are only version for Linux, HPUX, SunOS, IRIX, AIX, FreeBSD 4.2,
23and Windows 95/98/NT/2K.
24
25@macro nref{name,url}
26@ifhtml
27@item @uref{\url\,,\name\}
28@end ifhtml
29@ifinfo
30@item @code{\name\}
31@end ifinfo
32@end macro
33
34In this directory you find the following files:
35@table @asis
36@nref{COPYING, COPYING.html}
37license information for @sc{Singular}
38@item @code{Singular-@value{VERSION}-<package>.tar.gz}
39@sc{Singular} distribution archive which contains the package @code{<package>}
40@item @code{omalloc.tar.gz}
41@sc{Singular} distribution archives which contains the package omalloc
42@end table
43
44@heading To compile SINGULAR for a Unix platform
45
46Make sure that you have approximately 120 MByte of free disk space and
47follow these steps.
48
49@enumerate
50@item
51Make sure that you have the following software (the list may be incomplete):
52  @enumerate
53  @item
54  general unix utilities: grep, test, sed, cp, mv, gzip, uudecode, ...
55  @item
56  autoconf
57  @item
58  gnu-make
59  @item
60  gcc, g++ (version 2.95.3 preferred,
61  but version 2.7.2 to gcc 2.95.4 should work)
62  gcc 2.96 does not work
63  gcc 3.0 does not work, gcc 3.1.x, gcc 3.2.x, gcc 3.3.x/3.4.x should
64  gcc 4.x: beginnig with Singular-3-0-0-4, for some architectures
65  @item
66  bison (version >= 1.2.2)
67  @item
68  flex (version >=2.4, <=2.5.4)
69  @item
70  perl (version >=5)
71  @item
72  library gmp (version 3.x.x, 4.x.x)
73  @item
74  (optional) library libreadline
75  @item
76  (optional, required to build the documentation:)
77  latex2html, tex, texi2html, texinfo
78  @* (your latex2html should produce gif files, not png files)
79  @end enumerate
80@item
81(optional, required for MP:)
82@*make sure that you can log in to your computer via rsh/remsh
83or ssh without a password (check .rhosts/.shosts);
84otherwise the configure script stops while checking this:
85if you cannot fix it, simply kill the rsh/ssh-processes
86- the configure will then disable this particulare feature
87@*The following is tested by configure
88@*rsh localhost uname
89@*ssh localhost uname
90@*rsh `hostname` uname
91@*ssh `hostname` uname
92@item
93You need to download all of the .tar.gz-files
94@item
95create a new working directory
96@item
97unpack all packages into that working directory
98@item
99(optional, for porting to a unknown machine:)
100fix ./singuname.sh not to report something unknown, but to recognize the machine
101@item
102run ./configure
103@*(try ./configure --help, ./omalloc/configure --help, ./MP/configure --help,
104./factory/configure --help, ./Singular/configure --help for a list of
105all options of configure)
106@item
107make install (resp. gmake install - the make program must be GNU-Make)
108the make process will (hopefully) build:
109  @enumerate
110  @item
111  omalloc: the memory management routines (required)
112  @item
113  MP: Multi-Protocoll (optional)
114  @item
115  factory (optional, but strongly recommended)
116  @item
117  libfac (optional, but strongly recommended)
118  @item
119  @sc{Singular} (Kernel, required)
120  @item
121  doc (only possible, if all optional packages are included)
122  @item
123  emacs (only possible, if doc was build)
124  @item
125  IntegerProgramming
126  @item
127  misc
128  @end enumerate
129@item
130if you want to make any change in the directories kernel or Singular,
131run make depend there
132@item
133to install the resulting files at any other place in the system,
134run
135@*      make bindist sharedist
136@*(sharedist can only be build if doc was build sucessfully)
137and install the resulting .tar.gz files as explained
138for the binary distribution
139@item
140if you compiled @sc{Singular} for a non-standard architecture and
141you are willing to share your porting effort,
142upload the changed sources and the resulting binaries to
143@code{ftp://www.mathematik.uni-kl.de/pub/Incoming}
144and send us an email about it (Singular@@mathematik.uni-kl.de)
145@item
146bug-fixes or other improvements to the source code are welcome
147@end enumerate
148
149GOOD LUCK and ENJOY!
150Your @sc{Singular} team.
151
Note: See TracBrowser for help on using the repository browser.