Trailing-Edge
-
PDP-10 Archives
-
bb-d868e-bm_tops20_v41_2020_dist_1of2
-
4-1-documentation/helper.doc
There are 7 other files named helper.doc in the archive. Click here to see a list.
HELPER.DOC -- Changes from V5(41) to V7D(52)
January, 1982
COPYRIGHT (C) 1972,1974,1977,1981,1982 BY
DIGITAL EQUIPMENT CORPORATION, MAYNARD, MASS.
THIS SOFTWARE IS FURNISHED UNDER A LICENSE AND MAY BE USED AND COPIED
ONLY IN ACCORDANCE WITH THE TERMS OF SUCH LICENSE AND WITH THE
INCLUSION OF THE ABOVE COPYRIGHT NOTICE. THIS SOFTWARE OR ANY OTHER
COPIES THEREOF MAY NOT BE PROVIDED OR OTHERWISE MADE AVAILABLE TO ANY
OTHER PERSON. NO TITLE TO AND OWNERSHIP OF THE SOFTWARE IS HEREBY
TRANSFERRED.
THE INFORMATION IN THIS SOFTWARE IS SUBJECT TO CHANGE WITHOUT NOTICE
AND SHOULD NOT BE CONSTRUED AS A COMMITMENT BY DIGITAL EQUIPMENT
CORPORATION.
DIGITAL ASSUMES NO RESPONSIBILITY FOR THE USE OR RELIABILITY OF ITS
SOFTWARE ON EQUIPMENT WHICH IS NOT SUPPLIED BY DIGITAL.
HLR7D.DOC Page 2
HELPER.DOC -- Changes from V5(41) to V7D(52)
January, 1982
1.0 SUMMARY
This is a maintenance release of HELPER which is being shipped with
maintenance releases of SCAN 7D and WILD 7D. The primary purpose of
this release is to eliminate problems caused by the length of time
since the last release of HELPER. The version number of HELPER is
being changed to make it consistent with that of SCAN and WILD.
HELPER version 7D runs on all supported monitors. It has been tested
on TOPS-10 V7.01 and TOPS-20 V4. There are no known deficiencies.
1.1 Function of HELPER
HELPER is a subroutine used to output help texts (HLP:/SYS:??????.HLP)
onto device TTY. It is entered in one of two ways:
A. When using this calling sequence, the SIXBIT module name should
be placed in accumulator 1:
MOVE 1,[SIXBIT /module name/]
PUSHJ 17,.HELPR
return to here
B. When using this calling sequence, the address to the argument
block whose first element is the address of the SIXBIT module
name (ie. a FORTRAN or COBOL argument block) should be placed in
accumulator 16:
MOVEI 16,[0,,[SIXBIT /module name/]]
PUSHJ 17,HELPER
return to here
The return from HELPER is always to the location following the PUSHJ.
The contents of accumulator 1 on return is not guaranteed.
1.2 System Specific Information
There is now a TOPS-20 switch in HELPER that can be set at compilation
time. To compile TOPS-10 specific code, (the default) compile
HELPER.MAC with the TOPS20 switch equal to zero. When TOPS-20 native
code is desired, create a file U.MAC containing the line
TOPS20==1
Then compile U.MAC+HELPER.MAC. This will permit the inclusion of
HELPER in JSYSized programs without using PA1050. Note that turning
on the TOPS20 feature test is not supported by DEC.
HLR7D.DOC Page 3
When compiled for running under TOPS-10, HELPER presently requires
eight locations on the push-down list (provisions should be made to
allow for ten locations to allow future expansion) on which to store
and from which to restore user AC's and Job First Free for use by the
CORE UUO to shrink core back to its original size. Disk input of the
HELP text is accomplished on channel 0.
When compiled for running under TOPS-20, HELPER requires ten locations
on the push-down list on which to store and from which to restore user
AC's. Other locations on the list are for the help text input buffer.
By using this method, it is not necessary to map in extra pages, and
no extra memory is used.
2.0 CHANGES FROM HLR5 TO HLR7D
42 BPK
JSYSize HELPER and other assorted sundries.
43 BPK
Create label HLPVER to store helper version instead
of using .JBVER
44 BPK
Search universal HLP20 for definition of TOPS20
45 BPK
Implement new JSYS convention (ie. jsys%)
46 BPK
Replace HLPVER with %HELPR and make it accessible
to LINK.
47 PY 18-Aug-81
Change the version number to match SCAN and WILD. Remove
the reference to HLPR20, use an IFNDEF to default TOPS-10
version. Change to more informative edit history style.
50 LCR
If HLP: does not exist, try SYS: before giving error
message. Note: This edit was originally installed as
edit 42 in 1974.
51 LCR
Use monitor supplied /MESSAGE setting. Note: This edit
was installed as edit 43 in 1974.
52 PY 6-Oct-81
Re-install the previous two edits, which were lost about
eight years ago. Also change edit history format retroactive
to start of this version, and indicate edit level and date
last version was shipped.
HLR7D.DOC Page 4
3.0 KNOWN BUGS AND DEFICIENCIES
None.
4.0 INSTALLATION INSTRUCTIONS
To install in any program, relink that program using the new
HELPER.REL
Note that although there are several programs which use HELPER, we
will not necessarily rebuild all of them when HELPER is released. If
the customer experiences a problem with a program which is fixed by
the new versions of HELPER, he may rebuild the product at his
discretion.
5.0 SUGGESTIONS
Allow use of an extended channel to be used instead of time-sharing
channel 0.
Permit HELPER to run in or be called from extended sections.
[End of HLR7D.DOC]
[HLR5.DOC is appended as an integral part of HLR7D.DOC]
HLR5.DOC Page 5
HELPER.DOC -- Changes from V4 to V5
October, 1973
1.0 SUMMARY
1.1 This release extends HELPER to look at device HLP:, to read
sequence numbered files, and to improve its error messages. It
also adds an entry point so that it can be invoked from
FORTRAN-10 and COBOL programs. HELPER version 5 corrects all
SPRs received through October 10, 1973 (10-11567).
1.2 HELPER version 5 runs on all monitors. It has been tested on
5.06. There are no known deficiencies. This version fully
supports the DATE75 project.
1.3 HELPER version 5 is documented in a program specification in the
Software Notebooks.
2.0 CHANGES
36 (SPR 10-9713) Handle sequenced files. Also add an error message
in case of I/O errors. This message is "%HLRIOE I/O ERROR
READING HELP FILE; I'M SORRY, I CAN'T HELP YOU".
37 (SPR 10-11567) Look on device HLP: before looking on SYS:. This
allows all help files to be removed from SYS: which should speed
up LOOKUPs.
40 Add an alternate entry point "HELPER" which can be called from
FORTRAN-10 or from COBOL with one argument, the name of the
program in SIXBIT.
41 Improve the error message issued when the help file can not be
found. It now reads "%HLRNHF NO HELP FILE ON SYS:; I'M SORRY, I
CAN'T HELP YOU".
3.0 KNOWN BUGS AND DEFICIENCIES
None.
HLR5.DOC Page 6
4.0 CHANGES IN INSTALLATION INSTRUCTIONS
None.
5.0 SUGGESTIONS
None.
[End of HELPER.DOC]