summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2001-05-15 23:08:19 +0000
committerJose Antonio Ortega Ruiz <jao@gnu.org>2001-05-15 23:08:19 +0000
commitbbaf3258adced8e4d02b6a8880c4cd0883175cd8 (patch)
tree0cefab96c108efaaa096698432804ba25720e642 /doc
parent18b57c85c16a355c4a0b13528d0846f30fa277ce (diff)
downloadmdk-bbaf3258adced8e4d02b6a8880c4cd0883175cd8.tar.gz
mdk-bbaf3258adced8e4d02b6a8880c4cd0883175cd8.tar.bz2
0.3.2 release
Diffstat (limited to 'doc')
-rw-r--r--doc/img/ss_colors.jpgbin0 -> 8309 bytes
-rw-r--r--doc/img/ss_goto.jpgbin0 -> 2801 bytes
-rw-r--r--doc/mdk.texi4
-rw-r--r--doc/mdk_gmixvm.texi101
-rw-r--r--doc/mdk_install.texi8
5 files changed, 104 insertions, 9 deletions
diff --git a/doc/img/ss_colors.jpg b/doc/img/ss_colors.jpg
new file mode 100644
index 0000000..fe2afd8
--- /dev/null
+++ b/doc/img/ss_colors.jpg
Binary files differ
diff --git a/doc/img/ss_goto.jpg b/doc/img/ss_goto.jpg
new file mode 100644
index 0000000..cf6d8ba
--- /dev/null
+++ b/doc/img/ss_goto.jpg
Binary files differ
diff --git a/doc/mdk.texi b/doc/mdk.texi
index 9afe029..38c0a02 100644
--- a/doc/mdk.texi
+++ b/doc/mdk.texi
@@ -13,8 +13,8 @@
@set UPDATED 20 February 2001
-@set EDITION 0.3.1
-@set VERSION 0.3.1
+@set EDITION 0.3.2
+@set VERSION 0.3.2
@set JAO Jose Antonio Ortega Ruiz
@set PHILIP Philip E. King
@footnotestyle separate
diff --git a/doc/mdk_gmixvm.texi b/doc/mdk_gmixvm.texi
index 81ced1d..17c46f7 100644
--- a/doc/mdk_gmixvm.texi
+++ b/doc/mdk_gmixvm.texi
@@ -55,6 +55,11 @@ issued commands are presented. These widgets implement a @code{mixvm}
console which offers almost the same functionality as its @acronym{CLI}
counterpart.
+When @code{gmixvm} is run, it creates a directory named @file{.gmixvm}
+in your home directory (if it does not already exist). The
+@file{.gmixvm} directory contains the program settings and the device
+files used by your MIX programs (@pxref{Devices}).
+
The following sections describe the above mentioned components of
@code{gmixvm}.
@@ -69,7 +74,34 @@ the same functionality as its @acronym{CLI} counterpart, @code{mixvm}
@code{gmixvm}'s command prompt in order to manipulate the MIX virtual
machine. Please, refer to @xref{mixvm}, for a description of these
commands, and to @xref{Getting started}, for a tutorial on using the MIX
-virtual machine.
+virtual machine. The command prompt offers command line completion for
+partially typed commands using the @kbd{RET} key; e.g., if you type
+
+@example
+lo @kbd{RET}
+@end example
+@noindent
+the command is automatically completed to @code{load}. If multiple
+completions are available, they will be shown in the echo area. Thus,
+typing
+
+@example
+p @kbd{RET}
+@end example
+@noindent
+will produce the following output on the echo area:
+
+@example
+Completions:
+pc psym preg pflags pall
+pmem
+@end example
+@noindent
+which lists all the available commands starting with @code{p}.
+
+You can change the font used to display the issued commands and the
+messages in the echo area using the @w{Settings->Change font->Command
+prompt} and @w{Settings->Change font->Command log} menu commands.
@node MIX virtual machine, MIXAL source view, MIXVM console, gmixvm
@comment node-name, next, previous, up
@@ -96,16 +128,25 @@ address column's title, a dialog asking you for a memory address will
appear; if you introduce a valid address, this will be the first cell
displayed in the scrollable list after you click the OK button.
+@ifnotinfo
+The next figure shows the enter address dialog.
+@image{img/ss_goto}
+@end ifnotinfo
+
+
The register contents are shown as a list of MIX bytes plus sign. If you
place the mouse pointer over any of them, the decimal value of this MIX
word will appear inside a tooltip.
+You can change the font used to display the MIX virtual machine contents
+using the @w{Settings->Change font->MIX} menu command.
+
@node MIXAL source view, MIX devices view, MIX virtual machine, gmixvm
@comment node-name, next, previous, up
@section MIXAL source view
The second notebook's page, dubbed MIXAL, shows you the MIXAL source of
-the currently loaded MIX file. A shown in the next figure, the
+the currently loaded MIX file. As shown in the next figure, the
information is presented in two columns.
@image{img/ss_mixal, 400pt}
@@ -117,20 +158,47 @@ location of the location counter is highlighted in grey, while any set
breakpoint is marked in red. You can set/unset breakpoints by clicking
on any line in this view which has an associated memory address.
+The colors used to mark the location pointer line and the breakpoints
+can be customized with the @w{Settings->Colors...} menu command. When you
+click on this menu item, a dialog showing the current line colors will
+appear.
+
+@ifnotinfo
+The following figure shows the change color dialog.
+@image{img/ss_colors}
+@end ifnotinfo
+
+Clicking on any of the colors will produce a color selection dialog for
+choosing a new color for the given element. In this way, you can change
+the foreground and background colors used for drawing the current line,
+the lines where breakpoints have been set and plain MIXAL code lines.
+
+You can change the font used to display the MIXAL source code
+using the @w{Settings->Change font->MIXAL} menu command.
+
+
@node MIX devices view, Menu and status bars, MIXAL source view, gmixvm
@comment node-name, next, previous, up
@section MIX devices view
-The last notebook page, dubbed Devices, shows you the output on
-character based MIX devices (the console, line printer and paper tape,
-@pxref{Devices}) produced by the running program. The binary
-input/output devices (disks, cards, etc.) are handled via files, as in
-@code{mixvm} (@pxref{Devices}).
+The last notebook page, dubbed Devices, shows you the output/input
+to/from MIX block devices (the console, line printer, paper tape,
+disks, card and tapes @pxref{Devices}) produced by the running
+program.
@ifnotinfo
@image{img/ss_devices, 400pt}
@end ifnotinfo
+Input device contents is read from files located in the
+@file{~/.gmivm} directory, and the output is also written in files
+at the same location. Note that device tabs will appear as they are used
+by the program being run, and that loading a new MIX program will close
+all previously open devices.
+
+You can change the font used to display the devices content
+using the @w{Settings->Change font->Devices} menu command.
+
@node Menu and status bars, , MIX devices view, gmixvm
@comment node-name, next, previous, up
@section Menu and status bars
@@ -163,6 +231,25 @@ Clears all currently set breakpoints. It is equivalent to the
@code{mixvm}'s @code{cabp} command.
@end deffn
+@deffn Settings Colors...
+Lets you change the colors used to mark the current and breakpoint lines
+in the MIXAL tab, as well as the colors used for plain source lines.
+@end deffn
+
+@deffn Settings Change font
+Lets you change the font used in the various @code{gmixv} widgets
+(i.e. commad prompt, command log, MIX, MIXAL and devices).
+@end deffn
+
+@deffn Settings Save
+Saves the current settings (colors and fonts).
+@end deffn
+
+@deffn Settins Save on exit
+Mark this checkbox if you want @code{gmixvm} to save its settings
+(colors and fonts) every time you quit the program.
+@end deffn
+
@deffn Help About...
Shows information about @code{gmixvm}'s version and copyright.
@end deffn
diff --git a/doc/mdk_install.texi b/doc/mdk_install.texi
index d09426a..b337fd8 100644
--- a/doc/mdk_install.texi
+++ b/doc/mdk_install.texi
@@ -190,6 +190,14 @@ Redhat GNU/Linux 7.0 (Agustin Navarro), 6.2 (Roberto Ferrero)
FreeBSD 4.2 (Ying-Chieh Liao)
@item
Solaris 2.8/gcc 2.95.3 (Stephen Ramsay)
+@item
+MS Windows 98 SE/Cygwin 1.1.8-2 (Christoph von
+Nathusius)@footnote{Caveats: Christoph has only tested @code{mixvm} and
+@code{mixasm} on this platform, using @code{gcc} 2.95.3-2, @code{GLIB}
+1.2.10 and @code{GNUreadline} 4.1-2. He has reported missing history
+functionalities on a first try. If you find problems with
+history/readline functionality, please try a newer/manually installed
+readline version.}
@end itemize
MDK will probably work on any GNU/Linux and BSD platform. If you try it