summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorjaortega <jaortega>2001-03-22 02:33:58 +0000
committerjaortega <jaortega>2001-03-22 02:33:58 +0000
commit2ca96c58673afb1df494ae5b5b00256c140ce3d6 (patch)
tree7e70b3fe75884c837b7e674a13d3e08e1268f233 /doc
parent92e00ea7d9a1aa5b202495e993c5e69915c4ffee (diff)
downloadmdk-2ca96c58673afb1df494ae5b5b00256c140ce3d6.tar.gz
mdk-2ca96c58673afb1df494ae5b5b00256c140ce3d6.tar.bz2
minor changes
Diffstat (limited to 'doc')
-rw-r--r--doc/mdk.texi50
-rw-r--r--doc/mdk_bugs.texi10
-rw-r--r--doc/mdk_emixvm.texi24
-rw-r--r--doc/mdk_gstart.texi2
-rw-r--r--doc/mdk_install.texi58
-rw-r--r--doc/mdk_intro.texi2
-rw-r--r--doc/mdk_mixasm.texi2
-rw-r--r--doc/mdk_mixvm.texi4
-rw-r--r--doc/mdk_tut.texi2
9 files changed, 123 insertions, 31 deletions
diff --git a/doc/mdk.texi b/doc/mdk.texi
index 1a985c5..ba5b94f 100644
--- a/doc/mdk.texi
+++ b/doc/mdk.texi
@@ -10,6 +10,7 @@
@set EDITION 0.3
@set VERSION 0.3
@set JAO Jos@'e Antonio Ortega Ruiz
+@set PHILIP Philip E. King
@footnotestyle separate
@ifinfo
@@ -79,29 +80,48 @@ assembler-like language for programming a virtual computer called
MIX. They were created by Donald Knuth in the first volume of @cite{The
Art of Computer Programming} (Addison Wesley, 1997).
+GNU @sc{mdk} is an official GNU package.
+
GNU @sc{mdk} was written by @value{JAO} and is released under the GNU
General Public license (@pxref{Copying}), so that users are free to share
and improve it.
-GNU @sc{mdk} is an official GNU package.
+@value{PHILIP} has contributed to this package development with many
+helpful discussions, as well as actual code (@pxref{mixvm.el}).
@end ifinfo
@menu
-* Introduction::
-* MIX and MIXAL tutorial:: Learn the innards of MIX and MIXAL.
-* Getting started:: Basic usage of the @sc{mdk} tools.
-* mixvm:: Invoking the MIX virtual machine.
-* mixvm.el:: Using @code{mixvm} within Emacs.
-* mixasm:: Invoking the MIXAL assembler.
-* Copying:: @sc{mdk} licensing terms.
-* Problems:: Reporting bugs.
-* Concept Index:: Index of concepts.
+* Introduction::
+* Installing MDK::
+* MIX and MIXAL tutorial:: Learn the innards of MIX and MIXAL.
+* Getting started:: Basic usage of the @sc{mdk} tools.
+* mixvm.el:: Using @code{mixvm} within Emacs.
+* mixvm:: Invoking and using the MIX virtual machine.
+* gmixvm::
+* mixasm:: Invoking the MIXAL assembler.
+* Copying:: @sc{mdk} licensing terms.
+* Problems:: Reporting bugs.
+* Concept Index:: Index of concepts.
+
+
+
+
+
+
@detailmenu
--- The Detailed Node Listing ---
+Installing @sc{mdk}
+
+* Download::
+* Requirements::
+* Basic installation::
+* Emacs support::
+* Special configure flags::
+
MIX and MIXAL tutorial
* The MIX computer:: Architecture and instruction set
@@ -162,6 +182,12 @@ Interactive commands
* Debug commands:: Debugging programs.
* State commands:: Inspecting the virtual machine state.
+gmixvm
+
+* Invoking @code{gmixvm}::
+* MIX virtual machine::
+* Menu and status bars::
+
@code{mixasm}, the MIXAL assembler
* Invoking @code{mixasm}:: @code{mixasm} options
@@ -170,10 +196,12 @@ Interactive commands
@end menu
@include mdk_intro.texi
+@include mdk_install.texi
@include mdk_tut.texi
@include mdk_gstart.texi
-@include mdk_mixvm.texi
@include mdk_emixvm.texi
+@include mdk_mixvm.texi
+@include mdk_gmixvm.texi
@include mdk_mixasm.texi
@include gpl.texi
@include mdk_bugs.texi
diff --git a/doc/mdk_bugs.texi b/doc/mdk_bugs.texi
index 938c984..7531daa 100644
--- a/doc/mdk_bugs.texi
+++ b/doc/mdk_bugs.texi
@@ -2,10 +2,14 @@
@chapter Reporting Bugs
@cindex bugs
@cindex problems
+@cindex questions
+@cindex suggestions
-If you find a bug in @sc{mdk} (or have questions, comments or suggestions
-about it), please send electronic mail to @email{jaortega@@acm.org,
-the author}.
+If you have any questions, comments or suggestions, please send
+electronic mail to @email{jao@@gnu.org, the author}.
+
+If you find a bug in @sc{mdk}, please send electronic mail to
+@email{bug-mdk@@gnu.org, the @sc{mdk} bug list}.
In your report, please include the version number, which you can find by
running @w{@samp{mixasm --version}}. Also include in your message the
diff --git a/doc/mdk_emixvm.texi b/doc/mdk_emixvm.texi
index d99fd68..8fcbf55 100644
--- a/doc/mdk_emixvm.texi
+++ b/doc/mdk_emixvm.texi
@@ -1,9 +1,25 @@
-@node mixvm.el, mixasm, mixvm, Top
+@node mixvm.el, mixvm, Getting started, Top
@comment node-name, next, previous, up
@chapter mixvm.el
If you are an Emacs user and write your MIXAL programs using this
editor, you will find the elisp program @file{mixvm.el} quite
-useful. @file{mixvm.el} allows running the MIX virtual machine
-@code{mixvm} (@pxref{mixvm}) inside an Emacs @acronym{GUD} buffer, while
-visiting the MIXAL source file in another buffer.
+useful@footnote{@file{mixvm.el} has been kindly contributed by
+@value{PHILIP}. @file{mixvm.el} is based on a study of gdb, perldb, and
+pdb as found in @file{gud.el}, and @file{rubydb3x.el} distributed with
+the source code to the Ruby language.}. @file{mixvm.el} allows running
+the MIX virtual machine @code{mixvm} (@pxref{mixvm}) inside an Emacs
+@acronym{GUD} buffer, while visiting the MIXAL source file in another
+buffer.
+
+After installing @file{mixvm.el} (@pxref{Emacs support}), you can
+initiate an @sc{mdk}/@acronym{GUD} session inside Emacs with the command
+
+@example
+M-x mixvm
+@end example
+
+@noindent
+and you will have a @code{mixvm} prompt inside a newly created
+@acronym{GUD} buffer. @acronym{GUD} will reflect the current line in the
+corresponding source file buffer.
diff --git a/doc/mdk_gstart.texi b/doc/mdk_gstart.texi
index cfa44ea..bde4160 100644
--- a/doc/mdk_gstart.texi
+++ b/doc/mdk_gstart.texi
@@ -1,4 +1,4 @@
-@node Getting started, mixvm, MIX and MIXAL tutorial, Top
+@node Getting started, mixvm.el, MIX and MIXAL tutorial, Top
@comment node-name, next, previous, up
@chapter Getting started
diff --git a/doc/mdk_install.texi b/doc/mdk_install.texi
index c9ea868..78690ba 100644
--- a/doc/mdk_install.texi
+++ b/doc/mdk_install.texi
@@ -1,8 +1,16 @@
-@node Installing @sc{mdk}
+@node Installing MDK, MIX and MIXAL tutorial, Introduction, Top
@comment node-name, next, previous, up
@chapter Installing @sc{mdk}
-@node Download
+@menu
+* Download::
+* Requirements::
+* Basic installation::
+* Emacs support::
+* Special configure flags::
+@end menu
+
+@node Download, Requirements, Installing MDK, Installing MDK
@comment node-name, next, previous, up
@section Download the source tarball
@@ -36,7 +44,7 @@ tar xfvz mdk-X.Y.tar.gz
where @var{X.Y} stands for the downloaded version (the current stable
release being version @value{VERSION}).
-@node Requirements
+@node Requirements, Basic installation, Download, Installing MDK
@comment node-name, next, previous, up
@section Requirements
@@ -67,7 +75,7 @@ headers; this means both the library package and the @file{-dev} package
if you do not compile your libraries yourself (ex: installing
@file{libgtk1.2} and @file{libgtk1.2-dev} on Debian).
-@node Basic installation
+@node Basic installation, Emacs support, Requirements, Installing MDK
@comment node-name, next, previous, up
@section Basic installation
@@ -96,7 +104,7 @@ following:
Type make to build the following utilities:
- mixasm (MIX assembler)
- - mixvm (MIX virtual machine)
+ - mixvm (MIX virtual machine, with readline support)
- gmixvm (mixvm GTK+ GUI)
@end example
@@ -120,16 +128,52 @@ You can run these programs from within their directories, but I
recommend you to install them in proper locations using @code{make
install} from a root shell.
-@node Special configure flags
+@node Emacs support, Special configure flags, Basic installation, Installing MDK
+@comment node-name, next, previous, up
+@section Emacs support
+
+@code{mixvm} can be run within an Emacs GUD buffer using the elisp
+program @file{misc/mixvm.el}, kindly contributed by @value{PHILIP}.
+
+@file{mixvm.el} provides an interface between @sc{mdk}'s @code{mixvm}
+and Emacs, via @acronym{GUD}. Place this file in your load-path,
+optionally adding the following line to your @file{.emacs} file:
+
+@lisp
+(autoload 'mixvm "mixvm" "mixvm/gud interaction" t)
+@end lisp
+
+
+
+@node Special configure flags, , Emacs support, Installing MDK
@comment node-name, next, previous, up
@section Special configure flags
You can fine tunning the configuration process using the following
switches with configure:
+@defopt --enable-gui[=yes|no]
+@defoptx --disable-gui
+Enables/disables the built of the MIX virtual machine GUI
+(@code{gmixvm}). If the required libraries are missing
+(@pxref{Requirements}) the configure script with automatically disable
+this feature.
+@end defopt
+
+@defopt --with-readline[=yes|no]
+@defoptx --without-readline
+Enables/disables the GNU Readline support for @code{mixvm}. If the
+required libraries are missing (@pxref{Requirements}) the configure
+script with automatically disable this feature.
+@end defopt
+For additional, boilerplate configure options, see the @file{INSTALL}
+file, or run
+
+@example
+configure --help
+@end example
-Platforms
diff --git a/doc/mdk_intro.texi b/doc/mdk_intro.texi
index 8d1cfba..2a3f95d 100644
--- a/doc/mdk_intro.texi
+++ b/doc/mdk_intro.texi
@@ -1,4 +1,4 @@
-@node Introduction, MIX and MIXAL tutorial, Top, Top
+@node Introduction, Installing MDK, Top, Top
@comment node-name, next, previous, up
@unnumbered Introduction
@cindex Introduction
diff --git a/doc/mdk_mixasm.texi b/doc/mdk_mixasm.texi
index d48852a..753aa33 100644
--- a/doc/mdk_mixasm.texi
+++ b/doc/mdk_mixasm.texi
@@ -1,4 +1,4 @@
-@node mixasm, Copying, mixvm.el, Top
+@node mixasm, Copying, gmixvm, Top
@comment node-name, next, previous, up
@chapter @code{mixasm}, the MIXAL assembler
@cindex @code{mixasm}
diff --git a/doc/mdk_mixvm.texi b/doc/mdk_mixvm.texi
index 56a14fa..8289472 100644
--- a/doc/mdk_mixvm.texi
+++ b/doc/mdk_mixvm.texi
@@ -1,4 +1,4 @@
-@node mixvm, mixvm.el, Getting started, Top
+@node mixvm, gmixvm, mixvm.el, Top
@comment node-name, next, previous, up
@chapter @code{mixvm}, the MIX computer simulator
@@ -466,7 +466,7 @@ input-output devices this creation can be accomplished by a MIXAL
program writing to the device the required data, or, if you prefer, with
your favourite editor).
-@multitable {the device name} {xx-xx} {filena[x-x].dev} {bin i/o}
+@multitable {the device name} { xx-xx } {filename[x-x].dev} {bin i/o }
@item @emph{Device} @tab @emph{No.} @tab @emph{filename} @tab @emph{type}
@item Tape @tab 0-7 @tab @file{tape[0-7].dev} @tab bin i/o
@item Disks @tab 8-15 @tab @file{disk[0-7].dev} @tab bin i/o
diff --git a/doc/mdk_tut.texi b/doc/mdk_tut.texi
index f1ff53e..12bfb42 100644
--- a/doc/mdk_tut.texi
+++ b/doc/mdk_tut.texi
@@ -1,4 +1,4 @@
-@node MIX and MIXAL tutorial, Getting started, Introduction, Top
+@node MIX and MIXAL tutorial, Getting started, Installing MDK, Top
@comment node-name, next, previous, up
@chapter MIX and MIXAL tutorial
@cindex MIX