summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2001-06-09 14:38:24 +0000
committerJose Antonio Ortega Ruiz <jao@gnu.org>2001-06-09 14:38:24 +0000
commit07d87f081c9866c2e24358d4b1b4ddd9b2fea967 (patch)
tree4cbcccfab63c241d0a20685e2fb81c3bc560ba99 /doc
parent25a8b9398f635ce31462b4c1a3e426e1e7976f01 (diff)
downloadmdk-07d87f081c9866c2e24358d4b1b4ddd9b2fea967.tar.gz
mdk-07d87f081c9866c2e24358d4b1b4ddd9b2fea967.tar.bz2
version 0.3.3
Diffstat (limited to 'doc')
-rw-r--r--doc/img/.cvsignore1
-rw-r--r--doc/img/Makefile.am5
-rw-r--r--doc/img/ss_devform.jpgbin0 -> 8820 bytes
-rw-r--r--doc/img/ss_extprog.jpgbin0 -> 11689 bytes
-rw-r--r--doc/mdk.texi10
-rw-r--r--doc/mdk_gmixvm.texi75
-rw-r--r--doc/mdk_mixvm.texi19
7 files changed, 87 insertions, 23 deletions
diff --git a/doc/img/.cvsignore b/doc/img/.cvsignore
index 282522d..eba2e0d 100644
--- a/doc/img/.cvsignore
+++ b/doc/img/.cvsignore
@@ -1,2 +1,3 @@
+.xvpics
Makefile
Makefile.in
diff --git a/doc/img/Makefile.am b/doc/img/Makefile.am
index 364518b..e530599 100644
--- a/doc/img/Makefile.am
+++ b/doc/img/Makefile.am
@@ -1,6 +1,6 @@
## Process this file with automake to produce Makefile.in
-# Copyright (C) 2000 Free Software Foundation, Inc.
+# Copyright (C) 2001 Free Software Foundation, Inc.
#
# This file is free software; as a special exception the author gives
# unlimited permission to copy and/or distribute it, with or without
@@ -11,6 +11,7 @@
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
EXTRA_DIST = ss_mix.jpg ss_mixal.jpg ss_devices.jpg ss_worddlg.jpg \
- ss_mix.txt ss_mixal.txt ss_colors.jpg ss_goto.jpg
+ ss_mix.txt ss_mixal.txt ss_colors.jpg ss_goto.jpg \
+ ss_devform.jpg ss_extprog.jpg
diff --git a/doc/img/ss_devform.jpg b/doc/img/ss_devform.jpg
new file mode 100644
index 0000000..255c200
--- /dev/null
+++ b/doc/img/ss_devform.jpg
Binary files differ
diff --git a/doc/img/ss_extprog.jpg b/doc/img/ss_extprog.jpg
new file mode 100644
index 0000000..ae289d1
--- /dev/null
+++ b/doc/img/ss_extprog.jpg
Binary files differ
diff --git a/doc/mdk.texi b/doc/mdk.texi
index a525243..699e3e6 100644
--- a/doc/mdk.texi
+++ b/doc/mdk.texi
@@ -12,9 +12,9 @@
@end direntry
-@set UPDATED 20 February 2001
-@set EDITION 0.3.2
-@set VERSION 0.3.2
+@set UPDATED 9 June 2001
+@set EDITION 0.3.3
+@set VERSION 0.3.3
@set JAO Jose Antonio Ortega Ruiz
@set PHILIP Philip E. King
@footnotestyle separate
@@ -116,6 +116,8 @@ helpful discussions, as well as actual code (@pxref{mixvm.el}).
+
+
@detailmenu
--- The Detailed Node Listing ---
@@ -188,7 +190,7 @@ Interactive commands
* Debug commands:: Debugging programs.
* State commands:: Inspecting the virtual machine state.
-gmixvm
+@code{gmixvm}, the GTK virtual machine
* Invoking @code{gmixvm}:: Invoking the GTK+ interface.
* MIXVM console:: Using @code{mixvm} commands.
diff --git a/doc/mdk_gmixvm.texi b/doc/mdk_gmixvm.texi
index da60e26..a96459f 100644
--- a/doc/mdk_gmixvm.texi
+++ b/doc/mdk_gmixvm.texi
@@ -6,7 +6,7 @@
@node gmixvm, mixasm, mixvm, Top
@comment node-name, next, previous, up
-@chapter gmixvm
+@chapter @code{gmixvm}, the GTK virtual machine
@cindex @code{gmixvm}
@cindex GUI
@cindex GTK+
@@ -81,10 +81,10 @@ the same functionality as its @acronym{CLI} counterpart, @code{mixvm}
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. The command prompt offers command line completion for
-partially typed commands using the @kbd{RET} key; e.g., if you type
+partially typed commands using the @kbd{TAB} key; e.g., if you type
@example
-lo @kbd{RET}
+lo @kbd{TAB}
@end example
@noindent
the command is automatically completed to @code{load}. If multiple
@@ -92,7 +92,7 @@ completions are available, they will be shown in the echo area. Thus,
typing
@example
-p @kbd{RET}
+p @kbd{TAB}
@end example
@noindent
will produce the following output on the echo area:
@@ -103,7 +103,9 @@ pc psym preg pflags pall
pmem
@end example
@noindent
-which lists all the available commands starting with @code{p}.
+which lists all the available commands starting with @code{p}. In
+addition, the command prompt maintains a history of typed commands,
+which can be recovered using the arrow up and down keys.
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
@@ -196,11 +198,17 @@ program.
@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.
+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 MIX
+program being run, and that loading a new MIX program will close all
+previously open devices.
+
+The input/output for binary block devices (tapes and disks) shall be a
+list of MIX words, which can be displayed either in decimal or word
+format (e.g. @w{- 67} or @w{- 00 00 00 01 03}. The format used by
+@code{gmixvm} can be configured using the @w{Settings->Device output}
+menu command for each binary device.
You can change the font used to display the devices content
using the @w{Settings->Change font->Devices} menu command.
@@ -217,6 +225,20 @@ in the virtual machine's memory. It is equivalent to the @code{mixvm}'s
@code{load} command (@pxref{File commands}).
@end deffn
+@deffn File Edit...
+Opens a file dialog that lets your specify a MIXAL source file to be
+edited. It is equivalent to the @code{mixvm}'s @code{edit} command
+(@pxref{File commands}). The program used for editing can be specified
+using the menu entry @code{@w{Settings->External programs}}.
+@end deffn
+
+@deffn File Compile...
+Opens a file dialog that lets your specify a MIXAL source file to be
+compiled. It is equivalent to the @code{mixvm}'s @code{compile} command
+(@pxref{File commands}). The command used for compiling can be specified
+using the menu entry @code{@w{Settings->External programs}}.
+@end deffn
+
@deffn File Exit
Exits the application.
@end deffn
@@ -232,7 +254,7 @@ Executes the next MIX instruction. It is equivalent to the
@code{mixvm}'s @code{next} command (@pxref{Debug commands}).
@end deffn
-@deffn Debug Clear breakpoints
+@deffn Debug @w{Clear breakpoints}
Clears all currently set breakpoints. It is equivalent to the
@code{mixvm}'s @code{cabp} command.
@end deffn
@@ -242,11 +264,40 @@ 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
+@deffn Settings @w{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 @w{Device output...}
+Opens a dialog that lets you specify which format shall be used to show
+the contents of MIX binary block devices.
+
+@ifnotinfo
+@image{img/ss_devform}
+@end ifnotinfo
+
+The available formats are decimal (e.g. @w{-1234}) and MIX word
+(e.g. @w{- 00 00 00 19 18}).
+@end deffn
+
+
+@deffn Settings @{External programs...}
+This menu command opens a dialog that lets you specify the commands used
+for editing and compiling MIXAL source files.
+
+@ifnotinfo
+@image{img/ss_extprog}
+@end ifnotinfo
+
+The commands are specified as template strings, where the control
+substring @code{%s} will be substituted by the actual file name. Thus,
+if you want to edit programs using @code{vi} running in an @code{xterm},
+you must enter the command template @code{@w{xterm -e vi %s}} in the
+corresponding dialog entry.
+@end deffn
+
+
@deffn Settings Save
Saves the current settings (colors and fonts).
@end deffn
diff --git a/doc/mdk_mixvm.texi b/doc/mdk_mixvm.texi
index 3392bf0..ee932e6 100644
--- a/doc/mdk_mixvm.texi
+++ b/doc/mdk_mixvm.texi
@@ -159,19 +159,23 @@ given file will be loaded (as with @code{load} @var{file}) and
executed. If @code{run} is invoked again after program execution
completion (i.e., after the @code{HLT} instruction has been found in a
previous run), the program counter is repositioned and execution starts
-again from the beginning.
+again from the beginning (as a matter of fact, a @code{load} command
+preserving the currently set breakpoints is issued before resuming
+execution).
@end deffn
-@deffn {file command} edit file[.mixal]
+@deffn {file command} edit [file[.mixal]]
The source file @var{file.mixal} is edited using the editor defined in
the environment variable @var{MDK_EDITOR}. If this variable is not set,
the following ones are tried out in order: @var{X_EDITOR}, @var{EDITOR}
-and @var{VISUAL}.
+and @var{VISUAL}. If invoked without argument, the source file for the
+currently loaded MIX file is edited.
@end deffn
@deffn {file command} compile file[.mixal]
The source file @var{file.mixal} is compiled (with debug information
-enabled) using @code{mixasm}.
+enabled) using @code{mixasm}. If invoked without argument, the source
+file for the currently loaded MIX file is recompiled.
@end deffn
@@ -188,7 +192,12 @@ This command causes the virtual machine to fetch and execute up to
counter position. Execution is interrupted either when the specified
number of instructions have been fetched or a breakpoint is found,
whatever happens first. If run without arguments, one instruction is
-executed.
+executed. If @code{next} is invoked again after program execution
+completion (i.e., after the @code{HLT} instruction has been found in a
+previous run), the program counter is repositioned and execution starts
+again from the beginning (as a matter of fact, a @code{load} command
+preserving the currently set breakpoints is issued before resuming
+execution).
@end deffn
@deffn {debug command} sbp line_number