| 1 | Singular version <x.y.z> |
|---|
| 2 | University of Kaiserslautern |
|---|
| 3 | Department of Mathematics Centre for Computer Algebra |
|---|
| 4 | Authors: G.-M. Greuel, G. Pfister, H. Schoenemann |
|---|
| 5 | (C) 1986-1998 All Rights Reserved |
|---|
| 6 | |
|---|
| 7 | UNIX INSTALLATION INSTRUCTIONS FOR SINGULAR |
|---|
| 8 | ============================================ |
|---|
| 9 | |
|---|
| 10 | |
|---|
| 11 | To install Singular on a Unix platform, you need at least the |
|---|
| 12 | following two files: |
|---|
| 13 | |
|---|
| 14 | Singular-<x.y.z>-share.tar.gz |
|---|
| 15 | -- contains architecture-independent data like documentation or libraries |
|---|
| 16 | |
|---|
| 17 | Singular-<x.y.z>-<uname description>.tar.gz |
|---|
| 18 | -- contains architecture dependent executables, like the Singular program |
|---|
| 19 | |
|---|
| 20 | where <uname description> is a description of the processor and |
|---|
| 21 | operating system for which Singular is compiled (e.g, ix86-Linux). |
|---|
| 22 | You can obtain these files from |
|---|
| 23 | ftp://www.mathematik.uni-kl.de/pub/Math/Singular/. |
|---|
| 24 | |
|---|
| 25 | IMPORTANT |
|---|
| 26 | ========= |
|---|
| 27 | Please see the file COPYING contained in the distribution for license |
|---|
| 28 | information on Singular. In particular, notice that we only grant you |
|---|
| 29 | permission to use Singular, if you have registered yourself as a |
|---|
| 30 | Singular user by sending email to <singular@mathematik.uni-kl.de> |
|---|
| 31 | with the subject line (or, mail body) `register'. |
|---|
| 32 | |
|---|
| 33 | HOW TO INSTALL SINGULAR |
|---|
| 34 | ======================== |
|---|
| 35 | Simply change to the directory in which you wish to install SINGULAR, |
|---|
| 36 | and then unpack the architecture independent tar file, followed by |
|---|
| 37 | the architecture-dependent files for those architectures you use. |
|---|
| 38 | |
|---|
| 39 | cd /usr/local/ # or wherever you install 3rd-party software |
|---|
| 40 | gzip -dc Singular-<x.y.z>-share.tar.gz | tar -pxf - |
|---|
| 41 | gzip -dc Singular-<x.y.z>-<uname description>.tar.gz | tar -pxf - |
|---|
| 42 | |
|---|
| 43 | Replace `/usr/local/' with what you like, but it probably ought not |
|---|
| 44 | have `Singular' or a version number in it - that directory is expected |
|---|
| 45 | to be the common prefix for installed software, and Singular-specific |
|---|
| 46 | subdirectories of it will be created. The directories are arranged |
|---|
| 47 | in such a way that multiple versions of Singular can peaceably coexist |
|---|
| 48 | under the same `/usr/local/' tree. |
|---|
| 49 | You need appr. 10MByte of free disk space to unpack the archives. |
|---|
| 50 | |
|---|
| 51 | |
|---|
| 52 | After unpacking, you will have a directory structure like: |
|---|
| 53 | |
|---|
| 54 | ./<uname description>/bin/Singular-<x.y.z> executable(s) |
|---|
| 55 | ./<uname description>/bin/Singular soft link to executable |
|---|
| 56 | ./info/singular.hlp info file |
|---|
| 57 | ./Singular/LIB/<x.y.z>/ Singular libraries |
|---|
| 58 | ./Singular/doc/<x.y.z>/ documentation (ps, dvi, info) |
|---|
| 59 | ./Singular/html/<x.y.z>/ documentation (html) |
|---|
| 60 | |
|---|
| 61 | |
|---|
| 62 | For the executable to work, the directory layout must look pretty much |
|---|
| 63 | like this; the executable looks for "sibling" directories at run-time |
|---|
| 64 | to figure out where its Singular libraries and on-line info |
|---|
| 65 | documentation are. These constraints on the local directory layout |
|---|
| 66 | are necessary to avoid having to hardcode pathnames into the |
|---|
| 67 | executables, or require that environment variables be set before |
|---|
| 68 | running the executable. In particular, you should not move or copy |
|---|
| 69 | the Singular executables to another place, but use soft-links |
|---|
| 70 | instead. For example, to install Singular on your system, use |
|---|
| 71 | something like: |
|---|
| 72 | ln -s `pwd`./<uname description>/bin/Singular-<x.y.z> /usr/local/bin/Singular |
|---|
| 73 | Afterwards, you can start-up Singular by simply typing `Singular' at |
|---|
| 74 | the shell prompt. Alternatively, you can append ``pwd`./<uname |
|---|
| 75 | description>/bin/' to your environment PATH variable. |
|---|
| 76 | |
|---|
| 77 | See also the `TROUBLES' section below, if you run into any problems. |
|---|
| 78 | |
|---|
| 79 | |
|---|
| 80 | TO INSTALL THE ON-LINE DOCUMENTATION |
|---|
| 81 | ===================================== |
|---|
| 82 | Singular needs the `info' program for its on-line documentation. If |
|---|
| 83 | you do not have the `info' program installed on your system, you may |
|---|
| 84 | obtain it from |
|---|
| 85 | ftp://www.mathematik.uni-kl.de/pub/Math/Singular/utils/ |
|---|
| 86 | by downloading the respective info-<uname description>.tar.gz file. |
|---|
| 87 | |
|---|
| 88 | If you have the `info' program installed on your system, no further |
|---|
| 89 | actions are required. Otherwise, to install, simply cd to the |
|---|
| 90 | directory where you unpacked the other tar files and then unpack the |
|---|
| 91 | info tar file. |
|---|
| 92 | |
|---|
| 93 | cd /usr/local/ # i.e., wherever you have unpacked Singular tar files |
|---|
| 94 | gzip -dc info-<uname description>.tar.gz | tar -pxf - |
|---|
| 95 | |
|---|
| 96 | This adds |
|---|
| 97 | ./<uname description>/bin/info info program |
|---|
| 98 | to the above directory structure and ensures that the `info' program |
|---|
| 99 | is found at run-time. |
|---|
| 100 | |
|---|
| 101 | TROUBLES |
|---|
| 102 | ========= |
|---|
| 103 | |
|---|
| 104 | * For HPUX systems: |
|---|
| 105 | The /etc/termcap files which are pre-installed on these systems are |
|---|
| 106 | broken which leads to messages like |
|---|
| 107 | |
|---|
| 108 | Name collision between 9826 9836 |
|---|
| 109 | |
|---|
| 110 | when Singular is started. To fix this, you can get fixed termcap |
|---|
| 111 | files from |
|---|
| 112 | ftp://www.mathematik.uni-kl.de/pub/Math/Singular/utils |
|---|
| 113 | by downloading the files termcap-<uname-description> and either |
|---|
| 114 | replace your /etc/termcap file by the file found there, or view, and |
|---|
| 115 | redo the respective changes by diff'ing the downloaded and the |
|---|
| 116 | original file. |
|---|
| 117 | |
|---|
| 118 | * For Linux systems: |
|---|
| 119 | Due to some incompatibilities of shared libraries, the start-up of |
|---|
| 120 | Singular might fail with messages like |
|---|
| 121 | |
|---|
| 122 | Can not find shared library .... |
|---|
| 123 | |
|---|
| 124 | To fix this, first delete the files |
|---|
| 125 | ./<uname description>/bin/Singular |
|---|
| 126 | ./<uname description>/bin/Singular-<x.y.z> |
|---|
| 127 | |
|---|
| 128 | and then download and install |
|---|
| 129 | |
|---|
| 130 | Singular-<x.y.z>-<uname description>-static.tar.gz |
|---|
| 131 | |
|---|
| 132 | which contains statically linked executables. |
|---|
| 133 | |
|---|
| 134 | * For AIX systems: |
|---|
| 135 | The default 'info' program of the system is not GNU's hypertext |
|---|
| 136 | system which we need to display the on-line documentation. Therefore, |
|---|
| 137 | the distribution of the AIX executable already contains the 'info' |
|---|
| 138 | program we need. If you remove this program, make sure that the GNU |
|---|
| 139 | info program is executed if you call 'info' from your shell. |
|---|
| 140 | |
|---|
| 141 | * General: Singular can not find its libraries or info-file: |
|---|
| 142 | (1) Start up Singular, and issue the command `system("Singular");'. |
|---|
| 143 | If this does not return the correct and expanded location of the |
|---|
| 144 | Singular executable, then you found a bug in Singular, which we |
|---|
| 145 | ask you to report (see below). |
|---|
| 146 | (2) Check whether the directories containing the libraries and |
|---|
| 147 | info-file can be found by Singular: If $bindir denotes the |
|---|
| 148 | directory where the Singular executable resides, then Singular |
|---|
| 149 | looks for library files as follows: |
|---|
| 150 | 1.) In all dirs specified by the environment variable SINGULARPATH |
|---|
| 151 | 2.) $bindir/LIB |
|---|
| 152 | 3.) $bindir/LIB/<x.y.z> |
|---|
| 153 | 4.) $bindir/../../Singular/LIB |
|---|
| 154 | 5.) $bindir/../../Singular/LIB/<x.y.z> |
|---|
| 155 | 6.) /usr/local/Singular/LIB |
|---|
| 156 | 7.) /usr/local/Singular/LIB/<x.y.z> |
|---|
| 157 | The info-file, i.e., the file singular.hlp is looked for at the |
|---|
| 158 | following places: |
|---|
| 159 | 1.) $bindir/../doc |
|---|
| 160 | 2.) $bindir/../info |
|---|
| 161 | 3.) $bindir/../../Singular/doc/<x.y.z> |
|---|
| 162 | 4.) $bindir/../../Singular/doc |
|---|
| 163 | 5.) $bindir/../../info |
|---|
| 164 | 6.) /usr/local/Singular/doc/<x.y.z> |
|---|
| 165 | 7.) /usr/local/Singular/doc |
|---|
| 166 | 8.) /usr/local/info |
|---|
| 167 | 9.) In all directories contained in the Singular SearchPath. |
|---|
| 168 | (3) As a last resort, you can set the environment variable |
|---|
| 169 | SINGULARPATH, so that the directories containing the Singular |
|---|
| 170 | libraries and info-files are contained in the value of |
|---|
| 171 | SINGULARPATH. |
|---|
| 172 | You can inspect the used SearchPath and info-file by starting up |
|---|
| 173 | Singular with the `-v' option, or by issuing the command |
|---|
| 174 | `system("with")'. Use colons (i.e., `:') for directory separators |
|---|
| 175 | within the SINGULARPATH. |
|---|
| 176 | |
|---|
| 177 | |
|---|
| 178 | * General: Singular can not find the `info' program: |
|---|
| 179 | Install the info program on your system -- see the section |
|---|
| 180 | "TO INSTALL THE ON-LINE DOCUMENTATION" above. |
|---|
| 181 | |
|---|
| 182 | * For any other troubles, please send mail to |
|---|
| 183 | singular@mathematik.uni-kl.de |
|---|
| 184 | and include the header which is displayed by starting up Singular |
|---|
| 185 | with the `-v' option, and a description of your machine (issue the |
|---|
| 186 | command `uname -a' on your shell) in your report. |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | More information about Singular: Comments, Questions, Bug Reports |
|---|
| 190 | ================================================================= |
|---|
| 191 | |
|---|
| 192 | More and up-to-date information about Singular is always available |
|---|
| 193 | from |
|---|
| 194 | http://www.mathematik.uni-kl.de/~zca/Singular |
|---|
| 195 | We very much welcome any comments, questions, and bug reports. Please |
|---|
| 196 | contact us at |
|---|
| 197 | singular@mathematik.uni-kl.de |
|---|
| 198 | |
|---|
| 199 | |
|---|
| 200 | GOOD LUCK and ENJOY! Your Singular team. |
|---|
