Merge pull request #396 from kiwisincebirth/doc_folder

Moved Documentation into Doc/CPM folder

Doc/CPM/ReadMe.txt

@@ -0,0 +1,67 @@
+***********************************************************************
+***                                                                 ***
+***                          R o m W B W                            ***
+***                                                                 ***
+***                    Z80/Z180 System Software                     ***
+***                                                                 ***
+***********************************************************************
+
+This directory ("Doc/CPM") is part of the RomWBW System Software
+distribution archive.  It contains documentation for the CP/M
+operating system components of the system.
+
+
+CPM Manual ("CPM Manual.pdf")
+-----------------------------
+
+The original DRI CP/M 2.x Operating System Manual.  This should be
+considered the primary reference for system operation.  The section
+on CP/M 2 Alteration can be ignored since this work has already been
+completed as part of the RomWBW distribution.
+
+
+CPM3 Command Summary ("CPM3 Command Summary.pdf")
+CPM3 Programmer's Guide ("CPM3 Programmers Guide.pdf")
+CPM3 System Guide ("CPM3 System Guide.pdf")
+CPM3 User's Guide ("CPM3 Users Guide.pdf")
+------------------------------------------------------
+
+The original DRI CP/M 3.0 Operating System Documentation Set.  This
+should be considered the primary reference for CP/M 3 system operation.
+
+
+NZCOM User's Manual ("NZCOM Users Manual.pdf")
+----------------------------------------------
+
+NZCOM operating system operation manual.
+
+
+QP/M 2.7 Installation Guide and Supplements ("qpm27.pdf")
+QP/M 2.7 Interface Guide ("qdos27.pdf")
+QP/M 2.7 Features and Facilities ("qcp27.pdf")
+--------------------------------------------
+
+Official documentation set for QP/M 2.7 from original QP/M distribution.
+
+
+ZCPR Manual ("ZCPR Manual.pdf")
+-------------------------------
+
+ZCPR is the command proccessor portion of Z-System.  This is the
+manual for ZCPR 1.x as included in RomWBW.  The installation
+instructions can be ignored since that work has already been
+completed as part of the RomWBW distribution.
+
+ZCPR D&J Manual ("ZCPR-DJ.doc")
+-------------------------------
+
+ZCPR D&J User Manual.  This manual supplements the ZCPR Manual.
+
+
+ZSDOS Manual ("ZSDOS Manual.pdf")
+---------------------------------
+
+ZSDOS is the DOS portion of Z-System.  This is the manual for ZSDOS
+1.x as included in RomWBW.  The installation instructions can be
+ignored since that work has already been completed as part of the
+RomWBW distribution.

Doc/Contrib/ZSystem.txt

@@ -4,7 +4,7 @@ ZSDOS Adaptation Notes for RomWBW
 Wayne Warthen
 wwarthen@gmail.com
 
-This file is a log of the work done to adapt the ZSDOS distribution to the N8VEM platforms under RomWBW.  I strongly recommend reviewing the zsdos.pdf file in the Doc directory.
+This file is a log of the work done to adapt the ZSDOS distribution to the N8VEM platforms under RomWBW.  I strongly recommend reviewing the zsdos.pdf file in the Doc/CPM directory.
 
 The starting point was the general public release of ZSDOS that is generally available.  The first line of the README file is "ZSDOS-GP.  General Public Release of the ZSDOS 1.x Operating System."
 
@@ -52,4 +52,4 @@ Usage Notes
 
 6. After using PUTDS to initialize a directory for ZDS date stamping, I am finding that it is necessary to run RELOG before the stamping routines will actually start working.
 
-7. Generic CP/M PIP and ZSDOS path searching do not play well together if you use PIP to copy to or from a directory in the ZSDOS search path.  Best to use COPY from the ZSDOS distribution.
+7. Generic CP/M PIP and ZSDOS path searching do not play well together if you use PIP to copy to or from a directory in the ZSDOS search path.  Best to use COPY from the ZSDOS distribution.

Doc/Language/ReadMe.txt

@@ -0,0 +1,62 @@
+***********************************************************************
+***                                                                 ***
+***                          R o m W B W                            ***
+***                                                                 ***
+***                    Z80/Z180 System Software                     ***
+***                                                                 ***
+***********************************************************************
+
+This directory ("Doc/Language") is part of the RomWBW System Software
+distribution archive.  It contains documentation for Programming
+Languages provided with the system.
+
+
+Aztec C Compiler User Manual (Aztec_C_1.06_User_Manual_Mar84.pdf)
+-----------------------------------------------------------------
+
+Official user manual for the Aztec C Compiler included in the aztecc disk image.
+
+
+Borland TurboPascal User Manual (Turbo_Pascal_Version_3.0_Reference_Manual_1986.pdf)
+------------------------------------------------------------------------------------
+
+Official user manual Borland TurboPascal included in the pascal disk image.
+
+
+Cowgol Lanaguage (Cowgol Language.pdf)
+--------------------------------------
+
+Documentation for Cowgol Language included in the cowgol disk image
+
+
+HI-TECH C Compiler User Manual (HI-TECH Z80 C Compiler Manual.txt)
+------------------------------------------------------------------
+
+Official user manual for the HI-TECH C Compiler included in the
+hitechc disk image.
+
+
+Microsoft Basic-80 Reference Manual v5.0 (Microsoft Basic-80 Reference Manual v5.0.pdf)
+---------------------------------------------------------------------------------------
+
+Official manual for Microsoft BASIC as included in RomWBW.
+
+
+Microsoft FORTRAN-80 User Manual (Microsoft_FORTRAN-80_Users_Manual_1977.pdf)
+-----------------------------------------------------------------------------
+
+Official user manual for Microsoft's FORTRAN-80 compiler included in the fortran
+disk image.
+
+
+Z80 Assembler User Manual (z80asm (SLR Systems).pdf)
+----------------------------------------------------
+
+Official user manual for the Z80 Macro Assembler by SLR Systems
+included in the z80asm disk image.
+
+
+
+
+
+

Doc/ReadMe.txt

@@ -10,6 +10,18 @@ This directory ("Doc") is part of the RomWBW System Software
 distribution archive.  It contains documentation for components of
 the system.
 
+CPM (Directory)
+---------------
+
+Documentation specific to CP/M, including all versions and derivatives.
+
+
+Language (Directory)
+--------------------
+
+Documentation specific to programming languages, provided with the system
+
+
 ChangeLog.txt
 -------------
 
@@ -31,25 +43,6 @@ and utilities are detailed in the  Applications and
 ROM Applications documents.
 
 
-CPM Manual ("CPM Manual.pdf")
------------------------------
-
-The original DRI CP/M 2.x Operating System Manual.  This should be
-considered the primary reference for system operation.  The section
-on CP/M 2 Alteration can be ignored since this work has already been
-completed as part of the RomWBW distribution.
-
-
-CPM3 Command Summary ("CPM3 Command Summary.pdf")
-CPM3 Programmer's Guide ("CPM3 Programmers Guide.pdf")
-CPM3 System Guide ("CPM3 System Guide.pdf")
-CPM3 User's Guide ("CPM3 Users Guide.pdf")
-------------------------------------------------------
-
-The original DRI CP/M 3.0 Operating System Documentation Set.  This
-should be considered the primary reference for CP/M 3 system operation.
-
-
 DDTZ Manual ("DDTZ.doc")
 ------------------------
 
@@ -69,47 +62,6 @@ Hard Disk Anatomy ("Hard Disk Anatomy.pdf")
 Diagram of a CP/M & MS-DOS (FAT) hybrid hard disk layout.
 
 
-NZCOM User's Manual ("NZCOM Users Manual.pdf")
-----------------------------------------------
-
-NZCOM operating system operation manual.
-
-
-ZCPR Manual ("ZCPR Manual.pdf")
--------------------------------
-
-ZCPR is the command proccessor portion of Z-System.  This is the
-manual for ZCPR 1.x as included in RomWBW.  The installation
-instructions can be ignored since that work has already been
-completed as part of the RomWBW distribution.
-
-ZCPR D&J Manual ("ZCPR-DJ.doc")
--------------------------------
-
-ZCPR D&J User Manual.  This manual supplements the ZCPR Manual.
-
-
-ZSDOS Manual ("ZSDOS Manual.pdf")
----------------------------------
-
-ZSDOS is the DOS portion of Z-System.  This is the manual for ZSDOS
-1.x as included in RomWBW.  The installation instructions can be
-ignored since that work has already been completed as part of the
-RomWBW distribution.
-
-Microsoft Basic-80 Reference Manual v5.0 (Microsoft Basic-80 Reference Manual v5.0.pdf)
----------------------------------------------------------------------------------------
-
-Official manual for Microsoft BASIC as included in RomWBW.
-
-
-QP/M 2.7 Installation Guide and Supplements ("qpm27.pdf")
-QP/M 2.7 Interface Guide ("qdos27.pdf")
-QP/M 2.7 Features and Facilities ("qcp27.pdf")
---------------------------------------------
-
-Official documentation set for QP/M 2.7 from original QP/M distribution.
-
 SIO+CTC Baud Rate Options (SIO+CTC Baud Rate Options.pdf)
 ---------------------------------------------------------
 
@@ -132,37 +84,4 @@ UCSD p-System Users Manual ("UCSD p-System Users Manual.pdf")
 Official user manual for p-System operating system included with
 RomWBW.
 
-
-Z80 Assembler User Manual (z80asm (SLR Systems).pdf)
-----------------------------------------------------
-
-Official user manual for the Z80 Macro Assembler by SLR Systems
-included in the z80asm disk image.
-
-
-HI-TECH C Compiler User Manual (HI-TECH Z80 C Compiler Manual.txt)
-------------------------------------------------------------------
-
-Official user manual for the HI-TECH C Compiler included in the
-hitechc disk image.
-
-
-Borland TurboPascal User Manual (Turbo_Pascal_Version_3.0_Reference_Manual_1986.pdf)
-------------------------------------------------------------------------------------
-
-Official user manual Borland TurboPascal included in the pascal disk image.
-
-
-Aztec C Compiler User Manual (Aztec_C_1.06_User_Manual_Mar84.pdf)
------------------------------------------------------------------
-
-Official user manual for the Aztec C Compiler included in the aztecc disk image.
-
-
-FORTRAN-80 User Manual (Microsoft_FORTRAN-80_Users_Manual_1977.pdf)
----------------------------------------------------------------
-
-Official user manual for Microsoft's FORTRAN-80 compiler included in the fortran
-disk image.
-
---WBW 5:18 PM 6/14/2023
+--WBW 5:18 PM 6/14/2023

Source/Doc/UserGuide.md

@@ -2241,7 +2241,7 @@ less likely to encounter compatibility issues.
 
 #### Documentation
 
-* [CPM Manual]($doc_root$/CPM Manual.pdf)
+* [CPM Manual]($doc_root$/CPM/CPM Manual.pdf)
 
 #### Boot Disk
 
@@ -2287,9 +2287,9 @@ via the NZ-COM adaptation (see below).
 
 #### Documentation
 
-* [ZCPR Manual]($doc_root$/ZCPR Manual.pdf)
-* [ZCPR-DJ]($doc_root$/ZCPR-DJ.doc)
-* [ZSDOS Manual]($doc_root$/ZSDOS Manual.pdf)
+* [ZCPR Manual]($doc_root$/CPM/ZCPR Manual.pdf)
+* [ZCPR-DJ]($doc_root$/CPM/ZCPR-DJ.doc)
+* [ZSDOS Manual]($doc_root$/CPM/ZSDOS Manual.pdf)
 
 #### Boot Disk
 
@@ -2376,7 +2376,7 @@ Manual.pdf" document in order to use this operating system effectively.
 
 #### Documentation
 
-* [NZCOM Users Manual]($doc_root$/NZCOM Users Manual.pdf)
+* [NZCOM Users Manual]($doc_root$/CPM/NZCOM Users Manual.pdf)
 
 #### Boot Disk
 
@@ -2401,10 +2401,10 @@ has a new suite of support tools and help system.
 
 #### Documentation
 
-* [CPM3 Users Guide]($doc_root$/CPM3 Users Guide.pdf)
-* [CPM3 Command Summary]($doc_root$/CPM3 Command Summary.pdf)
-* [CPM3 Programmers Guide]($doc_root$/CPM3 Programmers Guide.pdf)
-* [CPM3 System Guide]($doc_root$/CPM3 System Guide.pdf)
+* [CPM3 Users Guide]($doc_root$/CPM/CPM3 Users Guide.pdf)
+* [CPM3 Command Summary]($doc_root$/CPM/CPM3 Command Summary.pdf)
+* [CPM3 Programmers Guide]($doc_root$/CPM/CPM3 Programmers Guide.pdf)
+* [CPM3 System Guide]($doc_root$/CPM/CPM3 System Guide.pdf)
 
 #### Boot Disk
 
@@ -2553,9 +2553,9 @@ regarding the RomWBW adaptation and customizations.
 
 #### Documentation
 
-* [QP/M 2.7 Installation Guide and Supplements]($doc_root$/qpm27.pdf)
-* [QP/M 2.7 Interface Guide]($doc_root$/qdos27.pdf)
-* [QP/M 2.7 Features and Facilities]($doc_root$/qcp27.pdf)
+* [QP/M 2.7 Installation Guide and Supplements]($doc_root$/CPM/qpm27.pdf)
+* [QP/M 2.7 Interface Guide]($doc_root$/CPM/qdos27.pdf)
+* [QP/M 2.7 Features and Facilities]($doc_root$/CPM/qcp27.pdf)
 
 #### Boot Disk
 

Source/Images/d_aztecc/Readme.txt

@@ -7,7 +7,7 @@ for MS-DOS or Windows XP is also available.
 
 For full documentation, see https://www.aztecmuseum.ca/
 
-The user manual is available in the Doc directory
+The user manual is available in the Doc/Language directory
 Aztec_C_1.06_User_Manual_Mar84.pdf
 
 == License ==

Source/Images/d_cowgol/Readme.txt

@@ -10,6 +10,9 @@ is tailored to RomWBW memory management.
 The primary distribution site for Cowgol 2.0 is at
 https://github.com/davidgiven/cowgol.
 
+The user manual is available in the Doc/Language directory
+Cowgol Language.pdf
+
 The Hi-Tech C compiler components were sourced from the updated
 version by Tony Nicholson at https://github.com/agn453/HI-TECH-Z80-C.
 However, the CPP.COM component was sourced from Ladislau Szilagyi's

Source/Images/d_cpm22/ReadMe.txt

@@ -42,7 +42,7 @@ RomWBW Distribution.
 
 The following CP/M 2.2 files were distributed by DRI with the operating
 system or as supplemental add-on programs.  They are documented in the
-"CP/M Manual.pdf" document in the Doc directory of the Rom WBW
+"CP/M Manual.pdf" document in the Doc/CPM directory of the Rom WBW
 distribution.  MAC, RMAC, ZSID are supplemental programs from DRI
 with separate standalone documentation which is not included in the
 RomWBW package (but easily found on the Internet via Google search).
@@ -165,4 +165,4 @@ in this user area for more information.
 N.B., at a minimum, some of the files in this user area must be copied
 to user area 0 for CP/NET to work properly.
 
--- WBW 3:20 PM 8/27/2021
+-- WBW 3:20 PM 8/27/2021

Source/Images/d_fortran/Readme.txt

@@ -6,5 +6,5 @@ programming language. It was one of their early core languages developed for the
 rebranded the product as Microsoft Fortran Powerstation. (Note: -80 refers to
 the 8080/Z80 platform, not the language specification version)
 
-The user manual is available in the Doc directory,
+The user manual is available in the Doc/Language directory,
 Microsoft_FORTRAN-80_Users_Manual_1977.pdf

Source/Images/d_hitechc/Readme.txt

@@ -10,7 +10,7 @@ without an operating system.
 This is the Mar 21, 2023 update 17 released by Tony Nicholson who currently
 maintains HI-TECH C at https://github.com/agn453/HI-TECH-Z80-C
 
-The manual is available in the Docs directory,
+The manual is available in the Doc/Language directory,
 HI-TECH Z80 C Compiler Manual.txt
 
 A good blog post about the HI-TECH C Compiler is available at
@@ -23,4 +23,4 @@ use, private or commercial, strictly as-is. No warranty or product
 support is offered or implied.
 
 You may use this software for whatever you like, providing you acknowledge
-that the copyright to this software remains with HI-TECH Software.
+that the copyright to this software remains with HI-TECH Software.

Source/Images/d_nzcom/ReadMe.txt

@@ -16,7 +16,7 @@ User Guide.pdf" document found in the Doc directory of the
 RomWBW Distribution.
 
 The primary documentation for NZ-COM is the "NZCOM Users Manual.pdf"
-document  contained in the Doc directory of the RomWBW distribution.
+document  contained in the Doc/CPM directory of the RomWBW distribution.
 This document is a supplement to the primary documentation.  Additionally,
 please review the file called RELEASE.NOT on this disk which contains
 a variety of updates regarding the NZ-COM distribuition.
@@ -77,7 +77,7 @@ The following additional customizations were also performed:
 
 The following files came from the official NZCOM distribution.  These
 are generally documented in the "NZCOM Users Manual.pdf" document in
-the Doc directory of the RomWBW distribution.  Note that some of the
+the Doc/CPM directory of the RomWBW distribution.  Note that some of the
 files included in the NZ-COM distribution are not listed below because
 they have been superseded by more recent versions listed in other
 sections below.  For example, TCSELECT is not listed here, but a more
@@ -164,7 +164,7 @@ The following files have been included from CP/M 2.2.  These files
 provide various functionality that is not really available from the
 ZSDOS applications themselves.  For example, the CP/M 2.2 application
 called STAT is useful for modifying the IOBYTE.  Most of these
-applications are documented in the "CPM Manual.pdf" document in the Doc
+applications are documented in the "CPM Manual.pdf" document in the Doc/CPM
 directory of the RomWBW distribution.
 
 ASM.COM - DRI 8080 assembler producing Intel hex files
@@ -180,7 +180,7 @@ XSUB.COM - DRI batch file enhancer resident system extension
 == ZSDOS Files ==
 
 The following files came from the official ZSDOS distribution.  These
-are generally documented in the "ZSDOS Manual.pdf" document in the Doc
+are generally documented in the "ZSDOS Manual.pdf" document in the Doc CPM
 directory of the RomWBW distribution.  These files are relevant under
 NZ-COM because ZSDOS is a part of the NZ-COM system.
 
@@ -320,4 +320,4 @@ in this user area for more information.
 N.B., at a minimum, some of the files in this user area must be copied
 to user area 0 for CP/NET to work properly.
 
--- WBW 11:19 AM 1/22/2024
+-- WBW 11:19 AM 1/22/2024

Source/Images/d_qpm/ReadMe.txt

@@ -36,12 +36,12 @@ code brakpoints.  This conflicts the use of that vector for any
 system that is using interrupt mode 1.  DEBUGZ can be configured
 (using DBGINST) to use a different vector.
 
-The QSTAMP program, which is used to initialize a disk for date/time 
-stamping, misbehavews when run on the (new) RomWBW 1024 directory 
-format disks.  It creates an invalid directory entry for the date/time 
-stamp data file.  This is definitely a QP/M issue.  The directory entry 
-can be manually corrected.  Specifically the byte offset 15 should 
-contain the number of 128-byte records in the file.  Instead, it is set 
+The QSTAMP program, which is used to initialize a disk for date/time
+stamping, misbehavews when run on the (new) RomWBW 1024 directory
+format disks.  It creates an invalid directory entry for the date/time
+stamp data file.  This is definitely a QP/M issue.  The directory entry
+can be manually corrected.  Specifically the byte offset 15 should
+contain the number of 128-byte records in the file.  Instead, it is set
 to 0x01.  You can edit the entry, change it to 0x80 and everything
 starts working.
 
@@ -92,7 +92,7 @@ The following files have been included from CP/M 2.2.  These files
 provide various functionality that is not really available from the
 ZSDOS applications themselves.  For example, the CP/M 2.2 application
 called STAT is useful for modifying the IOBYTE.  Most of these
-applications are documented in the "CPM Manual.pdf" document in the Doc
+applications are documented in the "CPM Manual.pdf" document in the Doc/CPM
 directory of the RomWBW distribution.
 
 ASM.COM - DRI 8080 assembler producing Intel hex files

Source/Images/d_tpascal/Readme.txt

@@ -8,7 +8,7 @@ and mathematician.
 Turbo Pascal closely follows the definition of Standard Pascal as defined in
 the Pascal User Manual and Report with a few minor differences.
 
-The manual can be found in the Docs directory,
+The manual can be found in the Docs/Language directory,
 Turbo_Pascal_Version_3.0_Reference_Manual_1986.pdf
 
 A good overview of using Turbo Pascal in CP/M is available at

Source/Images/d_z80asm/Readme.txt

@@ -8,7 +8,7 @@ listing output may be sent to a disk file, the console and/or the printer, in
 any combination. Output files may also be generated containing cross-reference
 information on each symbol used.
 
-The manual is available in the Doc directory,
+The manual is available in the Doc/Language directory,
 z80asm (SLR Systems).pdf
 
 A run through of using the assembler is available at

Source/Images/d_zsdos/ReadMe.txt

@@ -15,7 +15,7 @@ ZSDOS is a replacement for the BDOS portion of the CP/M 2.2 operating
 system.  Since it does not include it's own command processor, the
 the ZCPR D&J Command Processor has been included.
 
-The primary documentation for ZSDOS and ZCPR 1 are contained in the Doc
+The primary documentation for ZSDOS and ZCPR 1 are contained in the Doc/CPM
 directory of the RomWBW distribution.  The specific files are "ZSDOS
 Manual.pdf", "ZCPR Manual.pdf", and "ZCPR-DJ.doc".  This document is a
 supplement to the primary documentation.
@@ -141,7 +141,7 @@ distribution as possible.
 == ZSDOS 1.1 Files ==
 
 The following files came from the official ZSDOS distribution.  These
-are generally documented in the "ZSDOS Manual.pdf" document in the Doc
+are generally documented in the "ZSDOS Manual.pdf" document in the Doc/CPM
 directory of the RomWBW distribution.  Note that some of the files
 included in the ZSDOS distribution are not listed below because they
 have been superseded by more recent versions listed in other sections
@@ -192,7 +192,7 @@ The following files have been included from CP/M 2.2.  These files
 provide various functionality that is not really available from the
 ZSDOS applications themselves.  For example, the CP/M 2.2 application
 called STAT is useful for modifying the IOBYTE.  Most of these
-applications are documented in the "CPM Manual.pdf" document in the Doc
+applications are documented in the "CPM Manual.pdf" document in the Doc/CPM
 directory of the RomWBW distribution.
 
 ASM.COM - DRI 8080 assembler producing Intel hex files
@@ -304,4 +304,4 @@ in this user area for more information.
 N.B., at a minimum, some of the files in this user area must be copied
 to user area 0 for CP/NET to work properly.
 
--- WBW 3:20 PM 8/27/2021
+-- WBW 3:20 PM 8/27/2021