home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / progmisc / djasy10d.zip / README < prev    next >
Text File  |  1992-07-06  |  15KB  |  389 lines

  1.  
  2. This is the README file for DJ's GCC port to DOS ("djgpp")
  3.  
  4. Contents:
  5.     * Overview
  6.     * What's available
  7.     * How to install
  8.     * Deviations and Caveats
  9.     * Copyright information
  10.  
  11. Disclaimer: This software is distributed WITHOUT ANY WARRANTY; without
  12. even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  13. PURPOSE.
  14.  
  15. DJ Delorie
  16. USmail: 24 Kirsten Ave, Rochester, NH 03867-2954, USA
  17. email:  dj@ctron.com
  18.  
  19. mailing list: djgpp@sun.soe.clarkson.edu (listserv@sun.soe.clarkson.edu)
  20.  
  21.  
  22.  
  23.  
  24. Overview:
  25.  
  26. This package contains a 32-bit 80386 DOS extender with symbolic
  27. debugger, a C/C++ compiler with utilities, development libraries, and
  28. source code.  It generates full 32-bit programs and supports full
  29. virtual memory with paging to disk. 
  30.  
  31. Requirements:
  32.  
  33. A 80386-based IBM compatible PC or PS/2, approximately 4-5Mb of hard
  34. drive space, and 512K RAM.  Available extended (or expanded under VCPI)
  35. memory is strongly recommended.
  36.  
  37. Supported Wares:
  38.  
  39. * Up to 128M of extended memory (expanded under VCPI)
  40. * Up to 128M of disk space used for swapping
  41. * SuperVGA 256-color mode up to 1024x768
  42. * 80387
  43. * XMS & VDISK memory allocation strategies
  44. * VCPI programs, such as QEMM, DESQview, and 386MAX
  45.  
  46. Unsupported:
  47.  
  48. * DPMI
  49. * Microsoft Windows
  50. * Multiprocessing (fork())
  51.  
  52.  
  53.  
  54.  
  55. File location:
  56.  
  57.     host:      barnacle.erc.clarkson.edu
  58.     login:     ftp
  59.     password:  send your e-mail address
  60.     directory: ~ftp/pub/msdos/djgpp
  61.  
  62. Many thanks to the sysops at Clarkson for providing a home to djgpp!
  63.  
  64. As a convenience to non-FTP users, djgpp is also stored on Clarkson's
  65. archive server.  To access the archive server, do this:
  66.  
  67.    % mail archive-server@barnacle.erc.clarkson.edu
  68.    Subject: <none>
  69.    help
  70.    index msdos/djgpp
  71.    ^D
  72.  
  73. NOTE: In accordance with FSF CopyLeft, you are not allowed to upload
  74. this program to a distribution site unless that site also makes the FSF
  75. sources for these programs available.  Please read the file COPYING for
  76. more details.  FSF sources are available on prep.ai.mit.edu, and on
  77. barnacle.erc.clarkson.edu
  78.  
  79. NOTE: If your application links in object modules that were written
  80. by FSF, your application counts as a "derived work" and must obey
  81. the provisions of the FSF Copyrights.  See the file COPYING for
  82. details.  Specifically, the C++ classes in libc.a and obstacks are
  83. FSF works that are covered by the GNU GPL.  The mere act of compiling
  84. does not affect the copyright status of your program.
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94. INSTALLING:
  95.  
  96. To install, you must do the following:
  97.  
  98. * Create a "temp" directory, like c:\tmp.
  99.  
  100. * Create a directory to install in, like c:\djgpp.
  101.  
  102. * Un-zip the appropriate zipfiles in the install directory.
  103.     C:\DJGPP> pkunzip -d djdev107.zip
  104.     C:\DJGPP> pkunzip -d djgas138.zip
  105.     C:\DJGPP> pkunzip -d djgcc222.zip
  106.  
  107. * Add the following lines to C:\AUTOEXEC.BAT:
  108.     set COMPILER_PATH=c:/djgpp/bin
  109.     set C_INCLUDE_PATH=c:/djgpp/include
  110.     set CPLUS_INCLUDE_PATH=c:/djgpp/cplusinc:c:/djgpp/include
  111.     set OBJC_INCLUDE_PATH=c:/djgpp/include
  112.     set OBJCPLUS_INCLUDE_PATH=c:/djgpp/include
  113.     set LIBRARY_PATH=c:/djgpp/lib
  114.     set TMPDIR=c:/tmp
  115.              ^^^ this is where gcc's temp files go
  116.     set GO32TMP=c:/tmp
  117.                 ^^^ this is where your paging file goes
  118.     set GO32=ansi driver c:/djgpp/drivers/SOMETHING.grd gw 1024 gh 768
  119.                          ^^^ whatever driver works with your VGA (optional)
  120.     set BISON_SIMPLE=c:/djgpp/lib/bison.simple
  121.     set BISON_HAIRY=c:/djgpp/lib/bison.hairy
  122.     set FLEX_SKELETON=c:/djgpp/lib/flex.skeleton
  123.  
  124.   GO32TMP is where go32 puts its paging file (TMP and TEMP are checked,
  125.   in that order, also)
  126.  
  127.   Remember that unless you manually type these at the command line,
  128.   they won't take effect until you reboot.  Don't include the "ansi"
  129.   keyword in the "go32" variable if you don't have an ANSI.SYS driver
  130.   or equivalent.
  131.  
  132. * Add your binaries directory to your PATH in C:\AUTOEXEC.BAT
  133.     SET PATH= . . . ;C:\DJGPP\BIN
  134.  
  135. That's it! djgpp is now installed on your system.
  136.  
  137.  
  138.  
  139.  
  140.  
  141. The GO32 environment variable:
  142.  
  143.  
  144. This variable controls the options available in go32 or debug32.  The
  145. syntax of this variable is:
  146.  
  147.   SET GO32=[parm [value]] [parm [value]] . . .
  148.  
  149. Parameters:
  150.  
  151.   ansi           Use ANSI commands to control the color in debug32
  152.   mono           Use the Monochrome monitor for debugging - useful when
  153.                    debugging graphics applications
  154.   1rm            Redirect stdout (file #1) to the monochrome monitor
  155.   2rm            Redirect stderr (file #2) to the monochrome monitor
  156.   1r2            Redirect stdout (file #1) to stderr (file #2)
  157.   2r1            Redirect stderr (file #2) to stdout (file #1)
  158.  
  159.   glob           enable globbing (default)
  160.   noglob         disable globbing
  161.  
  162.   emu [path]     Use the specified file as the 80387 emulator
  163.  
  164.   driver [path]  Use the specified file as the graphics driver
  165.   gw [width]     Default graphics width
  166.   gh [height]    Default graphics height
  167.   tw [width]     Default text width
  168.   th [height]    Default text height
  169.   nc [colors]    Number of colors (for new-style drivers only - see cbgrx*.zip)
  170.  
  171.  
  172. These parameters may occur in any order.
  173.  
  174. Note that "1rm" and "2rm" are done before "1r2" and "2r1", so "1rm 2r1" sends
  175. stdout to the mono monitor and stderr to any redirection used.
  176.  
  177. Examples:
  178.  
  179.   C:\> set GO32=mono driver c:\djgpp\drivers\tseng4k.grd gw 1024 gh 768 tw 132 th 43 nc 256
  180.   C:\> set GO32=ansi
  181.   C:\> set GO32=driver c:\djgpp\drivers\tseng4k.grd ansi
  182.   C:\> set GO32=mono 1rm 2rm
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193. Deviations and Caveats:
  194.  
  195. GCC/G++ deviates from the U**x version in a number of ways, mostly to
  196. accomodate deficiencies in the MS-DOS environment, and my own laziness.
  197.  
  198. * An 80387 is required to do floating point.  An emulator is provided.
  199.   cc1 and cc1plus shouldn't use the 387 unless compiling floating point
  200.   code.  The environment variable "387" can override the auto-detection
  201.   routine:
  202.     SET 387=YES   to force 387 handlers to be enabled
  203.     SET 387=NO    to force 387 accesses to fault
  204.     SET 387=QUERY to get a message showing the results of the auto-detection
  205.   If no 80387 is present and the program attempts to use it, a message
  206.   indicating where the instruction is will be displayed.  To use the
  207.   387 emulator, add "emu c:\djgpp\emu387\emu387" to the GO32 environment
  208.   variable.  Specifying use of the emulator overrides the "387"
  209.   environment variable.
  210.  
  211. * The VDISK method of allocating extended memory is supported.  The
  212.   INT 15h method is also.  When the extender runs out of conventional and
  213.   extended memory, it uses a paging file named $(GO32TMP)/pgXXXXXX.386, where
  214.   XXXX is an unspecified hex value.  This file is normally removed on exit.
  215.  
  216. * Up to 128 MB of physical memory and 128 MB of disk swap space are allowed.
  217.   A 512K machine is sufficient, but very slow due to paging.
  218.  
  219. * The utilies support the MS-DOS standard response file method for giving
  220.   more than 128 bytes of command line.  Example: "gcc -o foo @foo.lnk" where
  221.   foo.lnk contains a list of .o files.  Wildcard expansion (globbing) is
  222.   performed on the parameters, unless they are surrounded by single quotes.
  223.   Double quotes can be used to prevent spaces from separating arguments.
  224.  
  225. * Since MS-DOS does not distinguish case in file names, some .h files
  226.   used for C++ have had underscores prepended to them to avoid conflict
  227.   (ie: String.h conflicts with string.h, so it became _String.h).
  228.  
  229. * When using ar to create archives, be warned that the ar version
  230.   supplied cannot update an archive that's been sequenced (ar s foo.a),
  231.   and cannot sequence a file that's been sequenced.  Also, ld cannot
  232.   use an archive that's not sequenced.  The following method is suggested:
  233.       ar rv mylib.a $(OBJS)
  234.       cp mylib.a mylib2.a
  235.       ar rvs mylib2.a
  236.       (and then link with mylib2.a)
  237.  
  238. * The extender can be added to any gcc-compiled program by copying go32.exe
  239.   to be <program>.exe, where <program> is the 32-bit program.  For example,
  240.   if "hello" is a gcc-compiled a.out file, and "hello.exe" is a copy of
  241.   go32.exe, then when "hello.exe" runs, it loads the file called "hello"
  242.   in the same directory, and executes it if present.  Otherwise,
  243.   the first parameter is the executable (ie: go32 cc1plus foo.cc).
  244.  
  245. * The extender can be merged to create one .exe file that is the extender
  246.   and the executable in one file, by using the stub.exe program:
  247.       copy /b stub.exe+myprog myprog.exe
  248.   This will only work if go32.exe is in your search path, because stub.exe
  249.   runs it.  Alternatively, you can prepend go32.exe itself to an a.out file
  250.   to get a single executable (stub.exe is much smaller).  Note that if
  251.   you re-compile go32 or stub, you must strip off the symbol table first. 
  252.  
  253. * The extender runs programs at logical address 0.  A copy of the first
  254.   1 MB of physical memory (including the AT channel) is mapped to
  255.   0xE0000000 in the program's address space.  The stack grows down from
  256.   0x7FFFFFFC in the program's address space.  Data usually starts at
  257.   0x00400000.
  258.  
  259. * The paging mechanism understands how SuperVGA's map their memory onto
  260.   the AT bus and automatically swaps pages as the program tries to
  261.   access them.  The program sees a linear range from 0xD0000000 to
  262.   0xD0100000 that corresponds to each pixel in the 256-color modes
  263.   of SuperVGAs.  To use this feature, you'll have to set the GO32
  264.   environment variable like this:
  265.     C>set go32=driver c:\djgpp\drivers\tseng4k.grd gw 640 gh 480 tw 132 th 43
  266.   These parameter pairs can be omitted or rearranged as needed.  They are
  267.   the "driver" name, default graphics width and height, and default
  268.   text width and height. Libgr.a doesn't have to be recompiled, nor
  269.   do graphics programs, when a different graphics mode is selected
  270.   (the extender handles it).  It is strongly recommended that the program
  271.   use the GR_default_graphics and GR_default_text modes to switch to
  272.   graphics or text.  These modes use the parameters specified by the
  273.   GO32 environment variable, allowing the user to select a favorite
  274.   graphics and text mode.
  275.  
  276. * Symbols are stored in virtual memory, so you won't run out of symbol
  277.   space until both extended memory and the disk are all used up.  For
  278.   large programs, you might notice a slight delay while it looks up
  279.   symbols.  Programs with a lot of lines in a given module may run out
  280.   of memory as the line number table is built in real memory and transferred
  281.   to virtual memory.
  282.  
  283. * Signals are not reported to the program.  However, interrupts do continue
  284.   to get serviced while in protected mode (ie: keypress, timer, etc).
  285.   CTRL-C will get you back to the debugger in debug32, and you can continue
  286.   from where you stopped.  All signals (ie: exceptions) cause debugging
  287.   traps in debug32, or general faults in go32.
  288.  
  289.  
  290.  
  291. Copyright Information:
  292.  
  293. * Source code for the GNU utilities is copyright (c) Free Software Foundation.
  294.   For more information on the FSF copyright, see their source code or write
  295.   Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  296.  
  297.   A copy of their file "COPYING" is included in the docs directory.  Some of
  298.   the FSF source code has been modified to operate properly in the MS-DOS
  299.   environment.
  300.  
  301. * Source code for most of libc.a are copyright (c) Regents of the University
  302.   of California.  These files include copyright information in them.  The
  303.   utilities are compiled against these libraries, and thus contain software
  304.   developed by the University of California, Berkeley, and its contributors.
  305.   Some of the BSD source code has been modified to operate properly in the
  306.   MS-DOS environment.
  307.  
  308. * Any sources not falling under the copyrights of FSF or UCB (as above) are
  309.   Copyright (c) 1991 DJ Delorie, 24 Kirsten Ave, Rochester NH 03867-2954.
  310.   To contact me via E-Mail, sent to "dj@ctron.com".  Cabletron Systems Inc
  311.   is in no way involved with this project; I just happen to work for them
  312.   during the day.
  313.  
  314. Terms and Conditions:
  315.  
  316. * Source code copyright FSF is distributed under the terms of the GNU
  317.   Public General License.  See the file "COPYING" in doc.arc for more
  318.   information.  If your program links in object modules (in libc.a) that
  319.   are compiled from GNU sources, then your entire program must be
  320.   distributed under the terms of the GNU GPL as a "derived work".  These
  321.   modules are the C++ class library (including the streams classes) and
  322.   obstacks.  The sources in libsrc have the copyright notices in them
  323.   for the various modules.
  324.  
  325. * Source code copyright UCB is distributed under the terms listed in the
  326.   UCB source code itself.
  327.  
  328. * Source code copyright DJ Delorie is distributed under the terms of the
  329.   GNU General Public Licence, with the following exceptions:
  330.   ("go32.exe" refers to go32.exe and debug32.exe)
  331.  
  332.   * There are no conditions on distributing copies of stub.exe or emu387
  333.     as they are originally distributed in this software package.
  334.  
  335.   * If a user creates an application, prepends a copy of go32.exe onto
  336.     the beginning of it, and distributes it free of charge, then the
  337.     user is under no obligations to distribute source or pay royalties.
  338.     Note that the copyright terms of the FSF and/or UCB must be
  339.     obeyed regardless of this.
  340.   
  341.   * If a user creates an application, prepends a copy of go32.exe onto
  342.     the beginning of it, and charges a fee for the software, then a
  343.     royalty of $5 or 5% of the selling price per copy sold must be paid
  344.     to DJ Delorie, 24 Kirsten Ave, Rochester NH 03867-2954.  Note that
  345.     shareware programs are not considered "sold" until payment is rendered
  346.     for them.
  347.  
  348.   * For all other cases, source code for go32.exe must be distributed
  349.     with any distributed copies of go32.exe, or made available as per
  350.     the terms of the GNU GPL.  In these cases, no royalties are due,
  351.     and all freedoms provided by the GPL apply.
  352.   
  353.   * Software that requires go32.exe to run, but is not distributed with
  354.     a copy of go32.exe, incurs no obligations with regards to the
  355.     above sections.
  356.  
  357.   * Contact me for special terms if none of the above are suitable.
  358.  
  359.   * Donations are always appreciated.
  360.  
  361.   The intent of this copyright is this: If you make money by using the
  362.   programs I wrote, I get some of it.  If you use your sources to
  363.   teach others how to write programs, I'll support you.
  364.  
  365.   Changes to source code copyright BSD or FSF are copyright DJ Delorie, but
  366.   fall under the terms of the original copyright.
  367.  
  368.  
  369.  
  370.  
  371.  
  372. Donations may be made to any of the following:
  373.  
  374.     DJ Delorie
  375.     24 Kirsten Ave
  376.     Rochester, NH  03867-2954
  377.     USA
  378.  
  379.     Free Software Foundation
  380.     675 Mass Ave
  381.     Cambridge, MA  02139
  382.     USA
  383.  
  384.     Computer Systems Research Group
  385.     Computer Science Division, EECS
  386.     University of California
  387.     Berkeley, California  94720
  388.     USA
  389.