summaryrefslogtreecommitdiffhomepage
path: root/doc/mdk.texi
blob: 0326e4bf9a93add53c6dd2d6ed5a39ad491a0cde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
\input texinfo 
@c %**start of header
@setfilename mdk.info
@settitle GNU MIX Development Kit (mdk)
@finalout
@setchapternewpage odd
@c %**end of header

@dircategory GNU programming tools
@direntry
* MDK: (mdk).           The GNU MIX Development Kit.
@end direntry


@set UPDATED 9 June 2001
@set EDITION 0.3.3
@set VERSION 0.3.4
@set JAO Jose Antonio Ortega Ruiz
@set PHILIP Philip E. King
@footnotestyle separate

@ifinfo
This file documents the the GNU @sc{mdk} utilities for developing
programs using Donald Knuth's MIX language.

Copyright (C) 2000, 2001 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.1 or any later version published by the Free Software
Foundation; with no Invariant Sections, no Front-Cover Texts and
no Back-Cover Texts.  A copy of the license is included in the
section entitled "GNU Free Documentation License".

@ignore
Permission is granted to process this file through TeX and print the
results, provided the printed document carries copying permission
notice identical to this one except for the removal of this paragraph
(this paragraph not being relevant to the printed manual).

@end ignore
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation License,
Version 1.1 or any later version published by the Free Software
Foundation; with no Invariant Sections, no Front-Cover Texts and
no Back-Cover Texts.  A copy of the license is included in the
section entitled "GNU Free Documentation License".

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation.
@end ifinfo

@titlepage
@title GNU MDK
@subtitle GNU MIX Development Kit
@subtitle Edition @value{EDITION}, for GNU @sc{mdk} Version @value{VERSION}
@subtitle @value{UPDATED}
@author by @value{JAO}

@page
@vskip 0pt plus 1filll
Copyright @copyright{} 2000, 2001 Free Software Foundation, Inc.

Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.

Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided also that the
sections entitled ``Copying'' and ``GNU General Public License'' are
included exactly as in the original, and provided that the entire
resulting derived work is distributed under the terms of a permission
notice identical to this one.

Permission is granted to copy and distribute translations of this manual
into another language, under the above conditions for modified versions,
except that this permission notice may be stated in a translation
approved by the Free Software Foundation.
@end titlepage

@node Top, Introduction, (dir), (dir)

@ifinfo
This file documents the GNU @sc{mdk} utilities to develop, run and debug
programs written in the MIXAL programming language.  MIXAL is an
assembler-like language for programming a virtual computer called
MIX. They were created by Donald Knuth in the first volume of @cite{The
Art of Computer Programming} (Addison Wesley, 1997).

GNU @sc{mdk} is an official GNU package.

GNU @sc{mdk} was written by @value{JAO} and is released under the GNU
General Public license (@pxref{Copying}), so that users are free to share
and improve it.

@value{PHILIP} has contributed to this package development with many
helpful discussions, as well as actual code (@pxref{mixvm.el}).

@end ifinfo

@menu
* Introduction::                
* Installing MDK::              Installing GNU MDK from the source tarball.
* MIX and MIXAL tutorial::      Learn the innards of MIX and MIXAL.
* Getting started::             Basic usage of the @sc{mdk} tools.
* mixvm.el::                    Using @code{mixvm} within Emacs.
* mixvm::                       Invoking and using the MIX virtual machine.
* gmixvm::                      Invoking and using the GTK+ virtual machine.
* mixasm::                      Invoking the MIXAL assembler.
* Problems::                    Reporting bugs.
* Copying::                     @sc{mdk} licensing terms.
* GNU Free Documentation License::  
* Concept Index::               Index of concepts.





@detailmenu
 --- The Detailed Node Listing ---

Installing @sc{mdk}

* Download::                    
* Requirements::                
* Basic installation::          
* Emacs support::               
* Special configure flags::     
* Supported platforms::         

MIX and MIXAL tutorial

* The MIX computer::            Architecture and instruction set 
                                of the MIX computer.
* MIXAL::                       The MIX assembly language.

The MIX computer

* MIX architecture::            
* MIX instruction set::         

MIX instruction set

* Instruction structure::       
* Loading operators::           
* Storing operators::           
* Arithmetic operators::        
* Address transfer operators::  
* Comparison operators::        
* Jump operators::              
* Input-output operators::      
* Conversion operators::        
* Shift operators::             
* Miscellaneous operators::     
* Execution times::             

MIXAL

* Basic structure::             Writing basic MIXAL programs.
* MIXAL directives::            Assembler directives.
* Expressions::                 Evaluation of expressions.
* W-expressions::               Evaluation of w-expressions.
* Local symbols::               Special symbol table entries.
* Literal constants::           Specifying an immediate operand.

Getting started

* Writing a source file::       A sample MIXAL source file.
* Compiling::                   Using @code{mixasm} to compile source
                                files into binary format.
* Running the program::         Running and debugging your program.

Running the program

* Non-interactive mode::        Running your programs non-interactively.
* Interactive mode::            Running programs interactively.
* Debugging::                   Commands for debugging your programs.

@code{mixvm}, the MIX computer simulator

* Invocation::                  Options when invoking @code{mixvm}.
* Commands::                    Commands available in interactive mode.
* Devices::                     MIX block devices implementation.

Interactive commands 

* File commands::               Loading and executing programs.
* Debug commands::              Debugging programs.
* State commands::              Inspecting the virtual machine state.

@code{gmixvm}, the GTK virtual machine

* Invoking @code{gmixvm}::      Invoking the GTK+ interface.
* MIXVM console::               Using @code{mixvm} commands.
* MIX virtual machine::         The MIX virtual machine window.
* MIXAL source view::           Viewing the MIXAL source code.
* MIX devices view::            Device output.
* Menu and status bars::        Available menu commands.

@code{mixasm}, the MIXAL assembler

* Invoking @code{mixasm}::      @code{mixasm} options

@end detailmenu
@end menu

@include mdk_intro.texi
@include mdk_install.texi
@include mdk_tut.texi
@include mdk_gstart.texi
@include mdk_emixvm.texi
@include mdk_mixvm.texi
@include mdk_gmixvm.texi
@include mdk_mixasm.texi
@include mdk_bugs.texi
@include gpl.texi
@include fdl.texi
@include mdk_index.texi


@shortcontents
@contents
@bye