home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR16 / FOLD33.ZIP / FOLDADD.DOC < prev    next >
Text File  |  1993-11-11  |  12KB  |  378 lines
  1.  
  2.                                FOLD-and-PRINT
  3.                                  version 3.2
  4.  
  5.                           Appendix to User's Manual
  6.  
  7.                           (C) Konrad Budych 1989-93
  8.  
  9.  
  10.         This appendix does not contain vital information that you need to run
  11. FOLD-and-PRINT.  It contains information that I always hate reading in other
  12. people's manuals.  Please have a look at FOLD.DOC first, and after you have
  13. done that, you may come back here...
  14.  
  15.  
  16.  
  17.  
  18. DISCLAIMER
  19. ==========
  20.  
  21.         FOLD-and-PRINT is supplied as is.  The author disclaims all
  22. warranties, expressed or implied, including, without limitation, the
  23. warranties of merchantability and of fitness for any purpose.  The author
  24. assumes no liability for any damages, direct or consequential, which may
  25. result from the use of, or inability to use FOLD-and-PRINT.
  26.  
  27.  
  28.  
  29.  
  30. WHERE TO BUY FOLD-and-PRINT?
  31. ============================
  32.  
  33.  
  34.         Nowhere.  FOLD-and-PRINT is free.  I wrote it for myself, but now I
  35. think more people can enjoy and make use of it.  You may give FOLD-and-PRINT
  36. away to your friends, but you are not permitted to sell or modify it.  If you
  37. distribute FOLD-and-PRINT, please distribute the original, unmodified archive
  38. file.
  39.  
  40.         If you think this program is great and worth contributing, please send
  41. something to the author: money is most welcome ($20 or more or less),
  42. diskettes, books, postcards, your programs, etc.  You can contact the author
  43. via e-mail or via snail mail using the following addresses:
  44.  
  45. Snail mail address:
  46.  
  47.         Konrad Budych
  48.         os. Bohaterow Wrzesnia 24/67
  49.         31-621 Krakow, Poland
  50.  
  51. Internet address:
  52.  
  53.         kbudych@ii.uj.edu.pl
  54.  
  55.         If you decide to send me some money you may use an international money
  56. order or a personal cheque.
  57.  
  58.  
  59.  
  60.  
  61. ACKNOWLEDGEMENTS
  62. ================
  63.  
  64.         I would like to thank Janusz, Jerzy, Jerzy, and Krzysztof for testing
  65. FOLD-and-PRINT and suggesting some improvements, Piero, George and Jean for
  66. nice words, Tom for his suggestions and his offer, John, Mark, and Nick for
  67. their suggestions.  Special thanks go to Edgar for his suggestions and
  68. 'debugging' the manual (to the version 3.0, all errors in this manual are my
  69. own invention!)
  70.  
  71.         Special thanks go to Sheldon for his patience in bug hunting.
  72.  
  73.         THANKS IN UPPERCASE go to all contributors.  To be honest, there are
  74. only two persons on this list...  THANKS, DAN!  THANKS, CARLOS!
  75.  
  76.  
  77.  
  78.  
  79. REVISION HISTORY
  80. ================
  81.  
  82.         The history of FOLD-and-PRINT is long and interesting.
  83.  
  84.  
  85.  
  86.  
  87. VERSIONS 1.0 thru 1.3
  88. ---------------------
  89.  
  90.         The first version of this program was running under CP/M-80.  It was
  91. written in Turbo Pascal 3.0 (!).  There were two parts: one which reformatted
  92. input file into another file; the second part printed that file.  All
  93. necessary parameters had to be entered each time the program was run.  Printer
  94. control codes were located inside the program and could not be changed without
  95. the recompilation of the source code as I used only one printer.
  96.  
  97.         The first part, which created the reformatted file, could also act on
  98. the WordStar 3.0 document files.
  99.  
  100.  
  101.  
  102.  
  103. VERSIONS 2.0A thru 2.0J
  104. -----------------------
  105.  
  106.         The version 2.0 was written with the use of Turbo Vision library in
  107. Turbo Pascal 6.0.  This program was a 'sum' of the previous two.  All
  108. parameters could be set in the program and the configuration could be saved.
  109. Several sets of control codes were still inside the program and only ESC/P
  110. compatible printers could be used.
  111.  
  112.         There was a possibility of printing selected pages and truncating
  113. lines.  An input file still was first formatted into temporary file which was
  114. then printed.  It sometimes took a while to reformat a long text.
  115.  
  116.         A lot of keys has to be pressed to start printing.
  117.  
  118.  
  119.  
  120.  
  121. VERSIONS 2.91 thru 2.98
  122. -----------------------
  123.  
  124.         As I found that I always use only two print modes, I thought of the
  125. separate configuration files for each of them.  A command line utility was the
  126. next idea.  A word wrap looks great when there are broken lines and the text
  127. is not a source code.  Printing separately odd and even pages was necessary as
  128. I started using a printer with the sheet feeder.  Printing each line few times
  129. was a great idea when I was forced to use printers with the very weak ribbons.
  130.  
  131.         FOLD-and-PRINT only reads now an input file: no temporary file is
  132. created.  This saves a lot of time: the page is reformatted and immediately
  133. printed; the program prepares the next page while the previous one is being
  134. printed.  The text is read once if no analyzis is performed, however if you
  135. want to know how many pages the text will have, it has to be read twice and
  136. the text analysis has to be performed.
  137.  
  138.         All necessary printer information is now in the printer definition
  139. file.  This allows (probably) all line printers to be used.
  140.  
  141.         Version 2.91 thru 2.98 were all pre-release versions of 3.0.  They
  142. were not widely distributed, but were still improved.  The suggestion form a
  143. number of people shaped FOLD-and-PRINT into its final form.
  144.  
  145.  
  146.  
  147.  
  148. VERSION 3.0
  149. -----------
  150.  
  151.         This version was the first to be widely distributed.
  152.  
  153.  
  154.  
  155.  
  156. VERSION 3.1
  157. -----------
  158.  
  159.         Here is a list of changes from version 3.0:
  160.  
  161.         * 'd' and 'q' switches have been added for the easier header/footer
  162. defining and printing.
  163.  
  164.         * 'c' switch has been removed as useless and not used (by me...)
  165.  
  166.         * a string of digits is now 'a word' too.  This changed the way
  167. FOLD-and-PRINT breaks lines.
  168.  
  169.         * when non-printable characters are found in a text, their codes are
  170. displayed now.
  171.  
  172.         * 'x' switch added to speed up printing of texts on printers with a
  173. sheet feeder.
  174.  
  175.         * 'g' switch added (set tab width).
  176.  
  177.         * 'r' parameter added to allow page numbering shifts.
  178.  
  179.         * the space fillers have been added to special header/footer symbols
  180. to create left/right-justified, odd/even-page-dependent headers and footers.
  181.  
  182.         * the printer configuration file now can contain comments.
  183.  
  184.  
  185.  
  186.  
  187. VERSION 3.2
  188. -----------
  189.  
  190.         Here is a list of major changes from version 3.1:
  191.  
  192.         * new syntax of .P files
  193.  
  194.         * user's title in headers and footer
  195.  
  196.         * line of hyphens may be printed below/above headers/footer
  197.  
  198.         * separate headers/footers for odd and even pages
  199.  
  200.         * different command line parsing: no switches, one- and two-letter
  201. options, case sensitive options
  202.  
  203.         * 'df' disables headers/footers on page no. 1
  204.  
  205.         * 'qt' asks for a user's title
  206.  
  207.         * 'oo', 'oe', 'ox', 'oa' instead of 'o', 'e', 'x'
  208.  
  209.         * 'tB' and 'tW' cuts off the ends of lines without any text
  210.  
  211.         * switches to remove/ignore control characters
  212.  
  213.         * left and right margins, width can be defined in command line
  214.  
  215.         * bug fix: headers and footers fit within margins
  216.  
  217.         * many minor changes: they are invisible to the user or described in
  218. the manual.
  219.  
  220.  
  221.  
  222.  
  223. VERSION 3.3
  224. -----------
  225.  
  226.         Here is a list of major changes from version 3.1:
  227.  
  228.         * bug fix: sometimes FOLD-and-PRINT printed some lines twice in a
  229. column instead of printing empty lines.  I have never experienced this but
  230. thanks to Sheldon I have managed to fix this...
  231.  
  232.         * when a line is broken all spaces at the beginning of the remaining
  233. part are now removed and the text is left justified; this makes long lines
  234. look as if they were formatted paragraphs
  235.  
  236.         * new '-cs' option to substitute non-printable characters with a '@'
  237.  
  238.         * new '-P' option to specify directory for .P files
  239.  
  240.         * new set of the header/footer special symbols
  241.  
  242.         * first version of TUNF added to the package
  243.  
  244.  
  245.  
  246.  
  247. FUTURE VERSIONS
  248. ---------------
  249.  
  250.         I think it is not history yet, but this is the best place to inform
  251. you about the future (of FOLD-and-PRINT).
  252.  
  253.         I cannot promise that there ever will be any future version of
  254. FOLD-and-PRINT, but I am afraid that there will.  I have improved this program
  255. for more than 3 years (for a few days each year...), to add something I need,
  256. remove something I dislike, etc.
  257.  
  258.  
  259.  
  260.  
  261. EXIT CODES AND ERRORS
  262. =====================
  263.  
  264.         If you are interested what exit codes FOLD-and-PRINT returns, here is
  265. the brief list:
  266.  
  267.         0 - everything was okay, the text has been printed
  268.         1 - the help screen has been displayed
  269.         2 - there were problems with command line parameters or FOLD variable
  270.         4 - there were problems with the printer configuration file
  271.         5 - there were problems with the input file
  272.         6 - there were problems with the output file or the printer
  273.         9 - [ESC] has been pressed
  274.  
  275.         And here you have the list of all possible error messages and the
  276. short descriptions of them:
  277.  
  278.  
  279. Invalid number: -xxx
  280.  
  281.         The number specified after the switch is not a valid decimal number.
  282.         Only one digit is allowed after 'b'.  Negative numbers are allowed
  283.         only after 'r'.  Zero is never allowed.
  284.  
  285. Invalid data in printer definition file 'FILE.EXT'.
  286. Invalid hex code in printer definition file 'FILE.EXT'.
  287. Invalid number in printer definition file 'FILE.EXT'.
  288. Invalid structure of printer definition file 'FILE.EXT'.
  289.  
  290.         The printer configuration file is invalid: contains invalid number of
  291.         entries or/and invalid entries or/and the heading or/and ending is
  292.         missing.  Please refer to the user's manual for the detailed
  293.         description of this file.
  294.  
  295. Invalid tab width.
  296.  
  297.         The tab width set with 'g' must be within the range from 2 to 32.
  298.  
  299. Invalid switch: '-Z'.
  300.  
  301.         The switch ('Z' in the example) is unknown and has no meaning.
  302.  
  303. Margin too large.
  304.  
  305.         The width of the margin is too big in comparison to page width.
  306.  
  307. Missing file name in command line.
  308.  
  309.         You have not given any file name in the command line.  If the name of
  310.         the file you want to print begins with '-', use '-' before.
  311.  
  312. No pages to print.
  313.  
  314.         You have specified an invalid range of pages to print.  For example:
  315.         '-f10 -l5' or '-s1 -oe'.
  316.  
  317. No printable text in input file 'FILE.EXT'.
  318.  
  319.         The file to be printed is empty.  This is detected only in the text
  320.         analyzis mode.
  321.  
  322. Non-printable character (ASCII nnn, HEX nn).
  323.  
  324.         The text to print cannot contain control characters.
  325.  
  326. Not enough memory to allocate page buffer.
  327.  
  328.         There is not enough memory for FOLD-and-PRINT to work in the specified
  329.         mode. Remove some TSRs and retry.
  330.  
  331. Too long printer control sequence.
  332.  
  333.         The printer control sequences must not be longer than 128 characters.
  334.  
  335. Too many columns specified for this paper width.
  336.  
  337.         The page is too narrow or/and the number of columns is too big.
  338.  
  339. Too many files specified in command line.
  340.  
  341.         You can specify only one file to print in the command line.
  342.  
  343. Too many TABs in line.
  344.  
  345.         Some line contains too many TAB characters to fit in the internal line
  346.         buffer.  Line is too long.
  347.  
  348. Unable to open configuration file 'FILE.EXT'.
  349.  
  350.         The printer configuration file should be located in the current
  351.         directory or in the FOLD.EXE home directory.
  352.  
  353. Unable to open input file 'FILE.EXT'.
  354.  
  355.         The file to be printed is missing or/and has another name.
  356.  
  357. Unable to open output file 'FILE.EXT'.
  358.  
  359.         The output file cannot be opened / created.  This can happen only if
  360.         you tell FOLD-and-PRINT to print to the file.
  361.  
  362. Unable to print.
  363.  
  364.         FOLD-and-PRINT encountered problems with a printer while printing.
  365.  
  366. Abnormal program termination
  367. Divide error
  368. Null pointer assignment
  369.  
  370.         These messages come from the run-time library and should *never*
  371.         appear.  Let me know if they do...  Describe in detail what have you
  372.         done to FOLD-and-PRINT that it stopped this way.
  373.  
  374.  
  375.  
  376.                        End of Appendix to User's Manual
  377.                        ********************************
  378.