Digital PDFs

AA-X730A-TE

May 1983

134 pages

Original

58MB

view download

OCR Version

29MB

view download

Document:	Wordstar Installation Manual
Order Number:	AA-X730A-TE
Revision:	0
Pages:	134
Original Filename:

OCR Text

MicroPro International

Corporation

WORDSTAR

&au?m&mc3 V3.0 3912-6306
Version

DEC order

No.

3.0

AA-X730A-TE

This document is distributed by Digital Equipment Co.
Limited under licence from MicroPro International
Cmrporatian and may not be copied in whole or 1in
part, for any purpose, without the written permission
of chrapro International Corporation, 33 San Pablo
Avenue, San Rafael, California 94903, USA.

Cprright 1983 MicroPro International Corporation

This document was initially typed, corrected, and edited using
WordStar word processing.

l Corporation. All Rights
Copyright (c) 1981 by MicroPro Internationabeen
provided pursuant to an
has
ation
public
Reserved Worldwide. This
The publication also is
agreement containing restrictions on its use. of
this publication may
part
No
law.
ght
protected by federal copyri
be copied or distributed, transmitted, transcribed, stored in a

ge,
retrieval system, or translated into any human or com puteric,langua
manual,
in any form or by any means, electronic, mechanical, magnet
ut the express
or otherwise, or disclosed to third parties witho
written permission of MicroPro International Corporation, 33 San Pablo
B

Avenue, San Rafael, California 94983 USA.

TRADEMARK

MicroPro, WordStar (Reg.), WordMaster (Reg.), MailMerge, DataStar,
SuperSort, CalcStar, SpellStar, StarBurst, StarIndex, and AllStar are
trademarks of MicroPro International Corporation.

DISCLAIMER

MicroPro International Corporation makes no representations or
warranties with respect to the contents hereof and specifically
any
disclaims any implied warranties of merchantibility or fitness for
ation
Corpor
particular purpose. Further, MicroPro International
from
reserves the right to revise this publication and to make changes
ro
MicroP
of
tion
obliga
t
withou
hereof
t
conten
the
in
time to time

International Corporation to notify any person or organization of such
|

revision or changes.

GNER

for
References are made throughout this manual to the Control Program
of
rk
tradema
a
is
Microprocessors, commonly known as CP/M. CP/M

Digital Research of Pacific Grove, California.

This page intentionally*l
eft blank

WordStar

Installation

Manual

Contents

1-1
1-1
1-1
1-1
1-2
1-2
1-2

Disk Drives
Terminal or Video Board
~
Selectinga Terminal
Serial Interface
- Random Access Memory (RAM)
|
Printers
Hiqhmemmlmty Printers

|
|

1-3
1-3
1-3

Other Printers
Suggested Setups
- Features and Defaults

Terminal Installation Considerations
Printer Installation Chnfiidmratiw~$
and Teletype-Like Printe:
Daisy Printers

2-1
2-1
2-1

2=3
2-4
2-5
2-8
2-9

|
R
[
Other Printers
P
,
Protocols
Communications
Printer Drivers
Summary of Printer-Related Inatallatmmn Selections
Printer Cbmfmguratlmn Lo
fan,Pracmdure

The Distribution Diskette
Creating a System Diskette

oy
Initiating Installation
|
|
Type
Terminal
the
Selecting
Selections
lated
Printer-Re
ST
Selecting a Printer
Protocol
tions
Communica
Selecting a

3-1
3-1

|
S
|

|
_
Selecting a Printer Driver
o
Port Driver
.
Bypassing the Patcher
Sel@ctimnm '
waa
g
Correctin
or
Confirming
Options
on
Installati

3-5
3=5
3-6
3-6
3-6

Ru
ll
Ordinary Instand

3=-2
3=3
3-3
3-3
3-4

Install to Another File and,wwlt (a;y=~~<;««Ww‘4m*?~~
Install to Another File and Rur (~~'

Modify Another File and Run

;

INSTALL's Patcher

Memory

‘

Output Data Pnrt
Output Status Port
Input Data Port
Input Status Port

WordStar Installation Manual

:ga”

3-9

4-1

4-1
4-3

4-4
4-4

iii

Testing WordStar
Testing Cursor Positioning
Checking for the Message File
Testing the Erase Function
Checking for the Overlay File
Testing the Editing Functions
Additional Testing for Highlighting
~ Testing the Printer

5=1
5-2

5-3
5=3

5=5

Qustom Terminal Installation

Modification by Patching

6-1
General Description
6-1
Listings in Appendix
- 6-1
Modifying the Terminal Patch Area
6-1
Installation for a Terminal Not Sh
on
ow
Termin
n
al Menu
6-2
Video Boards and Custom Terminal Drivers
6-5
Terminal Patch Area (USER1)
|
Terminal Installation
S
|
~ 6-7
Displaying in the Last Column of the Last
Line (USERLST)
6=7
Patchable Function Delays (DELCUS and DELMIS
)
6-8
Circumventing the System DELETE-Backspace “Featur
e®
Custaom Console Driver Routines
|
|
6-19
Delays
|
S
6-10
Patch Space for Added Subroutines
6-10
Testing Your Terminal Installation
6-11
Custom

Printer

Installati

Printer Type and Related Items
Printer Overstrike Method (POSMTH)
Bold-Strike (BLDSTR)
|
Double—-Strike (DBLSTR)
Printer Function Strings
'
Advance to the Next Line (PSCRLF)
|
Return to the Start of the Same Line (PSCR)
Non-Daisy Backspace (PRACKS)
|
Non-Daisy Half-Line Agdv:
(PSHALF—Optional)
Non-Daisy Roll Down (ROLDOW—Optiocnal)
Non-Daisy Alternate Pitch (PALT—Optional)
Non-Daisy Standard Pitch (PSTD—Cpticnal)
.
Special Functions (USRl through USR4—Optional)
Non-Daisy Ribbon Color (RIBON andRIBOFF—Opticn
al)
Non-Daisy Initialization String (PSINIT—Op
tional)
Non-Daisy Finish String (PSFINI—Optiocnal)
Initialization and Finish Subroutines
(PRINIT and PRFINI—Optional)

Printer Drivers
Printer Driver Flags
Driver Entry Points

CP/M List Device Driver

WordStar's Port Driver -Alternate Console Printer Driver

WordStar

Installation

Manual

Uaarwsuppiled Printer Driver Subroutines
Daisy Printer Driver

7=7

7=7
7=7
7-8

Othmr Patch Itwnw

Initial Mile

,Justificataan’w;:'

b1
INITTWE

Initial mfault o

(,VELIM)

Patching Wm'dsmr'a Printm: miver fwr
Altam

Cer! ain Tarmine

vnctmm Gmaphlcs

Wordstar for MP/M

Heath 89 Version

B~-1

TRS-80 Model 1 Version

Installation
TRS-80 Keyboard

Apple II Version
System Requirement
Installation
The Apple II Keybmard
C

B~2
B~-2
B~3
B~3
B-5

Specific Terminals
Explanation
The Terminals
Beehive 158

Cromemco 3100
Hazeltine 1500
Hewlett-Packard 2621 A/P
Imsai VIO
Infoton I-100
Lear-Siegler ADM~-3A
Lear-Siegler ADM-31
MicroTerm
ACT IV

Processor Technology VDM/SOL
Soroc IQ-129

WordStar

Inatallation'nanual‘

C-1
C-1
C-1
C-1
C-1
C-1
C-1
C-1
C-2
C-2
C=-2
C-2

Specific Printers

Daisy Wheel and Similar Printers
Features

Choice of Typewheels
OEM Daisy Wheel and Similar Printers
- Interfacing
Installation
Diablo Hy-Type II (1380 Series)
Qume Sprint 3
NEC Spinwriter 5560D
Serial Daisy Wheel and Similar Prlnters
Controls
Installation
Diablo 16108/1629

Diablo 1648/1658
Qume Sprint 5
NEC Spinwriter 5518/5528
'
Teletype~Like (Non-Daisy) Prxnters
"Any Teletype-Like Printer"
“Teletype-Like Printer That Can Eackspace“
Other Printers
|
Non-Return Printers

“Half-Line-Feed Printer"

The Terminal Patch Area (USER1)
The Printer Patch Area (USER4)
Installation Manual Index

VWordStar§Installation Manual

Section 1

Section

System

System Requirements

Requirements

r 2TM
Whiflh m W&““‘m“%a
pm,_ |

used on tlmm.r

loppy disk dxivw,

syatem..

a CRT t@rmml or video board, and

the

You Wlll mrmally alm wam: a pmnter, or acce% to anm:hex system

with a printer an

operational

WordSta

Two floppy disk drww are highly recommended,to allow you to back up files
conveniently and set up new working disks, but a mngle-dtwe system can be
used if you have a means of copying files from diskette to diskette and the
disk capacity of one disk is sufficient to support the essential WordStar files

(abmt mm mnd wmre twu tiw the size of the bmmmfile ymu will want to

You may use any CRT terminal or video board providing a display area of at
least 16 lines by 40 columns (and not larger than 120 lines by 250 columns)*
capable of displaying ASCII codes 28 thru 7E hex and capable of dlrectly
positioning the cursor bey deq line andcolumn.
The
terminal
s:.ble as the “console” device tmdm: Q/M; c@gwm video

or bright//dim hiq‘ ] xqfitimg ’m‘ayw@i Wi‘enhanced Mrfmmama with WordStar:

direct-memory-mapped video boards prwn.de the best perfmrmame

Selecting a Terminal
To be able to r:m WordStar, a terminal must haveabsc
sor
posi
g
In addition, WordStar must "know” the control sequences usedby the mrmcular
terminal or video board to position the cursor mm perfmm other (optional)
functions; these are set by the "installation" procedure, Section 2.
WordStar
may be installed for many common terminal types via a simple menu selection.
Serial

Interface

As a serial interfac& for the ter:minal, you may select the MicroPro "I/0

Master" S-100 mterfam board.
Thm Mard'fi 32—character "FIFO" buffer permits
the fastest text entry even duringdisk accesses and simultaneous printing and
editing. Further, thw board allmwa usimg t:he mexp@nmve “OEM® versions of
| the vmimm mmmfacwmm' iawy printers (next page).
(Centronic's port and

* Theoretical limit.

The actual limit is determined by the RAM available

- on your system.
WordStar

Installation

Manual

1-1

Section

System

Requirements

RANDOM ACCESS MEMORY

For a terminal with a 24 x 80 or smaller screen, including space for the operating system (CP/M) and text work areas, a minimum of 45K RAM is required.
To
- edit and print at the same time, 3K more RAM is required.
Terminals with
unusually large screens require, in addition to one byte for each of the first
1920 characters, one additional byte for each character position on the screen
in excess of 1920 total
cha racters,
If the board requires more than 28696
bytes, WordStar will require 2 bytes for every byte over 2096.
(If you have

one

the video boards that WordStar c n access in direct memory mapped mode,

2K less RAM is adequate,)

While WordStar is perfectly usable in the minimum amount of RAM, additional RAM
is recommended for systems which will be used extensively for documents longer
than a few pages.
Additional RAM increases the amount of text that can be held
in RAM simultaneously; thus, more RAM speeds editing and increases productivity
by reducing disk access. (Additional RAM does not affect maximum file size;

file size is limited by the capacity
of the diskette, not of the RAM.)

PRINTERS

Wordstar can be installed to drive virtually any printer. The features available are limited to those supported by the printer. Special installation is
required to access some features of some printers.
Underlining, boldface

(multi-strike method), and double strike require a printer that can overprint

(most printers have this capability). Microspace justification, continuously

variable line height, continuously variable character pitch, subscripts, superscripts,
and boldface (offset and restrike method) require a daisy wheel or

ther printer capable of incremental motion.

High-Quality Printers
The following printers are fully supported by WordStar and the installation
program supplied with WordStar.
All of WordStar's capabilities including bidirectional printing are available with these printers; simple menu selecticns
(detailed in Section 3) will install WordStar for these printers:
e

Diablo 1618/1628
‘Diablo 1648/1658
Qume Sprint 5
=
- NEC Spinwriter 5518/55289

NEC 5508D
|
Diablo Hy-Type II 1345, 1355, 1355wp

Qume Sprint 3 (with Diablo-compatible cable adapter)
* MicroPro “"I/O Master® Interface Board (or equivalent) required
The MicroPro “"I/0 Master" S-188 interface board allows use of the less—expensive “OEM" daisy printers and provides simple installation, maximum printing
speed, and good response when editing while printing. The NEC 5588D printer

(or equivalent) with a PA-1 board may be used for either an Altos or a TRS-80

II terminal.

1-2

WordStar

Installation Manual

System Requirements

Section 1

Other Printers
All othex: prm’mm ("Teletype-—like or "non-daisy pr:mtem) are treated in two
at

ckspace mfl those
e

paper

that

cannot.

The ability to return

thw

abj,lxty

lmkm,

cmlam,andup to four other apem.al
rih,m
two
I*M,
Pit"fi
tm
chamc
two
of
functions.
Suggested Setups

For a large mawllamm, you will probably want a line prmtar for fast draft

- printout and

daisy wheel mmtem fmr h:s.q~quality final copy

printout.

Wher

mult:.ple work atatimw are used, it is prwtical to omit the prmtex me«»um « y
«»uwwmxveflhamWware ltm“) on some,
u

wnfitmng stations only

the printm inm:f_ mrw.v

lons

aquired to run mrml damy whml p:mtem at maximum smd

mthmlt: buffm: warm

Sections 2-5 provide details on immlmWordStar to work withyour terminal

and printer. Sections 6-8 providedetails on specml installations. Smcml

installations are required for mttim up systems not handled by anordinary
installation and for modifying the operation of WordStar faatums (aee
“Features and Defaults” below). For a complete description of situations where
a special installation is required, see Sections 6, 7, and 8.

With an ordinary installation, WordStar comes up with all features set a

certain way by default. When you run the INSTALL program, as described in
Sections 2-5, you will automatically get the defaults. However, it is possible
to alter the standard defaults, i.e., to reset the defaults for WordStar
features to other values of your own choosing. Table 1-1 shows the standard
defaults that you will get if you make no alterations.
If you would like furthm mfumaum on setting up a custom WordStar system,
zation Notes from your dealer.

WordStar

Installation Manual

1-3

Section

System

Table

l1l-1. Defaults for

Requirements

Parameters

Item

Left Margin

Oflum11”

Right Margin

Column
65

(88-colum
screen)
Colunn
60
(64-column screen)

Variable
Tab Stops

Column 1

~ Colum 65

ceer 56

(88-—column screen)

(64-column screen)
Cols. 9, 17, 25,...73
,

8 9

Variable Tabbing

COFF
-

Justification
Page Break Display

Print Control Display

OFF

2 88888

Ruler Display

iopd

OFF

Incperative
o

OFF
OFF

WordStar

Installation

Manual

Section 2

Installation Considerations

Section

Imutallatimn C@naideratiauu
The “installatmn prmmdum mw up Wo ”,t.m: to wmk with yout mxticular
-ibuted Word:
es or
proced
This
r. al
in
and printe
term
mawmmcwfiflxavudaaL< a»

fl,_

&mmflfl.mmmuwm:fi:t;,@,w
any

inst:

cial

'vawaimn,are~ngenythezeh Check
instructions given there,

Compucolor 8081G

" Flashwriter I

Hmz@ltxnw 15@@

IMSA.

ion

Appendix

Beehive 150 / Cromemc

Flashwriter II

Hewlett-Packard 2621 A/P

,_Infwtmn Imlflfl ,

| Perkinmflmmar SSfi (Bantam) ,;Pnocammo: wwah 3@1
Soroc 1Q-120
B
TEC Model 571

iwelevidw»912/928

Visual 200

| If your termiml w not shawn, you will need to comult thm manufactumr 8

ting
w 'r‘mui:éd £dt éptim

own, follow

any instructi

‘
*w%aaf;mflmea.dmuwwwwwlamSEfimumrsmhnmmsami
“Teletype~-like" printers (i.e., most other printers).
We will discuss the
genaral charamteristic& and capabilities of these classes of pmintara here,

-also

other

consliderat:

ting n@fiuynmm uwmwuaCMn,

a««yfh:xnflmmmumnfo;, ,3, icular printer

WordStar Installation Manual

Appendis

2-1

Section

Installation

Considerations

Daisy wheel printers are printers capable of incremental horizontal and vertical motion, allowing use of variable line height, variable character spacing,
subscripts, and the rest of WordStar's print enhancements as described in the
Reference Manual. "Microspace Justification® is automatically implemented when
printing on a daisy wheel or similar printer. Since the control sequences are
different for each daisy wheel or similar printer, WordStar must be specifically installed for the printer that is to be used. WordStar can be installed
for one of the following daisy wheel printers via “menu” selection as will be
detailed in Section 3:
T
T
o
'NEC 5500D OEM printer with MicroPro *I/0O MasterTM Interface Board
Diablo 1380 series Hy-Type II CEM printer with MicroPro “I/O Master"
Qume Sprint 3 OEM printer with adapter and MicroPro "I/O Master"
- Diablo 1618/16208*
”
WA SR
|
|

Diablo 1648/1658

Qume Sprint 5
|
NEC Spinwriter 5510/5520

* Also used for the the NEC 558@D with a PA-1 board on Altos or TRS-86 II

Selecting one of the above printers from the menu installs WordStar to make use
will print bi-Girectionally if

of all capabilities of that printer, WordStar
any of the above printers is selected.,

WordStar may be installed to drive the NEC 5580D, Diablo Hy-type II 1300
series, and Qume Sprint 3 (with cable adapter) OEM printers through the MicroPro "I/0 Master® interface board with a single menu selection (as will be
described in Section 3),
For Altos and TRS-80 II terminals, WordStar may also
be installed to drive the NEC 5500D through the PA-1 interface board. Users of
OEM printers and the "I/O Master” interface board may disregard the rest of
this section and go on to Section 3.
|
|
S
R

The printers not noted as “OEM" in the above list are usually supplied with a
“Serial® interface.
When using a serial daisy printer with WordStar, you will
generally wish to set the printer and the computer interface to 1208 baud (120
characters per second), the highest transmission speed supported by these
printers. Such printers operate far below their speed capability with WordStar
when set to 300 baud or less.
Use of 1200 baud generally requires use of a
“communications protocol” to prevent loss of characters; use of a communications protocol usually precludes access to the printer as the "CP/M List Device®.
Read "Communications Protocols" and “Printer Drivers® later in this
section carefully and check Appendix D with regard to your printer, before
attempting to install WordStar to drive one of these printers at 1208 baud.

This class includes almost all printers other than daisy wheel printers—any

printer that prints the ASCII printing characters (codes 28 through 7E hex) and
responds to the carriage return and line feed codes, but not the more sophisticated printing features,
Using a Teletype-like printer, WordStar can under-

line,

2=-2

strike out,

double strike, and overprint. Boldface is printed with three

wOrdStar‘Installatien Manual

Installation Considerations

Section 2

a customer thmwh patching). Subscripts and superstrikes (or as specified by
scripts are printw in the lim below or above if that line is blank, otherwise
appear. Variable line height is not available.A
in the line in which they
colmm m wailyle thwu@h
4
and two;i.b
x itcm?n
3??” act p
chmca Qf two

ckspa

ode

gimn lirw,
pr intm: cm back

' (F@x a lmqw mos ; *; @f undaninq, @tc. in a

becomes faster.) Use selection B if you know your
you are 1in dout't: as to wm,her your printer can

Oth@r Primtmxa'
‘Gmmmlly,

of the two "I*eletywlim aelectims in tm ins

patches, if required, are covered in Section 7.

Both of the "Tule~~.«z pe-like” pxint:m: wlwctwm (A & ] B above) assume the
printer will mtu“ | carriagewithout advancing to the m-«tylina whmn sent a
rriage

return

code that is mt followed by
a line feed code.

our printer

annot mtum im mrriwgm without advancing to
nw« t lima but can backspace (Selection B), wumint (linmwill nm: print
ectlig,but Wordstar

ual.) If ymr Vprntafi mnf :'aaf mtur‘thac:m:tiauxth@ut "fmdingta

the next line nor Mckmwe, use Salmtian A and avoid use of underline

Mrikwut, bol&me,-,& atrike, backspace, and warprmt lines.

tm: selection on the Printer Menu, "Hal wmm Feed Px:mtem“, 'is intended
to facilitate installation for pmmm:s that can advance the paper cme-half
line at a time; the half-line advance is utilized in pmntmg mubscmpw and
superscripts. After making this selection, patches willmra‘fw be required.
See Section 7 (“Custom Printer InstallationTM along with Appendices D and E.

WordStar Installation Manual

2-3

Section

Installation

Considerations

Communicationn Protm:o].a
A “communications protocol* is a convention whereby a (serial) printer tells

Wordstar when to stop transmitting characters (while those already received by

the printer are beingprinted) and when to resume tmnmnitting -

Communications protocols as dmeumed here are not pertment to "OEM" or

Centronic's interfaced printers; users with the NEC5500D, NEC 5538, Diablo Hy-

type II, or Qume Sprint 3 CEM prmtem interfaced with ezther the MicroPro "I/O

Master" board or the PA-1 board may disregard this subsection

A communications protocol is not necwsary with a (serial) daisy wheel or
similar printers interfaced at 158 baud or less, and g@nerally not at 388 baud.,
However, if you have such a printer interfaced at that
speed, you will want to
change it to 1206 baud when you discover how slmwly it pr.mw.

Unlew hm:dware
cabling mtimw are wnilable and have been mplmented. a
ommunications w is always necessary with a serial daisy wheel or similar printer intmfv ed at 1208 baud., If no communications protocol is installed, the prinmr‘m buffar will overflw md chmm:mm will be lost.
|
We will descrim the availablemmwucatiom pmtwola in ger eral here; see
Appendw D fm: apecz.fic twt@s mlating toyour prmtem The pwtocmls aupm.catmns protocols require that the computer be able w wc:eim charmtew
from the printer as well as transmit characters to the printer.
This complicates installation when a communications protocol is to be used, since the
normal method of acceming a printer under CP/M » the "list device"”, provides

only for transn «:wmmof charwtem from tmm er to the printer.

Under this protocol, WordStar senda a measage ccmsmtlng of a specn.fn.ed
maximum number of chamcmm, followed by an “ETX"TM character (83).
After
printing all characters up to the ETX, the printer transmits an “ACK" character
(66H) back to the compu m:, thus signallingWordStar that another message may
be transmitted. All daisy wheel and similar printers supported by Wordstar can
use th.w protmol, though some printers require specific optioning to activate
J.t. See mms D mdthe prmtermanufactumr‘s documentation,
|

Under this protocol, the printer transmits an "XOFF" character (DC3 ASCII code)
to the computer when WordStar should stop transmitting characters, then trans-

mw an "XON*‘ character (DC1 ASCII code) when trammmmion may resume.

protocol is supmrted as an alternate protocol by some daisy wheel and

mmlar: prmtem: use XON/XOFF instead of ETX/ACK only if other considerations,
such as other software to be run on the same computer, necessitate its use, or
if you have an unusual printer that wa.ll perform XON/XOFF but not ETX/ACK.

2-4

WordStar Installation Manual

Installation Considerations

Section 2
Printaz Drivera

Users with NEC 5508D, Diablo

Hy-Type

;
faced with theMicroPro “I/O M :wtw board
tion ¢
combina
me
i.nmrf‘"
(selection ofOEM printer / I/0O Master

g insta’
to dtwe a
wwh
who
Umrs
tion a,utomatwally selects the required driver).
Users of
camful,ly,.
amtxm
ser ml daxsy prmter at 12% baud mwt ww t:hw
2C

oM printers

Lidlad

"list output devi

witt _.«-1

for Alt

Wh@r wy a.pzoq ra

nd TRS-80 II terminals
I{;;A,

,'f’,rt mceivim charac

doe!

To handle mmmumcmum protoco. w md pwmmra tests,

dmr CP/M -- the

rom the printer,

and

accommodat

smmal cmmm WM" j—;‘tar p‘iwid% mi‘ 3veral metfa f r m‘ "f%mng tha pr inum.
h.ng Wordsm, me mf the fmllwmg ptmter dr;wem * |

graphs that follow dxscmm emh printer driver in detail. mmtm tm d@mmd
durs”rf’zq~ imwllmim b Ml acting £ mm a menu
.
printer dgwar is «
|

(Sectmn

M "Lwt|

CP/M 'm o Conwlé Deiricwé

Port Driver (direct mput/autput by erdStar)

Custom Subroutines

This driver @utpuw ahmmwm toth@printer via the printer driver in your

operating system. The list output device isthe simplest way to access your
subprinter if your printer requires no communications pmtmcml (prmedmg
allows
that
patch
a
m
(Th@m
d.
desire
is
test
busy
r
printe
no
and
n)
sectio
..) If yom: prmmr,
Smeare m check bw for fwmr wpemtxm fmm

mte:tf’aced m: 12 J

portmn of the apekatxng mym

if the fiya em

coume, auch mywmm installation is not ne g;«@wary fm: erdsmr use unmm
rdStar

inst

ed to do printer output via the CP/M list device.

Wordstar Installation Manual

2=5

Section 2

Installation Considerations

In many systems, the “list output
device" (LST:) is a "logical® devic
e which

can be assigned to one of several “phys
ical® devices.
If this is true of your
system (check your system manual), you
must either give the necessary comma
nd
or provide the necessary system setup (SETUP
.COM or QONFIG.QOM) to assign LST:
to the desired printer device before you
can print with a WordStar installed to
use the CP/M LIST DEVICE.
:
'
o
y
,

CONFIG.COM, CONFIGURE.COM and related files
allow you to set up LIST DEVICE
conditions via a kind of menu. Usually you
have to run the"CONFIG"* program
and answer the questions (OONFIG is short
for *configure® which is similar to

MicroPro's INSTALL program).

programs in your CP/M manual.,

Look up theprocedures for running one of these
s

A more universal set-up is that procedure
available via the STAT.COM program,

Typing STAT LST:=LPT: will assign the LIST DEVICE to
the physical device and
its driver associated with the LPT:.
This nearly always works, but is
transi
ent (ie. is lost

up tends to be permanent

when the system is re—b

oted); while the CONFIGURE

(either optionally or by definition.)

set-

To verify that your operating system drive
s your printer and that LST:

indeed assigned to the printer, type control-P
at the system prompt (A>), then |
type
additional

everything

characters.

you type another control-P.

operation,

All

characters typed

the

console (and

that appears on the display) should be pPrinted on the printer until

CP/M has no provision for

This is an unqualified test of proper LIST DEVICE

inputting characters from the list output device, as

required by the communications protocols, nor
does it have a uniform provision
for a printer busy test. However, WordStar provid
es for installation of usersupplied printer character input and Print
er busy test subroutines (such as
those found in Spinware) for use in association
with CP/M list output device
printer output. (See Section 7.)
|
o
Pt
g

Do not attempt to install or use code in the operati
rat ng syst

em
to

implement ETX/ACK protocol when driving a Diablo
or Qume daisy wheel
printer, For WordStar to work with these printe
rs under this proto—
col, the protocol must be executed by WordsStar,
s
|

Wrfilm Ofm’/M the “console® is a logical device (G:N**) 'wluch can be

assigned
to any one of four physical devices, usually
called “TTY:", "CRT:",
"BAT:", and "UL1". The terminal used by
the operator is one of the "physical®
consoles and must be the active one when WordSt
ar is invoked; WordStar can

access the printer as another of the consol
es.
access the printer as the TTY: or CRT:

selection at the Printer Driver menu

soles can be accessed via patchin

WordStar can be installed to

(Section

Accessing the printer as an alternate console allows inputting chara

from

‘the printer, as required by communications protoc
ols, witho It system software
modifications or patching. The TTY: or. CRT: printer
driver is often the most

convenient printer driver choice when a communic: itions protocol is required, as

by a daisy wheel printer set to 1200 baud,

ccessing the printer as an alter-

nate console does not provide a printer busy test
unless the user installs his
own subroutine (Section 7).
|
|

2-6

WordStar

Installation Manual

*'Ys Altern 8 ¢ s

Installation Considerations

[

Section 2
QMQ B

| fl*"‘

This drivar mcwww the pmnwr as the TTY:* console device. This driver
will support communications protocols and may be used if your CP/M mpemtm
symmm muppmts multzpla consoles and the terminal from which mmsmr is
pera

m not tm “TTY:" device.

tlw mmt@r as the mw
Similar to thepreceding, this drivex
pt”tocols and may be used
mw
&
will
driver
Thw
device.
- sole
terminal m chh Wm:mm: is
e
if your CP/M sumorw multipla

operated is not the “CRT:" device.

nst

pm:w" as thwcase

port mmhmr (or memory:
determination of thm matput
mapped), output status port number, output matw biw,,
tions protocol is to be used, the-input-dataport,mput mmm ;,;x:t.
and input status bits. If you don't know the port numbers for your intm:'ffl e,

the WordStar installation program can be chmc ced to search for the ports (as
|
|
.
will be detailed 1&tm:)

Vector Graph.lw mrm, mfm: to Sectiam 4 and 8 mxd ppendi
formation there. ask your
1
,
mentary Application Notes.

If your printer inmrfmeinvolves more

dealer about suppl
-

one out

r |onewt;{tatat 3;‘“rt,@m i
hcation)
mapped

your ptinmrs mrt

mbe.

oped

resses

can determine them in ywr sym:@m with 'f’*’”ha insta latmm pri_ram's

automa

search featurw, t:he port driver is the best printer driver chm.ce where a
communications protocol is required or a printer busy test is desired.

Chwmng t:hm pr:inter drwm: selection causes w«at&fitm to call user-coded,
user-installed subroutines to out:put to the printer, input from the prmter
(for cmmmunicatioha pwtmmla) » and determine whether the pmnwr is busy.

WordStar Installation Manual

2=-17

Section 2

This choice may be used when the

Installation Considerations

CP/M list device won't work

(e.q., because a
communications protocol, and
thus printer Character input,
is required) and the
port driver won't work (e.q., beca
use an unusual printer uses seve
ral data or
status ports).
|
»
Foe,
,

After selecting wi"Cus;tc.':am Subroutines® on
code and install the necessar

the INSTALL menu, it is up to you to

y routines.
SeeAppendix E for listings
of the
area in which to install your code,
Section 7 for discussion,
|

Summary of Printer-Related

Installation Selections

OEM Printer with MicroPro I/0 Mast
er Interface Board:

complications discussed in this section are pertinent,
Choose “I/0 Master / OEM Printer"
at the
INSTALL program's printer menu
(as will be described in Sectio
3).
n For any
OEM printer with Spinwaand
re either the I/0 Master board or
the PA-1 board,
select "L" (CP/M list device) and D"
(Diablo 1618/28)., INSTALL will pres
ent
no further printer-related sele
ctions,
@
f
|
g
,

Teletype-like (Non-Daisy) Printer:
If your CP/M operating system can alrea
dy

drive the printer, specify *Teletypelike" at the printer choice menu,
specify
"None" for communications protocol,
and specify “CP/M list output device"
for
printer driver, Alternately, you may
wish to use the port driver for bett
er
keyboard response during
concurren

t editing and printing.

(Serizl) Daisy Wheel or Similar Printer Interfaced at

CP/M can already drive the printer,

300 Baud or Less: If your

choose the specific printer type at

the
printer menu, specify "None* for comm
unications protocol, and specify
“"CP/M
list output device" for printer driver.
Or use the port driver if desired, for
better keyboard response during conc
urrent editing and printing. You will
want
to change your printeto
r 120¢ baud as soon as possible so
WordStar can print
faster.,
)
e
T
_—

(Serial) Daisy Wheel or Similar Printer
Interfaced at 1209 Baud: You will need
use

a communicati protocol and a driv
er that can input as

well as output
characters.
See Appendix D for specific discussion
of your printer. ‘Specify
the particular printer type at the print
er choice menu. Specify ETX/ACX proto-

col, and set the printer to match, unles
s unusual considerations dictate using
a different protocol. |

System supports multiple consoles and

| waévw, if yourbperating

your printer is already accessible as
one

nate console driver. The CP/M list

output device printer driver canno
t be used
with a communications protocol unless
you patch in your own Printer Character
Input routine (Section 7).

2-8

WordStar

Installation

Manual

Section 2

Installation COnsideraticns

Exception: If your 12% baud printer is aNEC spinwnter 5518/5528, you may be
able to make a special cable instead of using a communications protocol (see
Appendix D).

If you use the special cable,

you may specify "None" for protocol

and "List output device" or "Port driver" for printer driver.

Printer Configuration
Some printers have option switches which must be correctly set. These switches
may be on an external control panel, on a control panel under the prmter‘
cover, or buried on circuit boards inside the printer. Common switches include the following:
UTO

OCAL LF (makes printer line feed

)receiving a carriage

return code) must be OFF.

AUTO CR (W% permter start a new line if an overlong line is printed):

Must match the rate at which your computer tra
»

ARITY: Set to ignore parity (“M" position on some printers).
Communications

Protocol

nmunicat

* must be used with

(serml) damy wh%l and mmxlm pmmers mterfaceé at 1200 baud (12@
chmmters Pexsecond), asdiscusse
pmtmml zmuu Mttim @mtchefi or adding jmpem on
circuxt mmrdfi inside the printer. See Appendix C and your printer's

LENCTH:

Should be set to match paper in use

optwn is to be used.

SET TOF: Press after mmmmim paper at top of form, if USE FCM! FEEDS
print option is to be used

WordStar

Installation

Manual

2=-9

The Page Intentionally Left

WordStar

Installation

Manual

Section

Installation

Procedure

Section 3
Installation Procedure
THE DISTRIBUTION DISKETTE

The diskette (or diskettes) you receive upon purchasing WordStar contain the
following files:

wsU.QoM

Uninstalled WordStar; imtallatwn for your terminal and
printer is achzwed by running INS ALL as described in this
section,
WordStar message and overlay files; must be on diskette in
logged drive or drive A whenever WordStar is in use,

WordStar installation program; used to install (customize)
Wordstar for your computer configuration.
File of s ample text demonstrating some WordStar features.,
Additional overlay file for the optional MailMerge feature
(extra—possibly on a separate diskette).
Creating a System Diskette

Follow these steps to create a new system diskette to work from:
1. Format a new disk.
2.

Copy a system onto this disk.
Copy PIP. mMQnto this diak.

4. Inaex:t this new disk into the boot dzive (a:) and boot

it.

5. Inmrt the origfi.ml distribution disk into a second drive (b:).

6. Copy INSTALL.OOM and WSU.COM from the distribution disk (drive b:) to the
new working di%k (drive a:) using PIP.

called ws.mm with Wm%tm: mt up for yourpar

will Create a new file

8. Once you are certain that WordStar has been properly installed, erase
INSTALL.COM and WSU,.M fmm your new working disk (drive a:), but not

9. Now copy all overlay files (WSMSGS.. VR, WSOVLY1l.OVR, and possibly the
optional file MAILMRGE.OVR) from the distribution disk (drive b:) to your
new working disk

(drive a.)

using PIP.

(Type pip a:=b:*.gvr after a>.)

18. If you have room on your working disk, you may also want to copy STAT.COM
and FORMAT.COM onto it.
11, Remove the distribution disk from drive b: and store it in a safe place.
WordStar

Installation

Manual

3-1

Section

Installation

Be sure to keep the original distribution diskett
e.

the future,

Initiating

you may need to return it to your dealer.

Procedure

If you wish an update

Installation

To initiate WordStar installation, insert the diske
tte containing the files
copied from the distribution diskette,
ready up),

or else cold-start (boot)

type control-C

the system,

(1f your system

and type the command:

is al-

INSTALL

and press RETURN.

INSTALL will take several seconds to load, after which

will display a sign-on message and ask its first
question.
sCreen should appear as follows:

At this point,

the

A>INSTALL

(C)

1981,

MicroPro International Corporation

INSTALL release x.x for MicroPro WordStar

release n.n

Do you want a normal first-time INSTALLation of
WordStar?
(Y = yes;
N = display other options): B
|
In response to this question, type Y.
(If you type N, additional options not
needed for initial installation as described here
are displayed. These installation options will be described in Section 5.)
1In response to the. Y, INSTALL
will tell you what it is going to do--create an instal
led WordStar on file
WS.QOM, obtaining the uninstalled version from file
WSU.COM—and ask for your
confirmation—as follows:
|
.
»

This will INSTALL the WSU.COM on the current drive,
save
the result on file WS.COM on the current drive, and
then
run the INSTALLed WordStar.
g,
4
OK (¥/N): &
Type Y.

(As with the previous question,

an N here gets the installation

options, which are not needed for an initial installation.)
An error message
will occur at this point if WSU.OOM is not on the current
(logged) drive.
(If

you need futher

explanation of any error message displayed while
you are

installing your WordStar,

3=-2

refer to Appendix A.)

WordStar

Installation

Manual

Section 3

Installation Procedure

THE TERMINAL TYPE
SELECTING

Aterminal choice fimenur appears next, as follwwfi:“
MicroPro WardStat release n.n serial 000000
WordStar TERMINAL MENU #1 **%=*%

Lear-Siegler ADM-3A
Hazeltine 1500

Beehive 158/Cromenco 3100
Hewlett-Packard 2621 A/P
Processor Tech SOL / VDM
Perkin-Elmer 550 (Bantam)

Terminal Menu #3

NOR~HOMmAO

*x***
wHrgmEo
>

l
l
I
l
i
l
l
!
I
|
|
l
I
!
|
l

Lear-Siegler ADM-31
Microterm ACT-IV

IMSAI VIO

Infoton I-100
Soroc IQ-128
Terminal Menu #2

None of the above

PLEASE ENTER SELECTION (1 LETTER): B

If your terminal is shown on the menu, enmr the corres
ingletter. If your
terminal is not shown, type *2" or "3" and another menu alwwmg additional
pond

terminals will be displayed

If your terminal
type is nat:mmmmmcwxamy of the menus, you must make
a custom
terminal installation as described in Section
6. Enter Z for "None of the
abnver in order te‘bypass the termanal menus; patch the required control
INct
‘determined
Appendix E, and your terminal's

After the bmmmumxltammsletner:usemmfired,
confirming the terminal type and ask
OK

(Y/N):

If you made an error or wish to change your selection, type N, and the TERMINAL
TYPE question will be asked again. Upmn repetition, a choice U for "NO CHANGE"
will appear on the menu, When you answer Y to OK (¥/N):, INSTALL will proceed
to printer choice. You can type "B" at this or any following question to
return to the terminal choice menu.
PRINTER-RELATED SELECTIONS

Installing WordStar for a prmnter involves choosing the S@Eclflc printer type,
communications protocol, and printer driver, as discussed in Section 2.
Selecting a Printer

The next "menu" displayed by INSTALL allows you to choose the type of printer
which the installed WordStar will drive:

WordStar

Installation Manual

3-3

Section

Installation

**%%%*

PRINTER

Procedure

l
|

****x

(More specific info is displayed after choic
e is entered)

NCOCXEHOYWEMUOAY

|
|
l
|
I
|
l
|
i
!
|
l
I
{

Any "Teletype-likeTM printer (ie almost any printe
r)
“Teletype-like" printer that can BACKSPACE
|
DIABLO 1616/1628 daisy wheel printer

DIABLO 1648/16580 daisy wheel prin
ter
QUME Sprint 5 daisy wheel printer
NEC Spinwriter 5520/5520 thimble printer

"Half-Line-Feed” Printers

[
|
1
l
|
|

|
-

I/O MASTER / O.E.M Printer combination

no change
none of the above

| PLEASE ENTER SELECTION (1 LETTER): B
l

|
|
|

If your printer is listed, enter the appropriate
letter.
If you don't see your
printer, type A, (or C if you know your printe
r can backspace).
See Section 2
and Appendix D for futher discussion of the printe
r choices.,
INSTALL will then
display a message explaining any special consi
derations relating the printer
selection, then ask
&

(Y/N):

If you wish to change your selection, type
N, and the PRINTER menu question
will be redisplayed,
To proceed to the next menu, type Y.
Also, you may type
B to return to the beginning of the dialogue.
The space bar may then be hit to

keep the prior answer to questions whose answer
you do not wish to change.

The M selection on the above menu applies
to all brands of “"OEM* daisy wheel
and similar printers (NEC 5506D, Qume Sprint
5, Diablo Hy-Type II) when interfaced with the MicroPro "I/0 Master® board. For
further discussion of these
printers in combination with the "I/O Master
" interface see Section 2, as well
as the message displayed when M is entered.
Since no communications protocol
nor driver selection is necessary when insta
lling WordStar to use an "OEM*
printer with the "I/O Master” interface, the next
two menus are skipped when M
is selected.
|
If you chose M at the printer menu (above),
proceed to the next subsection
("Bypassing the Patcher®)

Selecting a Communications Protocol

The next menu displayed permits choosing a "communicati
ons protocol®,
cussed in Section 2.

3-4

WordStar

Installation

as dis-

Manual

Insta.. ation Procedure

Section 3

Afi“Cmmmunicatian Protocol” is necessary with some printers
to prevent printer buffer overflow and character loss.
X
N
U

EXT/ACK Protocol

“"X-ON/X-OFF" Protocol
rdStar)
NONE required (or handled outmda of Word
no change

ENTER SELECTION

(E, X, N, B, or U): N

As noted in Section 2, the appropriate arwwe-r is usually "None” except for
daisy wheel and similar printers interfaced at 1200 baud (128 characters per
second), for which the appmpriate chmice m umually"ETX/ACK". Enter the
deaired letter.
INSTALL
ispla
Mimim the MlfiCtJ.Mr
siing merwis.

then ask K (Y/N)z mfm:

Selecting a Printer Driver

The final Ptintermmlatwmmu permi:

DRIVER MENU

**%%%*

no change

PLEASE ENTER SELECTION (L, P, S, B, OR U): ¥

CP/M “List"TM device
,
Direct I/0 to 8-bit port
Uaermimtalled driver subroutines

L
P
S

Or, how should WordStar send characters to your printer?

***%%

If "none” was specified for "Communications protocol®,

then “CP/M list output

device” is commonly the appropriate choice here. See Section 2 for further
discussion.
Enter the desired letter. INSTALL will diwplay a confirming
message and ask OK (Y/N): as after previous selections.
|
Port Driver
If you selected a printer driver other than P at the above menu, or if you
enterednn at the prmter menu, proceed to the next subsection ("Bypassing the
Patcher").

,
;
the
P on
§
If you selected
additional questz.w to determine how to access your prmter (m Sectim 4).
WordStar

Installation

Manual

3=5

Section

Installation

Procedure

BYPASSING THE PATCHER

- After the printer Vselections have been completed, INSTALL will display the
prampt :

ARE THE MODIFICATIONS TO WORDSTAR NOW COMPLETE?
IF THEY ARE ANSWER YES TO THE NEXT QUESTION.
ORDS

‘ATl

K (Y/N):

For a normal installation, type Y.

If you type N,

the “patcher" will be

activated.
The patcher permits additional custom modif ication
s, not usually
needed when WordStar is first installed.
Description of the patcher will be
deferred to the end of this section.

In the subsections that follow, you will learn how
to repeat the
installation dialog and how to re~INSTALL a previously
INSTALLed
WordStar (using the installation options).
1In either case, you can
retain the previous selection by pressing the space
bar (or RETURN)

at the Printer Driver Menu.
If the previous selection was P and you
press the space bar, the additional questions for
the port driver
will not be reasked; the old answers will be Kept.
If you wish the
port driver questions to be reasked, so that you may
change one or
more answers,

type P at the Printer Driver Menu.

CONFIRMING OR CORRECTING YOUR SELECTIONS

All of the installation choices have now been presented.
INSTALL will next
display the terminal type, printer type, communications protocol
, and printer
driver that you have selected, then ask OK (Y/N): yet once
more.
If you wish
to make any changes, type N or B, and INSTALL will return to the
Terminal Menu,
allowing you to repeat all of the selections. For those
choices you do not
wish to change, enter a space. INSTALL will keep the
previous selection.

When everything is as you wish it,

type a Y at this final confirmation.

INSTALL will then automatically save the installed WordSta
r on a file named
WS.COM, for future use, then start (pass control to)
the installed WordStar,
allowing immediate use..
e

The next two subsections describe the installation options and the patcher (not

normally needed for initial installation).
The various error messages that can
occur during INSTALL are given in Appendix A.

INSTALLATION OPTIONS

As described 'above,‘ the INSTALLprogram normally takes an uninstalled WordStar
from file WSU.COM on the current drive,

WS.COM on the current drive,

3-6

creates an installed WordStar on file

then executes the installed WordStar.

WordStar

Installation

Manual

Installation Procedure

Section 3

might wish
Occasions may arise when you wish to vary the above procedure,theYou
drive
current
to use different file names, or files on drives other than
a
with
start
to
for the final installed copy of WordStar or you might wish
without
ons
selecti
previously installed WordStar in order to change one of the
'

reentering them all.

for
INSTALL has provisions for operator entry of the file names to be used, and
To
.
return to the operating system instead of starting the installed WordStar
want
you
"Do
n
use these options, invoke INSTALL, then type N at first questio
a normal first-time installation?”. INSTALL will then display the INSTALLATICN
|

OPTIONS menu as follows:
i
l
l
I A
l
!
l
l|
N
!
! C
l
l D
l -

sx***

WordStar INSTALLATION OPTIONS MENU

*****

INSTALLation of a distributed WordStar, INSTALLing WSU.COM,
producing WS.COM, and then running the INSTALLed WordStar.

B INSTALLation or re-INSTALLation of _a WordStar COM filea of
file

I
|
l
!

to the operating system.
of your choice, and then exiting

Same as B except run the INSTALLed WordStar.
Modificatih of the INSTALLation of a WordStar COM file of
your choice.

The modified WordStar replaces the original

file. The modified WordStar is then run.

l’

your choice, placing the newly INSTALLed WordStar in

C, or D): N
PLEASE ENTER SELECTION (A, B,

l
and Run
Ordinary Instal
(Installation Option A)

Selection A on the Installation Options menu corresponds to the normal case.
The dialog then proceeds as described above, as though you had entered Y to
the question “do you want a normal first-time installation?®,
Install to Another FPile and Exit
n
(Installation OptioB)

Selection B asks fmrvf two file names as f'allowsz
Filename of WordStar to be INSTALLed? B

At this question, type in the name of the file from which INSTALL is to
take the WordStar to be "customized" for your terminal and/or printer.
Normally, this is file WSU.COM; you might want to enter "B:WSU" to get
WSU.COM from drive B when the currently logged drive is A; or, you might
want to enter the file name of a previously installed WordStar (e.g.,

“WS*) in order to change some of the installation selections without

re—entering all of them.

WordStar Instal;ation Manual

3=-7

Section

Installation

Procedure

Typing errors in the file name may
be corrected by backspacing with
control-H or rubout. Control-U may
be used to erase the entire answ
er,
Terminate your answer with the
RETURN key.
If you omit the period and
file type,

INSTALL will assume .COM.

entering anything,

(If you press RETURN without

INSTALL will assume WSU.COM).,

If the file you specified was not found
, INSTALL will respond
THAT FILE DOES NOT EXIST

and repeat the question.
Note that you must include the driv
e name
(letter followed by colon) at the begi
nning of the file name unless the
file is on the diskette in the current
logged drive,

Filename for saving

INSTALLed WordStar? B

At this question, type in the file name
in which you wish INSTALL to save
the installed WordStar.
"Wws" is the normal answer to this quest
ion; you

might want to enter "B:WS" to save the WordS
tar on the diskette in the B:
drive; or you may prefer a file name other
than "WS".,
(If you omit the

period and file type,

out typing anything,
current drive.)

INSTALL will assume +Q0OM;

if you press RETURN with-

INSTALL will write a file called "WS.C
OM" to the
|
|

After the two file names are accepted, the
dialog under Option B proceeds as
described earlier in this section. After
the final confirmation, INSTALL saves
the installed WordStar on a file of the
specified name and then exits to the
opera
ting system.

Install

Option B does not run the installed
WordStar.

to Another Pile

(Installation Option
C)

and Run

Selection C on the Installation Options menu
is the Same as selection B — file

names are requested as above ——

except that after the installed
WordStar

is
saved on the disk, it is run.
Option C is thus a convenience when immed
iate
use of the installed WordStar is desir
ed,

Modify Another Pile and Run

(Installation Option D)

Selection D on the Installation Options
menu combines the two

questions

of
selection B or C into a single question:
one file name only is requested.
WordStar is read from this file, customized
for your terminal or printer as you

specify during the dialog, then re-saved on
a file of the same name.

This

option is a convenience when you wish to modif
y the installation of a previous-

ly-installed WordStar — for example, to chang
e the printer type while keeping
the same terminal, or to change the communicat
ions protocol without changing
anything else,
|

When MfimmWfiaw

W&an‘mwmm.umwmfi

wwm

mmnmmm

those selection vou do not wis£
h
o chapge., INSTALL will respond by displaying
“Previous selection left unchanged:* and the previo
us terminal, printer, driver

selection, communications protocol, etc, and
allow you to confirm this un-

changed selection by asking OK (Y¥/N): in the usual
manner,

3-8

WordStar

Installation

Manual

Installation Procedure

Section 3

STALL's patcher facilitates making special mstallatlms and modifications to
Wo:dsm:* Installation of Wozdsm: for terminals and printers not shown on
NSTALL'S mmm, m other situations in which patching might be necessary or
dwirablef are discussed in mtlm 6 of this manual. If you wish to make such

listings
a special imtallatxmor modification, refer to Section 6, and to the Once
you

in Appendices E and F, to determme exactly what patches to make.
have studied Sectn.on 6 and determined what bytes you wish to change in

WordsStar,

INSTI

‘

‘The patcher permts ng and/or changing any byte in WS.COM. The location
of each byte to be changed may be specified by hexadecimal address or by label
name taken from the Usm or USER4 lz.stmg in Appendlx E or F of this manual;

the contents of mch mclfied byte is displayed in hexadecimal and a new value

may be entered in hexadecimal.

INSTALL's patcher is accessed by anwering N at the following prompt. As noted
earlier in this sectmn (“Bypaasmg the Patcher®), this prompt appears after
the prmter selections and before the final confirmation. (If you have already

'NSTALLed WordStar, and wish to make patches in the installed copy, you may use

mfltallatim option B, C, or D and press the space bar to bypass the terminal

and printer menus without re—entering those selections.)

K GVN)z

If you type N, a summary of the patchmg process will be displayed on your

terminal, followed by the prompt:

LOCATION TO BE CHANGED: N

Enter the desired address in Madeclml, or enter the desired label (as shown
in the USER] or USER4 listing in Appendix E) followed by a colon. A label may
be followed by a "+" and a hmdecmmal number to access the location that many

bytes after the label.
25B
CTRAIL:
CTRAIL:+2

Examples of valid answers:

(hexadecimal address)
(label)
(label plus numeric offset)

NSTALL will then display the address in hexadecimal and the present contents

of the indicated byte, and prompt you for the data you wish to replace it with,
The screen line will appear as follows:

ADDRESS: aaaaH

OLD VALUE: nnH

NEW VALUE: §

where 2aa represents the hexadecimal address and pnH represents the value that

is presently occupying the byte at that memory address. Enter the hexadecimal

value with which you wish to be replace the old value, or press RETURN only to
make no change.

erdSta:vInstallatian Manual

3-9

Section

Installation

You will then be prompted to enter
a new location.

you

may

press

RETURN)
.

RETURN only;

terminate patching,

Procedure

To access the next address,

enter

zero

(type @

and press

By using symbolic labels, you can
avoid absolute addresses, which chang
e from
release to release. Thus a patch
made for one release of WordStar
can easily be
applied to a subsequent release witho
ut concern for changein
s the location of
the values which

must be modified.

3-19

WordStar Installation Manual

Installation Procedure: Port Driver

Section 4

Section

Installation

Ptoceduxe~

Port Driver

driver menu in Section 3),
If you Mlected Wardsmr s mrt driver (P on the how
to access your printer.
S

ditional questions to determine

bmltwm port driver is the
Since the m&t&llatmn procedure for Wm:dsmr‘a
&wotw exclusively to this
is
4
mcmt mvmlvedm g prmedme, Sectim

whether your
The £irst of the pm:t driver questions requires you to specifyDetexm
Ports”.
Mapped
printer is connected to "I/0 ports” or "Memory“I/O ports" are most commonme. this
fmm the technical manuals for your computer;
Am the pri.nm:

RETURN only will
Enter either I for “I/O“ or M for "Memory Mapped Entering
m selection if
pmvmu
tm
default to "I/O" fman m.z.tml mmallatmm or to
re-installing a WordS

‘

md status mrts,
The remaining * detemme the mput and mxtmt data
tion in the
informa
my
necaw
the
and the status mtsm If possible, find
information
the
accept
INSTALL
have
technical manuals for your computer, and
ses to
addres
or
s
number
mrt
the
ine
from you. However, if you cannot determ
bits,
status
the
ine
determ
whmch your printer is connected or you cannot

NSTALL may be directed to attempt to determine the necessary mfmmatwn at

each of the fmllewm@ steps.

the mfomatmn
The determ:me funcnm ma.y not succeed in cmmctly identifyingnot
successfully
is
n.cm
in all cases (INSTALL may report failure if the mfwrmat
could not
that
r
WordSta
determined, but coulc'fl report success yet produce a
you to
ing
(requir
print). Further, INSTALL may lock up your computer system
Deteritems.
ing
rebout) during its attempt to d@texmme one mf the follow the information
ing INSTALL to accept
mining the information yourse:
from you is always Weferahle to havlw [NSTALL attempt to detemme the information.

(DOR A): D

WordStar Instaliation Manual

4-1

Section

Installation

Procedure:

Port

Driver

The next question allows you
to specify whether you wish
INSTALL to attempt to
determine the output port
to which your printer is
connected, or you wish
INSTALL to accept the port
number or address from you:
WEAT IS THE OUTPUT PORT FOR YOUR PRINTER?

‘

DO YOU WISH WORDSTAR TO DETERMIN
E THE VALUES OR SHOULD
WORD
ACCEPTST
THEM FROM
AR
YOU (D OR A): §

mmmmsrasmmmm
RINT

WHEEI

RIBBON

MUST

mmm, WITH PAPER FILLED,

INSTALLED

;

THE

COVER

MUST

On many specialty printers
(NEC, DIABLO, etc.) not only
do you have to have a
ribbon in the printer, but you
have to have enough to print
(especially with
the non-cycling carbon ribb
ons that can be used only once
); otherwise, the

In addition you should note tha‘t‘ if

the baud rate is wron

g, the printer will
usually print jumbled informat
ion, as well as issue odd nois
es; this usually
means that the port currentl
y showing is the correct one
»
but
that the baud
rate is incorrect (meaning the
baud rate set at the computer
does
n't match the
baud rate set at the
printer).,

Type A if you wish to enter the port
number
or D to have INSTALL help determin
e
the port number.
Pressing RETURN only will defaul
ttoA.'Mnotedabove, A is
preferable whenever you know
or can find out the port number,

If you entered A, INSTALL will
ask you for the port number:
What is the OUTPUT port number in
HEX: B

Enter the value as a Mxmcimal number,

entered value,

or press RETURN to keep a prev

iously
If you are not sure of the valu
e, consult the technical manu
als

for your computer, or try lett
ing INSTALL determine the valu
e for you by

answering D at the preceding
question,

If you entered D, INSTALL will
display a message prompting you
to remove the
diskette(s) from the disk driv
es. This is due to the fact that
while testing
ports to determine the
printer output port,

INSTALL

may

access a port used by
the disk system. Please follow
this instruction carefully.
REMOVE THE

DISKETTES,

INSTALL will tell you when it
is safe to re—i

nsert them, INSTALL
will also remind you that your
printer must now be connected
to the computer,

turned on, and ready to oper
ate.
print on it.

This is because INSTALL is
about to try to
|
~

4-2

WordStar

Installation

Manual

Installation Procedure: Port Driver

Section 4

Next, INSTALL will start outputting characters to a port and display the
following prompt:

where pn represents the port numbe

INSTALL is outputting characters.

If your printer is idle, tym I md INSTALL will try the next port. Wait a
few seconds and press N again if your printer is still idle. Keep pressing N
until characters mm to print. When your printer starts printing, press Y —
the correct port number has been found. (During the process of finding the
printer output port, characters may appear on your terminal. mmegard the
characters and press N to try the next port.)

mdbi.m (whereby erdStar can tell when the

t another ci afactw) must mdetermined.
determine

INSTALL will

or allow you to enter

etermine tm information. If you type
whenever ¥«
A
e
s
u
jain,
D, INSTALI will
e port number and bits, and will display
themmults. Any I“activ& atamm poxt between tha bottom mf pm:t addremmg
is
val printer port may cause erroneous port assignment. This
(608
80 ofiten the case that this"DETERMINE" function ia not as wmful as it might

seenm,

If you type A, INSTALL will ask the follmcinq three questions.

If in doubt

about the correct answers, study the technical manuals for yourcomputer or try
typing D instead of A.

What is the OUTBUT STATUS port number in HEX: B

ge(s) from a @ to a 1 (enter HEX value): N

Enter a hexadecimal number with 1 bits in the positions corresponding
to statxm bitm that are 1 when the printer is ready, and @ bits for
bits that must be @ or are insignificant. Umually, the answer to
this question is the same as the answer to the precedin

WordStar Installation Manual

4-3

Section

Installation

Procedure:

Port

Driver

After these prompts from INSTALL have been
answered, either via the DETERMINE

function, with data from your tech
nical manual or with “educated guess
es”,
INSTALL will ask you to confirm your
selections by displaying the foll
owin
g
prompt :
|

IF YOU WISH TO RETRY THIS OPERATION ANSWE
R “Y" TO THE "OK Y/N"
'QUESTION BELOW.
YOU MAY ABORT INSTALATION WITH A CONTR
OL C.
K

(Y/N): Y

Answering

'N' rather than 'Y', as shown above,
will cause INSTALL to return you
to the beginning of the OUTPUT PORT insta
llation sequence and you may correct
or change any values which you feel are
erroneous,

If you chose NO communications proto
col, supplying a 'Y' response to this
confirmation question will complete insta
llation of the port driver—proceed to
the next subsection (*Bypassing the Patch
ing®).,
If you selected a protocol,
[NSTALL will
ask a series of additional questions
to permit inputting from as

well as outputting to your printer,

INFUT DATA FORT

The DATA INPUT PORT is the port number

(or mapped address)

WordStar receives characters from the
printer,

in use.

port.

through which

as required when a protocol

This port is frequently, but not always, the
same as the output data

We will not take a step-by-step appro

ach to this set of prompts

since
they are nearly identical to those outli
ned above for the OUTPUT PORTS.
INSTALL again asks whether to Determine
or Accept the information,

then asks

for the port number (if you typed A) or
displays the results of its deter- mination (if you typed D).

Note that INSTALL will be able to determine the input
port only
onnected
connect
ed
printer is actually capable of and set
up for

for use by WordStar at the PROTOCOL MENU.

the protocol

if the

selected

It is possible that INSTALL will report
failure when attempting to DETERMINE
the values and bits for this operation
irrespective of the correct
configuration of your printer and WordS
tar.
In such cases it is possible to
force the DETERMINE function to return correc
t values,
If your printer has a
keyboard, try typing characters on the print
er keyboard while INSTALL is

attempting to determine the input data port.

If your printer does not have a

keyboard and you have an extra terminal or keyboa
rd available try substituting
this in place of the printer temporarily.
Now typing something at the keyboard
while the DETERMINE function is operating may
successfuly return the required

port number and status bits.

When this operation is complete you will,
of

course, want to replace the printer
on the port.

Finally, the input status port and bits (wher
eby WordStar can tell whether a
character has been received from the pPrint
er) must be determined.
Again,
INSTAL

L will ask whether to attempt to determine
the information or to accept
‘the information from you; the dialog and
reservations are similar to those

described above for the output status port,

4-4

WordStar

Installation

Manual

Testing WordStar

Section 5

Section 5
Testing WordStar

When WordStar is invoked--either as automatically occurs at termination of
INSTALLation, or when you type WS (or whatever file name your installed
WordStar is saved on)—WordStar
should dumr1mm:mxwmxamfléuqm@yauaumWfln
showing the WordStar release and serial number and the terminal, printer,
protocol, and printer driver choices you made at installation.

After several seconds (or as soon as you press any key), the no-file menu plus
the names of the flles on your diskette should display, like this:

/WW
*#

<<<

NO-FILE

% * preliminary Commands * *

L Change logged disk drmve
F File directm:y
D

leve

off (ON)

* |*

File

>>>

Commands

P Prmnt a file

Rename a file

<%@y

file

Y‘lkflaUaaifile

*|* System Commands *

|[RRun a program |
|[X Exit to system

}*kadmwx(xmumm**

'
bov
- symbol B represents the cuxsmr pmsxtlan.
If
hlghllghtmng is 1nstalled, the words displayed will be highlighted; if inverse
video highlighting is in use,
inverse video boxes will be formed around the
:mmuamdtmflgmmumau:MM&mm?mftmmsmmmm.

TESTING CURSOR POSITIONING

= % * % % Ek@hmmmmy

nands

.DOC

(HAPTR3.BAK

% l *

Flle

Commands *|*System 05?\

+ DIRECI'ORY Of dlsk A:

'mcrz «DOC

BAK CHAP
~ CHAPTRI.
CHAPTR1.DOC
CONTENTS.BAK
ENTS.DOC
CONT

Tmz RAK

with the lines run tfogether and random punctuation between lines, then the
cursor positioning control codes are not working.
Check your terminal documentation and the setting of all option switches on the terminal, and reinstall

WordStar or correct your terminal as required.

WordStar

Installation Manual

5-1

Section

Testing

WordStar

CHECKING FOR THE MESSAGE FILE

If you get

editing no file

eeee x

;

messages will display as @@€e only.

Pile WSMSGS.OVR not found.

Menus 't‘.

}

|
I

I
|

then the file WSMSGS.OVR, supplied on the distribution
diskette, has not been
copied to the diskette in use (or the diskette is neither
in drive A nor in the
logged drive). This file should always be on the disket
te in drive A, or the
diskette in the logged drive (or both), when WordStar is in
use.
Type an X to
exit from WordStar and return to the operating system, copy
WSMSGS.OVR to
diskette in drive A (or the logged drive) (the command PIP
is used to copy
files in most CP/M operating systems), and invoke your
installed WS again,

~ TESTING THE ERASE FUNCTION

Now (at the no-file me’nu, which should still be on the _sc:reen) type D.
should get:

You

~
editin
! D
no file
g
I
Use this command to create a new document file,
l
|
or to initiate alteration of an existing document file.
l
l
A file name is 1 to 8 letters/digits, a period,
l
and an optional 1-3 character type.
l
File name may be preceded by disk drive letter A-D
l
and colon, otherwise current logged disk is used.
l

“S=delete character
|
“Y=delete mtty “P=Pile directory
“D=restore character “R=Restore entry “U=cancel command
l
|
l
l
I DIRECTORY of disk A:
|
EXAMPLE.TXT
I
INSTALL.COM
PIP,.COM
STAT,COM
| WS. COM
WSU.COM
WSOVLY1.OVR WSMSGS.OVR
l

|
|
|
|
|
!
l
l
l
|
l
|
|
|
|

If parts of the no~file menu (what was last on the screen) appear where
there

should be blank lines,
working.
'

5-2

then an erase to end line code is installed but not
|
|

WordStar

Installation

Manual

Section 5

Testing WordStar

ttm the file WSOVLY1l.OVR, mwl:.ed on the distribution dimkette, has not been
ww the dwkatte;in,we (ar
‘ dmkette m neitlmr; drive A nor in the

ess

the

RETURNkey.

The no-file menu

diml. with the r.wt of the screen clear.
Type D to again obtain the last screen shown.

Answer the question NAME OF

'NEW FILE
willbe addm to the screen mwlay.

Afte: several seconds, the screen display

(9::..1

W!mlmlwlm

\
TESTING THE EDITIHG FUNCTIONS

Type a few words.
'I'hw should appear on the screen line below the “ruler® (the
line with the -'s and I's); they should not be m.ghlighted, the cursor should
move right as you type. If the cursor does not move, the “column® portion of
the cursor control codes is not functioning.

WordStar

Installation

Manual

5-3

Section

Testing

WordStar

Type @ “J ("J on the screen menus and in this manual means
to type control-J,
that is, hold down the CTRL key on your keyboard and press
J).
After a second

two,

a different menu should appear.

The top line of

“ruler", and the words you typed, should remain.,

the screen,

the.

If portions of the previous

menu remain to the right of the new, narrower one, then
an erase to end line
code is installed but not working. Press the space
bar to return to the
previous menu (the main menu).

Now type sevaral"lines of text.

Gibberish is OK for our present purposes.

WordStar will "wrap" the line for you if you type beyond the
R end of the ruler
without using the RETURN key; this is the normal operation of
word wrap.

It should be possible to move the cursor around within
the text you have

entered, using "E to move it up, "D to move it right, S to move it left,
and

"X to move it down.

Try it.

Recall that " means to hold down the CTRL key

while typing the following letter,
Type a control-Y.

;

The line of text containing the cursor should disappear,

and

the following lines move up.
This tests the “delete line" control code, if one
is installed. Type a control-N. A blank line should appear, with the
lines
below the cursor moving down. This tests the "insert line” control
code, if
one is installed.

ADDITIONAL TESTS FOR HIGHLIGHTING
Type a control-K.

A different menu will appear.

Type
a B (or

a b or "B).

The

original menu will reappear, and “" will appear at the cursor
position.
The
 will be highlighted if you have installed highlighting.
The characters on
the line to the right of the cursor will move right three charact
ers to make
room for the .
Move the cursor forward a few characters (D) or down a line
or two ("X), and type "K twice. The menu may not change, dependi
ng how soon

you type the second “K.

If no highlighting is installed, <K> will appear at the
cursor position., If
high-lighting is installed, the characters from the position of
the to the
posi-tion where “"KK was typed should highlight - display in
inverse video, or
dimmer or brighter than the rest of the screen.
The should disappear.
(What you have just done is "marked* a “block” of text, as in preparation
for a
block move or block copy command.)
If the disappears but the characters do
not highlight, then inoperative highlighting control codes are
installed.

Check the codes and reinstall if necessary;

if they can't be made to work,

remove them so the and <K> will display.
Another possibility (if you are
using bright/dim highlighting) is that the contrast or brightne
ss on your
terminal are set such that bright and dim characters are indistin
guishable,

Now type "K.

A new menu will appear.
SAVING

FILE

Type aD (or d or “D).

The message

A:TEST.DOC

should appear.
This saves the entered text on the disk, so that you can try
printing it.
Whenever text is entered or updated with WordStar, it is necessary to save it in order
to keep it permanently, or to print it.

After the

save is complete (a few seconds), the no-file menu should reappear
, as shown
above.
A
IR
|

5-4

WordStar

Installation

Manual

Section 5

Testing WordStar

TESTING THE PRINTER

To test the printer installation, type a P at the no-file menu. WordStar will
ask you for the name of the fxle to print; enter TEST.DOC or whatever you
called the file. Press the RETURN key. Several more questions will be asked;
just press RETURN at each one for now.
When Ready printer, press RETURN
appears, make sure your printer is turned on and on-line (whatever your

particular printer needs to be ready for use), then press any key. The text
- you entered should be printed, then the paper should feed to the bottom of the
page and a "1" (page number 1) should be printed.

You may now delete (erase) the test file you entered, by typing a Y and
answering the question NAME OF FILE TO DELETE? by entering TEST.DOC (or

whatever you called your file) and pressing RETURN

To return to the operating system, type an X at the no-file menu.
prompt A> will appear at the bottom of the screen,

WordStar

Installation

Manual

The system

5-5

This page intentionally left blank.

WordStar

Installation

Manual

Custom

Section
Terminal

6
Inatallation

MODIFICATION BY PATCHING
General

Description

Modification by patching is used in installing WordStar for terminals not
included in the installation menus (Section 3) and for printers that require
special control strings or modifications to one of WordStar's printer drivers,
and for achieving refinements in installation, such as supmrtmg specml
features of wpecific mn-dawyprinmm, cimumvmtm
DEL.ETE-h:ck pac

fwtum 0f cm:min operati

sten

Since basic

ieved

installation

enabling

displ

Sections 2-5, w users should mt need to patch.
"Patching” means modifying WordStar by chanqing tm contents of bytes in

ws.mu.

Patching may be ammplwhed m.th INSTA

pm:cher

(aa demnbed in

""mnt pmml witchem Sectima 6, 7, and 8 uf thw manual are pmmarily for
Lhose who already understand patching.

Listings in

Appe

Appendices E and F c@nt.ain absolute ammmbly listings of two user-patchable
portions of Wor: »’*’f*tar,USER] and USER4:

USERL w the module cmntmm.nq all terminal-installation related

patchares

USEM

contains

all

printer-related

patch

items for

non-daisy

printers, plua many used for both daisy and non-daisy printers.

The listings are commented hmwly, read them fm' a detmled description of
each item.
The following mwgmy
S give generaldescription of the modules,
and hit a few high points of the details, but do not att@mpt w duplicate the
detailed information contained in the program comments.
Note that the
addresses provided in these listings are correct for the revision of WordStar
specified on the listing and not necessarily for any other.
Where LABELS: can
be used,

independence from revision-dependent locations is provided and is

therefore demmble..

Modification of the tmmmal patch area is used for these purposes:
o

to install WordStar for a terminal or video board not provided for in the
INSTALL progmm

to achieve a dififiemnt installation for a terminal that is on the menu

(e.g., to reverse the sense of bright/dim highlighting to suit individual
preference)
|
)
WordStar

Installation

Manual

6-1

Section

Custom

Terminal

Installation

to achieve refinements in J.nstallatmn, such as permitting display in the
last character position of the last line of the screen or disabling some
operating systems' backspace-on-rubout “feature" that interferes with
WordStar's screen updating
~

to drive a terminal device which is not accessible via the operating
system,

Installation fara‘remmal

Not Shown an Terminal
Menu

WordStar can be installed for most terminals by determining the terminal's
control codes as discussed in this section, then making patches as discussed
later in this section (“Terminal Patch Area").
Unusual installations, such as
direct Storage access to a video board, or use of a terminal which cannot be
accessed via the operating system, are descrlma in the next subsection (*Video
Boards and Custom Terminal Drivers").

To be used with WordStar, the terminal must have a screen at least 16 (and not
more than 120) lines high by at least 40 columns wide, and have the capability
to place the cursor at any position on the screen upon receipt of a suitable
control sequence from the computer.

Desirable, but not essential, additional terminal features include line insert,
line delete, and/or erase to end line -- these may speed screen redisplay
during editing — and inverse video, bright/dim, or some other form of character-by-character highlighting — highlighting allows WordStar to differentiate
the menus and questions from the text of the document being edited, and to

highlight the “marked block" of text that is to be moved or deleted..

The first step in installing WordStar for a terminal not on the menu is to
study the terminal manufacturer's manual to determine the screen size and the
control codes which WordStar must transmit to the terminal to accomplish the
various functions.
Additional discussion of each required and optional
function follows; patching the codes into WordStar is covemd later in thzs
section ("Terminal Patch Ama") .

Positioning the cursor is the most complex terminal function used by WordStar,
since it involves transmitting the row and column at which the cursor is to be
placed. The form of the control string sent to the terminal to position the
cursor varies widely from terminal to terminal; WordStar's cursor-positioning
patch items are designed to accommodate almost all commonly used forms.
For
these reasons, it is necessary to analyze your terminal's.cursor-positioning
sequence to derive the information needed to patch WordStar.
Some terminals have a single control sequence to position the cursor at a line
(row) and column (character) number; others have separate control seguences to
position the cursor on a line and at a column; either will work with WordStar.
In the former case, the terminal may require either the row or column transmitted first.,
For some terminals, the line and column numbers are sent with no

6-2

WordStar Installation Manual

Section 6

Custom Terminal

Installation

offset, that is, a zero is sent for the top line on the screen (or left
column), a one for the next line down (next column over), etc.
For others, an
"offset" is added.
For example, several terminals require 280 (hexadecimal) for the top line or
left column, 21 for the second line (or column), etc.
For most terminals, the
row and column are sent in binary, with a single byte (character) transmitted
for each; for a few terminals, the row and column are each sent as a two- or
three-digit ASCII number, with a character (ASCII “@" thmugh "9") transmitted
for each digit.

Analyze the cursor positioning codes for your terminal, as described in the
terminal manufacturer's manual, and determine:
1.

Number of characters and character values that must be sent before
either the line or column is transmitted.

Whether the row or column is transmitted first.

Number of characters and character values that must be sent after the
row (or column, whichever is sent first), and before the other
dimension is sent.
For many terminals, this is no characters.

Number and values of chatmtam to send after both row and column, if

any—usually nmne.

Offset to add to Iow number—-vusually zero or 20 hex.

Offset to addw colmnn numb n ~usus 7 ‘ly;mmef as for row.

Whether row and column are sent as mnglawbyta binary value (the
usual case), or multi-character ASCII number. If ASCII, determine
the number of digits—ususally two or three,

«Jmm?wmw
LB
R NN

Termmnal requires, in mrder, 1B hex, 3D hex, line number plus 28 hex, column
number plus 20 hex, to set cursor position. The msfwem to the above questions
are as follows:

2, m, 3D
Row is first
-

~None

None
280 hex

20 hex
Binary

Terminal requires 1B hex, @1 hex, line number to set cursor to line, and 1B
hex, 82 hex, column number to set cursor to colwm. The above questions may be
answered as follows:

WordStar

Installation Manual

6-3

Section
l.
2.
3.
4.,
5.
6.
7.

Custom

Terminal

Installation

2, 1B, 01
Row is first
2, 1B, 0@
None.
0@
©
Binary

sJG‘tU‘lfhuNH

To position cursor, terminal requires, in order, 1B hex, 43 hex, column as 3character ASCII number (with leading zerces), row as 3-character ASCII number.
The answers to the above questions are:
-

2, 1B, 43
Column is first
None

None
g

3=digit ASCII

The answers to the above questions provide the information necessary to patch
WordStar for your terminal's cursor positioning control codes; application of
this information is covered later in this section (*Terminal Patch Area").

If you have an extremly unusual terminal, you may find that it is not possible
to analyze its required cursor positioning commands into answers to the above
seven questions.
For such cases, you must write (or have a programmer write) a
subroutine to generate the necessary cursor positioning command sequence;
installation of this subroutine is covered below ("Terminal Patch Area").

We also recommend determining the codes to invoke highlighting, if available,
by inverse video display, bright/dim display, or some other method. If both

bright/dim and character-by—character inverse video are available, we suggest

inverse video, as it will highlight blanks as well as other characters, and

stands out strongly.
The highlighting method must operate on a character-bycharacter basis, take no screen positions, and not be tied to field protection.

Determine the code or code sequence to turn highlighting on, and the sequence
to turn highlighting off.
The “Highlighting on" sequence should cause
subsequently transmitted characters to be highlighted until a “Highlighting

off" sequence is transmitted.
WordStar always turns highlighting off before
transmitting a carriage return, line feed, or cursor positioning sequence;
therefore, it does not matter whether or not these functions cancel highlighting on your terminal,
|

This function blanks all character positions from the cursor position to the
end of the current screen line.
|
|

6-4

WordStar

Installation

Manual

Section

Custom

Terminal

Installation

This function should delete the entire screen line containing the cursor,
moving the following screen lines up one line.

;

sh ~ insert a blank line on the screen at the line containing
the cursor 1ineand fmllawmg
es down
on

After datemming your termlml‘a contml codes, pmceed to "Terminal Patch
Area® later in this section.

NO
|
rmally
accesses the terminal by inputting and outputting characters
via the opemting wamm (dir:m:t jum@ to the "BIOS" entry points are used).

However, two variations

supported: direct storage into amemory-mapped

video board for output, and cwtnm umr«-amplwd subroutines for imt status,
and/or output. These variations are of interest only to users with unusual
stallation requirements; most readers may skip directly to "Terminal Patch
Ama“' lat:er in this section.
|
|
o
,

emory

mapped

accessible(including cursor positioning) through

the operatmg 3yatem ctmracter mtput calls may be installed as any other
terminal is installed; you may proceed as described in th.w mtlm ("Imtallam
tion for a Terminal Not Shown on Termim Menu" and“Terminal
1y Ar

mex, WordStar can acces
ry-mapped vxdeo display boards meeting certain
restrictions by awring dzrectly intmthe video mmmry area.. Such direct
fi?nge results in superior

mance

‘extrmely fwtscreen

upda

line deletz,m, and
exam wmd l%m w:.thout the mmd of cmntml codw for
these fmwtiem.

dirm: -storage ac

eo0 bo.

makes

Each character position must appear as a location in memory, contiguously from a starting address.
The first line must begin at the
starting address, the second line must immediately follow the first,

etc.

‘urth i.,r,

The lmea must always be full lmth WordStar will blank-fill

Highlighting, if used, must be invoked by setting the high order bit

of each character to be h:.ghlmght:ed. WordStar cannot invoke highlighting in any other manner while storing directly into a video
board.

When accessing a memory-mapped videoboard on a dlmct st:omge basis, WordStar
can position the cursor either with the control code sequence or user-installed
WordStar

Installation

Manual

6-5

Section 6

Custom Terminal Installation

subroutine (as for a terminal), or by setting the high order bit in memory
of
the character under the cursor.
Highlighting can be produced by setting the
high order bit; this produces inverse video on many boards.
If the high order
bit is used both for highlighting and for cursor display, WordStar can blink
the cursor to make it stand out when it is on or adjacent to highlighted text,

Even if cursor display is by high-order bit, a cursor position code sequence or
subroutine should be installed, as WordStar uses it to position the cursor at

the bottom of the screen at exit, and to initially get its cursor and the
extern
known
ally
cursor in the same place,
=
|
~
To Install WordStar to access a memory-mapped video board meeting the restrictions described above on
a direct-storage basis, patch locations MEMAPV,

MEMADR,

HIBIV,

HIBCUR,

and CRBLIV as explained in the associated comments.

Note that the cursor positioning items as used for a terminal should always be
patched even if HIBQUR is non-zero. Note also that there is a page of comments
near the end of the listing giving installation suggestions for video boards

which do not meet the requirements for direct-storage access and which cannot
conveniently be accessed via the operating system.
Use items SWIN and SWOUT if
it is necessary to switch the board into the address space before access and
switch it out after access.
|
e
|

For video boards that are not always addressable, WordStar can switch the board
into the address space before storing into it and switch it out after each
access, provided
“switched in".

the board occupies addresses above about 8888 hex when
|
|
|

Custom installation for direct-storage access to a memory-mapped video board is
accomplished by patching; proceed to "Terminal Patch Area.TM

Custom subroutines may be installed by the user for console input, console
status (character ready), and/or console output.
Such routines may be used to
access a terminal device not accessible through the operating system and which
1s not a memory-mapped video board meeting the requirements given above for
direct-storage access.
For example, a memory-mapped video board with noncontiguous lines or variable-length lines (disallowing direct-storage access)

and no cursor positioning control codes (disallowing access through the opera-

ting system) might be driven via a custom console output subroutine which could
interpret control codes as required.
The patch locations and calling sequences
for these routines are given in the USERl listing in Appendix E, as discussed
below (“Terminal Patch Area").
'

All patch items relating to terminal I/O and terminal control codes are in
program module USER1, as listed in Appendix E.
Many are set by the INSTALL
program (thus, INSTALL should be run before, not after, patching, if you patch
with DDT).
Additional items can be changed only by patching.
Each item is

identified and explained in detail by comments in the listing; the following
discussion corresponds approximately to the order of items in the listing.

Note that all character strings to be sent to the terminal (erase to end line,
etc.) have the number of characters to be sent in the first byte, and the

characters to send in following bytes,

6-6

WordStar

Installation Manual

Custom Terminal Installation

Section 6

An eazlmr subseetmn (*Installation for a Terminal Not Shown on Terminal
scussed

nu")

ure.

requirements and information to be obtained from the terminal

anual before making a custom terminal installation; read that

mctmn first ifyw have not already read it. The locations into which to
atch terminal-related items are clearly identified by comments in the USER1

lwtmq. The first two items in the listing are the locations into which to
patch the screen height and width; following these are locations for cursor
control string specmlcatxon as analyzed per the seven questions given earlier
in this secta.m.

There is provision (itam JCRPOS) for cursor positioning by an alternate me

’I'he callmng

calling a subx:outim wrztten and "patc:hed in by the umm
begixmm of mrwn m c:m:mr mitim.

;

Space for the optional erase to end line, delete line, insert line,
Spaces for strings to
hs.ghllghtmq on, and hxghlmhtiw off strings is given.,
,

erminal at startup and at exit are provided, to allow special

initmlmata.m or mode selecticn and deselection; there are also provisions for
supplied aubwutmm which are called at startup and at exit.

A flag, USE‘LST, is pzovided in USER1 which may be patahed non-zero to enable

display in the rightmost column of the last line of the screen, making the
|
"flag” chm:acter for: this lme dxmlay.

SCre

cept

direct memory accmm tm a video

boa

many terminals autor ‘twally mrrmge return after display in the last column
of a line, scrolling the screen up a line if it was the line at the bottom of

the screen.

For some terminals, mmll;mg after display in the last character

pomtwn on the screen can be disabled via an optmn switch {Wammy called

ETURN") inside the terminal; for others, such scrolling can be disabled

via a mode selected w:.th a control chmacter string sent f:mm ‘the computer.

If you have a terminal which does notscroll aftm dmplay in the last
character pomtim, or has been mnfmgumd thus, patch USELST in USER1 (see
listing in Appendix for address) non-zero to see the "flag” on the last file
line displayed. If a mode which does not scroll after display in the last
character position can be selected by a control sequence sent from the
computer, the initialization string TRMINI may be used; the exit string TRMUNI
may t:hen be used to m@tox:e the normal mode fm: amwmmc& whm um.ng other
.. a aftar am.tim frWardfitm:..

WordStar

Installation Manual

Note: it doesn't matter where

LSO

6-7

Section

Patchable FPunction Delays

Custom Terminal

Installation

(DELCUS and DELMIS)

Patchable function delays, DELCUS and DELMIS
, are provided
for use after the
terminal functions indicated in the listing,
These are present because many
terminals lose characters if character outpu
t occurs too soon after cursor
positioning or other functions. The defau
lt values are sufficient for most
terminals; INSTALL increases and decreases
them as necessary for certain
terminals on the menu.
For custom installations, you may need to patch
longer
or shorter delays as explained in the comments,
|
Usually it is best to get these delays to work
before implementing any of the

“unnecessary functions” (functions other than
ABSULUTE CQURSOR POSITIONING and
SCREEN HEIGHT and WIDTH),
Get the terminal to work reliably (meaning charac
ter's don't disappear and meaningless characters
don't appear) by increasing
the DELAYS. Start by varying DELAY AFTER CQURSOR
SET (DELQUS:).
Try increments

of 18 hex bytes until the terminal stops being errati
c.

This will get all the

spurious characters problems about 8@ per cent
of the time.

left over can usually be "fine-tuned" away by varyin
approach outlined for DELCUS:.

Those problems

g DELMIS: using the same
|

Once the “grossest" gross values for DELMIS: and DELCUS:
have been determined,
reduce DELCUS: until the problems just start to
reappear. Next raise this
delay 6 or 7 increments.,
Do the same thing for DELMIS:.
Next, install the highlighting functions (if
available). This can often
require that the DELAYS (either one or both)
be increased several times the
value required without highlighting them.
Sometimes the terminal becomes so
slow before highlighting will work properly that
the user will have to decide
whether or not highlighting is wcrthwhile.

Finally install ERASE-TO-END-OF-LINE,
INSERT-LIN
and
E DELETE-LINE FUNCTIONS,
These are supposed to speed things up, Sometimes
they do and sometimes they
slow things down (i.e., DELCUS and/or DELMIS have
to be increased to get the
display acceptable when any one or combination
of these functions are
As a rule of thumb, use only those which speed up operati
on. If any one of -the
special functions slows things down, do not
install it (them) and let the
software do that function instead,
|
S
|

If any of these functions or combination of these
functions resulted in a
significant increase (10 or more decrements of DELMIS:
, 20 or more decrements
of DELLUS:), it may be time to try the HIGHLIGHTING FUNCTIO
NS again (assuming
they slowed things down and they were left outg in
the previous step).
Sometimes, when these functions actually do speed things
up they can have a profound effect on the operation of the HIMIMM
ftmctimm.

Note that “sufficient” may mean acceptable to the general user,

but tweaking

for maximum performance is the American way and is more
often than not possible
and effective,
,
o
|
|

6-8

WordStar

Installation

Manual

Custom Terminal Installation

Section 6

When a command is Mmg entewd to the operating systen

key is used to erase the last character entemd, atandard CP/M echoefi the
character erased. A number of manufacturer's and distributors variants of CP/M
1.4 have a modification added in the I/0 patch mctwn of the system ("BIOS")
to cause tha DELETE key to emm the chamctm on the screen instead of echo
This modification works by outputting
sopy of thecharacter erased.
of the next character output after a
p.laca
m
backspace"
space,
"mckspm:e,
E is mput.

mands, thjs feature interferes
after

a DELETE

chm:actem, when you um the DELETE key whlle inputtm a system command

|
~
if thescreen line containing the cursor is not correctly updz
the DELETE key while Edltim with WordStar, or
- cursor 13 mlfiplmed after
use of the DELETE my, thm your ystem has the DELETE -backspace “feature” and
this “feature” mwtbe disabled for mrrect gcreen updating in

WordStar

Examine the code of the BIOS (1/0 pat:ch) section of your symam (Listings of
this portion of the system arenormally supplied, or available on request, or

you may poke around with yout debugger without a listing) to determine how your
DELETE backspace "feature” workm a.nd apply one of the following methods to
disable it

Many DELETE-backspace mplementatwm set a flag whm a DELETE is input, or

just store the last chamcter nput, in a fixed memory lmtim, then @ubstm

tute ‘backspace, space,

backs

‘

by
is input. Such implemantatiam can be diaabled when WordStat is runnmg
is non-

patching the address of this location into USER1l at ZAFCIN: if ZAFCIN

zero, the location it points to is Zeroed AFter Character INput by WordStar.

For example, S. D. Sales and Diqital Microsystems' vemmm of CP/M, among
others, store the last character input in lmtim 4F
4F pxwmts the DELETE-backspace feature in th@m
- screen umatim after the DELETE
dSt

Pat hi. g ZAch to

These USER1 locations may effect a partial fix to the DELETE-backspace problem
in cases where ZAFCIN cannot be effectively applied. If RUBFXF (RUBout FiX
Flag) is patcmd non-zero, then the contents of RFIXER is output immediately

- after a DELETE is input.

Put a relatively harmless character in RFIXER - try

WordStar Installation Manual

6-9

Section

Custom

Terminal

null (8@ hex), backspace (88 hex)
, or space (28 hex).

Installation

When this char

acter is
output, your system will repl
ace it with "backspace, space
, backspace"; this

will have less deleterious effect
than changing the beginning of a
subsequent
cursor positioning string to "back
space, space, backspace".
The
results will
probably be a single blanked scre
en position, instead of an entire
messed up

line and a misplaced cursor.

Qustom Console Driver Routines
Items UCNSTA, mx,

and UCONO allow installation of custo
m termi

nal 1/0 routines to be used in lieu of calls
to the operating system's “BIOS* entr
y

To facilitate special video board insta
llation, the custom terminal output
routine (UCONO, as detailed in the
listing comments) receives the foll
owing
informatio

n: character to be displayed (with high order
bit on for highlighting
if HIBIV is patched non-zero), IOW, colum
n, number of character positions from
beginning of screen to cursor position,
and number of character positions from
beginning of screen to beginning of scree
n line containing cursor.
|
Note that the custom terminal chara
cter input routine (UCONI) may

be called
whether or not the status routine (OCNS
TA) has already indicated that a
Character is available, despite a comm
ent to the contrary in a prior release
USER1 listing. Thus, your UOONI routi
ne must include code to wait if necessary
for a keystroke.
i

Items DELl through Dm ’allow control over the delay times

used within WordS

tar
to blink the cursor, hold the sign-on
on the sCreen, etc.
You may wish to vary
these to accomodate your CPU speed or to suit
your preference,
|

Near the top of page 15 (Appendix E) are
three specialflags, 'msms,
TRSCIF, and HETHBS.
These do nothing in normal WordStar;
they are
active only in special versions, and are appropriately set by the
s.
version
those
with
d
supplie
INSTALL program

Patch Space for Added Subroutines
Items UCRPOS, INISUB, UNISUB, and others
allow for a user-added subroutine;
however, space is provided at
se
items for a JMP instruction only. There
is
space for a considerable amount of code
at MORPAT, on the last page of the
USER] listing.
If more space is needed, go to the free memor
y area, as pointed
to by the actual contents (examine with DDT)
of PBGMEM
at the end of USERl.
If
you
make additions there, be sure to patch
PBGMEM to point beyon

d your addi-

tions, and be sure to determine and use the
necessary SAVE command size — note
that there are several thousand bytes betwe
en the normal end of the .COM file
and address contained in PBGMEM,
|
,
Patches in this area must be made with your
debugger (DDT); INSTALL's patcher
will not correctly make patches in this
area. Also, if you operate on your
WordStar with the INSTALL program after adding
code at the end, you will need
to redo your additions — INSTALL will delete
any code beyond the normal end of

WordStar,

6-19

WordStar

Installation

Manual

Section 6

Custom Terminal Installation

Review Section 5 (“Testing WordStar®). That section shows various correct and
incorrect screen displays, and gives likely causes of the incorrect displays.
The tests given there will help you determine whether your installation is
functioning correctly, and, if not, which patch item is most likely at fault.

WordStar Installation Manual

6-11

The Page Intention
Left
all
Blank
y

WordStar

Installation

Manual

-~ Section

Custom

Section

Printer

Installation

Modifications in the printer patch area Me used to support optional prmter
features, to install unusual printers which are similar to, but not exactly,
"reletype-like", and to support communications protocols including specif-

ication of ETX/ACK message length.

Modifications in the printer patch area are

also used to handle unusual installation requirements with regard to the
transmission of characters from (as required by cmmmummtiom protocols,
Section 2) and to the printer.

This manual does not cover patching to support the features of daisymwheel
printers.
The INSTALL program performs complete installation to support all
available features of the common daisy wheel and similar printers (mcludm
NEC 5580-series, Diablo, and Qume printers). Patching for such prmtem is
extremely complex due to the interaction of many features and the require

of bidirectional printing, variable character width, and variable line height.

By puwhamng Cumwmimtim Notes, youcan proceed with such patching.
However, allaspectsof transmission of chamatem to and fwm mm.al daisy
wheel and smllm: ptmwware ammmbl@ and docum
The assembly listing of module USER4 in Appendis
*
nodif
relatmg to Teletype-like and other mn-dawy pmmers. amd all modifiable
‘items relating to transmission of characters to and from Teletype like printers
and serial daisy wheel and similar printers,

The rest of this section will follow the approximate order of items in the

USER4 listing, to facilitate relation of the text to the listing. Users making
an installation requiring a communications protocol (Section 2) will probably
be first interested in the printer drimr patch items; these are described
later in this section (*Printer Drivers").

Mm determines hmw ovex:printing, ~as required for bmldfme,
mderlme, backspace, etc. is acheived,

double stnke,

If POSMTH contains FF hex (as set by INSTALL
when “Myf Teletywmke Printer"®
is selected), WordStar will overprint by sendmg a carriage return code (see
item PSCR) followed by another complete line, wntain* g spaces in columns not
to be overprinted.
Several overprint lines for the same document line will be
sent if necessitated by the use of multiple e
or boldface.
If mm contains zero (as set by INSTALL when "‘ml@tym-hke Printer That Can
ckspace” is %lected) , Wordst: "r:' will overprmt: by backspacing (see item
PBACKS in the next subsection) then sending the character to be overstruck as
each character position requirinq multlple strikes is encountered. POSMTH=0
produces faster: printing than POSMTH=FF for printers that can backspace; also,
POSMTH=#

will allow printing underline,

boldface,

backspace,

etc.

on printers

that can backspace but cannot return the carriage without line feeding.

7-1

WordStar

Installation

Manual

Section

Custom

Printer

Installation

If any daisy wheel or similar printer is selected in INSTALL

, POSMTH will be

set to 1 and should not be altered.

Bold-Strike (BLDSTR)
BLDSTR contains the number of strikes of each character
used for the "boldface"

print enhancement.
For Teletype-like printers, it may be increased or decreased to yield darker or lighter boldface; for daisy wheel
and similar
printers it should not be altered.
;
|
|

Double-Strike (DBLSTR)

DBLSTR contains the number of strikes

(normally 2)

used for the “double strike"

print enhancement; it may be increased for darker "double strike"
or reduced to
1 for no double strike, on any printer type.
|
»

Patchable strings for a number of mandatory and optional printer functions
are
provided. Each string consists
of the number of characters, followed
by the
Character values.
When altering a string, make sure you set the number of
characters correctly.
The optional string items should have a zero “number of
characters" if the optional functicn is not installed.
Print

String:

Carriage

Return,

Line

This is the character string, normally “carriage return, line
feed," sent to
advance a non-daisy printer to the beginning of the next line. The characters
in the string may be altered as required
by unusual printers; the count may be
increased to send nulls (zeroes) (up to a total of 19 characters) after
the
.Character string is sent if the printer requires a delay while
the carriage
returns and the paper advances.

(PSCR—Print String: Carriage Return)
This is the character string, normally carriage return only, used to return the
carriage of a non-daisy printer to the beginning of the same line.,
This string
1s used to permit overprinting for underline, boldface, etc.
if POSMTH (above)
is FF hex; it is also used whenever a carriage return without a line feed
is

encountered in the document,

if POSMTH is FF or @

(see “Overprint Lines" in the

This is the character string, normally an ASCII "backspace" character, used to
backspace a non—daisy printer. This string is transmitted if POSMTH (above)
is

zero in order to permit printing a character in the same position as the

preceding character for underline, boldface, backspace, etc.

Note that i

POSMTH 1is not zero this string
is never transmitted and thus the printer nee
not be capable of backspacing.
|
VAT
,

T7=2

WordStar

Installation

Manual

Custom Printer Installation

Section 7

paper oneThis is a character string to return the carriage and advance the the
capabiwithout
half line, for non—daisy printers with this capability but
and
ROLUP
also
lity of advancing the paper backwards a fractional line (see
print
to
used
be
ROLDOW below). If installed, the half-line advance will
subscripts and superscripts one-half line below or above, respectively, the
|

rest of the line.

Example: If the printer advances one-half line for each line feed code sent,e
install the sequence “carriage return, line feed" at PSHALF and the sequenc
"carriage return, line feed, line feed" or "carriage return, line feed,
|

carriage return, line feed" at PSCRLF.

Note

The INSTALL Printer Menu selection "Half-Line-Feed Printers” sets
PSHALF and PSCRLF to the foregoing strings; this selection is other-

wise identical to the selection "Teletype-Like Printer that can

This is a character string to roll the carriage UP (move the paper down)anda
fractional line, for non-daisy printers with this capability. If ROLUP
ROLDOW are installed, subscripts and superscripts will be printed by moving the
carriage up and down in the course of printing a line.

If ROLUP (p‘receding) is installed, then the string to roll the carriage down
(paper up) a fractional line should be installed at ROLDOW.

A string may be installed here to set the printer to an alternate character
pitch (character width), for non-daisy printers with this capability. An
alternate pitch print control ("A; Reference Manual) in the document will then
invoke transmission of this string.

Note

WordStar contains the necessary logic to restore normal pitch while
printing page offsets, headings, etc, that were specified when normal
pitch was in effect.

If PALT (preceding) is installed, then the string to restore the printer to its

normal character pitch should be installed at PSID.

These strings may be installed to invoke otherwise unsupported special
a sheet
functions of your printer (e.g. changing character fonts or activating

WordStar Installation Manual

7-3

Section
feeder)

Custom

Printer

Installation

in response to the User Printer
Function print

control characters ("Q,
"W, "E, and "R, Reference Manual)
imbedded in your document. For
character
pitch changes, PALT and PSTD shou
ld be used in preference to USRI
through USR4,
If you have a daisy printer,
USR1 through USR4 control stri
ngs should be
installed with great caution, and
tested thoroughly, as complex inte
ractions
with WordStar's operatim of t,he
printer are :\;1kze'ly to occur desp
ite the fact
*

printer function control.
these controls;

For some printers, INSTALL may defi
ne one

check Appendix D with regard to your
printer.

or more of

These strings may be installed
by the user to allow selection
of alternate
ribbon color with the “Y print cont
rol (Reference Manual) on non-dais
y printers
with this capability; for daisy
wheel and similar printers, RIBB
ON
and
RIROFF
are set appropriatel
y by INSTALL.

This is a string transmitted to the
printer at the start of printing.,
For nondaisy printers, you may add any desi
red controls, (e.g., to turn the moto
r on
or select ‘a line spaci
ng or character pitch).

INSTALL puts

a carriage return
in this item; add your bytes and incr
ease the count appropriately.
For daisy
printers, this item is appropriatel
y set by INSTALL and should not be
altered.

NonrDaisy Finish String

(PSFINI—Optional)

Similar to PSINIT, this string
is sent at the conclusion of prin
ting,

PRINIT and PRFINI—Optional)

These are subroutines called at the
beginning and end of print

ing, respectively; they may be used to perform prin
ter assignment or special initiali
zation
functions that cannot be performed
by transmitting a character string.
Space
is provided for a JMP only; for find
ing Space to put your subroutine,
see
"Terminal Patch Area,* Secticn 6.
|
|
PRINTER DRIVERS

Printer Driver Plags

PRINTER DRIVER FLAG (CSWICH)
Value determines which of the print
er drivers (see next subsection)
transmit characters to (and poss
ibly from) the printer:
|
A
8:

l:
2:
:

7-4

is used to

CP/M "List Output® Device

WordStar's Port Driver
User-installed Printer Driver Subr
outines

OEM Daisy Wheel and Similar
Printer Driver

Alternate Console Printer Driver

WbrdStar

Installation

Manual

Section

CSWTCH applies to all printers.

Custom

Printer

Installation

CSWTCH is set by INSTALL in accordance with

the choice made at the “Printer Driver” menu.

zero if no provision has been installed for determining when the
printer is ready to accept a chamcten

When non-zero, WordStar will not output to the printer until the printer is
ready, and WordsStar will check more often whether the printer is ready to
accept a character. Thus, a correctly installed printer busy test, plus a nonzero value in HAVBSY, cause the printer to run more steadily when editing is
bea.m performed at the same time as printing, while improving keyboard response
in editing because the printer output routine will never “hang” while waiting
for the printer to be ready to accept a character.
INSTALL sets HAVBSY non-zero if the port driver is selecte d, or zero if another
driver is selected., 'J.‘he user should set HAVBSY non-zero aftex: adding a busy
test to the CP/M listdevice driver or the alternate console driver, or after
installing custmm driver subroutines that mclude a prinmrbusy test.
yd

accmsible to user modlficatlm
which driver is called.

Iowtmm cswwm,

in USEM,; and

scribedabove,

thus

determines

iscussed in Section 2, WordStar must be able to inputfrom the printer as
well as outmt to the printer when a "Communications pmm*al“ (as required for

daisy wheel and similar printers at 12% baud) is in use. Also, WordStar's

performance improves when a "printer busy test® is available to determine
whether the printer is ready to accept an output character. Thus, each driver
has three entry minm, defined as follows:

er
Busy Test: This entry should return the carry flag set (1) if the
prmter m m ma. to accept a character; the carry flag should be
- returned clear (@) if the printer is ready to accept a chmaater or if
the busy test is not implemented.
If this mtry m
emented, HAVBSY
(above) should be non—-zero; if not mplemmtw.
ould be @.
Character: This entry shoulc
|
to the prmter:. If HAVBSY is nonwzero, this entry is not called until
the printer busy test entry returns the carry flag clam,
nput
|
n
Pri
s This entry need be implemented only if a
c, Aunmamm pmmwl (Sectim 2) requiring input from the printer is to
be used. This entry should return the carry flag set (1) if no character
has been received from the printer since last called, or return the character in the A register and the carry flag clear (@) if a character has been
received.
Specific descriptions of the printer drivers follow.
WordStar

Installation

Manual

7-=5

Section

Custom

Printer

Installation

CP/M List Device Driver
The “print character" entry point to
this driver is implemented to make the
appropriate operating

system call

to print

the character.

The

“printer busy"

and “input character from printer® entri
es are not implemented,

as stand

ard
CP/M provides no system calls for these
purposes; space is provided at LIBSY
and LISINP respectively for patching in
JMP instructions to user-installed

subroutines for these purposes.
For finding space into which to patch
added
subroutines, see the end of the subsectiocn
on “Printer Driver Flags” earlier in
this section.
|
i
-

If you add a “printer busy test” routine,

patch HAVESY to a non-zero value.

If you use a communications protocol with
the List output driver, you must code
and patch in an “Input character from print
er” routine, and put a JMP to it at
LISINP,
|
|
Iy
|
'
|

WordStar's Port Driver
The “Port driverTM does direct hardware I/0
to any

printer interface using at

moSt one output data port, one output
status port, one input data port, and
one

input status port.
The ports may be I/0 ports or memory-map
ped ports.
The
port driver includes implemented printer
busy test and printer character input
routines.,

When the port driver
is selected: during

installation, the

INSTAL

I
program will accept the port numbers
and status bits from the operator, or,
o
request, try to find them experime
ntally
as detailed in “Port Driver” under

“Printer-Related Selections.*

The port driver code is in USER4,

if desired.

Hhe

and thus accessible for further modification

Note that the port driver as shown in the USER4
listing access I/0

ports with "IN" and "OUT" instructions, but
that a NOP is present after each to
allow substitution of “LDA" and “STA“ instr
uctions for memory-mapped I/0.
INSTALL makes this substitution if memory-map
ped I/0O is specified.

The alternate console driver will drive a
printer interfaced to be one of the
four physical console devices (TTY:, CRT:,
BAT:, and UCl:) other than the
terminal, under operating systems which suppor
t multiple console devices and

device assignment via ICBYTE (location 3;

see your operating system documenta-

tion).
The alternate console driver supoc rts chara
cter input from the printer,
making it convenient for use with communicat
ions protocols (as required for
daisy wheel printers interfaced at 1200 baud);
the alternate console driver
does not include a printer busy test unless
added by the user at location ACBSY

(if you add a busy test, be sure to patch HAVRS
Y non-zero).

The alternate console driver entries work by
changing ICBYTE, doing the console
input or output, then restoring IOBYTE. The
IOBYTE console field value used
for printer access is taken from location CONFPI
E.
CONFIE is set to @ by the

INSTALL program when the TTY: printer driver
is selected, or to 1 when the CRT:
console driver is selected.
One of the other two console devices
may be
accessed by patching CONFIE to 2 or 3.
|
\
’

7-6

WordStar

Installation

Manual

Custom Printer Installation

Section 7

User-Supplied Printer Driver Subroutines
JMPs to userSpace is provided at PUSEND, PUBSY, and PUINP for patching rinbusy
test, and
printe
output,
ter
charac
r
coded and user-installed printe
your
patch
to
which
into
e
spa
g
findin
For
es,
routin
printer character input
patch
may
you
routines, see the end of "Terminal Patch Areas," Section 6; also,
date. Note
over the other drivers if you do not expect to use them atif aalater
communications
that the printer character input routine is mandatory
needed. Also patch
protocol is installed; otherwise, this routine is not or
zero if it is not
HAVBSY non-zero if the busy test entry is implemented,
printer
CSWTCH must be set to 2 to cause WordStar to call the user-installed
esTM
Subroutin
"User
g
selectin
by
achieved
be
may
patch
this
driver subroutines;
in INSTALL before patching in your routines,

CEM Daisy Printer Driver

printers
The OEM printer driver is pre-configured to drive certain “OEM" daisy
as
through the MicroPro "I/0 Master" interface addressed at ports F8~FA hex, not
should
detailed in Appendix D and Section 2. Modification of this driver listing
in
USER4
the
in
included
not
is
driver
OEM
the
y;
necessar
normally be
Appendix F.

"1/0
INSTALL sets CSWITCH to 3 to invoke the OEM daisy printer driver whenMenu.
Master Interface / O.E.M Printer Combination" is selected at the Printer

daisy
" A communications protocol (Section 2) is normally used with a (serial)
communi
the
wheel or similar printer interfaced at 1200 baud; in these cases,
the
,
However
cations protocol items are correctly set by the INSTALL program.
communications protocol logic will function with any printer (except an OEM
daisy printer, for which it is not pertinent). For an unusual Teletype-like
printer that requires a protocol, you may wish to patch these items.

PROTCL determines type of communications protocol. The types of protocols are

defined in the program comments and also in Section 2:
@:

None

XON/XOFF

1: ETX/ACK

(and see EAKBSZ, next)

PROTCL is set by INSTALL in accordance with the selection made at the
“Communications Protocol® menu.

WordStar Installation Manual

1-7

Section

Custom

Printer

Installation

EAKBSZ contains the message leng
th for ETX/ACK protocol;

protocol for a non—daisy printer
with a smaller buffer.

When a daisy wheel or

must be equal to or
less than ONE-HALF OF the printer'
s buffer slze, as WordStar keeps
two “messages" active at a time.
The default value (127) assumes the
prin
ter
can hold
abuffeof
r atleast 254 bytes; be sure to
reduce it if you install ETX/ACK

similar printer is installed with ETX/A
CK protocol,

INSTALL automatically sets

EARBSZ for the buffer capacity of
the particular printer selected.

7-8

WordStar

Installation

Manual

Additional Modifications

Section 8
Section

Additional

Modifications

OTHER PATCH ITEMS
In addition to the previocusly described patch items mlatmg to terminal and
printer installation, WordStar can be patched for a number of additional items,
including the following:
o

Command keys, including prefix relationships and keystroke synonyms

All texts -— menus, error messages, question prompts, etc.

Initial values for help level and insert toggle

Initial values for all on-screen formatting options

Default page format

Flag characters (rightrhost scmm column)

Serial diasy wheel and similar printer function strings

OEM dawy printer driver

Complete nstmgfi of the patch areas for these items, alom mth dxscusswns,
are contained in a separate publication, the WordStar Customizatlo
es.
If

you are interested in obtaining a copy of that‘publlcatlon,ficontact:ycur
dealer.

Descriptions of a few additionalpatch items of parmcular mterest follow.
The items are identified here bylabel only; theitems may be patched (and/or
their current hexadecimal addresses obtained) by using INSTALL's patcher as
described in Section 3. Further discussion of these md many other items, plus
n Notes.
pertinent listings, are included in theWordStar Customi

Change this byte to g, 1, 2, or 3 as demred to set the "Help Level” in effect
when WordStar is invoked.

M‘p m 1 e
Setting this byte to @ enables display of the message
For maximum help (full menu dlmlay) ’
S

selwt Help Level 3 by typing“JH3.

message- will clear when a kw is pressed

at the start of the first edit if help level is 1 or 2. Setting this byte to

FF suppresses the above message. Use @ if ITHELP (previous item) is changed to
2 and some users will be new WordStar users to whom level 3 would be helpful.
Use FF if ITHELP is 3, so the above message will not appear if the user types
H2 at the no file menu before initiating an edit.

WordStar

Installation Manual

8-1

Section

Additional

Modifications

Initial Insert Toggle (ITITOG)
Change this byte to @ to make WordStar come up with inserti
on OFF, FF hex to
come up with insertion ON.
|

Initial No—Pile Menu Directory
Display Toggle (ITDSDR)
Set to FF hex to come up with directory display ON;
directory display OFF.
|
-

to @ to come up with
‘

Justification Toggle (INITWF+l)
Set this byte to 8 to come up with justification OFF (ragged right);
hex to come up with justification ON,

set to FF

Byphen—Help Toggle (INTIWFP44)

Set this byte to @ to come up with "Hyphen-help* OFF: FF hex to come
up with
"Hyphen-help" ON.
N

This byte is normally 2E hex to designate a period as the decimal
point in
decimal tabs; European users might wish to change to 2C hex (comma).

Decrease

for

hyphenation pauses

(i.e.,

to hyphenate shorter words)

"B with Hyphen-help on; increase for fewer such pauses.

under

Normal value is about

Form Peeds (PODELX:]
Default for the Print and MailMerge USE FORM FEEDS question: make
FF hex to
use form feeds unless operator explicitly enters a *no" response
,

Omit Page Numbers (ITPOPN)

Default omit-page-numbers flag: patch non-zero for implied “.OP" at beginning

of each file, i.e., to omit page number at bottom of each printed
or Mergeprinted page unless and until .PN dot command is encountered in document.

Variable Name Delimiters

(VAR(H1 and VARCH2)

Delimiter characters used before and after variable names where the variable

value is to be inserted in a document being MailMerged. VARCH1 is
the character used before the variable name; VARCH2 is the character after the variable
name.

Both are normally
"&".

They may be changed if desired; if changed,

they may be the same or different.
Data File Field Delimiter

(RVELIM)

Delimiter character used between fields in a data file being read by MailMerge.

8-2

Normally 2C hex

(comma).

WordStar

Installation

Manual

Additional Modifications

Section 8

Initial Default to N Mode (NONDOC)

default entry
Patch m OFFH to emble

to n

ent mode (0 after re

Up to 190 aumbacmpace characters may be defined by entering their ASCII
codes at AUTOBS and following locations, Wheneverone of these characters is
qmmdtmmi tmn:wmuw"mmmmuu'wfiu,au*»wfimmflW*mMmmaaa»w~w» print
control (“H) into the file after the character. This feature reduces the

number of keystrokes required to enter text containing accent marks, in cases
where the accent marks are separate characters an<tha'prinmflm;

For example, if

you patch 68 hex (the ASCII cuda for “'“) at AUTOBS, then whenever "'" is
pressed during text entry, " " and a controlwa are entered into the file,
making it possible to enter *3* with the keystmkea *, a only.
PATCHING WOMSTAR' S PRINTER DRIVER
FOR CEMAIW TERMINALS
Altos

[

FUNCTION

RESS

|| VALUE |

i% 2.10 | 2.25 | .93A.|1.91§;mf§E;m”{
i
1. %l MASK ALL
ig 7zc}m;ggww§ SE8 : 618 {{ 04 |
2. 11
R || 722 | 728 | sEA A Il o4 |
3. |
UT PORT (D2
i% 7 | 734 Tore |62 || IE |
4. }1 UT PORT (mmmmo e
ii”"?!I”% 741 {;,, : 62D gi 1IE |
5. %l MASK FOR CHAR FRM PTR READY {imm;§;m§7am §5F6 % 627 }5 o1 |
6. ||MAKE BITS CNE FOR CHAR READY i 7 | 73 | sre | 629 .
7. §| STATUS PORT
{i:1 729
} 729 ; 606 } 615 :% 1IF ||
738 g 738 {m“m“mm; 624 :} IF
:I

WIW NOTES:

Uaes port designated as prmter port in ALTOS
documentation.

NUSD = NOT USED IN THIS VERSION

WordStar

Installation Manual

Section

Additional

Modifications

NOTES:

64-28-80
-

WMRS A S TR

(not rele
tovant
RELEASE's

1.06 and later)

iiiifi

— A—, g I8 ilhaean

. - idd

i fstigfi i zi

;;;;!;gi‘if; ’ifizi i -~¢

Dynabyte

It wil
be neces
lsary to connect pins 4,6,8, and
26 at the prin t er side of the cable to each
Ner.
The pins at the camputer side can be
left unconnected.
This willprovide that all
handshaking is done via software
(this means

,ywunmmtlmmrflno%cxpmomxxu);

UNSD = NOT USED IN THIS VERSION

WordStar

Installation

Manual

Section

Additional

Modifications

Vector Graphics

—|

NN
1. :zmmmmmmms (ANT) ifm {729{'618 fg a1 ';
2. :| MAKE BITS QNE IF

READ) (XOR} “ 72C : 72C { 61A ”m

3. ;lwmrrmm (DATA)

” 734 ; 734}623 H g6

4. :l INPUT FORT (DATA)

H 741

;

741 { 62D

s.{ummnmmmm

”733}

735:527

73D}627

“

6.:|mammnmamnm2”7w

7. || STATUS PORT

11720 | 729
| 615 || @7

1; 738

738

; 624

;}

P4-28-80 - You will very likely have some difficulty
bringing WORDSTAR up on a VECTOR GRAPHICS MZ
but this has nothing to do with the pr:mter
mtch.
See the dommm NOTES mCONF IGURIN

frmz r dwlt.
UNSD = MUSEDWMISVMIW

A WordStar which is targeted for use under MP/M should be installed to take

advantage of certain MP/M-specific functions and/or avoid certain CP/M-specific
conditions.

TCXFLG:
The use of the MP/M system clock for determining certain timing
functions within WordStar will significantly improve performance when more than
one WordStar is running under the same MP/M system.
Changing TCXFLG: from 00
to FFH will cause WordStar to utilize the MP/M clock rather than its own
isolated l6-millisecond timing loop.
RSTFLG: Due to the presence of a number of USERS on a single system and to the
nature of multm—ommtmg syatms in general, the normal disk “remounting"” or
RESET function is often a nuisance.

This reset functmn can be suppressed for

operation in MP/M environments by pm:chmg the flag RSTFLG: to FFH.

WordStar

Installation

Manual

8-5

Section

Additional

Modifications

NMOFUS: NMOFUS+1: The number of users on the system is set to 1, but can be
patched to handle up to 255.
Resetting will increase throughput of WordStar

under MP/M (or on a console—driven, interrupt-driven computer),

WordStar not to poll CSTAT as often.

initial response,

and will cause

Be sure to set NMOFUS+1:=NMOFUS:

for

DEFDSK:
Due to the possible configurations of the multiple user files, it is
sometimes desirable to redefine the disk (read USER) to which WordStar will
automatically go to find the overlay files.
This can be done by placing
the suitable drive number in DEFDSK: where A: is @1H, B: is 82H, etc.

8-=6

WordStar

Installation Manual

Appendix A

INSTALL

Error

Messages

This appendix pmvldw explanations of the mwmefi that can be dlsplayed while

‘you are z:urmmg INSTALL (Section 3).

messags
INSTALL is invoked if your computer system
cmntmm insuff 1cient memary. Alm, this message will occur even when
sufficient memory is present in the computer but your operating system

(CP/M or equivalent) hw not been “relocated” to make the RAM available.
Such relocation is :a lished with a system command sometimes called
*

"RELOC" — see your system documentation
for details.

eding message will occur when the memory available is suff:x.ca.ent tm run INSTALL, but not enough to run WordStar.
If
you get this message, you can still produce an installed WordStar on a
diskette file (for use after more memory has been made available on the
system, or for use on a different system) by re-invoking INSTALL and

specifying Inmallatwn Option B. This error message can occur only on

normal installation and on those options which run the mstallm WordStar
after installation has been completed. See Section 1 for WordStar
~
memory requirement.

This message occurs dur:mg mmal" installation, or under Installation

Option A (“Installation Options,* Section 3) if the uninstalled WordStar
(file WSU.COM) is not found on tha logged drive. For example, if WSU.COM
- is not on the diskette in any dmve, or if the current drive is A: but
file WSU.COM is on the diskette in drive B.
Copy WSU.COM onto the diskette in use, or use installation optwn B or C to read it from the

diskette in another drive.

This message does not occur during "normal® installation. Under Installation Option B, C, or D, this message indicates that no file was found with
the name you entered for the WordStar to be installed.
This message
usually indicates that the name was mistyped, the drive was omitted, or
the desired diskette was not in the drive.
After displaying the message,
INSTALL asks for the file name again, allowing you to enter the corrected
name or allowing you to reenter the name after inserting the correct
diskette.
|

WordStar

Installation

Manual

A-1

Appendix

INSTALL

Error

Messages

[INCURRECTLY FORMED FILENAME

Under Installation Options B, C, and D, this
message indicates that a file
name entered was not a correctly forme
d CP/M file name as described in the

Reference Manual,
After displaying this message, INSTALL will
repeat the
file name question. Enter the corrected filen
ame,

UNEX
ENDPE
OF FILE
CT
DURING
ED
READ

The file from which the uninstalled WordS
tar was being read was shorter
than expected. This message may indicate
that you are using a bad copy of

WSU.COM — try getting a fresh copy
from your distribution diskette.
If
you entered the file name under Installation
Option B, C, or D ("Installa-

tion Options," Section 3), this message may
indicate that the file you
- named was not a WordStar,
|
|

The diskette, or its file directory, has filled
up while attempting to

record the installed WordStar.
After this message, the WS.COM (or other
file being written under Installation
Option B, C, or D) will not be
valid.
Arrange more diskette space (e.q., by copyin
g some files off onto

another diskette),

then repeat installation.

ERROR CLOSING FILE

This message should not occur; it indicates a system failure, or
that you

changed diskettes while INSTALL was recording
the installed WordStar.

This version of INSTALL is incompatible with the
version of WordStar you are trying to install
This message can occur on using one release
of INSTALL with a differént |
release of WSU.OOM, or with a previously instal
led WordStar of a different
release. Use INSTALL and WSU from the same
distribution diskette together. This message may also occur if the
file from which the uninstalled Wordstar is being taken (WSU.COM, or name
entered by operator under
Installation Option B, C, or D) does not actual
ly contain a WordStar,

The INSTALL sign-cn message, showing the vrelease number,
and the WordStar

sign—-on message, showing its release number,
below this error message,

A=-2

are displayed on the screen

WordStar

Installation

Manual

Appendix

Specific

Appendix

Computer

Systems

WordStar Versions for

Specific

Computer

Most computer systems use the standard

Systems

vers

rdSta

the rest of this manual.
Specml Wtfii‘ 1S
rdStar are dist
stributed for
a
few specific syst@ms which require a hlghly apecmlized adaptatmn of
WordStar.
This appendix describes the differences between these special
versions and the m'.mdaxd version.

The

st—,.vrd vemim m

, program,

m‘i t:o Wur tmmmal and printer usmq the

as described in Sectn.ons 2-4,

"Special WordStar versions" does not refer to the fox:mat upon which the
WordStar is delivered. In many cases where a “"specialWordStar version” is
available, MicroPro will also make available in its pwduct line a “standarg"
version on the same format.
Two such cases are the Apple and H-89 products which are wwlmd on the Apple

and amag formats, mspectn.vely, in both specn.al“ and “standard" versions.

The &pecial "Heath 89 Version" is intended to run on Heath 89 and Zenith 89
computers whmh have mm in the first 16K.

Hex (mther

This version is origined at 4300

tmsual 100 Hex) and has the terminal pre-installed.

An "A" appendefi to the release number (e.g,., "2.25A") indicates the
4300 hex orn.q:.n..

A “"standard® versionof WordStar on the B-89 format is availwle for Heath and
Zenith 89 computers which have been modified to accept m
[
origined at 190
Hex.
Select “fleath or Zenith 89"‘ as terminal when INSTALLing
|

Since the terminal m pre-installed, a file called "WS.COM* is supplied on the

distribution diskette in place of the usual "WSU.COM",

Upon receiving your Heath 89 wOrwtar, do the following:

Format a blank diskette with the FORMAT program and place a CP/M
system image on the diskette using the SYSGEN program.

Use FILECOPY to copy WS.COM, WSMSGS.OVR, WSOVLY1.OVR and INSTALL.COM
from the distribution diskette to the newly formatted diskette.

The edit function may now be used, as the Heath 89 WordStar is supplied with
the terminal pre-installed.
To select a specific printer (or a different
terminal, if you have an external terminal connected to your Heath/Zenith 89),
use the INSTALL program

WordStar

(Section 3).

Installation

Manual

Because of the limited capacity of a
B-1

Appendix

Specific

Computer

Systems

Heath/Zenith 89 diskette, it is necessary to write the newly installed WordStar
back onto the same file. We suggest the following steps:
3.

Invoke INSTALL by typing INSI‘ALL and pressing RETURN (Section 3).

Press N to get"to the installation options menu.

Press D to select installation option D

Section 3).

Enter the filename WS.ODM.

("Installation Optmns, '

'Im space bar may be usad to bypass the terminal menu.

Make the desired printer selections ("Printer-Related Seleétlons,

Section 3), and complete INSTALLation in the usual manner ("Bypammg
the Patcher" and “Confirming or Carmctmg Your Selectwns, Section

3).

TRS-88 MODEL I VERSION
Installation
Upon receiving your TRS-88 Model I WordStar, do the following:

Format a blank diskette with the FORMAT program and place a CP/M

Use PIP to copy WS.COM, WSMSGS.OVR, WSOVLY1l.OVR and INSTALL.QOM from

system image on the diskette using the SYSGEN program.

the distribution diskette to the newly formatted diskette.

The edit function may now be used, as TRS-88 Model I WordStar is supplied with
the terminal pre-installed.
To select a specific printer (or a different
terminal, if you have an external terminal connected to your TRS-80), use the
INSTALL program (Section 3).
Due to the limited capacity of a TRS-80 diskette,
it is necessary (in a single drive system) to write the newly installed
WordStar back onto the same file.
We suggest the following steps:

B=-2

Invoke INSTALL by typing INSTALL and pressing RETURN (Section 3).

Press N to get to the installation options menu,

Press D to select installation option D ("Installation Optmns,
Section 3). Enter the filename ws.mm.

The space bar may be used to bypass the terminal menu.

Make the desired printer selections ("Printer-Related Selections,"

Section 3), and complete INSTALLation in the usual manner ("Bypassing
the Patcher® and “Confirming or Correcting Your Selections," Section
3).

WordStar

Installation

Manual

Appendix

Specific

Computer

Systems

The TRS-88 Model I lacks a number of keys present on normal terminals. The
following keys on the TRS-80 keyboard are used to perform the indicated
functions in WordStar:

To enter a control character,
hold DOWN ARROW
desired letter.

and press

press UP ARROW

"Hor °S

LEFT ARM«I, "H, or °S

TAB or "I

RIGHT ARROW or "I

(alpha lock)

Advance to next tab stop
Set keybaard
letters only.
lower case.

for upper case
Press again for
'

APPLE II VERSION

Welcome to WordStar! To be able to run WordStar on an 2

you must have the following:

A 4&( or 64m Apple II computer (64K is not nemamry, but is highly
recommended—use either the lanmge card or a 16K RAM card)

A MicmSoft wa soft 'card
An wwcolumn video board (mther the deax VideoTerm or the M&R
Sup'R'Terminal)

One of the following systems:

DOS 3.2 (Eor the 13--mctm:m version of WordStar)
or

DOS 3.3 or the language system (for the l6-sectored version of
WordStar)

WordStar

Installation

Manual

B-3

Appendix

Specific

Computer

Systems

Note

With either the language card or a 16K RAM card, more pages
of text
(about ten) can be put in memory for fast access. Without the additional 16K, text access will be slowed down as fewer pages are held
in memory and the computer must access the disk drive more
often.
(EXAMPLE.TXT will not be available on the l3-sectored version.) In
addition, a user will find that they are unable
to block move more
than one or two lines without the additional 16K of RAM, nor will
- they have simultaneous edit and print under this condition.
Installation
Upon receiving your Apple II WordStar,
then do the following:

Format a blank diskette with the Microsoft FORMAT program (pp. 1-9
in the Microsoft manual).
|

Use the Microsoft COPY program to make a backup of the distribution

WordStar diskette

first study the Microsoft CP/M Manual,
|
|

(pp. 1-18 in the Microsoft manual).

Place an image of your Microsoft CB/M operating system on the backup
a.

Do this by running the COPY program again; but this time, use

the /S option (see COPY in the Microsoft CP/M manual.

The /S function copies only the operating system to thebackup
diskette, rather than the entire disk.

¢.

If you forget to use the /S for this step, you will just copy

the CP/M disk onto your WordStar disk again.
4.
|

Run the INSTALL program by typing INSTALL and pressing RETURN
(Section 3 of

this manual).

”

Ordinarily, INSTALL takes the original distribution file (WSU.COM) and
writes
a new file for a particular system (WS.COM or some other name).
But because
of the the limited capacity of an Apple II diskette (especially the
l3-sector
formatted version), you will have to use the same file name (WSU.COM)
to put
the newly installed WordStar back onto the disk. Steps 5-7 may be used:

Press D to select installation Qm.mnn (writing back to the same
file—Section 3).

The computer will ask you for the name of the file that you are
RETURN.
installing., Type WSOLDM and press

In the Apple II menu, select the appropriate combination of 88-

column videocard, upper/lower (U/L) case conversion method and
availability of shift key modification (optional but recommended for
extensive use of the shift function).

B-4

WordStar

Installation

Manual

Appendix B

Specific

Computer

Systems

Currently the special Apple version of WordStar supports three video boards
via two menu options:

Videx Vidf}emter (cursor on)

M&R Sup’R'Term (cursor off)

The Smart Term board (vended by Apple) is installed by selecting the Videx
Videotemm option.

The first class (Videoterm) leaves the cursor on at all times. This should be
your first choice for a trial video board if you are not using either of the
video cards named above. If you cannot see tt e cursor, try the other option

(Sup'R'Term). These menu @ptimm may be cmmderw as “classes" of video

boards and the user may, therey, um them fi_j;,n;;j_inmalling a variety of Video
boards which do not explicitly appes

-he

menus

If you have the hmrdmm to generate lower-case, thenselect the "hardware U/L

mmwmim option; otherwise, select the “"software U/L conversion® option to
allowWordStar w perform the conversion.
Finally, by umng the very simple
shift key mificatwn (see your Apple dealer), you can enable the software
U/L conversion to use the SHIFT key instead of the ESC key to perform the
shift fmtion.
In addition,

Just »aelect the "shift key mod" option.
Apple u&ers

DOES NOT SUPPORT._ou; *

18.

should note that the

"“special" Apple version

Iminals vm a mri&l mtm:face card,

The user

Mak«e the immmd printer selections (swtion 3) and complete
~installation in the usual manner. Note that a printer must use a
protocol to run atover 388 baud and that the Apple Asynchmmus
serial card will not pmperly support a pwmcol,. For user's who
wish to use WordStar's builtin port driver (necessary if one wishes
to operate the printer at over 300 baud since the CP/M LIST device
does not support protwols) the fullmwm port and bit assignments
are rmmd whm anmnm port driver questions:
Answer M (Memory mapped) to the first question.
Data Port is at EO9F
Status Port is at E@9E
‘Receive Ready bit is 01
Transmit Ready bit is 82
Note

For those who wish to change the name of the resultant 'WSU.COM'
file to a filename uther than WSU, be advised that renaming under

CP/M after INSTALLation will result in the disabling of the 'R' (Run
program)command

Attampts to use the 'Run' program after a rename

will result in the error message 'Cannot find PILENAME.FILETYPE',

where PILENAMEFILETYPE is the original name of the file as established by the INSTALLation program.

WordStar

Installation

Manual

B-5

Appendix

Specific

Computer

Systems

The Apple II Keyboard
The Apple II lacks some keys found on most termina
ls. In ‘particular, there is
no provision for generating lower case or a number
of special characters. If
the "software U/L case conversion" option was
selected during installation,
then WordStar will provide for generation of lower
case, as well as the full

ASCII character set,

The ESC key is used by the Apple II for the shift
lock/unlock function. In
addition if the SHIFT key modification is not install
ed then ESC also doubles
as the shift key. In this case, press ESC twice
for shift lock and once for
regular shift. Note that the ESC key is also used
for WordStar functions.
Whenever you press ESC for a WordStar function, an additi
onal press or two
will be needed to return to the proper upper/lower
case mode.
(A little
experimentation here can be helpful.)

The LEFT ARROW key, which was previously a backspace
(CTRL H), has been
translated to give the RUBOUT code.
This allows LEFT ARROW to be used to

delete a character to the left of the cursor. - If the SHIFT key
modification
has been made the FORWARD ARROW key can move the cursor to the
right without
altering the text under it.
o
e
|
The nine ASCII characters not usually available from
the Apple II Reyboard are
software generated in the lock mode.
|

WordStar has adapted the alpha lock function (using the ESC
key as described
above) to give you the complete set of possible charac
ters, including some
that don't appear on the Apple II keyboard.
For example, normally you get an

exclamation point when you hold the SHIFT key down and press

screen. The same principle applies in the follow
ing cases:

However, when

you are in alpha lock mode, you will see a vertical line
instead on the

Key

SHIFT Key in Unlocked Mode

Exclamation Point (1)
Closing single quote ( )

Bqual Sign (=)

won

Question Mark (?)

‘ gTM

Left Parenthesis ( ()

".“"
"M*

Right Parenthesis

~ Opening single quote ( )*

Underline (1)
Backslash (\)

())

Left Angle Bracket (<)

| Right Anjgle Bracket (>
Capital "M" (M)

SHIFT Key in Alpha Lock Mode
Vertical Line (|)

Left Brace ({)
|

Right Brace (})

Left Square Bracket ([)

Right Square Bracket (])

Tilde (7) |

* Cannot be displayed by the Sup'R'Term; you will see a space instead.
~ To type "€" and "7,
" use alpha lock mode with the shift

the key tops indicate.

B-6

WordStar

key depressed, just as

Installation

Manual

Appendix C

Terminals

Appendix C
Specific Terminals

EXPLANATION

Thm append:.x demr ibes features available and gives configuration hints for
ny of the terminals on INSTALL's terminal menw.
Note

had an auto line feed switch, make

mplemented.

Same as Beehive 158.

AUTO LINE FEED switch (under little cover above keyboard) must be OFF,
Highlighted text displays dim. Erase end line and line insert/delete are used.

No highlighting, erase BOL, or line insert/delete implemented.
IMSAI VIO

This includes the IMSAI VDP-48, VDP-88, PCS 80/38, and other integrated systems
containing the VIO display board. Highlighting and cursor display is by inverse video; WordStar blinks the cursor when necessary to distinguish it from
highlighted areas. The video RAM is accessed directly at F9@0 hex, producing
fast screen update. The VIO must have the firmware ROM (as it always does in
the above integrated symems) s OF equivalent routines must be present in your

operating system.

Infoton I-180

Highlighted text displays dim; line insert/delete are implemented.

The CURSOR CONTROL switch inside the terminal must be ON; the SPACE/ADVANCE
switch should be set to SPACE.

WordStar

No highlighting.

Instal;ation Manual

c=-1

Appendix

Terminals

Lear—-Siegler ADM-31

Highlighted areas display dim.

Erase end line and line insert/delete are used.

MicroTerm ACT IV

Highlighted text displays dim, assuming terminal was
in dim state when WordStar
invoked. Erase end line implemented; terminal does
not have line insert/delete
invocable from CrFU,
|
o
Processor Technologq
VDM
y / SOL
,

essed

through

the

operating system;

OB hex

sent

to clear

the

screen, escape, 2, line number, escape, 1, column
number is sent to position

the cursor. No other functions are implemented.
WordStar's working with the
VDM depends on the particular adaptation of CP/M to the
VDM not interfering; in
particular, transmission of all line feeds and all
non-redundant carriage
returns must occur,

Soroc ID~-128

No highlighting, erase EQL, or line insert/delete implemented,

C-2

WordStar

Installation

Manual

Appendix D

Printers

Appendix

Specific

Printers

DAISY WHEEL AND SIMILAR PRINTERS
Peatures

All printem demnMd m this m*tim .. all of w 's gtint enhance
in individual damriptxmm belmm Ml pr:mw.m
bidirecticnally; “"formed" text will printed with

hem w:.ll ptint
ica
ce Ju

Choice of typewh@els
The interchangeable typewheels for daisy printers come in many choices of
characters and character arrangements. The printed characters will match those
seen on the screen during editing anly if the typewh@el in use contains the
standard ASCII characters in the standard
d
Some typewheels have
other character graphics; many have a dxffermt chmmter arrangment so that,
for emmple, a period in the document will print as some other character. Some
compatible typewheels for each printer are listed below.

OEM DAISY WHEEL AND SIMILAR PRINTERS
WordStar can drive the following “OEM" (Orginal Equipment Manufacturer) daisy
wheel and similar printer models when interfaced with the MicroPro “I/0O Master”
interface board:

Diablo Hy-Type II 1380 Series

Qume Sprint 3 (with cable adapter)
Nec Spinwriter 5560D

The OEM printers provide simple mstallm;:.m and unexcelled performance with
WordStar and are generally the least expensive to buy; their chief diwdvmtme
is that they are more dlffmult to drive from other software than other types
of printers.

The above pr:lnters have a 24-bit parallel interface umng a very different
nmand structure from that of all other printers supported by WordStar.,
One
mmallatim selection specifies any of these prmt@rs, gelects the OEM printer
driver in WordStar, and specifies the “I/O Master“ (or IMSAI PIC-4) interface
board.
When installed for an OEM printer, WordStar accesses the printer
interface directly.
No operating system routines are used, and many
installation complications are thus avoided.
A "“printer busy test" is
provided, resulting in good response when editing and printing simultaneously.
Interfacing

For any of the OEM printers listed above, use the MicroPro "I/O Master" interface board with theOEM printer ports addressed at F8 through FA hex. Connect
the interface board to the printer with the MicroPro printer cable (umng an
adapter as noted be %m: with the Qume Sprint 3).

WordStar

Installation Manual

D-1

Appendix

Printers

An IMSAI PIO-4 board addressed at ports F8
through FB may also be used; the
cable required is the same as the cable previo
usly supplied by IMSAI, plus an
additional conductor bringing the printer's
“data 1/2* bit to bit 4 of port F9.
Installation

To install Wordstar to drive any of the OEM print
ers listed above through
either of the interfaces listed above, select
“I/0O Master / OEM Printer® at
INSTALL's printer menu (see “Printer-Related Selecti
ons," Section 3).
The same
selection works with all the supported OEM printe
rs and interfaces.
The OEM
daisy printer driver ispre-configurfor
ed the
standard
OEM printer port
numbers and bit assignments used with the “I/O
Master® interface.
(Extensive
modification would be required to drive another interfa
ce or to change the port
numbers.
A listing of the code that would require modification
is available in

Diablo Hy-Type II

(1388 Series)

The MicroPro printer cable can be used.

Diablo
Diablo
Diablo
Diablo
Qume

381980
38107
38101
38182

Courier 10
Courier 72
Pica 189

82167

Prestige Elite 12

Elite 12

Qume Sprintv 3
INTERFACING
The cable adapter (available from Qume) that provides a Diablocompatible
termination from this printer's connector is necessary in
order to mate with
the MicroPro printer cable.

COMPATIRLE TXPEWHEELS
Compatible 'Iypewheels for the Qume Sprint 3 are as listed above for the
Diablo

By-Type II.

NEC Spinwriter SSD!D

The MicroPro printer cable can be used.

This is the Hy-Type-II-compatible version of NEC's OEM thimble
printer.g

The NEC 5500D will buzz and stop printing if the (carbon) ribbon
is used up,
the paper runs out, or the cover is opened. Install a new ribbon,
new paper,
or close the cover,

D=2

and printing will continue with no character loss.

WordStar

Installation

Manual

Printers

Appendix D
SERIAL DAISY WHEEL AND
SIMILAR PRINTERS

The descriptions in this sect:xm awly to the following printers, which have
“mrial"* interfaces::

Diablo 1619/162@/1649/165@

Qume Sprint 5

Nec Spinwriter 5510/20

Some of the manufactu:em also wpply equivalent versions with an 8-bit
be similar to the serial versions and
parallel interface; installation should
y a) pplicable.
gemrfll
be
Md
the descriptions here
Controls

Most serial daisy wheel and similar printers have a control panel including
some or all of the following switches:
AUTO LF: must be CFF.

AUTO CR: should be OFF.

~ These switcheshave NO EFFECT on print;mg under WordStar. Character and
lzme apacmq undm: W@rdsmt always d@fault to 6 lines per inch and 19
inch respectively, and may be modified via print directives
characte:
After printing with
dm ument (RmmmmmManual
e»mh
m
mb@dd@d
for use with
settings
swltch
the
to
set
left
is
printer
the
tm:,
ept as noted below.

LENGTH: set to match length of paper in use — commonly 1l inches or

"ORM

66 lines; setting does not matter if USE FORM FEEDS print option (Section

11) will not be used and you don't wmh the FF switch to work.

aftw: positionir g paper at top of form; necessary only
USE PORMFEEDS print option is to be used or you wish the EF switch

SET
if

TOF:

to work.

FF or FORM FEED: depress to feed paper to top of form, e.g. after
aborting print.

Installation

All daisy wheel and similar prmtex:s interfaced at 1200 baud (123 characters
per second) must be installed with a “communications protocol” (as discussed in
Section 2) in order to avoid buffer overrun and consequent character lcss (a
possible exception for the NEC is noted below). At speeds slower than 12080
baud, these printers print slowly; ymu Wlll find the effort invested to install
ocne of these printers with a communications; protocol rewarding because of the
markedly increased printing med.

WordStar Instal;atian Manual

D=3

Appendix

Printers

Caution

Do not attempt to use ETX/ACK protocol in
your operating system when

driving a Diablo or Qume printer

your

operating

from WordStar, It won't work.

system already can drive a Diabl
o or Qume printer at

1268 baud through the use of ETX/
ACK protocol, the portion of

the
operating system which implemen
ts the protocol must be disabled
or
bypassed when printing from Word
Star.
|

The reason for this limitation is that
if an "ETX" inserted in the
character stream happens to fall with
in an “"escape sequence" being
trans
ETX,

mitted to the printer, the printer
will not recognize it as an
and not respond with an ACK; nor
will the printer interpret the

éscape

sequence

Sequences

correctly.

is practical

Keeping

only in the

the

program

ETX's

out

the

escape

generating the character

stream; WordStar contains the neces
sary special code.

Diablo 1618/1628

FEATURES
The “"phantom space" and “phantom
rubout" features of WordStar
Manual) are not supported by these
printers,

(Reference

After printing, WordStar leaves these
printers set for 6 lines per inch and
18
Characters per inch.
To set the character spacing according
to the printer's

“spacing 18/12" switch before use of othe
r software, depress

the “Clear"
button.
If other software has printed on the
printer since it was powered up
and before WordStar prints, you may,
in unusual cases, find it necessary
to

press the printer's “clear® butto

or to turn the printer off and on,
before
WordStar will print correctly (this
is because the Diablo 1618/28 has no
provision for a full reset initiated from
the computer).
|
|

When installing WordStar to use a Diabl
o 1616/1628 printer interfaced at 1208
baud (120 characters per second), spec
ify “ETX/ACK" protocol, and a driver

capable of inputting characters, as
discussed in Section 14.
No settings are
required on the printer for ETX/ACK opera
tion.
These printers do not support

XON/XOFF protocol.

Compatible Typewheels for the Diablo 1610/
1628 include:

Diablo 381088
Diablo 38187
Diablo 38161
Diablo 38182
Qume
82167

D=4

Courier 18
Courier 72
Pica 12
Elite 12
Prestige Elite 12

WordStar

Installation

Manual

Appendix D

Printers

Diablo 1648/1658

me Feeds cannot be used with the Diablo 1640 and 1653, the USE FORM FEEDS

occur in the print initiation dialog(Reference Manual) when

quest i

nstalled for a 1640 or 1650.

When installing Wm:th: to use a Dmblo 1649/ 1659 printer interfaced at 1280
baud (12@ chamctem per second), spe if - *ETX/ACK" protocol, and a driver
setpable of inputtir charwtem, as discussed in sectim 2-5, A switch
2
(switch
protocol
ssary inside the prmmr m mmbla ETX/ACK
tm may be .
deas
or
fitted,
on the HPRO4 c:x.rc:uv:%it»; bmm, if operator control panel is
scribed in your Diablo manual). These printers also support XON/XCF protocol
(Diablo calls x.t DC1/DC3 protocol); a switch setting is mcmmry inside the
printer to enable this pwtmml(switch 3 on HPRO4 circuit board, or as described in your m O

Mme

Compatible typewheels for the Diablo 1648 are as listed for the 1618/28 above.
Qume Sprint S5

When 1mtallmgwazdsmx touse a Q me Sprint 5 interfaced at 1286 baud (128

econd) , apcmfy "ETX/ACK" protocol, and a driver capable of

mttm charmmm, asdiscussed “in Sectwm 2-5. No settings are required

on the printer for mmcx ommtiom

XON/XOFF protocol.

The Qume Sprint S5 does not support

ed above for the Diablo 1618/28.

The "pham:om space and "phwmm rubout” features (Reference nmml) are not
supported on, nor mlwmnt to, these printers.

When WordStar is m&talled for a NEC spinwriter 5519/552@, two of the User
Printer Function print control characters (Section 18) are defined as follows
to permlt access to additional characters on NEC ptint thimbles (typing
with more tlmn 94 graphics:

sends “shift out” code to printer; changes to alternate char-

acter definitions, as described in your NEC documentation, until
“W is encountered in document.

WordStar Installation Manual

D=5

Appendix

Printers

sends “shift in" code to Prin
ter;

definitions after use of ~(Q.

restores normal character

The NEC 5518/5528 will buzz
and stop printing if the (car
bon) ribbon is used
up, the paper runs out, or
the cover is opened. Inst
all a new ribbon, new
paper,
or close the cover,

then press the “Reset*
switch,

continue with no character loss.

and printing will

ANOTALLATION
When installing WordStar to use
a NEC Spinwriter 5518/5528 at 1206
baud (120
characters per second), a comm
unications protocol or a Spec
ial cable must be
used to prevent buffer overrun and
character loss.,
The NEC printer is extremely versatile; we know of four poss
ible solutions to the buffer over
run problem:

Check that the printer is set to use
on DIP switch SW1 on the circ

ETX/ACK protocol (switch 4 OFF

uit board behind the control

panel, or
as described in the NEC documentatio
n).
In the WordStar installation
dialog, specify ETX/ACK protocol
and a driver that can input
characters from the printer (as
discussed in Section 2-4). We sug-

gest this as the normal solution.

Set the printer for XON/XOFF protocol

(switch 4 ON on DIP swit

ch SWl
on the circuit board behind the
control panel, or as described
in the
NEC documentation).
In the WordStar installation dial
og, specify

XON/XOFF protocol and a driver
that can input characters from
the
printer (as discussed in Section
2-4).

ETX/ACK or XON/XOFF protocol
implemented in a printer driv
er
installed in your operating syst
em may also be used with a NEC

‘printer.

In this case, specify “"None" for
protocol in the

installatim dimmw

WordStar

This is a hardware solution, requ
iring fabrication of a cable
adapter.
It may not work in all Cases; if
it works in your case it
has the advantages that it works
with other software in addition to
WordStar, and that no communicatio
ns protocol, nor a printer driver
that can input characters,
need be specified in WordStar
installation,
|

Make up a cable adapter which
runs the printer's "Reverse Chan
nel®
signal (line 19 of EIA connector)
into the "Request to Send” line
(pin 4 of EIA connector) of the comp
uter's serial interface. Check
that the printer is set to prod
uce a “low" signal on buffer full
(switch 5 OFF on DIP switch SWl
on the circuit board behind the
control
panel,

as described in the NEC docu
mentation).

This
signal will cause the USART in the
computer's serial interface to

Stop sending characters when the
printer cannot accept them,
any special software considerat
ions,
=

D=6

WordStar

without

Installation

Manual

Printers

Appendix D
TELETYPE-LIKE (NON-DAISY) PRINTERS

The term “Teletype-like" printer includes almost any printer designed to be
ted to a microcomputer.

The printer should return the carriage to the

ing of the
‘ advancing the paper upon receipt of a "carriage
code”, advance the paper one line upon receipt of a "line feed" code,
upon receipt of ASCII codes 20 through 7E
and print the approp
hex., With such a printer, WordStar will not Microspace Justify nor print using
racter pitch. Subscripts and superscripts
variable line height nor variable

line;
are printed in-line, or in the line below or above if it is a blank
backspace

boldface is printed by overprinting the same characters three times;
is supported only if the printer can backspace.

If your printer has an AUTO LF switch, make sure it is OFF.

The following special features of specific Teletype-like printers may be
supported via special installation (patching) done by the user as discussed in

Sections 6-8:

Choice of TWO character pitches via "A and "N print controls
Choice of two ribbon colors via “Y print control
Ability to feed paper up and down a fractional line for superscripts and
subscripts

Up to4 other special features via "Q, "W, "E, "R print controls

Any printer shown explicitly in WordStar's printer selection menu should be

installed with the appropriate selection, rather than as "Teletype-like", to

make its full capabilities available.

~ "Any Teletype-like Printer®

This menu selection will drive any printer meeting the above description, with
the limitations noted above.

Use it when no other selections match or when in

doubt about the applicability of other selections.
*"Teletype-like Printer

That Can Backspace®

This menu selection is preferred for printers that can back up the carriage to
the preceding character position on the same line upon receipt of an ASCII
"hackspace” code (08 hex). Use of this selection will yield faster printing of
underline, boldface, and double strike, and makes the *backspace” print control
available.

OTHER PRINTERS

Non-Return Printers

WordStar provides limited support of printers that cannot return the carriage
without advancing the paper, such as Selectrics. If the printer can backspace,
install as “Teletype-like printer that can backspace" and avoid use of overprint lines (Reference Manual). Other print enhancements will work as described for "Teletype-like" printers. If printer cannot backspace, install as
“Any Teletype-like printer and avoid use of underline, strike out, double
strike, bold face, backspace, and overprint lines in your documents.

WordStar Installation Manual

D=7

Appendix

*Half-Line-Feed

Printers

Printer®

This menu selection is provided for

use with Printers that advance one-h

line at a time, such as a Selectric with
a half-line ratchet.

Back

alf

spacing
capability is also assumed by this menu
selection, but no ability to feed paper

backwardis
s required. The half-line advance is utili
zed to print superscripts
and subscripts half a line above and below
, respectively, the rest of the text,
Two line feeds are transmitted between
lines where no subscripand
ts superscripts appear.
Depending on the characters your inter
face is equipped to
mmxmmitw,;m&

6"80

D-8

)

dfing:mw&uaramfixmdafwm:tmugaéum

tnwxisIMMb;smeéhmtnmm

WordStar

Installation

Manual

Appendix E

The Terminal Patch Area (USER1)

Appendix E

The Terminal Patch Area (USERl)

A listing of the WordStar user-modifiable module USERl follows this page.
This assembly listing is supplied for the convenience of the occasional user
who may need to install War&?tar for an unusual terminal or printer.

this listing is for the standard TBASE=100 Hex version.

Note that

For the TRS-80 Model I

version, and the Heath 89 vemwn m:igined at 4308 Hex, add 4200 Hex to all
addresses shown in listing
8.

A separate publication, WordStar Qusi
sto
and system programmers.
listings, including:

default areas

message files

keyboard dispatch tables

WordsStar

Installation Manual

liscussion of this listing, see Sections 6tion Notes, is directed towards OEM's

ation

Notes contain additional source

E-1

Appendix E

The

This page

Terminal

intentionally

left

WordStar

Patch

Area

(USER1)

blank.

Installation

Manual

USER1 Listing

Appendix E
USER1

p4/23/81

ERMINAL PATCH AREA MACRO-88 3.4

TITLE USER1
«

’

pu/23/81

1
PAGE

TERMINAL PATCH AREA

FOR WordStar RELEASE 3.8 May, 1981

ENTRY’HITE;HID, CLEAD1,CLEAD2,CTRAIL,CBA4LFG,LINCFF, COLCFF
uflf=‘WMWLAIMELJJMWBJNWWIWWF
RY ASCU
u,mmamflmufls
X *“Wwwfifflfififi\«‘r
ms,*
munm
mafl
ENTRY DEL1 Ww,m
| *~MMr'mewflflflflfllflmmfiflmmuNQMflnN

TBASE

B199

BQU 180H

;WHERE TO LOAD PROGRAM FOR NORMAL CP/M
LUTE CODE, FOR LISTING

ASEG

2000

ORG TBASE+148H
PAGE 63

WordStar

Installation

Manual

;BEGINS AT 248 HEX OR 4448 HEX
S
PAGE LENGTH
;SET

TERMINAL PATCH AREA MACRO-89 3.1

Listing

PAGE 2

!ilfiililiifii.!.llllfillliiif

USER-MODIFIABLE CONSTANTS AND ROUTI
NES FOR
IARDWARE-DEPENDENT TERMINAL CHARACTERI
STICS
AND FUNCTIONS USED BY EDITOR

iiUiilllilliiiililfiiiiflll

@4/23/81

USER1

e we we "l N Wl

USER1

Appendix

l'!’fi'i.iiQfliiifli’fl‘lfliif

i!lii!&lfi.‘illllllllll!ll‘l

;MflE:fifiShfi%ZBFMMMUJIMNEE
DPNIKBRTEMDML
yTYPE VIA THE INTERACTIVE INSTALL PROGR
AM.
ADDITIONAL

swnmmsmxmmrmmmn:smmm«mmz&sum

m,cmwmn

ALLOTHER
ARE
S
THERS

ARE

OPTIONS FOR SPECIAL CASES OR ENHAN
CEMENT.

WwE

fl%fififlflfNflMflSMflmISNEH
EDGMXEMRUMMHM.HWKNMS
;GRUM%flMuVHmDEMMES,ORTD!EET
SHKEM;RKWHEMBflS
;OR ENHANCE OR PERSONALIZE PERFORMANC
E.

SCREEN SIZE

18
59

HITE:
WID:

DB 24
DB 80

;MUST BE EXACT SCREEN HEIGHT IN LINES
;MUST BE <= EXACT SCREEN WIDTH

p2u8
2249

SCREEN HEIGHT AND WIDTH PATCHES ARE
MANDATORY.

E=}

nwmu‘ammmmm!mmnmsIoafismmrnn
nmmmmg
EUBTB?EIH%MWEMl%’Gflfi“flfiw,CHM
MGEMSH%LGL

WordStar

Installation

Manual

Appendix E
gh/23/81

TERMINAL PATCH AREA MACRO-88 3.4

Listing

PAGe, 2

PROVISIONS FOR PATGHING

RSOR POSITIONING CONTROL SEQUENCE
S
|

RSOR POSITIONING
PATGH IS MANDATORY.

WE WP WS

WS W

W W

we wWe

USER1?

USER1

WordStar Inatallqtion Manual

E=5

Appendix

USER1

@4/23/81

USER1

TERMINAL PATCH AREA MACRO-89 3.4

Listing

PAGE 4

; CURSOR POSITIONING...

WBE

;

SBWaS
g8
g8

244
p24B
P2uC
p2uD
2250

p254
9255

p258

ESCAPE, =,
LINE # PLUS 29 HEX,
COLUMN NUMBER PLUS 2@ HEX.
1mEFmLGflM}mWQiMmMSMEEETUPFWQfiHS

TERMINAL, AS AN EXAMF

CURSOR POSITI
INITIALONI
LEAD-IN NG
STRING

;NUM
OF CHARACTERS
BER

DB 1BH

;FIRST CHARACTER

DB '='

s SECOND CHARACTER

DB 9,8,8
DB 8,8,0

;

COMMENTS PRECEDING PAGE

FOR EXAMPLE, THE CURSOR IS POSITIONED ON THE
ADM=-3A TERM
BY
INAL
SENDING:

CLEAD1: DB 2

;

8253

SEE

;SPACE FOR MORE
s+. CHARACTERS

CURSOR POSITION
STRING SENTING
BETWEEN

LINE
AND COLUMN

CLEAD2: DB 9

;NU
OFMBE
CHARACTERS
R
=
3

20
20 99 0P

NONE IN QUR EXAMPLE

DB @
IB 9,0,0

;FIRST CHARACTER
; SECOND THRU 4TH

; CURSOR POSITIONING STRING SENT AFTER
BOTH LINE AND COLUMN HAVE BEEN SENT
CTRAIL: DB @
;NUMBER OF CHARACTERS (NONE)
;

9259

20 00 00 20

925D

DB 2,2,8,8

; FLAG NON-ZERO TO SEND COLUMN BEFORE LINE

CBULFG: DB P

;LI
GOES NE
BEFCRE

;.CO
INLUMN
QUR EXAMPLE

P2SE

; OFF
TO ADD
SET
TO LINE
LINCFF
DB 20H
:
;ADD THIS TO LINE #

; (WHERE @ IS TOP LINE ON
;

SCREEN BEFORE OFFSET)

; OFFSET TO ADD TO COLUMN
COLOFF
DB 28H
: ;ADD THIS TO COLUMN
#

P2SF

; (WHERE @ IS LEFT EDGE OF

;

B269

SCREEN BEFORE OFFSET)

; BINARY / ASCII FLAG AND # ASCII DIGITS

ASCUR:

DB @

;ZERO TO SEND BINARY LINE & COLUMN
;& TO SEND 2-DIGIT ASCII NUMBERS
;3 TC SEND 3-DIGIT ASCII NUMBERS

;SEE NEXT PAGE FOR POSITIONING
;CURSOR VIA USER-CODED SUBROCUTINE

E=6

WordStar

Installation

Manual

Appendix E

p261

94/23/81

9266

Listing

PAGE 5

:BYTES RESERVED FOR EXPANSION

DB 9,9,0

0D 0D PP

p265

TERMINAL PATCH AREA MACRO-89 3.4

£l 9e we o we W 9o e we we we

USER1

USERY

PROVISION
FOR POSITIONING
CURSOR BY USER-CODED
smmmmwwgnmmmnavummacmmmmcw:mmm:mmm.

AL
CASES ONLY:
FOR USE IN EXCEPTION
EMTA

Jm?:mmmmmumwuaflmnsmmannme

m—a, m:zs LOCATION

CALLED TO POSITION

\BOVE CURSOR PATCH ITEMS WILL BE DISREGARDED.

sNORMALLY #, OR JMP TO YOUR

sSPECIAL CURSOR POSITIONING

;ROUTINE.

;
HE END OF THIS LISTING
; FOR smcz TO PUT YOUR SUBROUTINE IN.
;

SUBROUTINE WILL RECEIVE LINE IN L REGISTER

SCH

OLUMN IN H (@=LEFT EDGE).

:
;

mmwrammmmmmmm&mmwmm
- SUBROUTINE
XAMINE THE FOLLOWING

;

9267

POBO*

DW OUTCHR

;ADDRESS OF BYTE CUTPUT
sROUTINE LOADED HERE

s YOUR CUSTOM CURSOR POSITIONING ROUTINE WILL ALSO

; RECEIVE THE FOLLOWING, WHICH MIGHT BE USEFUL
; IN SPECIAL VIDEO BOARD DRIVERS:
:
E=NUMBER OF CHAR POSITIONS FROM BEGINNING OF SCREEN
:
TO NEW CURSOR POSITION (P=UPPER LEFT CORNER).
:+
BC=NUMBER OF CHAR POSITIONS FROM BEGINNING SCREEN TO
;
BEGINNING OF LINE IN WHIGH CURSOR IS BEING PLACED.

P69

P9 PO PO PP

WordStar

Installation

DB 2,8,0,0

Manual

s RESERVED BYTES

E=T7

Appendix

USER1

P4/23/81

USER1

TERMINAL PATCH AREA MACRO-89 3.4

Listing

PAGE

EACH ITEMS RELATE EITHER TO ENHANCED PERFORMANCE (FOR EXAMPLE, USE OF INVERSE VIDEO
cmxmnmmmnaflaamrmwrwamscwzznfi,

onrummnmwumm:mmwm,nmmmms

mmmmnmwmwrmxumsxscmumuL.

3ER
TO END
ASE
OF LINE. OPTIONAL
- IF FUNCTION
;NOT AVAILABLE, LEAVE FIRST BYTE ZERO AND EDITOR
~wn¢xm:mmfmmmnmrnmzmflmxwumsmmmum

926D
P26E
D26F
9279

20 00 PP OO

ERAECDB
L:
@
DB @

DB P

;PUT NUMBER OF GHARCTERS
HERE
;PUT FIRST CHARACTER HERE

;IF 2-CHAR SEQUENCE, PUT 2ND HERE

DB 9,8,0,8 ;IF 3 TO 6 CHAR SEQUENCE,

;PUT ADDITIONAL CHARS HERE.

;DELETE SCREEN LINE CONTAINING CRSOR, MOVE

;LOWER LINES
ON SCREEN
UP ONE LINE. OPTIONAL.
;ammxnnfmflsanmms&mmmtmmux.

p274
B275

p278

20 29 20
20 20 99

LINDEL: DB
DB 9,8,8
DB nmun

;PUT LENGTH HERE

;SPACE FOR 1-6 CHARACTERS

;INSERT A BLNK LINE ON SCREEN, MOVING CURSOR
;LINE AND LINES BELOW IT DOWN ONE. OPTIONAL.
;SUTHIS
PPL
SPEEDS YIN
SCREEN UPDATE.
G
;N. B.
IF YOUR TERMINAL INSERTS BELOW THE
;CURSCR LINE,

PUT A “CURSOR UP"TM BEFORE THE

; "INSERT LINETM CHARACTER(S).

2278
927C

p289

P9
20 00 PP 09
20 00 29 20

LININS: DB @

B 2,0,0,9 ~

Qfllhfl
TMy

;PUT LENGTH HERE
;SPACE FOR 1-8 CHARACTERTS

WordStar

Installation

Manual

Appendix

USER1

gu/23/81

USER1

ERMINAL PATCH AREA MACRO-89 3.1

Listing

PAGE 7

;TURN ON HIGHLIGHTING (INVERSE VIDEO, BRIGHT/DIM, OR
;OTHER MEANS OF HIGHLIGHTING A SECTION OF TEXT).

;APPLICABLE ONLY IF MEMAPV (NEXT PAGE) IS @. OPTIONAL.

g28s

9205
2288

0D 20 9D
PP 20 99

§28B
28C
B28F

PP
20 PO 0P
PP 09 P9

p292
293

20
29 0P 00 PP

8297

00 20 0D 09

s LENGTH
;UP TO 6 CHARACTERS

',awflafica
,

0298
29C
B2A0

'ERMINAL

END

wwwwmmwmmwmm

99
99 P9 PP PP
0D PP PP PO

DB 8,0,0,0

DB 9,0,9,9

; LENGTH

THE BYTES, »
;UP TO 8.

INITIALIZATION SUBROUTINE. CALLED

BEFORE TRMINI (PREVIOUS PAGE) IS SENT, THIS

ROUTINE MAY BE USED FORSPECIAL CONSOLE INIT-

,mmmm OR OTHER

p2A4

~flflflm,NOF

g205

206

NOP
RET

PURPOSE

;ENTRY POINT. PUT DESIRED CODE IN
; "MORPATTM AREA (3 PAGES AHEAD IN
; THIS LISTING) AND PATCH IN A "JMP®
- ;INSTRUCTION
HERE. FOR YET MORE
;SPACE, SEE "PBGMEM"TM ON SAME PAGE.

;USER-PATCHABLE DE-INITIALIZATION SUBROUTINE.
,muumwmrmux(mMflrmmmmumwmxxssmno,
; THIS SUBROUTINE MAY BE USED TO "UNDO"TM ANY SPECIAL
,nmmmm,mmnmwMWJninmtmnma

tmnmm'nm?
NOP

@2A9

RET

;PUT DESIRED CODE IN
; TMORPA
AREA, PATCH
TTM
IN
;A "JMP" HERE.
'

B2A7

B2A8

WordStar

Installation

Manual

E-=Q

Appendix

USER1

P4/23/81

USER1

TERMINAL PATCH AREA MACRO-89 3.4

Listing

PAGE 8

; MISCELLANEOUS TERMINAL-RELATED ITEMS
’

;FLAG TO PERMIT DISPLAY IN LAST COLUMN OF LAST LINE.
;INITIALLY DISABLED, AS MANY TERMINALS SCROLL SCREEN
; WHEN A CHARACTER IS DISPLAYED IN THIS POSITION.

P2AA

)

USELST: DB @
|

;PATCH NON-2 TO PERMIT LAST CHAR ON LAST

sLINE TO DISPLAY IF THIS WILL NOT SCROLL

;SCREEN OF YOUR TERMINAL. NORMALLY LEAVE 8
;FOR USE WITH TERMINAL, PATCH NON-2

sFOR USE WITH MEMORY-MAPPED VIDEO BOARD.

D2AB

oo 20 29

DB 9,2,P

;BYTES RESERVED FOR EXPANSION

]

;DELAYS EXECUTED AFTER VARIOUS TERMINAL FUNCTIONS,
;BEFORE NEXT CHAR IS SENT TO TERMINAL, TO ALLOW RESPONSE

;TIME REQUIRED BY CERTAIN TERMINALS WHEN USED AT HIGH

;BAUD RATES.

PATCH LARGER IF YOU EXPERIENCE, FOR
;EXAMPLE, LOSS OF CHARACTERS AFTER CURSOR POSITIONING.

;EACH DELAY IS APPROX NUMBER OF MILLISECONDS ON
;4 MHZ Z-8@; DELA
IS ABOUT
Y TWICE AS LONG ON 2 MHZ 8@88.
?

B2AE
D2AF

DELCUS: DB 18

DELMIS: DB 5

;18+ MSEC DELAY AFTER CURSOR SET

35+ MSEC DELAY AFTER OTHER FUNCTIONS
L4

WordStar

Installation

Manual

PAGE 9

p4/23/81

%~”@kfl&rmwwfiimififlfl%fllfl‘TflTfl&MfiMfiS
SPACE, OR IT MUST BE SWITCHABLE IN AT AN ADDRESS
ABOVE APPROX 8@PP HEX AND ROUTINES MUST BE PATGHED
IN AT "SWIN"TM AND "SWOUT" ON PAGE 12 OR SO BELOW.
ZMAPV

IS NON-ZERO, WORDSTAR WILL STORE DIRECTLY

/IDEO BOARDRATHER THAN DOING CONSCLE OUTRUT
S THE BEST INSTALLATION METHOD FOR

1] we we we we

WE WS WE We WE WE wWE W We e WS WE BE S W ws s s

USER1

USER1 Listing

Appendix E

2000
we we ws we we ws we

p2B1

_wf usm mpv (RECK THE

KIBIV:

NON-§ FOR KICH-BIT HILITDNG (DETAILS BELOW)

ififlflfl:flfl%fiEmRHEMMflICflwmfi

REl

WordStar Installation Manual

0 BLINK CURSOR IF ON HILIGHTED GHAR

E=11

Appendix

USER1

P2B3

P4/23/81

USER1

TERMINAL PATCH AREA MAC
RO-89 3.4

HIBIV:

DB
@

Listing

PAGE 10

;PATCH NON-g IF YOU HAVE INVERSE

‘.

;VIDEO ETC.

INVOKED BY HI

ORDER BIT,

;UNDER CURSOR, RATHER THAN BY SENDING A CURS

OR POSI-

g2B4

|
-

WE We e W we WwE ws

:
:

;

é’

;TINING STRING UNDER CONT
ROL OF THE PATCH ITEMS O

HIBCUR: DB §

;NON-@ TO DISPLAY CRSR BY SETTING

sHIGH

ORDER

BIT

CHARACTER

sAPPLICABLE IF MEMAPV, ABOV
E, IS NON-g.
;
sFLAG TO SAY CURSOR MUST BE
BLINKED BY THE EDITOR
iIN ORDER TO BE VISIBLE WHEN
ON OR ADJACENT TO AN
s INVERSE VIDEO (OR OTHERW
ISE HIGHLIGHTED)

;NMDDWfiEm\HEQJfiSWED
(WUMHWWTWE?CREHEHU.
;NmMMLINmmmamnfltm
uxmrmmmnvmmmrmuws
;WITH HIBIV AND HIBCUR BOTH
@FFH.
HWHJQEHBKJMflHIEME
M%SAMDWEHJ&MMB.

;flumxummmnmflnsnnn1m
mamm:Aummunmx
;SEND IVON, IVOFF STRINGS,
WITH DELAYS.

8255

CRBLIV: DB @

;FF HEX FOR EDITOR TO BLINK CURSOR

;WHEN ON INVERSE VIDEO CHAR
ACTER.

E-12