summaryrefslogtreecommitdiffhomepage
path: root/doc
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2001-07-13 20:17:04 +0000
committerJose Antonio Ortega Ruiz <jao@gnu.org>2001-07-13 20:17:04 +0000
commitb18af386c53f81e31f98a1c1b699666ec69a7aa4 (patch)
tree86b5b6e96fa98834b01405ac2183a622ac2af5ae /doc
parent6b57caa914cf2ad0586eb7a90606cc5d50ca1cb1 (diff)
downloadmdk-b18af386c53f81e31f98a1c1b699666ec69a7aa4.tar.gz
mdk-b18af386c53f81e31f98a1c1b699666ec69a7aa4.tar.bz2
version 0.4
Diffstat (limited to 'doc')
-rw-r--r--doc/img/ss_devdir.jpgbin0 -> 7618 bytes
-rw-r--r--doc/img/ss_split.jpgbin0 -> 37127 bytes
-rw-r--r--doc/mdk_gmixvm.texi64
-rw-r--r--doc/mdk_gstart.texi17
4 files changed, 66 insertions, 15 deletions
diff --git a/doc/img/ss_devdir.jpg b/doc/img/ss_devdir.jpg
new file mode 100644
index 0000000..aaaa00f
--- /dev/null
+++ b/doc/img/ss_devdir.jpg
Binary files differ
diff --git a/doc/img/ss_split.jpg b/doc/img/ss_split.jpg
new file mode 100644
index 0000000..cd72d13
--- /dev/null
+++ b/doc/img/ss_split.jpg
Binary files differ
diff --git a/doc/mdk_gmixvm.texi b/doc/mdk_gmixvm.texi
index f850384..4cc5399 100644
--- a/doc/mdk_gmixvm.texi
+++ b/doc/mdk_gmixvm.texi
@@ -55,16 +55,31 @@ devices.
@end itemize
@noindent
+The application can run in two modes: non-split (the above windows are
+placed in a notebook in the main window) or split mode (the windows are
+detached from the main one, and can be hidden individually). You can
+choose the display mode using the menu command @w{Settings->Split
+windows}.
+
+@ifnotinfo
+Here is an screenshot showing how @code{gmixvm} looks like when running
+in split mode:
+
+@image{img/ss_split}
+
+@end ifnotinfo
+
On the other hand, the main window's lower half presents you a
@code{mixvm} command prompt and a logging area where results of the
-issued commands are presented. These widgets implement a @code{mixvm}
-console which offers almost the same functionality as its @acronym{CLI}
-counterpart.
+issued commands are presented (in split mode, these widgets occupy the
+whole main window's space between the menu and status bars). 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}).
+When @code{gmixvm} is run, it creates a directory named @file{.mdk} in
+your home directory (if it does not already exist). The @file{.mdk}
+directory contains the program settings, the device files used by your
+MIX programs (@pxref{Devices}), and a command history file.
The following sections describe the above mentioned components of
@code{gmixvm}.
@@ -78,7 +93,7 @@ command text entry and, above it, an echo area. These widgets offer you
the same functionality as its @acronym{CLI} counterpart, @code{mixvm}
(@pxref{mixvm}). You can issue almost all @code{mixmv} commands at the
@code{gmixvm}'s command prompt in order to manipulate the MIX virtual
-machine. Please, refer to @xref{mixvm}, for a description of these
+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{TAB} key; e.g., if you type
@@ -105,7 +120,10 @@ pmem
@noindent
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.
+which can be recovered using the arrow up and down keys. As mentioned
+above, a file containing previous sessions' commands is stored in the
+configuration directory @file{~/.mdk}, and reloaded every time you start
+@code{gmixvm}.
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
@@ -138,7 +156,9 @@ 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
@@ -249,6 +269,16 @@ equivalent to the @code{mixvm}'s @code{run} command (@pxref{Debug
commands}).
@end deffn
+@deffn View MIX
+@deffnx View MIXAL
+@deffnx View Devices
+
+These toggles are available when running @code{gmixvm} in split mode,
+and let you turn on/off the visibility of the corresponding
+@code{gmixvm} windows.
+
+@end deffn
+
@deffn Debug Next
Executes the next MIX instruction. It is equivalent to the
@code{mixvm}'s @code{next} command (@pxref{Debug commands}).
@@ -292,6 +322,18 @@ The available formats are decimal (e.g. @w{-1234}) and MIX word
(e.g. @w{- 00 00 00 19 18}).
@end deffn
+@deffn Settings @w{Devices dir...}
+Opens a dialog that lets you choose where the MIX device files will be
+stored (@file{~/.mdk} is the default location).
+
+@ifnotinfo
+@image{img/ss_devdir}
+@end ifnotinfo
+
+You can also specify the devices directory using the @code{mixvm}
+command @code{devdir} (@pxref{Configuration commands}).
+
+@end deffn
@deffn Settings @w{External programs...}
This menu command opens a dialog that lets you specify the commands used
@@ -305,7 +347,9 @@ 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.
+corresponding dialog entry. These settings can also be changed using the
+@code{mixvm} commands @code{sedit} and @code{sasm} (@pxref{Configuration
+commands}).
@end deffn
diff --git a/doc/mdk_gstart.texi b/doc/mdk_gstart.texi
index 1fee48c..4c8b025 100644
--- a/doc/mdk_gstart.texi
+++ b/doc/mdk_gstart.texi
@@ -170,9 +170,14 @@ its output device (@pxref{Writing a source file}), the output is
redirected to the shell's standard output. Had you used any other MIX
output devices (disks, drums, line printer, etc.), @code{mixvm} would
have created a file named after the device used (e.g. @file{disk4.dev})
-and written its output there. Note also that the virtual machine reports
-the execution time of the program, according to the (virtual) time spent
-in each of the binary instructions (@pxref{Execution times}).
+and written its output there@footnote{The device files are stored, by
+default, in a directory called @file{.mdk}, which is created in your
+home directory the first time @code{mixvm} is run. You can change this
+default directory using the command @code{devdir} when running
+@code{mixvm} in interactive mode (@pxref{Configuration commands})}. Note
+also that the virtual machine reports the execution time of the program,
+according to the (virtual) time spent in each of the binary instructions
+(@pxref{Execution times}).
Sometimes, you will prefer to store the results of your program in MIX
registers rather than writing them to a device. In such cases,
@@ -276,7 +281,9 @@ elapsed execution time (i.e., the time spent executing instructions
since the last breakpoint), the total execution time for the program up
to now (which in our case coincides with the elapsed time, since there
were no breakpoints), and the total uptime for the virtual machine (you
-can load and run more than one program in the same session). After
+can load and run more than one program in the same
+session)@footnote{Printing of timing statistics can be disabled using
+the command @code{timing} (@pxref{Configuration commands}).}. After
running the program, the program counter will point to the address after
the one containing the @code{HLT} instruction. In our case, asking the
value of the program counter after executing the program will give us
@@ -433,7 +440,7 @@ MSG: 3002
MIX >
@end example
-Other useful commands for debugging are @code{tron} (which turns on
+Other useful commands for debugging are @code{tracing} (which turns on
tracing of executed intructions) and @code{weval} (which evaluates
w-expressions on the fly). For a complete description of all available
MIX commands, @xref{mixvm}.