home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / program / boota / !UnNum / !Help < prev    next >
Encoding:
Text File  |  1991-12-06  |  6.6 KB  |  170 lines
  1. UnNum utility  -  remove line sequence numbers
  2. ----------------------------------------------
  3.  
  4. This application is a specialised utility which removes standard
  5. line numbers from files which have been downloaded from IBM
  6. mainframes.
  7.  
  8. If you use !EDIT or TWIN, it is normally easier to edit these
  9. files without the line numbers, since they make for longer lines
  10. which can be too wide to fit on a single line in the edit window.
  11. In many cases, these line sequence numbers are not actually
  12. required and the files only become sequenced in the first place
  13. because the mainframe editor automatically inserts the numbers.
  14.  
  15. The line numbers could, of course, be removed before downloading
  16. from the mainframe, but this is often overlooked (at least I
  17. often overlook them - hence this utility).
  18.  
  19. UnNum can be used from the desktop (by means of an application
  20. using a BootA front-end) or from the command line.
  21.  
  22. To use it from the desktop, simply double click on the !UnNum
  23. icon to install the application on the icon bar. Then drag files
  24. you want unnumbered to the icon to process them. Any special
  25. options can be set via the "CmdOpts" choice in the menu (see
  26. below for an explanation of these options).
  27.  
  28. To use from the command line, copy the "UnNum" application from
  29. the !UnNum application directory to your Library directory, and
  30. then issue the "UnNum" command with suitable arguments as
  31. described below.
  32.  
  33. UnNum distinguishes automatically between two different types of
  34. files:
  35.  
  36.  (1) Card-image files, which have a fixed line length of 80
  37.      characters and are sequenced in columns 73-80. These are
  38.      unnumbered by deleting these columns and by further deleting
  39.      any trailing blanks.
  40.  
  41.  (2) Other files which have variable line lengths and are
  42.      sequenced in columns 1-8. These are unnumbered by deleting
  43.      these columns plus any trailing blanks.
  44.  
  45. To be eligible for unnumbering the following conditions must be
  46. met:
  47.  
  48.   -  the file type must be TEXT (hex FFF)
  49.   -  each line must have valid decimal digits (with leading
  50.      zeros) in the appropriate sequence number columns
  51.   -  the remain columns must contain only printable characters.
  52.  
  53. Any file which does not meet these conditions will be rejected.
  54.  
  55. UnNum will also convert any DOS standard CR/LF (hex 0d0a) end-of-
  56. line character combinations it encounters in the input file to
  57. standard Archimedes newline characters  (i.e. just LF (hex 0A))
  58. and will truncate the file if it comes across a DOS CTRL-Z (hex
  59. 1A) EOF character.
  60.  
  61. UnNum can process multiple files in one command. It will accept
  62. as an argument:
  63.  
  64.   -  a single file name
  65.   -  a directory name
  66.   -  a wildcarded file or directory name.
  67.   -  recursively (i.e. all text files in the specified directory
  68.      and all subordinate directories) if required.
  69.  
  70. It only processes files with a file-type of "text" (hex FFF).
  71. Using the desktop !UnNum application (with BootA assisted front-
  72. end), you can drag a text file or a directory to the !UnNum icon
  73. on the icon bar to process, respectively, the single file or all
  74. the text files in the directory.
  75.  
  76. If you are using UnNum as a command (without the !UnNum front-
  77. end) you specify the text file, directory or wild-carded name as
  78. an argument:
  79.  
  80.   e.g. *UnNum myfile
  81.        *UnNum mydir
  82.        *UnNum myfil*
  83.  
  84. If you specify a wildcarded name it will process all text files
  85. that match the name, or if there are no matching files it will
  86. treat the name as a wildcarded directory name and process the
  87. first matching directory. If the recursion option is specified
  88. (see below), then all matching text files are processed plus all
  89. the text files in any matching directories plus all their
  90. subordinate directories.
  91.  
  92. Four options can also be specified as arguments (via the CMDOPTS
  93. option of the !UnNum menu):
  94.  
  95.   (1) The OVERWRITE option (specified as "-o") which causes the
  96.       unnumbered file to be written back to disk with the same
  97.       name as the original input file (otherwise the output file
  98.       is written back to disk with a name formed by adding a
  99.       prefix to the front of the input file name).
  100.  
  101.   (2) The PREFIX option (specified as "-p") which sets the prefix
  102.       that will be added to the front of the input file name to
  103.       form the output file name (when OVERWRITE not in effect).
  104.       The prefix can be one or more characters and must follow
  105.       the "-p" in the arguments:
  106.  
  107.       e.g.  set CMDOPTS to  "-p X"
  108.                         or  "-p outdir."
  109.  
  110.       The prefix string cannot begin with "-". If not specified a
  111.       prefix of "_" is used.
  112.  
  113.   (3) The RECURSION option (specified as "-r") which causes all
  114.       subdirectories to be processed. If you use the !UnNum
  115.       application from the desktop and set CmdOpts to "-r", then
  116.       dragging a directory to the !UnNum icon will unnumber all
  117.       text files in that directory and any subdirectories. If you
  118.       are using UnNum from the command line, then the effect is
  119.       similar:
  120.  
  121.       e.g.  *UnNum mydirect -r
  122.  
  123.  (4) The TEST option (specified as "-t") which stops the output
  124.      file being written and can be used to check what files would
  125.      be converted if you specify a directory name or a wildcarded
  126.      filename.
  127.  
  128. The default choices for these options can be set via the !CmdOpts
  129. file in the !UnNum application directory.
  130.  
  131. When specifying more than one option at the same time, separate
  132. the option letters (and any following values) by spaces:
  133.  
  134.       e.g.  set CMDOPTS to  "-l ram:list -p X -r"
  135.  
  136. For a summary of the syntax of the *UnNum command, either issue
  137. the command without any arguments, or click on the !UnNum icon
  138. after installing it on the icon bar. To cause the output from
  139. this to be written to a disk file, use redirection:
  140.  
  141.                e.g. *UnNum >listfile
  142.  
  143. or set  "CMDOPTS" on the !UnNum icon menu to "{ > listfile }".
  144.  
  145. UnNum will also convert any DOS standard CR/LF (hex 0d0a) end-of-
  146. line character combinations it encounters in the input file to
  147. standard Archimedes newline characters  (i.e. just LF (hex 0A))
  148. and will truncate the file if it comes across a DOS CTRL-Z (hex
  149. 1A) EOF character.
  150.  
  151. UnNum was written in C and compiled with the AcornSoft ANSI C
  152. Compiler Version 4. It requires the Acorn Floating Pointer
  153. Emulator and Shared C Library relocatable modules to be
  154. installed. See the !RunA file in the !UnNum application directory
  155. for specific version details.
  156.  
  157. Copyright notice
  158. ----------------
  159.  
  160. UnNum is subject to Copyright.
  161.  
  162. Permission is granted by the author to any recipient of this
  163. material to use and make/disseminate copies of the application
  164. provided that no charges are made for doing so (other than to
  165. cover any cost of media or postage) and that this notice is
  166. included with all copies.
  167.  
  168. Paul Witheridge - 04 December 1991.
  169.  
  170.