home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / a / armedit / Docs / ARMEDIT next >
Text File  |  1997-02-21  |  3KB  |  99 lines
  1. File        : ARMEDIT
  2. Date        : 21-Feb-97
  3. Author      : © A.Thoukydides, 1996, 1997
  4. Description : Description of the PC ARMEDIT command that is part of the ARMEdit
  5.               suite.
  6.  
  7.  
  8. INTRODUCTION
  9.  
  10. The "ARMEDIT" command allows DOS files to be edited using a RISC OS editor.
  11. To use this command it is necessary to load the ARMEdit module before
  12. starting the PC front-end, and to have both the !ARMEdit front-end and a
  13. suitable RISC OS editor running.
  14.  
  15. The External Data Editing Protocol is used to control the edit. Both Zap
  16. and StrongEd support this protocol (see comments below), but unfortunately
  17. Edit does not.
  18.  
  19.  
  20. USAGE
  21.  
  22. The syntax is:
  23.  
  24.     ARMEDIT [/?] <file> [<file> [...]]
  25.     ARMEDIT [/?] /L <file> [<line> [<file> [<line> [...]]]]
  26.  
  27. where
  28.  
  29.     /?              - Displays some help text.
  30.     /L              - Filenames are followed by line number to place cursor at.
  31.     <file>          - Wildcarded name of files to edit.
  32.     <line>          - Line number to position cursor at.
  33.  
  34. All files are treated as text files when being edited.
  35.  
  36.  
  37. USE WITH ZAP
  38.  
  39. Zap uses several techniques for choosing the mode to edit a file in. These
  40. include using the filetype, filename and the contents of the file. Due to the
  41. operation of the External Data Editing Protocol, only the file leaf name will
  42. be used. Hence, to enable selection of editing modes the following lines
  43. should be placed at the start of the !Zap.Keys file:
  44.  
  45. &500    &FFF    \#\*/c            +C
  46. &500    &FFF    \#\*/cc            +C
  47. &500    &FFF    \#\*/c++        +C
  48. &500    &FFF    \#\*/h            +C
  49. &500    &FFF    \#\*/asm        +Assembler
  50.  
  51. Other mappings can be added in a similar fashion. Files that do not match any
  52. of the patterns will be placed in Text mode.
  53.  
  54.  
  55. USE WITH STRONGED
  56.  
  57. Some versions of StrongEd do not support The External Data Editing Protocol
  58. correctly. If you experience problems with the ARMEDIT utility still polling
  59. edits that have been ended, then try upgrading to the latest version of
  60. StrongEd.
  61.  
  62.  
  63. OTHER POINTS TO NOTE
  64.  
  65. If a suitable editor is not running, then the command will exit without
  66. giving an error message - no attempt is made to automatically load a suitable
  67. editor.
  68.  
  69. Filenames may contain standard DOS wildcards, i.e. "?" for single characters,
  70. and "*" for multiple characters. Files are matched using the same rules as
  71. used by other DOS commands.
  72.  
  73. The cursor position is selected by counting new-line characters (ASCII 10).
  74. If the editor changes the line end character sequences then the cursor may be
  75. positioned on the wrong line.
  76.  
  77.  
  78. THINGS TO DO
  79.  
  80. The following are changes that may be made to the ARMEDIT command sometime in
  81. the future.
  82.  
  83.     None at the moment!
  84.  
  85.  
  86. VERSION HISTORY
  87.  
  88. 0.00 (10-Sep-96)    Original development version.
  89.  
  90. 0.01 (12-Sep-96)    Current status and operation is displayed.
  91.                     Better error handling and recovery.
  92.                     Multiple files can be simultaneously edited.
  93.                     Initial cursor position may be specified.
  94.  
  95. 0.02 (14-Oct-96)    Rewrite after source code lost when PC partition corrupted.
  96.  
  97. 0.03 (05-Feb-97)    Temporary files are deleted before quitting.
  98.  
  99. 1.03 (21-Feb-97)    First official release version.