gdb/README

   1 /************************************************************************/
   2 /*
   3 /*                      Instructions for Installing GDB
   4 /*
   5 /*                          Noah Mendelsohn
   6 /*                           April 22, 1987
   7 /*
   8 /*      Copyright (C) 1987 Massachusetts Institute of Technology
   9 /*
  10 /*                      =========================
  11 /*
  12 /*      NOTE:  GDB is not currently a supported service of Project Athena
  13 /*      or of any other MIT organization.  It is a set of programs which
  14 /*      I have written while working for Project Athena and which I
  15 /*      am making available to the MIT community in the hope that they
  16 /*      will prove useful.  The decision as to whether GDB will become
  17 /*      supported is not mine to make.   If you wish to express an opinion,
  18 /*      you should write a note including the following people on the
  19 /*      distibution:
  20 /*
  21 /*              Prof. Steve Lerman    (lerman@athena.mit.edu)
  22 /*              Prof. Jerry Saltzer   (Saltzer@athena.mit.edu)
  23 /*              Dan Geer              (geer@athena.mit.edu)
  24 /*              Noah Mendelsohn       (noah@athena.mit.edu)
  25 /*
  26 /*      Thank you!
  27 /*
  28 /*      This file is named: README
  29 /*
  30 /************************************************************************/
  31
  32
  33 /************************************************************************/
  34 /*
  35 /*                      Obtaining GDB
  36 /*
  37 /************************************************************************/
  38
  39
  40 GDB is now available to the MIT community by anonymous ftp
  41 from meathead.mit.edu.  There are currently two files:
  42
  43         1) README    (this file)
  44
  45         2) tar.file.Z  (compressed tar.file containing all of gdb)
  46
  47 To install gdb, make a directory on your own system.  It can
  48 have any name, but we'll use gdb in this example:
  49
  50         % mkdir gdb
  51         % cd gdb
  52         % ftp meathead.mit.edu
  53         ===>login as anonymous and give your user i.d. as passwd
  54         ftp> cd gdb
  55         ftp> get README
  56         ftp> bin                       <= make sure transfer of tar.file.Z
  57                                           is done in binary mode, or the
  58                                           uncompress step below may fail
  59         ftp> get tar.file.Z
  60         ftp> quit
  61
  62         % uncompress tar.file.Z        <== this re-creates tar.file
  63                                            If this step fails, you may have
  64                                            forgotten to transfer the file
  65                                            in binary mode (see above.)
  66         % tar xf tar.file              <== this extracts all the gdb
  67                                            files from the tar file
  68
  69 /************************************************************************/
  70 /*
  71 /*      Making the gdb libraries
  72 /*
  73 /************************************************************************/
  74
  75 To build the GDB library:
  76
  77         % make libgdb.a
  78
  79 /************************************************************************/
  80 /*
  81 /*      Formatting documentation
  82 /*
  83 /************************************************************************/
  84
  85 To format the gdb documents, you need scribe and access to a PostScript
  86 printer.  To make the user guide:
  87
  88         % make gdb_ugd.PS
  89         % rm gdb_ugd.PS
  90         % make gdb_ugd.PS
  91
  92 The reason you do it twice is that scribe requires two tries at a document
  93 in order to get the forward references to page numbers right.  The resulting
  94 gdb_ugd.PS file may be sent to your PostScript printer:
  95
  96         % lpr gdb_ugd.PS
  97
  98 To format the library reference manual:
  99
 100         % make library.PS
 101         % rm library.PS
 102         % make library.PS
 103
 104 /************************************************************************/
 105 /*
 106 /*                      Writing and running programs
 107 /*
 108 /************************************************************************/
 109
 110 The user guide tells you how to do this.  Note that gdb.h winds up in
 111 the gdb directory (where the tar.file is) when you use these installation
 112 instructions, and so does libgdb.a.  You will have to use the appropriate
 113 Unix incantations, i.e. making links or telling cc and ld where to find
 114 things in order for your compilations and loads to work.  Make sure you
 115 specify libgdb.a as one of the files to load along with your program.
 116
 117 /************************************************************************/
 118 /*
 119 /*                      Building the database server
 120 /*
 121 /************************************************************************/
 122
 123 The database server program is named dbserv.  To build it:
 124
 125         % make dbserv
 126
 127 This MUST be done on a machine where RTI Ingres is installed.  You may
 128 have to edit the makefile if /rtingres is not the directory where Ingres
 129 lives, and you may have to put /rtingres/bin in your path before doing the
 130 make.
 131
 132 /************************************************************************/
 133 /*
 134 /*                              Sample programs
 135 /*
 136 /************************************************************************/
 137
 138 Various test programs are included in the tar.file.  These are not intended
 139 primarily for users, they are used for my private testing, but a few of
 140 them are well commented and many of them work.  The ones whose names begin
 141 with the letter 't' are most likely to be useful.  Each of them can be
 142 built with 'make'.
 143
 144 /************************************************************************/
 145 /*
 146 /*                                Debugging
 147 /*
 148 /************************************************************************/
 149
 150 Both the dbx and the Saber C debuggers have successfully executed many
 151 GDB applications.  I have found Saber to be particularly useful, and I
 152 have included a .saberinit file which should serve as a starting point
 153 for you.  (Warning:  .saberinit is supplied as a courtesy and I don't
 154 guarantee to check it out with every re-release.  If you know enough
 155 to use Saber, you can probably make any minor corrections which may
 156 be needed without too much trouble.)  Note that both debuggers have trouble
 157 on programs that fork.  See the gdb_debug routine and the GDB_NOFORK flag
 158 for a useful trick to avoid forking when debugging.
 159
 160 /************************************************************************/
 161 /*
 162 /*                              Mailing lists
 163 /*
 164 /************************************************************************/
 165
 166 gdb-users@athena.mit.edu        reaches all users of GDB bugs and fixes
 167                                 are advertised here
 168 gdb-news@athena.mit.edu         announcements of interest to a wider
 169                                 community of people who may not want to
 170                                 know about every 2 line change to the system
 171
 172 noah@athena.mit.edu             the author
 173
 174
 175