home *** CD-ROM | disk | FTP | other *** search
/ 8bitfiles.net/archives / archives.tar / archives / genie-commodore-file-library / C64-128Toolkit / ACE14E.SFX / ace14-bcode.doc < prev    next >
Encoding:
Text File  |  1990-02-12  |  6.2 KB  |  119 lines
  1.  
  2. ┴├┼-128/64 ┬├╧─┼/╒╬┬├╧─┼ ─╧├╒═┼╬╘┴╘╔╧╬  FOR VERSION 1.00   [╩UNE 29, 1995]
  3. ------------------------------------------------------------------------------
  4. 1. ╔╬╘╥╧─╒├╘╔╧╬
  5.  
  6. ╘HIS DOCUMENT CONTAINS THE DOCUMENTATION FOR THE "BCODE" AND "UNBCODE"
  7. PROGRAMS FOR ┴├┼.  ╘HERE ARE ALSO (MORE ADVANCED) VERSIONS OF THESE PROGRAMS
  8. AVAILABLE IN THE ├ PROGRAMMING LANGUAGE FOR ╒NIX AND ═╙-─╧╙ ENVIRONMENTS.
  9.  
  10. ╘HESE PROGRAMS ALLOW YOU TO ENCODE BINARY DATA INTO A TEXT FORMAT THAT CAN
  11. BE E-MAILED OR POSTED TO ╒╙┼╬┼╘ NEWSGROUPS.  ╞UNCTIONALLY, THEY ARE QUITE
  12. SIMILAR TO THE UUENCODE/UUDECODE STANDARD ╒NIX UTILITIES, EXCEPT THAT THESE
  13. PROGRAMS CAN USE A DIFFERENT ENCODING TECHNIQUE FROM "UUCODE" WHICH ALLOW
  14. FOR THE AUTOMATIC SPLITTING, REORDERING, AND INCREMENTAL REASSEMBLY OF
  15. MULTIPLE FILE SEGMENTS FOR LONG FILES, AND PROVIDE ├╥├-32 AND SIZE ERROR
  16. CHECKING ON EACH ENCODED SEGMENT.  ╘HESE ┴├┼ PROGRAMS WILL EVENTUALLY BE
  17. EXTENDED TO THE LEVEL OF THE ├-LANGUAGE PROGRAMS, WHICH CAN HANDLE UUCODE
  18. AND HEXCODE FORMATS IN ADDITION TO BCODE FORMAT.
  19.  
  20. 2. ┬├╧─┼ ╨╥╧╟╥┴═
  21.  
  22. BCODE [-HELP] [-V] [-U] [-M] [-L MAX_LINE_COUNT] [FILENAME ...]
  23.  
  24. ┼NCODE THE GIVEN FILES INTO ┬├╧─┼ FORMAT.  ╘HIS FORMAT, LIKE UUENCODED
  25. FORMAT, IS USED FOR TRANSMITTING BINARY INFORMATION THROUGH A TEXT-ONLY
  26. MEDIUM.  ╘HE "-HELP" FLAG IS USED TO DISPLAY "USAGE" INFORMATION TO STDERR.
  27. ╘HE COMMAND WILL EXIT AFTER ENCOUNTERING THE FLAG, BEFORE DOING ANY WORK.
  28.  
  29. ╘HE "-V" FLAG MEANS TO GIVE "VERBOSE" INFORMATION ABOUT WHAT IS GOING ON.
  30. ╘HE "-U" AND "-M" FLAGS INSTRUCT BCODE TO OUTPUT IN EITHER ╒NIX (┴SCII-╠F)
  31. OR ═┼╙╙-─╧╙ (┴SCII-├R╠F) FORMAT.  ╘HE DEFAULT IS GOOD OLE ╨ETSCII.
  32.  
  33. ╘HE "-L" FLAG AND VALUE ALLOWS YOU TO SPECIFY THE MAXIMUM NUMBER OF BCODED
  34. LINES TO INCLUDE IN EACH SEGMENT OF THE BCODED DATA.  ╫HEN THIS FLAG IS
  35. USED, OUTPUT IS SENT TO SPECIAL OUTPUT FILES RATHER THAN TO STDOUT (WHERE IT
  36. IS USUALLY SENT).  ╧NE SEGMENT IS SENT TO EACH SPECIAL OUTPUT FILE.  ╘HESE
  37. SPECIAL OUTPUT FILES ARE NAMED AFTER THE FILE BEING ENCODED, APPENDED WITH A
  38. ".B" FOLLOWED BY THE AT-LEAST-TWO DIGIT SEGMENT NUMBER.  ╔F THE FULL NAME
  39. WOULD EXCEED 16 CHARACTERS, THE "BASENAME" IS TRUNCATED.  ╔F THE SOURCE FILE
  40. INCLUDES A PATH, THE PATH IS IGNORED AND THE SPECIAL FILE IS PUT IN THE
  41. CURRENT DIRECTORY.  ╞OR EXAMPLE,
  42.  
  43. BCODE -L 800 B:JUNKFILE
  44.  
  45. WOULD PUT THE BCODED SEGMENT DATA INTO "JUNKFILE.B01", "JUNKFILE.B02", ...,
  46. "JUNKFILE.B99", "JUNKFILE.B100", ETC., IN THE CURRENT DIRECTORY.  ┼ACH LINE
  47. OF BCODED DATA CONTAINS 72 CHARACTERS (WHICH REPRESENT 54 RAW DATA BYTES),
  48. SO 800 LINES WILL PRODUCE 59200 BYTES OF OUTPUT (COUNTING ├╥ AND ╠╞ AT THE
  49. END OF EACH LINE), WHICH IS A GOOD SIZE FOR POSTING OR FOR MAILING TO
  50. BRAIN-DAMAGED MAILERS (UNDER 64╦).  ╘HE MAX_LINE_COUNT DOES NOT INCLUDE THE
  51. TWO CONTROL LINES IN THE BCODE FORMAT.
  52.  
  53. ╔F YOU INCLUDE FILENAMES ON THE COMMAND LINE, THEN INPUT WILL BE TAKEN FROM
  54. THEM IN TURN.  ╧THERWISE, INPUT WILL ╬╧╘ BE TAKEN FROM STDIN AND NO WORK
  55. WILL BE DONE.  ┘OU MAY INCLUDE MANY FILENAMES (AND ASSOCIATED ALIASES) ON A
  56. COMMAND LINE TO CREATE A ┬├╧─┼ ARCHIVE (WHICH SHOULD BE SUFFIXED ".BCA").
  57.  
  58. ╔F YOU SPECIFY THAT A FILE IS TO BE BROKEN INTO MULTIPLE SEGMENTS FOR
  59. ENCODING, THEN LAST SEGMENT MAY BE OF ZERO LENGTH.  ╘HIS IS NOT AN ERROR AND
  60. WILL BE DECODED CORRECTLY, ALTHOUGH IT MAY BE A BIT OF A PAIN.
  61.  
  62. 3. ╒╬┬├╧─┼ ╨╥╧╟╥┴═
  63.  
  64. UNBCODE [-HELP] [-I] [-V] [-D] [FILENAME ...]
  65.  
  66. ╘HIS IS A FULL-BLOWN ┬├╧─┼ DECODER.  ╔T WILL READ ┬├╧─┼ DATA FROM FILES
  67. NAMED IN ANY ORDER AND RECONSTRUCT THE ORIGINAL BINARY FILES THAT WERE
  68. ENCODED USING THE ┬├╧─┼ PROGRAM ABOVE.  ╔F THE "-HELP" FLAG IS SPECIFIED,
  69. USAGE INFORMATION WILL BE GIVEN AND THE PROGRAM WILL EXIT.
  70.  
  71. ╘HE THREE OTHER FLAGS ARE USED TO REQUEST DIFFERENT LEVELS OF OPERATIONAL
  72. INFORMATION: INFORMATIVE, VERBOSE, AND DEBUGGING.  ╔NFORMATIVE MESSAGES
  73. INCLUDE WHEN A FILE IS COMPLETELY PIECED BACK TOGETHER, VERBOSE INFORMATION
  74. INCLUDES WHEN A FILE IS OPENED OR CLOSED, AND DEBUGGING INFORMATION INCLUDES
  75. A DUMP OF THE INTERNAL "HAVE" TABLE THAT KEEPS TRACK OF WHICH SEGMENTS OF
  76. WHICH FILES THE DECODER CURRENTLY HAS.  ├URRENTLY, INFORMATIVE AND VERBOSE
  77. INFORMATION IS HARD-WIRED ON.
  78.  
  79. ╔NTERMEDIATE SEGMENTS ARE DECODED IMMEDIATELY AND PLACED INTO TEMPORARY
  80. FILES IN THE CURRENT DIRECTORY WITH NAMES LIKE "0┬├00001", WITH DIFFERENT
  81. NUMBERS.  ╘HESE FILES ARE CREATED AND DELETED AS NEEDED.  ┬ETWEEN RUNS, IF
  82. THERE ARE ANY FILES THAT HAVE NOT YET BEEN COMPLETELY PIECED TOGETHER, THE
  83. "HAVE" INFORMATION IS SAVED INTO "0┬├-╙╘┴╘", WHICH CAN BE LISTED TO SEE WHAT
  84. IS IN THE TEMPORARY FILES AND WHICH SEGMENTS OF THE FILES ARE MISSING.  ┴N
  85. EXAMPLE OF ITS CONTENTS WOULD BE:
  86.  
  87. 00001-00001  BEG  0000001223  0┬├00002  FILEA
  88. 00001-00001  BEG  0000540122  0┬├00004  FILEB
  89. 00003-00003  MID  0000002832  0┬├00001  FILEB
  90. 00005-00005  END  0000000023  0┬├00003  FILEB
  91.  
  92. ╘HE FIRST TWO COLUMNS WITH THE DASH BETWEEN INDICATE THE RANGE OF SEGMENT
  93. NUMBERS THAT ARE CONTAINED IN THE TEMPORARY FILE.  ╘HE NEXT COLUMN GIVES THE
  94. INTERPRETATION OF THE TEMPORARY FILE, INDICATING IF IT IS THE BEGINNING,
  95. MIDDLE, OR THE END OF THE COMPLETE FILE BEING DECODED.  ╘HE NEXT COLUMN
  96. GIVES THE LENGTH OF THE TEMPORARY DATA (USED FOR ERROR RECOVERY).  ╘HE NEXT
  97. COLUMN GIVES THE NAME OF THE TEMPORARY FILE, AND THE FINAL COLUMN GIVES THE
  98. NAME OF THE FILE THAT THE "FRAGMENT" BELONGS TO.
  99.  
  100. ╘HE FACT THAT THE STATUS OF DECODING IS KEPT BETWEEN RUNS MEANS THAT YOU
  101. DON'T HAVE TO HAVE ALL OF THE SEGMENTS OF THE FINAL FILE(S) PRESENT AT ANY
  102. ONE RUN.  ┼RROR CHECKING IS PERFORMED ON EACH SEGMENT AS IT IS BEING
  103. DECODED, AND IF AN ERROR IS ENCOUTERED, THE SEGMENT WILL BE IGNORED.
  104. ┬ECAUSE OF THE "INCREMENTAL DECODE" FEATURE, YOU CAN OBTAIN CORRECT COPIES
  105. OF THE SEGMENTS THAT WERE FOUND TO BE IN ERROR BEFORE AND RUN THEM THROUGH
  106. AGAIN.
  107.  
  108. ╘HIS PROGRAM WILL RECOVER FROM ALL ERRORS IN THE INPUT DATA, INCLUDING ONE
  109. TRICKY CASE THAT THE ├ UNBCODE PROGRAM RELEASED EARLIER BEFORE COULD NOT.
  110. ╘HE ONLY WAYS THAT THINGS CAN GET FOWLED UP ARE IF UNBCODE HAS ACCESS
  111. PROBLEMS TO THE TEMPORARY FILES, OR IF YOU ╙╘╧╨ THE PROGRAM AT AN
  112. INOPPORTUNE TIME.  ╘O RECOVER FROM ALL ERRORS, YOU JUST HAVE TO DELETE ALL
  113. OF THE "0┬├" TEMPORARY FILES, INCLUDING "0┬├-╙╘┴╘".
  114.  
  115. ─URING DECODING, THIS PROGRAM WILL OVERWRITE EXISTING "0┬├" FILES OR FILES
  116. BEING DECODED.
  117. ------------------------------------------------------------------------┼╬─---
  118.  
  119.