summaryrefslogtreecommitdiffhomepage
path: root/doc/mdk_install.texi
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/mdk_install.texi
parent92e00ea7d9a1aa5b202495e993c5e69915c4ffee (diff)
downloadmdk-2ca96c58673afb1df494ae5b5b00256c140ce3d6.tar.gz
mdk-2ca96c58673afb1df494ae5b5b00256c140ce3d6.tar.bz2
minor changes
Diffstat (limited to 'doc/mdk_install.texi')
-rw-r--r--doc/mdk_install.texi58
1 files changed, 51 insertions, 7 deletions
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