diff options
| -rw-r--r-- | doc/mdk_gmixvm.texi | 157 |
1 files changed, 62 insertions, 95 deletions
diff --git a/doc/mdk_gmixvm.texi b/doc/mdk_gmixvm.texi index 0966679..9bf502b 100644 --- a/doc/mdk_gmixvm.texi +++ b/doc/mdk_gmixvm.texi @@ -1,10 +1,10 @@ @c -*-texinfo-*- @c This is part of the GNU MDK Reference Manual. -@c Copyright (C) 2000, 2001, 2003 +@c Copyright (C) 2000, 2001, 2003, 2004 @c Free Software Foundation, Inc. @c See the file mdk.texi for copying conditions. -@c $Id: mdk_gmixvm.texi,v 1.16 2003/06/02 23:20:38 jao Exp $ +@c $Id: mdk_gmixvm.texi,v 1.17 2004/08/01 23:32:58 jao Exp $ @node gmixvm, mixguile, mixvm, Top @comment node-name, next, previous, up @@ -67,9 +67,13 @@ Typing @code{gmixvm} or @code{gmixvm -q} at your command prompt, the main window will appear, offering you a graphical interface to run and debug your MIX programs. -@ifnottex +@ifinfo @image{img/ss_mix, 400pt} -@end ifnottex +@end ifinfo + +@ifhtml +@image{../img/ss_mix, 400pt} +@end ifhtml Apart from the menu and status bars, we can distinguish two zones (or halves) in this main window. In the upper half of @code{gmixvm}'s main @@ -88,26 +92,23 @@ 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 corresponding command from the -@code{View} menu. +These three windows can be detached from the notebook, using either +the penultimate toolbar button (which detachs the currently visible +notebook page) or the menu entries under @code{@w{View->Detached windows}}. @ifhtml Here is an screenshot showing how @code{gmixvm} looks like when running -in split mode: +with a couple of detached windows: -@image{img/ss_split, 420pt} +@image{../img/ss_split, 420pt} @end ifhtml 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 (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. +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{.mdk} in your home directory (if it does not already exist). The @file{.mdk} @@ -159,8 +160,8 @@ 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 -prompt} and @w{Settings->Change font->Command log} menu commands. +messages in the echo area using the @code{@w{Settings->Change font->Command +prompt}} and @code{@w{Settings->Change font->Command log}} menu commands. @node MIX virtual machine, MIXAL source view, MIXVM console, gmixvm @comment node-name, next, previous, up @@ -173,13 +174,13 @@ memory cells and their contents, and the time statistics (including total uptime, elapsed time since the last run command and total execution time for the currently loaded MIX program). -Clicking any register entry, you will be prompted for a new register's +If you click any register entry, you will be prompted for a new register's contents. @ifhtml The next figure shows the enter word dialog. -@image{img/ss_worddlg, 250pt} +@image{../img/ss_worddlg, 250pt} @end ifhtml @@ -189,58 +190,34 @@ 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. -@ifhtml -The next figure shows the enter address dialog. - -@image{img/ss_goto, 200pt} - -@end ifhtml - - 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. +using the @code{@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 second notebook's page, dubbed Source, shows you the MIXAL source of the currently loaded MIX file. -@ifnottex -@image{img/ss_mixal, 400pt} -@end ifnottex - -The information is presented in two columns. The first column shows the -address and memory contents of the compiled MIX instruction, while the -second one displays its corresponding MIXAL representation, together -with the source file line number. The current 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. @ifhtml -The following figure shows the change color dialog. - -@image{img/ss_colors, 250pt} - +@image{../img/ss_mixal, 400pt} @end ifhtml -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. +The information is presented in four columns. The first column +displays little icons showing the current program pointer and any set +breakpoints. The second and third columns show the address and memory +contents of the compiled MIX instruction, while the last one displays +its corresponding MIXAL representation, together with the source file +line number. You can set/unset breakpoints by clicking on any line +that has an associated memory address. +You can change the font used to display the MIXAL source code +using the @code{@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 @@ -253,24 +230,24 @@ program. @ifhtml -@image{img/ss_devices, 400pt} +@image{../img/ss_devices, 400pt} @end ifhtml -Input device contents is read from files located in the @file{~/.gmivm} -directory, and the output is also written in files at the same +Input device contents is read from files located in the @file{~/.mdk} +directory, and the output is also written to 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} +The input/output for binary block devices (tapes and disks) is 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 @code{@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. +using the @code{@w{Settings->Change font->Devices}} menu command. @node Menu and status bars, , MIX devices view, gmixvm @comment node-name, next, previous, up @@ -304,29 +281,6 @@ using the menu entry @code{@w{Settings->External programs}}, or using the Exits the application. @end deffn -@deffn View @w{Toolbar(s)} -Toggles the toolbar(s) in the @code{gmixvm} window(s) (in split mode -there are multiple windows and, hence, multiple toolbars). -@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 View @w{Split windows} -@deffnx View @w{One window} - -Change the mode between one and split windows. - -@end deffn - - @deffn Debug Run Runs the currently loaded MIX program, up to the next breakpoint. It is equivalent to the @code{mixvm}'s @code{run} command (@pxref{Debug @@ -345,24 +299,37 @@ Clears all currently set breakpoints. It is equivalent to the @deffn Debug Symbols... Opens a dialog showing the list of symbols defined in the currently -loaded MIX program. +loaded MIX program. The font used to display this list can be +customised using the meny entry @code{@w{Settings->Change font->Symbol +list}}. @ifhtml -@image{img/ss_symbols, 250pt} +@image{../img/ss_symbols, 250pt} @end ifhtml @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. +@deffn View @w{Toolbar(s)} +Toggles the toolbar(s) in the @code{gmixvm} window(s) (when notebook +pages are detached, each one has its own toolbar). +@end deffn + +@deffn View @w{Detached windows} @w{Virtual machine} +@deffnx View @w{Detached windows} Source +@deffnx View @w{Detached windows} Devices + +These toggles let you detach (or re-attach) the corresponding notebook +page. + @end deffn @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). +(i.e. commad prompt, command log, Virtual machine, Source, Devices and +Symbol list). There is also an entry (@code{All}) to change all fonts +at once. @end deffn @deffn Settings @w{Device output...} @@ -370,7 +337,7 @@ Opens a dialog that lets you specify which format shall be used to show the contents of MIX binary block devices. @ifhtml -@image{img/ss_devform, 250pt} +@image{../img/ss_devform, 250pt} @end ifhtml The available formats are decimal (e.g. @w{-1234}) and MIX word @@ -382,7 +349,7 @@ Opens a dialog that lets you choose where the MIX device files will be stored (@file{~/.mdk} is the default location). @ifhtml -@image{img/ss_devdir, 250pt} +@image{../img/ss_devdir, 250pt} @end ifhtml You can also specify the devices directory using the @code{mixvm} @@ -395,7 +362,7 @@ This menu command opens a dialog that lets you specify the commands used for editing and compiling MIXAL source files. @ifhtml -@image{img/ss_extprog, 250pt} +@image{../img/ss_extprog, 250pt} @end ifhtml The commands are specified as template strings, where the control |