home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / pc / armedit_1 / Docs / QuickStart < prev    next >
Text File  |  1997-12-06  |  8KB  |  171 lines

  1. File        : QuickStart
  2. Date        : 07-Dec-97
  3. Author      : © A.Thoukydides, 1997
  4. Description : A quick introduction to installing and using the ARMEdit suite.
  5.  
  6.  
  7. INTRODUCTION
  8.  
  9. This file explains how to get the ARMEdit suite up and running quickly. More
  10. experienced users may prefer to read the other documentation files for
  11. greater control over how the software is installed and configured.
  12.  
  13. It is assumed that you know how to use the mouse and windows environment on
  14. your RISC OS computer. If this is not the case then please read the Welcome
  15. guide which came with your computer before continuing.
  16.  
  17.  
  18. PREPARATION
  19.  
  20. The ARMEdit suite requires either a version of the PC front-end software 1.87
  21. or above, or any version of Acorn's software emulator. Better performance
  22. will be obtained if PCPro (!PC version 2.00 or higher) is used. The version
  23. number is displayed in the Info window from the icon-bar icon. See the
  24. Docs.Contacts file for details of obtaining upgrades.
  25.  
  26. The rest of this file assumes that a PC card (Risc PC second processor or
  27. podule) is being used.
  28.  
  29. The !ARMEdit front-end also requires copies of the Acorn Toolbox modules.
  30. These are already present in RISC OS 3.6 and above, but must be placed in the
  31. !System directory on older machines. See the Docs.Contacts file for details
  32. of where to obtain them.
  33.  
  34.  
  35. INSTALLING THE SOFTWARE
  36.  
  37. The first step, unless it has already been performed, is to copy the
  38. "!ARMEdit" application to the computer's hard disc. A good choice of location
  39. is to use the same directory as used for the PC front-end software. If the
  40. software was distributed compressed then it must also be decompressed before
  41. use.
  42.  
  43. Start the front-end by double-clicking SELECT on the "!ARMEdit" icon in a
  44. directory viewer. If the software has not previously been configured then the
  45. installer window will automatically open. Interactive help is fully
  46. supported; use Acorn's !Help application to obtain information about the item
  47. under the mouse pointer. This may be started by clicking on the HELP icon at
  48. the bottom of the installer window.
  49.  
  50. Follow the prompts to configure the main options. Click CONTINUE to advance
  51. to the next stage after making any changes required. The following values
  52. will be requested:
  53.  
  54.     Application paths   The path for the PC card front-end software and
  55.                         configuration tool are required. These are used when
  56.                         the multiple configurations option is used. If the
  57.                         PC front-end has been "seen" by the filer then these
  58.                         fields should already be correctly filled, otherwise
  59.                         simply drag their icons over the "drop icons" to set
  60.                         the correct paths.
  61.                         
  62.     DOS partition path  The path for the PC partition. This will normally be
  63.                         an image file called DriveC. If a direct SCSI device
  64.                         is being used then specify the RISC OS path of the
  65.                         root directory, e.g. "SCSI::4.$".
  66.  
  67. At this stage the configuration will be stored for later use, and a prompt is
  68. displayed to allow either a standard or custom installation of files into the
  69. DOS partition. Unless you know what you are doing it is advisable to click
  70. CONTINUE to automatically perform a standard installation.
  71.  
  72. After a brief pause a window should be opened stating that the installation
  73. has been successfully completed. At this point all the features of the
  74. ARMEdit suite should be available for use.
  75.  
  76. Read the Docs.FrontEnd file for details of how to change the configuration or
  77. install other components.
  78.  
  79.  
  80. MODIFYING CONFIGURATION FILES
  81.  
  82. The CONFIG.SYS and AUTOEXEC.BAT files in the PC partition require
  83. modification to inform DOS about ARMEdit. These files may be edited using a
  84. RISC OS editor, such as !Zap or !Edit, or from a DOS or Windows editor.
  85.  
  86. Load the C:\CONFIG.SYS file (CONFIG/SYS from the top level directory of your
  87. PC partition) into your chosen editor, and add this line to the end:
  88.  
  89.     DEVICE=C:\DRIVERS\3RDPARTY\ARMEDIT\ARMEDIT.SYS -long -write ADFS::4.$
  90.  
  91. If you are not using Windows 95 then omit the "-long" keyword. The final path
  92. "ADFS::4.$" should be changed if you main harddisc is not an ADFS one. When
  93. finished, save and close the file. See the Docs.Device file for more details
  94. of the available options.
  95.  
  96. Next load the C:\AUTOEXEC.BAT file (AUTOEXEC/BAT from the PC partition) into
  97. the same editor. You should find a line that begins with "PATH=". Append
  98. ";C:\DRIVERS\3RDPARTY\ARMEDIT" to the end of that line. Save and close the
  99. file when finished.
  100.  
  101.  
  102. STARTING THE PC CARD
  103.  
  104. If the standard installation process described above has been completed then
  105. ARMEdit should be ready for use.
  106.  
  107. Firstly ensure that the "!ARMEdit" icon (a grey PC with an !Edit style pen
  108. over the top) is shown on the iconbar at the bottom of the screen. If it is
  109. not presend then double-click SELECT on the "!ARMEdit" icon in a directory
  110. viewer.
  111.  
  112. Click MENU over the "!ARMEdit" icon on the iconbar to display the main menu.
  113. Select the "PC card" option to start the PC front-end. This will use the
  114. current configuration. However, ARMEdit allows multiple configurations to be
  115. defined; these will be listed on the sub-menu.
  116.  
  117.  
  118. COMMAND LINE UTILITIES
  119.  
  120. ARMEdit includes several command line utilities for use from DOS. If you are
  121. not at a DOS prompt then obtain one, e.g. from Windows double-click on the
  122. MS-DOS Prompt icon.
  123.  
  124. Type "OSCLI /?". This should display limited help about the OSCLI command.
  125. The other utilities supplied as part of the ARMEdit suite also display help
  126. information if "/?" is used.
  127.  
  128. As indicated by the displayed help, the OSCLI command allows RISC OS
  129. *commands to be executed. Try typing "OSCLI CAT" to display the contents of
  130. the current RISC OS directory. Experiment with other commands and the
  131. different command line switches. However, be careful - do not try starting
  132. another application (such as BASIC) without using the "/T" switch. Failure to
  133. do this is likely to crash the computer.
  134.  
  135. The other command line utilities are:
  136.  
  137.     ARMEDIT     This command allows DOS text files to be edited using a
  138.                 RISC OS editor such as !Zap or !StrongEd.
  139.     
  140.     GETFILE     This is similar to the utility of the same name supplied with
  141.                 Acorn's software emulator, allowing RISC OS files to be
  142.                 copied to DOS.
  143.     
  144.     PUTFILE     This is similar to the utility of the same name supplied with
  145.                 Acorn's software emulator, allowing DOS files to be copied to
  146.                 RISC OS.
  147.  
  148. Read the corresponding documentation file for details of how to use these
  149. commands. Alternatively try running them with "/?" added to the end of the
  150. command line to obtain a description of their parameters.
  151.     
  152.  
  153. DEVICE DRIVER
  154.  
  155. If it has been installed correctly, the ARMEDIT.SYS device driver should be
  156. loaded, and one or more extra drive letters will be available. On a system
  157. with only a single hard disc partition the first drive letter used by the
  158. device driver would be D:. Try looking at the contents of each of the drives
  159. in turn; one should show files from a RISC OS hard disc.
  160.  
  161. The device driver only allows the files to be read. Any modifications made
  162. from the PC are stored in memory; they do not affect the original files. To
  163. copy changes back to RISC OS it is necessary to use the PUTFILE command.
  164.  
  165.  
  166. OTHER FEATURES
  167.  
  168. This guide has only skimmed the surface of the ARMEdit suite. For more
  169. details read the relevant sections of the documentation, e.g. Docs.FrontEnd
  170. for an explanation of the other features offered by the front-end, or
  171. Docs.Module for more technical details about the ARMEdit module itself.