summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2004-08-03 13:23:05 +0000
committerJose Antonio Ortega Ruiz <jao@gnu.org>2004-08-03 13:23:05 +0000
commitc7360972a2deb33fed25c60810559df35e918f82 (patch)
tree272a39085d6ab494caa0f49dacf335b436ab31b4
parent49062bd52b40953544363f760dbb672fa898a4bf (diff)
downloadmdk-c7360972a2deb33fed25c60810559df35e918f82.tar.gz
mdk-c7360972a2deb33fed25c60810559df35e918f82.tar.bz2
documentation cleanup
-rw-r--r--ChangeLog4
-rw-r--r--doc/mdk.texi127
-rw-r--r--doc/mdk_ack.texi4
-rw-r--r--doc/mdk_bugs.texi4
-rw-r--r--doc/mdk_copying.texi2
-rw-r--r--doc/mdk_emacs.texi2
-rw-r--r--doc/mdk_findex.texi4
-rw-r--r--doc/mdk_gmixvm.texi8
-rw-r--r--doc/mdk_index.texi4
-rw-r--r--doc/mdk_intro.texi4
-rw-r--r--doc/mdk_mixasm.texi6
-rw-r--r--doc/mdk_mixguile.texi4
-rw-r--r--doc/mdk_mixvm.texi4
13 files changed, 76 insertions, 101 deletions
diff --git a/ChangeLog b/ChangeLog
index 3df620b..ea28588 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2004-08-03 Jose Antonio Ortega Ruiz <jao@gnu.org>
+
+ * doc: documentation cleanup.
+
2004-08-02 Jose Antonio Ortega Ruiz <jao@gnu.org>
* INSTALL:
diff --git a/doc/mdk.texi b/doc/mdk.texi
index 793158c..bd41b79 100644
--- a/doc/mdk.texi
+++ b/doc/mdk.texi
@@ -1,17 +1,12 @@
-\input texinfo
+\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename mdk.info
@settitle GNU MIX Development Kit (mdk)
-@finalout
+@syncodeindex pg cp
+@c @finalout
@setchapternewpage odd
@c %**end of header
-@dircategory GNU programming tools
-@direntry
-* MDK: (mdk). The GNU MIX Development Kit.
-@end direntry
-
-
@set UPDATED August, 2004
@set EDITION 1.2
@set VERSION 1.2
@@ -19,83 +14,57 @@
@set PHILIP Philip E. King
@set PIETER Pieter E. J. Pareit
@set MIKE Michael Scholz
-@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, 2002, 2003, 2004 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
+@copying
+This manual is for GNU MDK (version @value{VERSION}, @value{UPDATED}),
+a set of utilities for developing programs using Donald Knuth's MIX
+language.
+
+Copyright @copyright{} 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
+
+@quotation
+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, with the Front-Cover Texts being ``A GNU Manual,''
+and with the Back-Cover Texts as in (a) below. A copy of the
+license is included in the section entitled ``GNU Free Documentation
+License.''
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
+@end quotation
+@end copying
+
+@dircategory GNU programming tools
+@direntry
+* MDK: (mdk). The GNU MIX Development Kit.
+@end direntry
+
+
+@footnotestyle separate
@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}
-
+@author by @value{JAO} (@email{jao@@gnu.org})
@page
@vskip 0pt plus 1filll
-Copyright @copyright{} 2000, 2001, 2002, 2003, 2004 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, 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.
+@insertcopying
@end titlepage
-@node Top, Introduction, (dir), (dir)
+@shortcontents
+@contents
-@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).
+@ifnottex
+@node Top, Introduction, (dir), (dir)
-GNU @sc{mdk} is part of the GNU project.
+@insertcopying
-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.
+GNU MDK was written and designed by @value{JAO}.
@value{PIETER} is the author of the Emacs @code{MIXAL} mode
(@pxref{MIXAL mode}), and has also contributed many bug fixes.
@@ -106,7 +75,7 @@ helpful discussions, as well as actual code (@pxref{GUD integration}).
@value{MIKE} is the author of the German translation of @sc{mdk}'s
user interface.
-@end ifinfo
+@end ifnottex
@menu
* Introduction::
@@ -124,6 +93,10 @@ user interface.
* Concept Index:: Index of concepts.
* Instructions and commands:: Index of MIXAL instructions and MIXVM commands.
+
+
+
+
@detailmenu
--- The Detailed Node Listing ---
@@ -213,11 +186,11 @@ MIXAL mode
@code{mixasm}, the MIXAL assembler
-* Invoking @code{mixasm}:: @code{mixasm} options
+* Invoking mixasm::
@code{mixvm}, the MIX computer simulator
-* Invocation:: Options when invoking @code{mixvm}.
+* Invocation::
* Commands:: Commands available in interactive mode.
* Devices:: MIX block devices implementation.
@@ -231,7 +204,7 @@ Interactive commands
@code{gmixvm}, the GTK virtual machine
-* Invoking @code{gmixvm}:: Invoking the GTK+ interface.
+* Invoking gmixvm::
* MIXVM console:: Using @code{mixvm} commands.
* MIX virtual machine:: The MIX virtual machine window.
* MIXAL source view:: Viewing the MIXAL source code.
@@ -272,8 +245,6 @@ Copying
@include mdk_index.texi
@include mdk_findex.texi
-@shortcontents
-@contents
@bye
-$Id: mdk.texi,v 1.23 2004/08/02 10:49:25 jao Exp $
+$Id: mdk.texi,v 1.24 2004/08/03 13:23:05 jao Exp $
diff --git a/doc/mdk_ack.texi b/doc/mdk_ack.texi
index a157f97..e252c86 100644
--- a/doc/mdk_ack.texi
+++ b/doc/mdk_ack.texi
@@ -4,7 +4,7 @@
@c Free Software Foundation, Inc.
@c See the file mdk.texi for copying conditions.
-@c $Id: mdk_ack.texi,v 1.11 2004/08/02 10:49:25 jao Exp $
+@c $Id: mdk_ack.texi,v 1.12 2004/08/03 13:23:06 jao Exp $
@node Acknowledgments, Installing MDK, Introduction, Top
@comment node-name, next, previous, up
@@ -53,7 +53,7 @@ tested @sc{mdk} on different platforms, and helped fix the configuration
process in them.
@item @sc{mdk} was inspired by Darius Bacon's
-@uref{http://www.accesscom.com/~darius/, MIXAL program}.
+@uref{http://www.accesscom.com/@/~darius/, MIXAL program}.
@end itemize
diff --git a/doc/mdk_bugs.texi b/doc/mdk_bugs.texi
index 4b8ee1c..1b18064 100644
--- a/doc/mdk_bugs.texi
+++ b/doc/mdk_bugs.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_bugs.texi,v 1.5 2003/06/02 23:20:38 jao Exp $
+@c $Id: mdk_bugs.texi,v 1.6 2004/08/03 13:23:06 jao Exp $
@node Problems, Copying, mixguile, Top
@chapter Reporting Bugs
diff --git a/doc/mdk_copying.texi b/doc/mdk_copying.texi
index 1bfca8e..646173d 100644
--- a/doc/mdk_copying.texi
+++ b/doc/mdk_copying.texi
@@ -18,7 +18,7 @@ this manual under the GNU Free Documentation License (GFDL).
@center Version 2, June 1991
@display
-Copyright @copyright{} 1989, 1991, 2003 Free Software Foundation, Inc.
+Copyright @copyright{} 1989, 1991, 2003, 2004 Free Software Foundation, Inc.
675 Mass Ave, Cambridge, MA 02139, USA
Everyone is permitted to copy and distribute verbatim copies
diff --git a/doc/mdk_emacs.texi b/doc/mdk_emacs.texi
index 1fd848a..e0c6973 100644
--- a/doc/mdk_emacs.texi
+++ b/doc/mdk_emacs.texi
@@ -1,6 +1,6 @@
@c -*-texinfo-*-
@c This is part of the GNU MDK Reference Manual.
-@c Copyright (C) 2003
+@c Copyright (C) 2003, 2004
@c Free Software Foundation, Inc.
@c See the file mdk.texi for copying conditions.
diff --git a/doc/mdk_findex.texi b/doc/mdk_findex.texi
index dffb6a3..24a269f 100644
--- a/doc/mdk_findex.texi
+++ b/doc/mdk_findex.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_findex.texi,v 1.2 2003/06/02 23:20:38 jao Exp $
+@c $Id: mdk_findex.texi,v 1.3 2004/08/03 13:23:06 jao Exp $
@node Instructions and commands, , Concept Index, Top
@unnumbered Instructions and commands
diff --git a/doc/mdk_gmixvm.texi b/doc/mdk_gmixvm.texi
index 9bf502b..bddb362 100644
--- a/doc/mdk_gmixvm.texi
+++ b/doc/mdk_gmixvm.texi
@@ -4,7 +4,7 @@
@c Free Software Foundation, Inc.
@c See the file mdk.texi for copying conditions.
-@c $Id: mdk_gmixvm.texi,v 1.17 2004/08/01 23:32:58 jao Exp $
+@c $Id: mdk_gmixvm.texi,v 1.18 2004/08/03 13:23:06 jao Exp $
@node gmixvm, mixguile, mixvm, Top
@comment node-name, next, previous, up
@@ -21,7 +21,7 @@ displaying the status of the virtual machine, the source code of the the
downloaded programs and the contents of the MIX devices.
@menu
-* Invoking @code{gmixvm}:: Invoking the GTK+ interface.
+* Invoking gmixvm::
* MIXVM console:: Using @code{mixvm} commands.
* MIX virtual machine:: The MIX virtual machine window.
* MIXAL source view:: Viewing the MIXAL source code.
@@ -29,7 +29,7 @@ downloaded programs and the contents of the MIX devices.
* Menu and status bars:: Available menu commands.
@end menu
-@node Invoking @code{gmixvm}, MIXVM console, gmixvm, gmixvm
+@node Invoking gmixvm, MIXVM console, gmixvm, gmixvm
@comment node-name, next, previous, up
@section Invoking @code{gmixvm}
@@ -118,7 +118,7 @@ MIX programs (@pxref{Devices}), and a command history file.
The following sections describe the above mentioned components of
@code{gmixvm}.
-@node MIXVM console, MIX virtual machine, Invoking @code{gmixvm}, gmixvm
+@node MIXVM console, MIX virtual machine, Invoking gmixvm, gmixvm
@comment node-name, next, previous, up
@section MIXVM console
diff --git a/doc/mdk_index.texi b/doc/mdk_index.texi
index 04e545f..68f3c48 100644
--- a/doc/mdk_index.texi
+++ b/doc/mdk_index.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_index.texi,v 1.6 2003/06/02 23:20:38 jao Exp $
+@c $Id: mdk_index.texi,v 1.7 2004/08/03 13:23:06 jao Exp $
@node Concept Index, Instructions and commands, Copying, Top
@unnumbered Concept Index
diff --git a/doc/mdk_intro.texi b/doc/mdk_intro.texi
index d695770..b4ce2ad 100644
--- a/doc/mdk_intro.texi
+++ b/doc/mdk_intro.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_intro.texi,v 1.7 2003/06/04 00:03:19 jao Exp $
+@c $Id: mdk_intro.texi,v 1.8 2004/08/03 13:23:06 jao Exp $
@node Introduction, Acknowledgments, Top, Top
@comment node-name, next, previous, up
diff --git a/doc/mdk_mixasm.texi b/doc/mdk_mixasm.texi
index 4a956c1..c76480f 100644
--- a/doc/mdk_mixasm.texi
+++ b/doc/mdk_mixasm.texi
@@ -4,7 +4,7 @@
@c Free Software Foundation, Inc.
@c See the file mdk.texi for copying conditions.
-@c $Id: mdk_mixasm.texi,v 1.8 2004/08/01 21:43:29 jao Exp $
+@c $Id: mdk_mixasm.texi,v 1.9 2004/08/03 13:23:06 jao Exp $
@node mixasm, mixvm, Emacs tools, Top
@comment node-name, next, previous, up
@@ -22,10 +22,10 @@ form by @code{mixasm}, the MIXAL assembler included in @sc{mdk}. In this
chapter, you will find a complete description of @code{mixasm} options.
@menu
-* Invoking @code{mixasm}:: @code{mixasm} options
+* Invoking mixasm::
@end menu
-@node Invoking @code{mixasm}, , mixasm, mixasm
+@node Invoking mixasm, , mixasm, mixasm
@comment node-name, next, previous, up
@section Invoking @code{mixasm}
diff --git a/doc/mdk_mixguile.texi b/doc/mdk_mixguile.texi
index c91e1f2..2d6ac65 100644
--- a/doc/mdk_mixguile.texi
+++ b/doc/mdk_mixguile.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_mixguile.texi,v 1.4 2003/01/11 22:39:40 jao Exp $
+@c $Id: mdk_mixguile.texi,v 1.5 2004/08/03 13:23:06 jao Exp $
@node mixguile, Problems, gmixvm, Top
@chapter @code{mixguile}, the Scheme virtual machine
diff --git a/doc/mdk_mixvm.texi b/doc/mdk_mixvm.texi
index ff7f567..427d100 100644
--- a/doc/mdk_mixvm.texi
+++ b/doc/mdk_mixvm.texi
@@ -4,7 +4,7 @@
@c Free Software Foundation, Inc.
@c See the file mdk.texi for copying conditions.
-@c $Id: mdk_mixvm.texi,v 1.18 2004/08/01 21:43:29 jao Exp $
+@c $Id: mdk_mixvm.texi,v 1.19 2004/08/03 13:23:06 jao Exp $
@node mixvm, gmixvm, mixasm, Top
@comment node-name, next, previous, up
@@ -23,7 +23,7 @@ setting to aid you in debugging your code. For a tutorial description of
@code{mixvm} usage, @xref{Running the program}.
@menu
-* Invocation:: Options when invoking @code{mixvm}.
+* Invocation::
* Commands:: Commands available in interactive mode.
* Devices:: MIX block devices implementation.
@end menu