reorganize everything

This commit is contained in:
Dennis Gunia
2024-06-24 20:38:02 +02:00
parent ea1069e59c
commit 1ed6034d99
3867 changed files with 16188 additions and 13447 deletions

View File

@@ -0,0 +1,79 @@
.TH SERIALVIEW 1
.SH NAME
serialview \- Terminal emulator for uCsim
.SH SYNOPSIS
.B serialview
\-i <filename> \-o <filename> \-L n \-a <pattern> \-A <answer> \-IOh
.SH DESCRIPTION
serialview is a simple terminal emulator which can be used with uCsim.
.SH OPTIONS
.TP
.B \-i filename
.I filename
is the pipe to the controllers's serial input. Characters typed into
the input panel will be written to this file.
.TP
.B \-o filename
.I filename
is the pipe to the controllers's serial output. Content of this file
is prosented on the output panel.
.TP
.B \-I
Use hexadecimal filter on input. Only hexadecimal characters are
accepted in input panel. Two characters are combined into a
hexadecimal code and value is written to the input pipe.
.TP
.B \-O
Use hexadecimal filter on output. Content of output pipe is presented
as a hexadecimal dump. \-L option can be used to set how many bytes
are printed in one line.
.TP
.B \-a pattern
.I pattern
is a string which is recognized in output stream and automaticaly
answered by sending an answer string (see \-A option). String can be
formatted as a C string, non-asci characters can be escaped in C
style.
.TP
.B \-A answer
.I answer
is a string which is sent when a pattern (see \-a option) is detected
in simulator's output. This answer string is written to the input pipe
but not shown in the input panel.
.TP
.B \-L n
Set line length of hexadecimal dump in output panel (default=8).
.TP
.B \-h
Show summary of options.
.PP
When no options are provided the input and output pipes are created in
.B /tmp
and named respectively
.B in
and
.B out
.SH "SEE ALSO"
sdcc(1), ucsim(1).
.SH AUTHOR
Timothy Hurman

View File

@@ -0,0 +1,271 @@
.TH UCSIM 1
.SH NAME
uCsim \- Micro\-controller simulator
.SH SYNOPSIS
.B ucsim_51
.br
.B ucsim_xa
.br
.B ucsim_z80
.br
.B ucsim_tlc
.br
.B ucsim_rxk
.br
.B ucsim_avr
.br
.B ucsim_pdk
.br
.B ucsim_st7
.br
.B ucsim_stm8
.br
.B ucsim_p1516
.br
.B ucsim_m6800
.br
.B ucsim_m6809
.br
.B ucsim_m68hc08
.br
.B ucsim_m68hc11
.br
.B ucsim_m68hc12
.br
.B ucsim_mos6502
.br
.B ucsim_plaze
.br
.RS
.B \-t cpu_type
.B \-X freq[k|M]
.B \-R seed
.B \-C cfg_file
.B \-e command
.B \-c file
.B \-Z portnum
.B \-k portnum
.B \-s file
.B \-S options
.B \-I options
.B \-p prompt
.B \-P
.B \-o colors
.B \-l
.B \-b
.B \-B
.B \-g
.B \-G
.B \-a nr
.B \-w
.B \-V
.B \-v
.B \-H
.B \-h
.RE
.SH DESCRIPTION
uCsim is a microcontroller, microprocessor simulator for several
processor familes. It can be started as
.B ucsim_XXXX
command, where XXXX specifies the simulated processor type. Eg.
.I ucsim_51
starts Intel MCS51 microcontroller simulator,
.I ucsim_z80
starts Zilog Z80 microprocessor simulator, etc.
.SH OPTIONS
.B Options of the command
.TP
.B \-t cpu_type
Specifies type of the controller. Use \-H to list possible values.
.TP
.B \-X freq[k|M]
XTAL frequency in Hz, Use
.I k
or
.I M
suffix to specify frequency in kHz or MHz.
.TP
.B \-R seed
Set the random number generator seed.
.TP
.B \-C file
Read initial commands from
.I file
and execute them.
.TP
.B \-e command
Execute
.I command
at program startup (before config file).
.TP
.B \-c file
Open command console on
.I file
(use \- for std in/out).
.TP
.B \-Z portnum
Use
.I localhost:portnum
for command console.
.TP
.B \-k portnum
Use
.I localhost:portnum
for serial I/O. This option is obsolete, use \-S instead.
.TP
.B \-s file
Connect serial interface uart0 to
.I file
This option is obsolete, use \-S instead.
.TP
.B \-S options
.I options
is a comma separated list of options according to serial interface. Know options are:
.br
.I uart=nr
number of uart (default=0)
.br
.I in=file
serial input will be read from file named `file'.
.br
.I out=file
serial output will be written to `file'.
.br
.I port=nr
use localhost:nr as server for serial line.
.br
.I iport=nr
use localhost:nr as server for serial input.
.br
.I oport=nr
use localhost:nr as server for serial onput.
.br
.I raw
perform non-interactive communication even on tty.
.TP
.B \-I options
.I options
is a comma separated list of options according to simulator
interface. Known options are:
.br
.I if=memory[address]
turn on interface on given memory location.
.br
.I in=file
specify input file for IO.
.br
.I out=file
specify output file for IO.
.PP
.TP
.B \-p prompt
Specify string for prompt.
.TP
.B \-P
Prompt is a null ('\\0') character.
.PP
.TP
.B \-o colors
List of color specification: what=colspec,... where colspec is :
separated list of color options e.g.: prompt=b:white:black (bold white
on black).
.TP
.B \-l
Use colors of the light theme (default is dark).
.PP
.TP
.B \-b
Black & white (non-color) console.
.TP
.B \-B
Beep on breakpoints.
.TP
.B \-g
Go, start simulation.
.TP
.B \-G
Go, start simulation, quit on stop.
.TP
.B \-a nr
Specify size of variable space (default=256).
.TP
.B \-w
Writable flash.
.TP
.B \-V
Verbose mode.
.TP
.B \-v
Print out version number and quit.
.TP
.B \-H
Print out types of known CPUs and quit.
.TP
.B \-h
Print out this help and quit.
.SH EXAMPLES
None yet.
.SH "SEE ALSO"
sdcc(1), sdcdb(1), serialview(1).
.SH BUGS
Probably many.
.SH AUTHORS, CONTRIBUTORS
Daniel Drotos,
Gunar Holm,
Sandeep Dutta,
Salvador Eduardo Tropea,
Josef Wolf,
Stephane Meyer,
Larry Doolittle,
Timothy Hurman,
Karl-Max Wagner,
Edmar Wienskoski Jr,
Alexandre Frey,
Kaido Karner,
Kalr Bongers,
Alexis Pavlov,
Davine Zanni,
Anton Persson,
Nicolas Lesser,
Mike Jagdis,
Jiri Simek,
Zbynek Krivka,
Vaclav Peroutka,
Valentin Dudouyt,
Erik Petrich,
Leland Morrison,
Johan Knol.