home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
ARM Club 3
/
TheARMClub_PDCD3.iso
/
hensa
/
utilities
/
armedit_1
/
ReadMe
Wrap
Text File
|
1997-02-21
|
9KB
|
229 lines
File : ReadMe
Date : 21-Feb-97
Author : © A.Thoukydides, 1995, 1996, 1997
Description : Help file for the "ARMEdit" suite of software.
INTRODUCTION
ARMEdit is a suite of utilities for use with Acorn and Aleph One PC cards. It
consists of a RISC OS module, a desktop front-end application, several DOS
executables, and support for third party programmers.
This release of the software contains some support for the Acorn software PC
emulator. Due to the lower level of programmer support provided, some
features of the ARMEdit suite may not operate as expected when used with the
software emulator - this may be fixed in a later version.
ARMEdit is still under development. Some of the components that may be added
or improved are:
An extended OSCLI command that supports the use of TaskWindows and
processing of VDU sequences prior to display of output.
Enhanced versions of the GETFILE command that support wildcards and
recursion of subdirectories.
A version of the device driver that supports write operations.
An automatic installer to copy required files into the PC partition, and
modify any required configuration files.
This suite of software is FreeWare; it may be freely used and copied.
However, I retain full copyright. See the section on "LEGAL MATTERS" for more
details.
FILE LIST
This is the complete lists of files contained in this ARMEdit distribution.
All of these files must be included unmodified if distributed further.
!ARMEdit The front-end application. This is only required for
!Help some of the functionality of the suite.
!Run
!Run2 The application directory also contains the ARMEdit
!RunImage module that is always required. It is normally
!Sprites necessary to load the module before starting the PC
!Sprites22 front-end.
ARMEdit
Banner The PCQuit file may be modified, or used as an example
Configure of an obey file to be run when the PC front-end is
!Run quit. The supplied example file kills all PC related
!RunImage modules.
Messages
Res
Sprites
Sprites22
Ensure
Launch
!Run
!RunImage
PCQuit
Resources
Banner
Banner22
Messages
Res
Templates
Code Header files and object files required for developing
ARMFILE/H extra utilities (both under RISC OS and on the PC).
ARMEDIT/LIB See Docs.Code for more details of how to use these.
CLI/H
SWI/H
TALK/H
h.armeditswi
o.armeditswi
Docs The rest of the documentation. The different files
ARMEDIT are described below. Read these before reporting any
Banner problems.
Code
Contacts
Device
Ensure
FrontEnd
GETFILE
HPC
Module
OSCLI
PUTFILE
Talk
PC The PC executables. These should be copied directly
ARMEDIT/COM from the archive to a PC partition, otherwise the
ARMEDIT/SYS filenames are likely to get truncated.
GETFILE/COM
OSCLI/COM
PUTFILE/COM
ReadMe This file.
QUICK START
Before starting it is worth noting that this software requires a version of
the PC front-end software 1.87 or above. Better performance will be obtained
if PCPro (!PC version 2.00 of higher) is used. The version number is
displayed in the Info window from the icon-bar icon. See the Contacts
documentation for details of obtaining upgrades.
To try these programs quickly follow these simple instructions:
Copy the files from the PC directory of the archive into your PC
partition. If you are unsure of how to do this then read the relevant
sections of the manuals that came with the computer and PC card.
Load the !ARMEdit front-end (double-click on its icon in a filer window)
before starting the PC software. This will automatically load the ARMEdit
module.
Start the PC front-end software.
If you are not at a DOS prompt then obtain one, e.g. from Windows
double-click on the MS-DOS Prompt icon.
Change to the directory containing the files copied from the PC directory
of the archive.
Type "OSCLI Help ARMEdit". This should display some familiar looking
help text.
For information about each of the commands simply append /? after the
command name, e.g. "PUTFILE /?".
To find out more read the documentation files listed below.
DOCUMENTATION
For more information on this set of utilities please refer to the documents
in the "Docs" sub-directory. The files are:
ARMEDIT - Documentation for the "ARMEDIT.COM" PC executable that allows
DOS files to be edited using RISC OS editors.
Banner - Documentation for the "Banner" utility used by the front-end
to display the title window.
Code - Documentation required for writing extra utilities for use
with the ARMEdit module.
Contacts - Contact details, including how to obtain upgrades to ARMEdit
and the PC card software.
Device - Documentation for the "ARMEDIT.SYS" PC device driver that
allows access to RISC OS filestore from DOS.
Ensure - Documentation for the "Ensure" utility used by the front-end
to load required system modules.
FrontEnd - Documentation for the "!ARMEdit" front-end that enhances
the functionality of the suite.
GETFILE - Documentation for the "GETFILE.COM" PC executable that allows
files to be copied from RISC OS to DOS.
HPC - Documentation intended for other PC card device driver
developers, detailing some of the calls that may be made
to the ARMEdit module from the PC.
Module - Documentation for the "ARMEdit" module that provides vital
support for all parts of the system.
OSCLI - Documentation for the "OSCLI.COM" PC executable that allows
RISC OS *commands to be executed from DOS.
PUTFILE - Documentation for the "PUTFILE.COM" PC executable that allows
files to be copied from DOS to RISC OS.
Talk - Documentation required for using the "!ARMEdit" front-end
from new PC utilities.
LEGAL MATTERS
The "ARMEdit" suite of software and documentation is supplied "as is"; no
warranty, express or implied, of the merchantability of this software or its
fitness for any particular purpose is given. In no circumstances shall the
author, or any provider or distributor of this software, be liable for any
damage, loss of profits, or any indirect or consequential loss arising out of
the use of this software or inability to use this software.
This software is FreeWare. Permission is granted for anyone to distribute it
unchanged and in its entirety, providing that no profit is made in the
process. The "ARMEdit" suite may not be distributed if modified or
incomplete; neither may it be distributed without this documentation.
However, the "Banner" application and "Ensure" utility may be used and
distributed independently providing the terms in the relevant documentation
file are complied with.
To use this suite, or any part of it, as part of a system or other
application that is for sale (for however much and for whatever reasons) or
released as copyright material then the author's express permission in
writing must be obtained. The author maintains copyright on all the material
supplied and reserves the right to change these conditions at any time
without notice.
ACKNOWLEDGEMENTS
I would like to the thank the following people for their contributions to
the development of this software:
Acorn Computers - The Risc PC, RISC OS and the ObjAsm assembler.
Aleph One - Producing the PC cards, information and support.
Neil Bingham - Promoting ARMEdit, and numerous constructing comments.
Ray Dawson - Suggestion for improvements to early versions.
John Harrison - Bug reports and suggestions for improvements.
Mike Hobbs - Useful comments during early development and testing.
Karl Davis - Hosting the ARMEdit mailing list on ARMature Online.
Dominic Symes - The brilliant !Zap editor; get a copy immediately.
Brian Tucker - Pointing out a bug that many others did not notice.
Robin Watts - !Larger, the greatest backdrop program ever.
Mark Wooding - !Glass, the best template editor.
Thanks also to all the beta-testers who have helped with the development
of this software.