changeset 152:6c48191bd06a

Refentries for CoCo OS-9 commands
author boisy
date Sun, 07 Jul 2002 18:44:28 +0000
parents 845e890728df
children f4af2c0b842c
files docs/nitros9guide/config.refentry docs/nitros9guide/help.refentry docs/nitros9guide/iniz.refentry docs/nitros9guide/tuneport.refentry
diffstat 4 files changed, 415 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/config.refentry	Sun Jul 07 18:44:28 2002 +0000
@@ -0,0 +1,213 @@
+<refentry id="config">
+<refnamediv>
+<refname>CONFIG</refname>
+<refpurpose>Configures an OS-9 system diskette</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>CONFIG</command>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>
+CONFIG provides menus of all I/O options and all system commands.  You select
+the device drivers and commands you want to include on a new system diskette
+from these menus.  Selecting only the device drivers and commands you and
+your system require lets you make the most efficient use of computer
+memory and system diskette storage.
+</para>
+<para>
+The CONFIG utility is on a separate CONFIG/BOOT Diskette.  Make a copy of this
+diskette using the OS-9 BACKUP command and use the copy as your working
+diskette.  Keep the original CONFIG/BOOT Diskette in a safe place to use
+for future backups.  You can use the CONFIG/BOOT Diskette for booting OS-9
+from Color Disk BASIC from Drive /D0.
+</para>
+<para>
+CONFIG requires no initial parameters.  You establish parameters during the
+operation of CONFIG.  Be sure that the execution directory is at /D0/CMDS
+before executing the command.
+</para>
+<para>
+Examples:
+</para>
+<screen>
+	CONFIG [ENTER]
+</screen>
+<para>
+CONFIG executes and a prompt asks you to indicate whether you wish to use
+one or two disk drives.  Press [1] for single- or [2] for two-drive
+operation.
+</para>
+<para>
+Next, CONFIG builds a list of the various devices from the MODULES directory.
+When the list is complete, a screen menu appears.  Use the up and down arrow
+keys to move to a device.  Then, press [S] to either select or exclude a
+particular device.  Press [S] once to display an X to the right of the
+selected device.  Press [S] again to erase the X.  The device is selected
+only when the "X" appears.  Information about each device is available with
+a special help command.  To display the information on the current device
+(the device indicated by the right arrow [->]), press [H].
+</para>
+<para>
+If there are more than ten devices in a CONFIG menu, use [->] to move ahead
+page-by-page and [<-] to move back.
+</para>
+<para>
+The devices you can select are:
+</para>
+<para>
+	term32	The computer keyboard and standard TV display
+	term80	The computer keyboard and optional 80 column video display
+	d0	Disk Drive 0
+	d1	Disk Drive 1
+	d2	Disk Drive 2
+	d3	Disk Drive 3
+	h0_15	A 15 meg hard disk drive 0
+	h1_15	A 15 meg hard disk drive 1
+	h0_35	A 35 meg hard disk drive 0
+	h1_35	A 35 meg hard disk drive 1
+	p	A printer using the RS-232 serial port
+	t1	A terminal port using the standard RS-232 port
+	t2	A terminal port using the optional RS-232 communications pak
+	t3	A terminal port using the optional RS-232 communications pak
+	m1	A modem
+	m2	A modem
+	ssc	Speech/Sound Cartridge
+</para>
+<para>
+To use your computer keyboard and video display, you must select one term.
+You must select d0 as your first disk drive.  Select d1, d2, and d3 for
+additional floppy disk drives.  Select /p to use a printer with OS-9,
+select ssc to use a Speech/Sound Cartridge from a Multi-Pak slot, and
+so forth.
+</para>
+<para>
+After selecting the devices you desire, press [D].  The screen displays,
+ARE YOU SURE (Y/N) ?  If you are satisfied with your selections, press [Y].
+If you wish to make further changes, press [N].
+</para>
+<para>
+When the driver selection is complete, a screen prompt requests that you
+select among the Color Computer terminal I/O subroutines.  Select these
+subroutines in the same manner that you selected the device drivers.
+You have the following modules from which to make your selections:
+</para>
+<para>
+	CO32	A video output module for a 32 column TV display
+	CO80	A video output module for a 80 column video display
+	GRFO	A graphics module for TV display
+</para>
+<para>
+When choosing subroutine modules, you must select the video output module
+that matches the terminal module you previously selected for your console
+device.
+</para>
+<para>
+CONFIG builds a boot list from the selected devices and their associated
+drivers and managers.  "Bootlist" is created in the ROOT directory of
+Drive 0.  CONFIG next displays two clock options:
+</para>
+<para>
+	1 - 60Hz (American)
+	2 - 50Hz (European)
+</para>
+<para>
+If you live in the United States, Canada, or other country with 60Hz
+electrical power, press [1].  If you live in a country with 50Hz power,
+press [2].
+</para>
+<para>
+If you have a single disk drive, a screen prompt asks you to swap diskettes
+and press [C].  When asked to isnert the SOURCE diskette, insert the
+CONFIG/BOOT Diskette.  When asked to insert the DESTINATION diskette, insert
+the diskette on which you wish to create the new OS-9 System.
+</para>
+<para>
+If you have more than one drive, a screen prompt asks you to insert a blank
+formatted diskette (the DESTINATION diskette) in /D1.  The rest of the boot
+file creation is automatic.
+</para>
+<para>
+Following the boot file generation, a menu lets you select the commands you
+wish to include on your system diskette.  You have the following choices:
+</para>
+<para>
+	[N]o Commands, Stop Now - Do not add any commands
+	[B]asic Command Set - Adds the basic OS-9 commands
+	[F]ull COmmand Set - Add all OS-9 commands
+	[I]ndividually Select - Select desired commands one by one
+	[?] Receive Help - Get help on the command set
+</para>
+<para>
+Press [N] if you want to create a boot file, but do not wish to add any
+commands to the new system diskette.  Use this option to create a new boot
+file on a diskette on which you have prefviously copied the OS-9 system.
+If you have only one disk drive, this procedure is quicker than using
+the CONFIG utility to complete the entire system transfer, as less
+diskette swaps are required.
+</para>
+<para>
+Press [B] if you wish to add a basic command set (the most commonly used
+commands) to your new diskette.  This selection does not copy the following:
+</para>
+<para>
+	1. Assembly language development tools, asm, debug, and edit and the
+	DEFS directory
+
+	2. Timesharing utilities, tsmon, login, and the SYS/motd and
+	SYS/password files
+
+	3. The system maintenance utilites, such as dsave, dcheck, and cobbler
+</para>
+<para>
+Press [F] to copy all of the commands (an exact copy of the standard OS-9
+system diskette, with a new boot file).
+</para>
+<para>
+Press [I] to individually select commands to copy on the new diskette.  This
+option displays a selection similar to the device selection screen.  Again,
+press [S] to select or exclude commands, and use the arrow keys to move
+among the commands in the menu.  Commands marked with an X are selected.  If
+a command does not have an X beside it, it is excluded on the new system
+diskette.
+</para>
+<para>
+If you have a multi-drive system, a prompt appears asking you to insert your
+OS-9 system diskette in /D0.  Press the spacebar.  The process finishes the
+CONFIG operation and returns to OS-9.
+</para>
+<para>
+If you have a single-drive system, you swawp diskettes during the final
+process.  This time, the SOURCE diskette is the OS-9 System Diskette,
+instead of the CONFIG/BOOT Diskette.  The DESTINATION diskette is the new
+system diskette you are creating.  The number of swaps in this procedure, as
+well as in the boot file creation procedure, depends on the number of options
+you select.
+</para>
+<para>
+It would be quicker and easier to use BACKUP to create a system disk, use
+CONFIG to create a new bootfile, then delete unwanted commands.  However,
+this process causes fragmentation of diskette space.  Fragmentation results
+in slower diskette access, and free memory is broken into segments that
+might not be large enough for some OS-9 operations.  CONFIG causes no
+fragmentation.
+</para>
+<para>
+The MODULES directory of the CONFIG/BOOT diskette contains all the device
+drivers and descriptors supported by OS-9.  The filename extension
+describes the type of file, as noted in the following table:
+</para>
+<para>
+	Extension 	Module Type
+	.dd		Device Descriptor module
+	.dr		Device Driver module
+	.io		Input/Output subroutine module
+	.hp		Help file
+</para>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/help.refentry	Sun Jul 07 18:44:28 2002 +0000
@@ -0,0 +1,99 @@
+<refentry id="help">
+<refnamediv>
+<refname>HELP</refname>
+<refpurpose>Displays the usage and syntax of OS-9 commands.</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>TUNEPORT</command>
+<arg choice="opt">
+  <option>command - the command for which you want syntax help.  Include
+as many command names in one HELP line as you wish.  The proper form and
+syntax appears for each valid command you include.
+</option>
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Notes</title>
+
+<para>
+To use HELP, first copy Cmds.hp from the SYS directory of the CONFIG/BOOT
+Diskette to the SYS directory of your system diskette.  Next, copy HELP
+from the CMDS directory of the CONFIG/BOOT Diskette to the CMDS directory
+of your system diskette as follows:
+</para>
+<para>
+Procedure for one disk drive:
+</para>
+<para>
+1. With OS-9 booted and the system diskette in your drive, type:
+</para>
+<screen>
+	LOAD COPY [ENTER]
+</screen>
+<para>
+2. Replace the system diskete with the CONFIG/BOOT Diskette and type:
+</para>
+<screen>
+	COPY /D0/SYS/CMDS.HP /D0/SYS/CMDS.HP -S #30K [ENTER]
+</screen>
+<para>
+3. Exchange the two diskettes as requested by the screen prompts until the
+process is complete.
+</para>
+<para>
+4. Again, place the CONFIG/BOOT DIskette int he drive, and type:
+</para>
+<screen>
+	COPY /D0/CMDS/help /D0/CMDS/help -S #30K [ENTER]
+</screen>
+<para>
+5. Swap diskettes as requested until the process is complete.
+</para>
+<para>
+Procedure for two disk drives
+</para>
+<para>
+1. With OS-9 booted, place the CONFIG/BOOT Diskette in Drive 1.  Be sure
+the system diskette is in Drive 0.
+</para>
+<para>
+2. Type:
+</para>
+<screen>
+	COPY /D1/SYS/CMDS.HP /D0/SYS/CMDS.HP [ENTER]
+</screen>
+<para>
+3. When the first copy is complete, type:
+</para>
+<screen>
+	COPY /D1/CMDS/help /D0/CMDS/help [ENTER]
+</screen>
+<para>
+Cmds.hp is a data file, not a text file, and you cannot successfully display
+it on your screen or edit it with a standard text editor.  It contains help
+for standard OS-9 commands.
+</para>
+<para>
+HELP displays the form and syntax of the specified command.  If you use a
+non-standard command name, a screen display tells you that help is not
+available for that command.
+</para>
+<para>
+Examples:
+</para>
+<screen>
+	HELP BACKUP [ENTER]
+	BACUKP [e][s][-v][dev][dev]
+	Copies all data from one device to another
+
+	HELP ME [ENTER]
+	ME Help not available
+
+	HELP [ENTER]
+	HELP [command name][...]
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/iniz.refentry	Sun Jul 07 18:44:28 2002 +0000
@@ -0,0 +1,51 @@
+<refentry id="iniz">
+<refnamediv>
+<refname>INIZ</refname>
+<refpurpose>Initialize a device.</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>INIZ</command>
+<arg choice="opt">
+  <option>devicename [...]</option>
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>
+Links the specified device to OS-9, places the device addres in a new device
+table entry, allocates the memory needed by the device driver, and calls
+the device driver initialization routine.  If the device is already
+installed, INIZ does not reinitialize it.
+</para>
+<para>
+Options:
+</para>
+<para>
+	devicename	is the name of the device drivere you want to
+			initialize.  Specify as many device drivers as you
+			wish with one INIZ command.
+</para>
+<para>
+Notes:
+</para>
+<para>
+You can use Iniz in the startup file or at the system startup to initialize
+devices and allocate their static storage at the top of memory (to reduce
+memory fragmentation).
+</para>
+<para>
+Example:
+</para>
+<screen>
+	INIZ P T2 [ENTER]
+</screen>
+<para>
+initializes the P (printer) and T2 (terminal 2) devices.
+</para>
+</refsect1>
+</refentry>
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/nitros9guide/tuneport.refentry	Sun Jul 07 18:44:28 2002 +0000
@@ -0,0 +1,52 @@
+<refentry id="tuneport">
+<refnamediv>
+<refname>TUNEPORT</refname>
+<refpurpose>Tune the printer port on the Color Computer</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<cmdsynopsis>
+<command>TUNEPORT</command>
+<arg choice="opt">
+  <option>-s=value</option>
+</arg>
+</cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>
+This command lets you test and set delay loop values for the current baud
+rate and select the best value for your printer (/P) or terminal (/T1).
+</para>
+<para>
+Examples
+</para>
+<screen>
+	TUNEPORT /P [ENTER]
+</screen>
+<para>
+Provides a text operation for your printer.  After a short delay, TUNEPORT
+displays the current baud rate and sends data to the printer to test if it
+is working properly.  The program then displays the current delay value and
+asks for a new value.  Enter a decimal delay value and press [ENTER].  Again,
+test data is sent to the printer as a test.  Continue this process until you
+find the best value.  When you are satisfied, press [ENTER] instead of
+entering a value at the prompt.  A closing message displays your new value.
+</para>
+<para>
+Use the same process to set a new delay loop value for /T1 terminal
+</para>
+<screen>
+	TUNEPORT /P -s=225 [ENTER]
+</screen>
+<para>
+Sets the delay loop value for your printer at 225.  Use such a command on
+future system boots to set the optimum delay value determined with the
+TUNEPORT test function.  Then, using OS9GEN or COBBLER, generate a new
+boot file for your system diskette.  You can also use TUNEPORT in your
+system startup file to set the value using the -S option.
+</para>
+</refsect1>
+</refentry>
+