mirror of
http://git.hugovil.com/git/emu8051.git
synced 2025-05-09 00:51:03 +08:00
Add documentation
This commit is contained in:
Hugo Villeneuve
parent
1c6cc28cf5
commit
223164c042
@ -1,3 +1,11 @@
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
2004/05/07 Hugo Villeneuve <hugo@hugovil.com>
|
||||
-Corrected a bug with the CJNE instruction.
|
||||
-Modified the directory layout and autoconf files.
|
||||
-Added support for GTK2.
|
||||
-Added project to subversion.
|
||||
|
||||
------------------------------------------------------------------------------
|
||||
2002/11/12 Hugo Villeneuve <hugovil@videotron.ca>
|
||||
-Removed some warnings for GCC 3.2: replaced <fstream.h> by <fstream>
|
||||
|
||||
@ -4,11 +4,11 @@ AUTOMAKE_OPTIONS = gnu
|
||||
|
||||
SUBDIRS = src doc
|
||||
|
||||
EXTRA_DIST = bootstrap \
|
||||
EXTRA_DIST = autogen.sh \
|
||||
$(ac_aux_dir)/debug.m4 \
|
||||
$(ac_aux_dir)/gtk2.m4 \
|
||||
pixmaps/*.xpm \
|
||||
test_files/*
|
||||
pixmaps \
|
||||
test_files
|
||||
|
||||
ACLOCAL = aclocal -I $(ac_aux_dir)
|
||||
|
||||
|
||||
4
NEWS
4
NEWS
@ -0,0 +1,4 @@
|
||||
|
||||
2005-05-07: emu8051-0.1.0 has been released.
|
||||
Fixed bug with CJNE instruction and autoconf files cleanup.
|
||||
See the file 'ChangeLog' for further details.
|
||||
20
README
20
README
@ -0,0 +1,20 @@
|
||||
Emu8051
|
||||
|
||||
Emu8051 is a simulator/emulator for the Intel 8051 family of microcontrollers. It is
|
||||
available in two versions: a console (text-only) version and a graphical version (using
|
||||
the GTK+ toolkit). This is an Open-Source project. The program can load Intel HEX files.
|
||||
Once loaded, a program can be run (it will run indefinitely or until a breakpoint is
|
||||
encountered). You can also use the STEP button to execute only a single instruction at
|
||||
a time and see the effects on registers and memory. It is written in C++, and uses Perl
|
||||
scripts to generate automatically C++ functions corresponding to each assembly instruction
|
||||
of the 8051 microcontroller.
|
||||
|
||||
Project website:
|
||||
http://www.hugovil.com/en/emu8051
|
||||
|
||||
This program was tested on the following systems:
|
||||
"Linux From Scratch 4.0"
|
||||
|
||||
For installation instructions, see the INSTALL file.
|
||||
|
||||
For recent project news, see the NEWS file.
|
||||
110
doc/emu8051.man
110
doc/emu8051.man
@ -1,52 +1,20 @@
|
||||
.TH WMNOTIFY 1 "March 2003" "wmnotify" "User's Manual"
|
||||
.TH EMU8051 1 "May 2004" "emu8051" "User's Manual"
|
||||
|
||||
.SH NAME
|
||||
wmnotify \- Dockable E-mail notification program for single POP3 account
|
||||
emu8051 \- Simulator/emulator for the Intel 8051 family of microcontrollers
|
||||
|
||||
.SH SYNOPSIS
|
||||
.B wmnotify
|
||||
[\fIOPTION\fR]...
|
||||
.B emu8051
|
||||
[\fIOPTION\fR]... [\fIFILENAME\fR]
|
||||
|
||||
.SH DESCRIPTION
|
||||
\fBwmnotify\fR is a dockable application (DockApp) for the WindowMaker window
|
||||
manager to periodically check a POP3 E-mail account for new messages. If there
|
||||
are new messages in the mailbox, a simple animation is started to notify the
|
||||
user. An optional beep or sound can also be produced if desired.
|
||||
\fBemu8051\fR is a simulator/emulator for the Intel 8051 family of microcontrollers. It is available in two versions: a console (text-only) version and a graphical version (using the GTK+ toolkit). This is an Open-Source project. The program can load Intel HEX files.
|
||||
|
||||
The interface is kept very simple. To immediately check for new messages,
|
||||
single-click on the mailbox image. To start your favorite email program,
|
||||
double-click on the mailbox image.
|
||||
Once loaded, a program can be run (it will run indefinitely or until a breakpoint is encountered). You can also use the STEP button to execute only a single instruction at a time and see the effects on registers and memory.
|
||||
|
||||
When you double-click on the mailbox image to start your email program,
|
||||
the new messages animation is stopped, assuming that you will read your new
|
||||
messages. If you don't, the wmnotify program will simply continue it's
|
||||
periodic checking of your email account and will restart the new messages
|
||||
animation after the usual delay if new messages are unread.
|
||||
|
||||
By default, the interval between checks is 1 minute, and this can be changed in
|
||||
the configuration file. You can also enable audio notification as well as
|
||||
specify an optional audio sound file (WAV or AU). If audio notification is
|
||||
enabled but no audio sound file is specified, a beep will be produced. There is
|
||||
an option in the configuration file to adjust the volume of the sound file.
|
||||
It is written in C++, and uses Perl scripts to generate automatically C++ functions corresponding to each assembly instruction of the 8051 microcontroller.
|
||||
|
||||
.SH "OPTIONS"
|
||||
.TP
|
||||
.BI "\-\^c " config-file
|
||||
.B wmnotify
|
||||
reads your POP3 account settings and preferences from the specified
|
||||
configuration file. This option overrides the use of the default config file,
|
||||
.IR "$HOME/.wmnotifyrc".
|
||||
|
||||
.TP
|
||||
.BI \-display " host" : display
|
||||
Specifies the host and screen to be used by \fBwmnotify\fR. By default this
|
||||
is obtained from the environment variable
|
||||
.SB DISPLAY.
|
||||
|
||||
.TP
|
||||
.BI \-geometry " geometry"
|
||||
.RB ( *geometry )
|
||||
Specifies the initial geometry of the window.
|
||||
|
||||
.TP
|
||||
\fB\-h\fR
|
||||
@ -55,69 +23,11 @@ display usage and exit
|
||||
\fB\-v\fR
|
||||
output version information and exit
|
||||
|
||||
.SH "CONFIGURATION FILE"
|
||||
.IR $HOME/.wmnotifyrc
|
||||
|
||||
The first time the program is run, it will check for the presence of the
|
||||
configuration file in the user's home directory. If this file is not found,
|
||||
wmnotify will automatically create a new one, and exit. Then the user must
|
||||
enter it's POP3 account settings and preferences in the configuration file
|
||||
before restarting wmnotify.
|
||||
|
||||
.TP
|
||||
.BI "server " <pop3-servername>
|
||||
POP3 server name.
|
||||
|
||||
.TP
|
||||
.BI "port " <pop3-portnumber>
|
||||
POP3 port number (optional, default value is 110).
|
||||
|
||||
.TP
|
||||
.BI "username " <pop3-username>
|
||||
POP3 username.
|
||||
|
||||
.TP
|
||||
.BI "password " <pop3-password>
|
||||
POP3 password.
|
||||
|
||||
.TP
|
||||
.BI "mailcheckdelay " <delay-in-minutes>
|
||||
Mail check interval, in minutes (optional, default value is 1).
|
||||
|
||||
.TP
|
||||
.BI "mailclient " <program>
|
||||
The program to start when double-clicking on the mailbox image (optional).
|
||||
|
||||
.TP
|
||||
.BI "enablebeep " <value>
|
||||
This option controls the audio notification enabling/disabling. If this option
|
||||
is enabled and the "audiofile" option below contains a valid audio file, it
|
||||
will be played whenever new message(s) are detected. If "audiofile" is
|
||||
commented, the console beep will be used to produce the audio notification. The
|
||||
value may be set to "0" to disable or to "1" to enable (optional, default value is 0, disabled).
|
||||
|
||||
.TP
|
||||
.BI "audiofile " <path-to-audiofile>
|
||||
Path and filename of the WAV or AU audio sound file to play when new message(s)
|
||||
are detected (optional).
|
||||
|
||||
.TP
|
||||
.BI "volume " <value>
|
||||
Volume value, in percent, when playing an audio file (optional, default value is
|
||||
100%). This volume value is relative to the values you have set in your sound
|
||||
card mixer settings. If you find the audio notification sound to be too loud,
|
||||
just reduce the volume value. On the other hand, if you want to increase the
|
||||
audio notification sound amplitude, just increase the volume. If you increase
|
||||
the volume value to 100% and you find that it is not sufficient, then you would
|
||||
have to increase the volume using your favorite sound card mixer program
|
||||
(ex: with alsamixer, increase the PCM or master value).
|
||||
|
||||
.SH CREDITS
|
||||
\fBwmnotify\fR was written by Hugo Villeneuve <hugovil@videotron.ca>, based on
|
||||
the WMPop3 program by Scott Holden <scotth@thezone.net>.
|
||||
\fBemu8051\fR was originally written by Jonathan St-André, Hugo Villeneuve <hugo@hugovil.com> and Pascal Fecteau.
|
||||
|
||||
.SH COPYRIGHT
|
||||
\fBwmnotify\fR is free; anyone may redistribute it to anyone under the terms
|
||||
\fBemu8051\fR is free; anyone may redistribute it to anyone under the terms
|
||||
stated in the GNU General Public License. A copy of the license is included in
|
||||
the \fBwmnotify\fR distribution. You can also browse it online at
|
||||
the \fBemu8051\fR distribution. You can also browse it online at
|
||||
.I http://www.gnu.org/copyleft/gpl.html
|
||||
|
||||
@ -6,10 +6,10 @@
|
||||
#include "CPU8051.hpp"
|
||||
#include "EmuGtk.hpp"
|
||||
#include "exceptions.hpp"
|
||||
#include "pixmaps/reset.xpm"
|
||||
#include "pixmaps/run.xpm"
|
||||
#include "pixmaps/stop.xpm"
|
||||
#include "pixmaps/step.xpm"
|
||||
#include "reset.xpm"
|
||||
#include "run.xpm"
|
||||
#include "stop.xpm"
|
||||
#include "step.xpm"
|
||||
|
||||
|
||||
int EmuGtkNumber = 0;
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user