Imported Debian patch 2.9.0-5
[debian/cc1111] / debian / manpages / sdcdb.1
1 .TH SDCDB 1 
2 .SH NAME
3 sdcdb \- Source debugger for SDCC
4 .SH SYNOPSIS
5 .B sdcdb [options] filename
6 .SH WARNING
7 The information in this man page is an extract from the full
8 documentation of SDCC, and is limited to the meaning of the
9 options.
10 .PP
11 For complete and current documentation, refer to the
12 .B
13 SDCC Compiler User Guide\c
14 \&.
15 .SH "DESCRIPTION"
16 .B sdcdb\c
17 \& is a source debugger for 
18 .B SDCC\c
19 \&. It uses 
20 .B ucSim\c
21 \& to execute the program, the programm execution is controlled
22 by the debugger. 
23 .PP
24 The command interface for the debugger has been deliberately kept as close the 
25 GNU debugger gdb, as possible. This will help the integration with existing 
26 graphical user interfaces (like ddd, xxgdb or xemacs) existing for the GNU 
27 debugger.
28 .SH STARTING THE DEBUGGER
29 The debugger can be started using the following command line (Assume the file 
30 you are debugging has the file name foo):
31 .PP
32 .B sdcdb foo
33 .PP
34 The debugger will look for the following files:
35 .PP
36 .nf
37 foo.c   - the source file.
38 foo.cdb - the debugger symbol information file.
39 foo.ihx - the intel hex format object file.
40 .fi
41 .SH OPTIONS
42 .TP
43 .BI "\-directory=" "<source file directory>" 
44 This option can used to specify the directory search list. The debugger will 
45 look into the directory list specified for source, cdb & ihx files. The items 
46 in the directory list must be separated by ':', e.g. if the source files can be
47 in the directories /home/src1 and /home/src2, the 
48 .B -directory\c
49 \& option should be
50 .B -directory=/home/src1:/home/src2\c
51 \&. Note there can be no spaces in the option.
52 .TP
53 .BI "\-cd " "<directory>"
54 Change to the <directory>.
55 .TP
56 .BI "\-fullname"
57 Used by GUI front ends.
58 .TP
59 .BI "\-cpu " "<cpu-type>"
60 This argument is passed to the simulator. Please see the simulator docs for 
61 details.
62 .TP
63 .BI "\-X " "<Clock frequency>" 
64 This option is passed to the simulator. Please see the simulator docs for 
65 details.
66 .TP
67 .BI "\-s " "<serial port file>" 
68 This option is passed to simulator. Please see the simulator docs for details.
69 .TP
70 .BI "\-S " "<serial in,out>"
71 This argument is passed to simulator. Please  see the simulator docs for 
72 details.
73 .SH COPYING
74 The entire source code for the debugger is distributed under GNU General Public
75 License.
76 .SH SEE ALSO
77 sdcc(1), ucsim(1), s51(1), savr(1), sz80(1).
78 .SH AUTHOR
79 This manual page was written by Aurelien Jarno <aurel32@debian.org>,
80 for the Debian GNU/Linux system (but may be used by others).