This document describes how to install GAP 4 on a Macintosh under MacOS. Section "Getting GAP" describes where to get GAP 4 and which files to get. Section "Installation of GAP for MacOS" describes the installation process. Getting GAP GAP is distributed free of charge. You can obtain it via ftp and give it away to your colleagues. GAP is not in the public domain, however. In particular you are not allowed to incorporate GAP or parts thereof into a commercial product. If you get GAP, we would appreciate it if you could notify us, e.g., by sending a short e-mail message to gap@dcs.st-and.ac.uk, containing your full name and address, so that we have a rough idea of the number of users. We also hope that this number will be large enough to convince various agencies that GAP is a project worthy of (financial) support. If you publish some result that was partly obtained using GAP, we would appreciate it if you would cite GAP, just as you would cite another paper that you used. (The copyright page of the manual gives a sample citation.) Again we would appreciate if you could inform us about such a paper. The current release of GAP is version 4.3. We distribute the full source for everything, the C code for the kernel, the GAP code for the library, and the TeX code for the manual. So it should be no problem to get GAP, even if you have a rather uncommon system. Of course, ports to non UNIX systems may require some work. Note that about 16 MByte of main memory (though at least 32 MByte is desirable) and about 30MB of disk space are required to run GAP. A full GAP installation, including all GAP packages and data libraries can use 200MB and more of disk space. GAP will compile on pentium (586) processors, though a faster machine is recommended. We list and describe the extraction from .zoo archives below. As of GAP 4.3, however, we also supply the equivalent .zip and .tar.gz archives (simply download the archive type you prefer and use the corresponding extraction command). (If you already downloaded an installation archive, you may ignore the rest of this section.) The easiest way to get GAP for most users is probably via the World Wide Web. The main GAP Web site is found at http://www.gap-system.org There are two mirror sites updated automatically each night, at: http://www.math.rwth-aachen.de/~GAP http://www.ccs.neu.edu/mirrors/GAP and At these sites you can browse this manual, download the system and contributed extensions, read past postings to the GAP forum, and find out about authors of and contributors to GAP, publications that cited GAP and GAP related events. GAP can also be obtained by anonymous ftp from (at least) the following servers. ftp-gap.dcs.st-and.ac.uk: School of Mathematical and Computational Sciences, University of St Andrews, Scotland, UK. Directory /pub/gap/gap4/. ftp.math.rwth-aachen.de: Lehrstuhl D für Mathematik, RWTH Aachen, Germany. Directory /pub/gap4/. ftp.ccs.neu.edu: College of Computer Science, Northeastern University, Boston, USA. Directory /pub/mirrors/ftp-gap.dcs.st-and.ac.uk/pub/gap/gap4. ftp to the server closest to you, login as user ftp and give your full e-mail address as password. Remember when you transmit the files to set the file transfer type to binary image, otherwise you will only receive unusable garbage. Those servers will always have the latest version of GAP available. The WWW page for the GAP distribution and the ftp directory contain the following files. Please check first which files you need, to avoid transferring those that you do not need. Except for the package archives all archives should be extracted at the ``top'' level level (i.e. they contain a gap4r3 directory). INSTALL, INSTALL.WIN, INSTALL-MAC.TXT: Installation files, one of which you are currently reading. FILES: More detailed description of the available files. gap4r3.zoo: This file contains the complete standard distribution of GAP version 4.3 (it does not include the packages contained in accpkg4r3.zoo and deppkg4r3.zoo). basic4r3.zoo: This file contains a minimal distribution of GAP version 4.3. (There are further archives with which you can ``upgrade'' it to the full version.) gappc4r3.zoo: This file contains a complete distribution for 32-bit Windows. It includes a precompiled binary. gapmac4r3.zoo: This file contains a complete distribution for Macintosh under MacOS. You will also need to obtain the binaries separately from the bin subdirectory via ftp or from the links on the Distribution web page. accpkg4r3.zoo: This file contains all accepted GAP packages as of the release date. It should be extracted in the pkg directory of a previously extracted GAP distribution or a user's private pkg directory. deppkg4r3.zoo: This file contains all deposited, but not accepted, GAP packages whose authors wish to make them available, as of the release date. They should be viewed as analogous to preprints. It should be extracted in the pkg directory of a previously extracted GAP distribution or a user's private pkg directory. tools4r3.zoo: This file contains additional files not provided in the standard distribution, mainly needed by package developers for the purpose of generating documentation. util/unzoo.c: A simple zoo archive extractor, which should be used to unpack the distribution. The bin subdirectory contains precompiled executables for common systems. More files are available from the Distribution web page links or the following ftp subdirectories: bin: This directory contains executables for systems that do not come with a C compiler or where another C compiler produces a faster executable. split: This directory contains the complete distribution of GAP 4.3 in several smaller archives. accpkg: This directory contains all accepted GAP packages in case you don't want to load the comprehensive accpkg archive. deposit/pkg: This directory contains all deposited but not yet accepted GAP packages whose authors wish to make them available, in case you don't want to load the comprehensive deppkg archive. GAP for MacOS This section contains information about GAP that is specific to the port of GAP for Apple Macintosh systems under MacOS (simply called GAP for MacOS below). To run GAP for MacOS you need an Apple Macintosh with a Motorola M68020, M68030, or M68040 processor, or a Power Macintosh. The computer must have at least 16MByte of (physical) memory and a harddisk. For serious calculations, much more may be needed. The operating system must be System 7 or higher. GAP for MacOS runs under System X, however only in Classic Mode. Note that, alternatively, you can run GAP for UNIX version of GAP in the Terminal window. However, you may need additional development software, available from Apple, to compile GAP yourself. See GAP for UNIX for installation instructions. The section Copyright of GAP for MacOS describes the copyright as it applies to the executable version that we distribute. The section Installation of GAP for MacOS describes how you install GAP for MacOS. Please refer to the relevant sections of Chapter Running GAP in the GAP reference manual (included with the GAP distribution for an overview over the features of GAP for MacOS. Copyright of GAP for MacOS In addition to the general copyright for GAP set forth in the Copyright the following terms apply to GAP for the Mac. The system dependent part of GAP for the Mac was written by Burkhard Höfling (his email address is b.hoefling@tu-bs.de). He assigns the copyright to the GAP group. Many thanks to Burkhard for his help! Burkhard Höfling's port was partly based on an earlier port of GAP for the Mac, which was done by Dave Bayer (dab@math.columbia.edu) and used the Mac Programmers Workshop (MPW) compiler. Many thanks to Dave for his work. Moreover, the built-in editor is based upon the freeware text editor PlainText by Mel Park which, in turn, uses TE32K, a TextEdit replacement by Roy Wood. It also uses Internet Config. For technical reasons we do not distribute the Macintosh specific source and project files as part of the standard archives. If you are interested in compiling GAP yourself, we are happy to provide you with the appropriate files (contact us at gap-trouble@dcs.st-and.ac.uk). The source can be compiled with CodeWarrior Pro 5 with Apple's Universal Headers 3.3 installed. Please contact the author b.hoefling@tu-bs.de or gap-trouble@dcs.st-and.ac.uk if you need further information. Installation of GAP for MacOS Installing GAP under MacOS is fairly easy. First, decide into which folder you want to install GAP 4.3. GAP will be installed in a subfolder gap4r3 of this folder. You can later move GAP to a different location. Note that certain parts of the output in the examples should only be taken as rough outline, especially file sizes and file dates are not to be taken literally. If you encounter problems please also see section If Things Go Wrong of this document. Get the Mac-specific files described in Getting GAP, that is, the distribution gapmac4r3.zoo, the binary archive unzoo4r3-PPC.sit, the most recent bugfix, and the GAP application program (also called binary or executable). The GAP application program is distributed as a binary archive. It is called bin4r3-PPC.sit if no bugfixes requiring a new GAP application have been issued so far. Otherwise, it is called bin4r3nX-PPC.sit, where X is the number of the last bugfix. The latest GAP application archive is available from the GAP distribution web page, or from the mac subdirectory of the bin subdirectory on the ftp servers. How you can get those files is described in the section Getting GAP. Remember that the distribution consists of binary files and that you must transmit them in binary mode. If the sit files did not extract automatically click on them to extract them. If even this fails use one of the standard decompression utilities, such as Stuffit Expander. After this process you should end up with two applications, GAP 4 PPC and unzoo 4.3 PPC. The latter is used to uncompress the .zoo archives which contain most of GAP. The zoo archives we provide for GAP contain comments which indicate whether files are text or binary files. The unzoo we provide uses these comments. If you use another zoo extractor you might lose this information and end up with files that contain text but cannot be opened as text files. The following installation example assumes that you are installing GAP in the folder Applications on a PowerPC Macintosh. (For a 68k Macintosh you should replace all references to PPC to ones referring to 68K Move the file gapmac4r3.zoo into the folder Applications and drag it onto the icon of unzoo 4.3 PPC. You will get many lines of output in this window. This should have created a folder gap4r3 in the current folder. (You will not need the file gapmac4r3.zoo any longer. If you are short of disk space you can remove it now.) If you got not the full distribution file but several small files, extract all of them (except the bug fixes and GAP packages!) in this way. Move GAP 4 PPC and the bugfix file (if there is one) in the folder gap4r3. Drag the bugfix file onto the icon of unzoo 4.3 PPC to decompress it. If you got any GAP packages, move them into the pkg folder in the folder folder gap4r3 extract them there, in the same way as the bugfix. Some GAP packages are set up to load (or provide the documentation) automatically. To enable this, after installing all the packages you think you will need, you should list all the GAP packages you have installed in a file ALLPKG in the pkg directory (see Section Loading a GAP Package in the Reference Manual for details). After extraction you may discard all .zoo files if you are short of disk space. The folders trans, small and prim contain data libraries. If you are short of disk space you can erase some of them and any GAP package directories in the pkg directory that you don't need, but then of course you will not be able to access these data and packages. (Any GAP package that has a C code component is essentially UNIX-dependent and you may as well delete those; such packages typically describe in their README files that they require configure and make to complete their installation or have a src directory.) Before you use GAP, you should set up GAP's memory allocation, by setting appropriate values by selecting the GAP application and Get Info... in the Finder's File menu (in order to be able to modify the values there, you have to do this before you launch GAP). The maximum amount of workspace GAP can use depends on the amount of memory the Finder allocates to GAP when it is launched. The maximum amount of GAP workspace is this value, minus a certain amount used internally by the GAP application (for the PPC version, currently around 1.7 Megabytes, plus the size of the GAP application if you do not use virtual memory, and 2.9 Megabytes for the 68K version), minus any additional amount set with the -a, -P or -W command line options (see below). You can find information about the amount of free GAP workspace, the total amount of available workspace, and the remaining free memory, by choosing About GAP in the Apple menu. To ensure efficient operation, you should not allocate more memory to GAP than the amount of physical memory in your computer. If you are not using virtual memory, the amount may have to be considerably less (depending on your system and the number of other applications which you may want to run at the same time). If you notice heavy disk use during garbage collections, this is a clear indication that you have allocated too much memory to GAP. In order to test your installation now run the GAP application by clicking on GAP 4 PPC. You should get the GAP banner and then the GAP prompt in a window titled GAP log. (The process of starting GAP may take a while.) Try a few things to see if the installation succeeded. gap> 2 * 3 + 4; 10 gap> Factorial( 30 ); 265252859812191058636308480000000 gap> Size( SymmetricGroup( 10 ) ); 3628800 gap> Factors( 10^42 + 1 ); [ 29, 101, 281, 9901, 226549, 121499449, 4458192223320340849 ] gap> m11 := Group((1,2,3,4,5,6,7,8,9,10,11),(3,7,11,8)(4,10,5,6));; gap> Size( m11 ); 7920 gap> Factors( 7920 ); [ 2, 2, 2, 2, 3, 3, 5, 11 ] gap> Length( ConjugacyClasses( m11 ) ); 10 A set of test files is provided, running them all probably takes some 40 minutes on a 200 MHz PPC machine. As a quick test we start combinat.tst first. Initially we must ensure that the print width of GAP is 80 characters per line which we achieve with the SizeScreen command (otherwise we will be swamped with error messages). gap> SizeScreen([80,]);; gap> Filename( DirectoriesLibrary("tst"), "combinat.tst" ); "./tst/combinat.tst" gap> ReadTest(last); + $ld: combinat.tst,v 4.7 1997/11/21 10:19:47 ahulpke Exp $ + GAP4stones: 27801 true Now use Read (not ReadTest) to read the file testall.g to run all available test files. This is not a necessary part of the installation; it only serves as a confirmation that everything went OK. The full test suite takes some time (almost 2 hours on a Pentium III/500) and uses quite a bit of memory (around 100MB), so you may wish to skip this step or run only part of the tests. This does no harm. You should not pay too much attention to the GAPstone ratings of the different files. The time measurements are not calibrated and sometimes vary substantially because further tests have been added to a file. gap> Filename( DirectoriesLibrary("tst"), "testall.g" ); "./tst/testall.g" gap> Read(last); [lines omitted] test file GAP4stones time(msec) ------------------------------------------- unknown.tst 15238 21 (next ~ 0 sec) listgen.tst 118000 5 (next ~ 0 sec) gaussian.tst 2738 325 (next ~ 0 sec) [further lines omitted] You can ignore warnings from weakptr.tst, which stem from garbage collections occurring at different times, and those from grpconst.tst which stem from differences in available GAP packages. The information about the manual is system independent; you can find it in section The Documentation. A few final reminders: * Make sure that you got and installed the most recent bugfix. * We would appreciate after installation your sending us a short note at gap@dcs.st-and.ac.uk (even if you have installed GAP 3 before). Generally, we do not reply to such emails; we only use them to gain some idea of how many people use GAP and of the machines/operating systems on which GAP has been successfully installed. * We also suggest that you subscribe to our gap-forum mailing list; see the GAP web pages for details. Whenever there is a bug fix or new release of GAP this is where it is announced. The gap-forum also deals with user questions of a general nature; bug reports and other problems you have while installing and/or using GAP should be sent to gap-trouble@dcs.st-and.ac.uk. That's all, your installation should be complete. Please refer to Chapter Running GAP in the GAP reference manual for a description of some special features and options of GAP for MacOS. We hope that you will enjoy using GAP. Remember, if you have problems, do not hesitate to contact us at gap-trouble@dcs.st-and.ac.uk. See Section If Things Go Wrong for what to include in a bug report. The Documentation The GAP manual is distributed in various ``books''. The standard distribution contains four of them (as well as a comprehensive index). GAP packages (see Chapter GAP Packages and, in particular, Section Loading a GAP Package) provide their own documentation in their own doc directories. All documentation will be available automatically for the online help (see Section Tut:Help in the Tutorial and Chapter The Help System in this manual for more details). There also is (if installed) an HTML version of some books that can be viewed with an HTML browser, see Changing the Help Viewer. Some of these use symbol fonts for mathematical formulae. To get them correctly displayed (only in a browser which uses a graphical display), you may want to adjust the font setup for your browser. See HTML Font Setup below for a hint. The manual is also available in dvi and pdf format. In the full UNIX distribution (gap4r3.zoo) these files are included in the directory gap4r3/doc in the subdirectories tut (a beginner's tutorial), ref (the reference manual), prg (programmer's tutorial), ext (programmer's reference) and new (new material that might still change in future versions). If you downloaded another distribution file, you can get the missing dvi (resp. pdf) files by downloading the archive docdvi4r3.zoo (resp. docpdf4r3.zoo) from the same place you got GAP. If you want to use these manual files with the online help you may check (or make sure) that your system provides some additional software like xpdf see http://www.foolabs.com/xpdf/ xdvi see any of the CTAN sites/mirrors; the main site is: http://www.ctan.org/ and the mirrors are listed at: http://www.ctan.org/tex-archive/CTAN.sites At any of the mirrors the path of the file containing the xdvi archive (after the main site name) is tex-archive/dviware/xdvi/xdvi.tar.gz. acroread see http://www.adobe.com/products/acrobat/readstep.html As a complete beginner, we suggest you read the tutorial first for an introduction to GAP 4. Then start to use the system with extensive use of the online help system (see Section Tut:Help in the Tutorial and Chapter The Help System in this manual). If you have experience with GAP 3, it might be still worthwhile to at least glance over the first chapters of the tutorial. You however should read the last chapter of the tutorial, ``Migrating to GAP4''. This chapter gives a summary of changes between GAP 3 and GAP 4 that will affect the user. It also explains a ``compatibility mode'' you may turn on to make GAP 4 behave a bit more like GAP 3. As some of the manuals are quite large, you should not immediately print them. If you start using GAP it will be helpful to print the tutorial (and probably the first chapters of the reference manual). There is no compelling reason to print the whole of the reference manual, better use the online help which provides useful search features. HTML Font Setup The HTML pages of the manual use the symbol font to display non-latin symbols in mathematical formulae. This font might not be enabled by default on your browser. The documentation of the tth converter we use http://hutchinson.belmont.ma.us/tth/Xfonts.html describes how to set up this font for use in Netscape or Konqueror. For Netscape on UNIX, essentially you want: Netscape*documentFonts.charset*adobe-fontspecific: iso-8859-1 in your .Xresources or .Xdefaults file. A good test to see if you need this remedy is to check the display of: {1,...,n}; if you see an ellipsis (three dots) between the commas, you are ok, and if you see 1/4 you need the remedy! If you have problems viewing symbol fonts on the Mac, you may have to choose Mac font encoding, sometimes called MacRoman, or Western (Mac). More information about the font setup on Macintoshes can be found http://hutchinson.belmont.ma.us/tth/manual/sec12.html, Section 12.3. If Things Go Wrong This section lists a few common problems when installing or running GAP and their remedies. Also see the FAQ list on the GAP web pages at http://www.gap-system.org/Info/faq.html GAP starts with a warning ``hmm, I cannot find 'lib/init.g'''. You either started only the binary or did not edit the shell script/batch file to give the correct library path. You must start the binary with the command line option -l path where path is the path to the GAP home directory. See section Command Line Options in the reference manual. When starting, GAP produces error messages about undefined variables. You might have a .gaprc file that was intended for GAP 3 but is not compatible with GAP 4. See section The .gaprc file in chapter Running GAP of the reference manual. GAP stops with an error message: ``cannot extend the workspace any more''. Your calculation exceeded the available memory. Most likely you asked GAP to do something which required more memory than you have (as listing all elements of S[15] for example). You can use the command line option -g (see section Command Line Options in the reference manual) to display how much memory GAP uses. If this is below what your machine has available (this happens for example under Windows) extending the workspace is impossible. Start GAP with more memory or use the -a option to pre-allocate initially a large piece of workspace. GAP complains: ``corrupted completion file''. Some library files got changed without rebuilding the completion files. This is often a sign that earlier a bugfix was not installed properly or that you changed the library yourself. In the latter case, start GAP with command line option -N and see section Completion Files. GAP stops with an error message ``exceeded the permitted memory''. Your job got bigger than what is permitted by default (128MB). (This is a safety feature to avoid single jobs wrecking a multi-user system.) You can type return; to continue, if the error message happens repeatedly you better start the job anew and use the command line option -o to set a higher memory limit. make complains about not being able to find files in cnf or src which exist. The dates of the new files were not extracted properly (Alpha-OSF machines are prone to this). Call touch * cnf/* src/* from the main GAP directory (this ought to reset the date of all relevant files to ``now'') and try again. Recompilation does not actually compile changed files. The dates of the new files were not extracted properly. Go in the source directory and touch (UNIX command to change date) the new files. Recompilation fails or the new binary crashes. Call make clean and restart the configure / make process completely from scratch. (It is possible that the operating system and/or compiler got upgraded in the meantime and so the existing .o files cannot be used any longer. A calculation runs into an error ``no method found''. GAP is not able to execute a certain operation with the given arguments. Besides the possibility of bugs in the library this means two things: Either GAP truly is incapable of coping with this task (the objects might be too complicated for the existing algorithms or there might be no algorithm that can cope with the input). Another possibility is that GAP does not know that the objects have certain nice properties (like being finite) which are required for the available algorithms. See sections ApplicableMethod and KnownPropertiesOfObject. Problems specific to Windows The gap.bat file does not start GAP. Make sure you ran instwin.bat. If your version of Windows uses a language other than English you must still edit the resulting file gap.bat in the bin subdirectory, due to a misdesign of Windows. If the path name contains long file names or blanks, you might have to edit the file to rectify the -l argument or to enclose it by apostrophes. Windows complains Out of environment space. Click the batch file instwin.bat or gap.bat which caused the problem with the right mouse button and select Properties,Memory and increase the initial environment space to at least 1024. This will create a pif shortcut which should be used to start GAP. Command line editing does not work under Windows. The default key commands are UNIX-like. GAP also tries to emulate some of the special keys under Windows, however if the key repeat is set too high, Windows loses parts of the codes for these keys and thus GAP cannot recognize them. Windows98 produces the same scan code for all cursor keys. As GAP does not interface directly with the Windows machinery, there is no way around this problem so far. The ^-key cannot be entered. This is a problem if you are running a keyboard driver for some non-english languages. These drivers catch the ^ character to produce the French circumflex accent and do not pass it properly to GAP. No fix is known. Cut and Paste does not work See http://www.gap-system.org/Info4/windows.html for a remedy. If all these remedies fail or you encountered a bug please send a mail to gap-trouble@dcs.st-and.ac.uk. Please give: * a (short, if possible) self-contained excerpt of a GAP session containing both input and output that illustrates your problem (including comments of why you think it is a bug); and * state the type of machine, operating system, (compiler used, if UNIX/Linux) and version of GAP (for example ``gap4r3, fix1'') you are using (the line after the GAP 4 banner starting: GAP4, Version: 4... when your GAP 4 starts up, supplies the information required).