usr/src/cmd/sgs/librtld_db/demo/00README

   1 #
   2 # CDDL HEADER START
   3 #
   4 # The contents of this file are subject to the terms of the
   5 # Common Development and Distribution License (the "License").
   6 # You may not use this file except in compliance with the License.
   7 #
   8 # You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   9 # or http://www.opensolaris.org/os/licensing.
  10 # See the License for the specific language governing permissions
  11 # and limitations under the License.
  12 #
  13 # When distributing Covered Code, include this CDDL HEADER in each
  14 # file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  15 # If applicable, add the following below this CDDL HEADER, with the
  16 # fields enclosed by brackets "[]" replaced with your own identifying
  17 # information: Portions Copyright [yyyy] [name of copyright owner]
  18 #
  19 # CDDL HEADER END
  20 #
  21
  22 #
  23 # Copyright (c) 1995, 2010, Oracle and/or its affiliates. All rights reserved.
  24 #
  25
  26 This directory contains source code to the rdb debugger.  This debugger
  27 is distributed as an example client of the librtld_db.so.1 interface.
  28 As well as offering examples of the proper calling sequence for the
  29 librtld_db.so.1 interface rdb also offers a sample implementation of the
  30 proc_services (/usr/include/proc_service.h) that rdb is dependent upon.
  31
  32 The following is an overview of the directory structure and highlight
  33 of some of the important files contained within:
  34
  35 rdb.man         - man page for the rdb debugger
  36 Makefile.com
  37 Makefile.targ   - common Makefiles included by ${MACH)/Makefile
  38 common/*        - common source code used for all architectures
  39 amd64/          - build directory contains architecture specific source files
  40 i386/                   "       "       "       "
  41 sparc/                  "       "       "       "
  42 sparcv9/                "       "       "       "
  43 amd64/Makefile  - makefiles to build rdb for each architecture
  44 i386/Makefile           "       "       "       "
  45 sparc/Makefil           "       "       "       "
  46 sparcv9/Makefil         "       "       "       "
  47 test/*          - sample command files which can be used to test rdb
  48
  49
  50 Building rdb
  51 ------------
  52
  53 To build rdb:
  54
  55  % cd {amd64,i386,sparc,sparcv9}        - depending on which architecture
  56                                           you are building for
  57  % make all
  58
  59 To test the demo:
  60
  61  % make test