home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / turbopas / decuf10.ark / DECUF.DOC next >
Encoding:
Text File  |  1989-09-27  |  4.5 KB  |  111 lines
  1. DecUF documentation, 199106, Wim J.M. Nelis
  2.  
  3.  
  4. Introduction
  5.  
  6. DecUF  is an acronym for DECode_Uuencoded_File.  It is yet another  program 
  7. to 'uudecode' a file.  It's features are:
  8.  
  9.  o One  input  file might contain more than one encoded file.  If  the  end 
  10.    statement of an encoded file is encountered, it will search for a  begin 
  11.    statement of the next encoded file.
  12.  
  13.  o Lines  within an encoded file, which are obviously NOT uuencoded  lines, 
  14.    can be skipped without causing a (fatal) error condition.  This  feature 
  15.    is usefull if a (big) uuencoded file is split up into multiple files  by 
  16.    for  instance an email system.  After merging the (email)  files,  there 
  17.    are  some  email  header lines within the encoded  file  which  must  be 
  18.    skipped while decoding the file.
  19.  
  20.  o The  I/O  time  is optimised by buffering the decoded file  as  much  as 
  21.    possible in the heap.  Once the heap is full, the whole heap is  written 
  22.    to a disk file.  This implementation minimises the number of head  moves 
  23.    if the input and the output file(s) are located on the same disk.
  24.  
  25.  o Two types of uuencoded files are supported: the first type uses the  '`' 
  26.    character in stead of the blank space for a 6-bit zero, the second  type 
  27.    uses  the  blank space for a 6-bit zero and it adds  a  terminator,  the 
  28.    character  'M', at the end of each encoded line.  DecUF  will  recognise 
  29.    the type of encoding from the first encoded line.
  30.  
  31.  o Any CP/M, MS-DOS or UNIX pathname is removed from the filename specified 
  32.    in the begin statement.
  33.  
  34. Usage.
  35.  
  36. The calling sequence of DecUF can be described in a short way as:
  37.   DecUF <InputFile> [ /o<Outputpath>] [ /c{+,-}] [ /s{+,-}] [ /v{+,-}]
  38.  
  39. Program DecUF expects at least the name of the file containing the  encoded 
  40. file(s) to be supplied.  Moreover some options can be specified, which  are 
  41. all  optional.  An option is recognised by its first character, which  must 
  42. be a '/'.
  43.  
  44. The  input file name must be a legal unambigious file name.   However,  one 
  45. extension is allowed: between the drive letter and the colon, the user area 
  46. number can be specified.
  47.  
  48. The  '/o'  option can be used to specify the path to the area to  save  the 
  49. result  file(s) in.  The path consists of three fields: the  drive  letter, 
  50. the  user  area number and a colon.  If two or three of  these  fields  are 
  51. given,  they must be specified in order stated above.  If the drive  and/or 
  52. the user area are not specified, the current value is used.
  53.  
  54. The '/c' option controls the effect of illegally formatted lines within  an 
  55. encoded file.  If the option is enabled (/c+), an illegally formatted  line 
  56. will  cause the decoding to stop and the result file to be erased.  If  the 
  57. option  is  disabled  (/c-), illegally formatted lines  are  skipped.   The 
  58. default value for this option is disabled (/c-).
  59.  
  60. The  '/s' option specifies the number of encoded files in the  input  file.  
  61. If  enabled  (/s+), there is only one encoded file in the input  file.   If 
  62. disabled  (/s-), there can be more than one one encoded file in  the  input 
  63. file.  By enabling this option, the standard with regard to uuencoded files 
  64. is followed: there it is specified that all lines following the 'end'  line 
  65. should be ignored.  The default value for this option is disabled (/s-).
  66.  
  67. The  '/v' option controls the amount of output on the screen.   If  enabled 
  68. (/v+),  the number of the line being decoded is displayed and a summary  of 
  69. the statistics is presented after completing the decoding of each file.  If 
  70. the option is disabled (/v-), neither the progres report nor the statistics 
  71. are  written to the screen.  The default value for this option  is  enabled 
  72. (/v+).
  73.  
  74.  
  75. Remarks.
  76.  
  77. DecUF uses the EXTended_File_Name unit, which is also available  seperately 
  78. as  EXTFN.ARK.  In that archive you'll find some  additional  documentation 
  79. about the EXTended_File_Name unit.  The use of this unit has one  drawback: 
  80. if  the  program  DecUF is terminated abnormally, that  is  with  an  error 
  81. message from the TP run-time system, the pointer to the BDOS will be wrong.  
  82. Any reference to BDOS (CP/M) will cause most probably a system hang.   Thus 
  83. if DecUF terminates abnormally, reboot your system.
  84.  
  85. Any  remarks,  comments  and/or suggestions about DecUF  are  welcome.   My 
  86. address is:
  87.    Wim Nelis
  88.    Rozenhof 4
  89.    8316 CX  Marknesse
  90.    The Netherlands
  91.  
  92. I am also reachable via e-mail at Internet address
  93.    NELIS@NLR.NL.
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.