Imported Debian patch 2.9.0-5
[debian/cc1111] / debian / manpages / ucsim.1
1 .TH UCSIM 1 
2 .SH NAME
3 s51, savr, sz80 \- 8051, AVR and Z80 microcontrollers simulator for SDCC. 
4 .SH SYNOPSIS
5 .B s51
6 .I "[options] filenames"
7 .br
8 .B savr
9 .I "[options] filenames"
10 .br
11 .B sz80
12 .I "[options] filenames"
13 .SH WARNING
14 The information in this man page is an extract from the full
15 documentation of 
16 .B SDCC\c
17 \&, and is limited to the meaning of the options.
18 .PP
19 For complete and current documentation, refer to the
20 .B
21 ucSim simulator User Guide\c
22 \&.
23 .SH "DESCRIPTION"
24 .B ucSim\c
25 \& is a microcontroller simulator. It is extensible to support
26 different microcontroller families. 
27 .PP
28 .B MCS51\c
29 \& family is simulated by\c
30 .B s51\c
31 \&.
32 .br
33 .B AVR\c
34 \& family is simulated by
35 .B savr\c
36 \&.
37 .br
38 .B Z80\c
39 \& processor is simulated by 
40 .B sz80\c
41 \&.
42 .PP
43 Specified files must be names of Intel hex files. Simulator loads them in 
44 specified order into the ROM of the simulated system.
45 .SH OPTIONS
46 .TP
47 .BI "\-t " "CPU"
48 Type of CPU. Recognized types are: 51, 8051, 8751, C51, 80C51, 87C51, 31, 8031,
49 C31, 80C31, 52, 8052, 8752, C52, 80C52, 87C52, 32, 8032, C32, 80C32, 51R, 51RA,
50 51RB, 51RC, C51R, C51RA, C51RB, C51RC, 89C51R, 251, C251, DS390, DS390F. Note 
51 that recongition of a CPU type as option does not mean that the simulator can 
52 simulate that kind of CPU. Default type is C51. DS390 supports Dallas DS80C390 
53 dual-dptr operations, DS390F supports minimal flat24 mode code and dual-dptr 
54 operations.
55 .TP
56 .BI "\-X " "freq[k|M]"
57 XTAL frequency is 
58 .I freq\c
59 \& Hertz. 
60 .B k\c
61 \& or
62 .B M\c
63 \& can be used to specify frequency in kHZ or MHz. Space is not allowed between
64 the number and the 
65 .B k\c
66 \& or
67 .B M\c
68 \&. Default value is 11059200 Hz. 
69 .TP
70 .BI "\-c " "file"
71 Open command console on 
72 .I file\c
73 \&. Command consoles are on standard input and output
74 by default. Using this option the console can be opened on any file for example
75 on the serial interface of the computer. 
76 .TP
77 .BI "\-Z " "portnum"
78 Listen for incoming connections on port 
79 .I portnum\c
80 \&. Using this option uCsim can 
81 serve multiple consoles. You can get a console by simply telnet into machine 
82 running 
83 .B uCsim\c
84 \&to port 
85 .I portnumber\c
86 \&. This option is not available on platforms which doesn't support BSD 
87 networking.
88 .TP
89 .BI "\-s " "file"
90 Connect serial interface of the simulated microcontroller to the 
91 .I file\c
92 \&. Nothing is used by default which means that characters transmitted by 
93 serial interface of the simulated microcontroller go to nowhere and it will 
94 never receive anything. If you are going to communicate with serial interface 
95 interactively the best idea is to specify a teminal with 
96 .B -s\c
97 \& option.
98 .TP
99 .BI "-S " "in=file,out=file"
100 Using this option you can specify different files for input and output streams 
101 that 
102 .B uCsim\c
103 \& uses to simulate microprocessor's serial interface.
104 .TP
105 .BI "\-p prompt"
106 Using this option you can specify any string to be the prompt of command 
107 interpreter, for example:
108 .nf
109 $ s51 -p "s51> "
110 ucsim 0.2.12, Copyright (C) 1997 Daniel Drotos, Talker Bt.
111 ucsim comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
112 This is free software, and you are welcome to redistribute it
113 under certain conditions; type `show c' for details.
114 s51> 
115 .fi
116 .TP
117 .BI "\-P"
118 Prompt will be a null ('\\0') character. This feature can be useful for 
119 programs which controlls simulator through a pipe. 
120 .TP
121 .BI "\-V"
122 Verbose mode. The simulator notifies you about some kind of internal actions 
123 for example interrupts. Messages are printed on command console. 
124 .TP
125 .BI "\-v"
126 Print out version number and stop. 
127 .TP
128 .BI "\-H"
129 Print out types of known CPUs. Names printed out by this option can be used to 
130 determine CPU type using -t option. 
131 .TP
132 .BI "\-h"
133 Print out a short help about the options and stop.
134 .SH COPYING
135 ucSim is distributed under the GNU General Public License.
136 .SH SEE ALSO
137 sdcc(1), s51(1), savr(1), sz80(1).
138 .SH AUTHOR
139 This manual page was written by Aurelien Jarno <aurel32@debian.org>,
140 for the Debian GNU/Linux system (but may be used by others).