xref: /illumos-gate/usr/src/cmd/sgs/demo_rdb/00README (revision 4fcda281302fdcc1753c1f266173e7b59a500c3c)
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
26This directory contains source code to the rdb debugger.  This debugger
27is distributed as an example client of the librtld_db.so.1 interface.
28As well as offering examples of the proper calling sequence for the
29librtld_db.so.1 interface rdb also offers a sample implementation of the
30proc_services (/usr/include/proc_service.h) that rdb is dependent upon.
31
32The following is an overview of the directory structure and highlight
33of some of the important files contained within:
34
35rdb.man		- man page for the rdb debugger
36Makefile.com
37Makefile.targ	- common Makefiles included by ${MACH)/Makefile
38common/*	- common source code used for all architectures
39amd64/		- build directory contains architecture specific source files
40i386/		 	"	"	"	"
41sparc/			"	"	"	"
42sparcv9/		"	"	"	"
43amd64/Makefile	- makefiles to build rdb for each architecture
44i386/Makefile		"	"	"	"
45sparc/Makefil		"	"	"	"
46sparcv9/Makefil		"	"	"	"
47test/*		- sample command files which can be used to test rdb
48
49
50Building rdb
51------------
52
53To build rdb:
54
55 % cd {amd64,i386,sparc,sparcv9}	- depending on which architecture
56					  you are building for
57 % make all
58
59To test the demo:
60
61 % make test
62