home *** CD-ROM | disk | FTP | other *** search
/ YPA: Your Privacy Assured / YPA.ISO / other_goodies / utilities / mprint14.lha / MiserPrint / MiserPrint.doc < prev    next >
Text File  |  1995-01-12  |  17KB  |  499 lines
  1.  
  2.                            MiserPrint V1.14
  3.                            ================
  4.  
  5.                      ****************************
  6.                      * This program is GIFTWARE *
  7.                      ****************************
  8.  
  9.                    Written by Heinz-Guenter Boettger
  10.                   GUI created with GadToolsBox V2.0c
  11.  
  12.               Comments, suggestions, bug reports etc. to
  13.                   hgb@pool.informatik.rwth-aachen.de
  14.  
  15.  
  16. 0. Important
  17. ============
  18.  
  19.   *********************************************************************
  20.   *       Starting with release V1.11, MiserPrint is 'Giftware'       *
  21.   *                                                                   *
  22.   * If  you like this program and will use it, you should consider to *
  23.   * send  me  a  litte (or big ;-) donation for my work (please don't *
  24.   * send cheques or money orders). If you can't afford to send me any * 
  25.   * donation you can write a picture postcard to                      *
  26.   *                                                                   *
  27.   *                      Heinz-Guenter Boettger                       *
  28.   *                         Roermonder Bahn 5                         *
  29.   *                           41844 Wegberg                           *
  30.   *                              Germany                              *
  31.   *********************************************************************
  32.  
  33. 0.1. Disclaimer
  34. ===============
  35. This  software comes with no warranty, either expressed or implied. The
  36. author  is  in no way responsible for any damage or loss that may occur
  37. due  to  direct  or  indirect usage of this software. Use this software
  38. entirely at your own risk.
  39.  
  40. 0.2. Copyright
  41. ==============
  42. This   software   is   freely   distributable,  BUT  all  programs  and
  43. documentation are copyright by Heinz-Guenter Boettger.
  44.  
  45. 0.3. Distribution
  46. =================
  47. Permission is given to include this program in a public archive (such as
  48. a BBS, FTP site or PD library (disk and CD-ROM versions)) providing that
  49. all  parts  of  the  original distribution are kept intact. These are as
  50. follows:
  51.  
  52.     MiserPrint.info
  53.     MiserPrint/MiserPrint
  54.     MiserPrint/MiserPrint.info
  55.     MiserPrint/MiserPrint.doc
  56.     MiserPrint/MiserPrint.doc.info
  57.     MiserPrint/MiserPrint.guide
  58.     MiserPrint/MiserPrint.guide.info
  59.     MiserPrint/Install
  60.     MiserPrint/Install.info
  61.     MiserPrint/env-archive/MiserPrint/MiserPrint.prefs
  62.     MiserPrint/env-archive/MiserPrint/Manual.prefs
  63.     MiserPrint/env-archive/MiserPrint/Listing.prefs
  64.     MiserPrint/Icons.info
  65.     MiserPrint/Icons/MiserPrint_DG.info
  66.     MiserPrint/Icons/MiserPrint_PP.info
  67.  
  68. No charge may be made for this program, other than a reasonable copying
  69. fee,  and/or  the  price of the media. This fee _must not_ be more than
  70. USá$3 or DM 4 for floppy disks and US 35$ or DM 50 for CD-ROMs.
  71.  
  72. Finally  if  you  wish to include MiserPrint on a disk magazine you are
  73. REQUIRED  to  get  the  author's  permission  FIRST.  Usually this will
  74. require  you  to  just  send  me  a  copy  of  the issue which contains
  75. MiserPrint free of charge.
  76.  
  77. This program may not be included or used in commercial programs unless
  78. by written permission from the author.
  79.  
  80. 1. Requirements
  81. ===============
  82. MiserPrint requires
  83.  
  84. - an Amiga with Kickstart V37 or higher
  85. - any printer that is _compatible_ to a Hewlett-Packard Deskjet 500
  86.  
  87. The  program  should work fine with the Hewlett-Packard Deskjet series
  88. and compatible printers too (e.g. PCL-printers or other ink-jets).
  89.  
  90. I have tested MiserPrint with a HP Deskjet 500.
  91.  
  92. 2. Installation
  93. ===============
  94. To  install  MiserPrint, simply copy it to your utilities directory and
  95. the  directory of the preferences files to envarc: or click the Install
  96. icon.
  97.  
  98. Denis  Galiana  and Peter Popanda sent me some icons. You can find them
  99. in the 'Icons' drawer.
  100.  
  101. 3. Introduction
  102. ===============
  103. MiserPrint is a print utility that puts up to 8 normal pages of text on
  104. one  sheet  of  paper.  You are able to save paper and time. MiserPrint
  105. uses  the  small  built-in  fonts  (Courier  and  Letter Gothic) of the
  106. HP-Deskjet or compatible printers.
  107.  
  108. 4. Using MiserPrint
  109. ===================
  110. MiserPrint  can  be  started  from a CLI or from the Workbench. When the
  111. program  starts  up,  the default values are set and MiserPrint.prefs is
  112. read.  After  that  the  commandline  arguments  or  the  tool types are
  113. evaluated and the main window is opened.
  114.  
  115. MiserPrint  tries to add an AppWindow if you are running the Workbench.
  116. An  AppIcon  is  also  available (see ICONIFY in the CLI section or the
  117. 'Iconify' command in the project menu).
  118.  
  119. 4.1. CLI
  120. --------
  121. To  start  MiserPrint  from CLI simply type its name and the parameters
  122. you  need.  You  can  use '?' to get the template. The program uses the
  123. defaults and the command line options override them.
  124.  
  125. Template:   FILE,ICONIFY/S,USLEGAL/S,USLETTER/S,BLOCK/K/N,COURIER/S,
  126.             LPI/K/N,PFF=PERMITFF/S,PESC=PERMITESC/S,DRAFT/S,
  127.             LQB=LQBOLD/S,DOUBLE/K,HEADER/K,FOOTER/K,SEPERATE/K,
  128.             BN=BLOCKNUMBER/K,TAB/K/N,TO/K,PREFS/K,PT=PRINTERTYPE/K,
  129.             ICONX/K/N,ICONY/K/N,WINDOWX/K/N,WINDOWY/K/N
  130.  
  131. Most  of  them  are  switches,  which  are  explained  in the `Gadgets'
  132. section.
  133.  
  134.     FILE
  135.         The file that you want to print.
  136.  
  137.     ICONIFY
  138.         The  main window is not opened, only an appicon is displayed on
  139.         the  workbench.  Doubleclick  it and the main window is opened.
  140.         Drop  another  icon  on top of it, the window is opened and you
  141.         get the new filename in the string gadget.
  142.  
  143.     BLOCK <n>
  144.         n must be 1, 2 or 4.
  145.  
  146.     LPI <n>
  147.         n must be a number between 8 and 16.
  148.  
  149.     DOUBLE (ON|OFF)
  150.     HEADER (ON|OFF)
  151.     FOOTER (ON|OFF)
  152.     SEPERATE (ON|OFF)
  153.     BLOCKNUMBER (ON|OFF)
  154.         These  flags must be set to ON or OFF. The format of the header
  155.         and the footer can be changed in the string gadget of the GUI.
  156.  
  157.     TAB <n>
  158.         n must be a number between 1 and 10.
  159.  
  160.     TO <filename>
  161.         The filename must be a valid AmigaDOS one.
  162.  
  163.     PREFS <filename>
  164.         The filename must include the full path.
  165.     
  166.     PRINTERTYPE (HP_DESKJET|OTHER_INKJET)
  167.         Set the printer type to HP_DESKJET if your printer is a Hewlett
  168.         Packard. The printer takes the sheets from the bottom.
  169.         Other inkjets have a different paper feeding from the top side.
  170.         For  this reason the sequence of printing is wrong and you have
  171.         to change the type to OTHER_INKJET.
  172.  
  173.     ICONX <ix>
  174.     ICONY <iy>
  175.     WINDOWX <wx>
  176.     WINDOWY <wy>
  177.         The  position  of the the appicon and the main window. The icon
  178.         coordinates  of the commandline or tooltypes parameters and the
  179.         actual position of the window is saved to your prefs file.
  180.  
  181. 4.2. Workbench
  182. --------------
  183. The  Workbench tool types for Miserprint are:
  184.  
  185.     ICONIFY, USLEGAL, USLETTER, BLOCK=<n>, COURIER, LPI=<n>,
  186.     PERMITFF, PERMITESC, DRAFT, LQBOLD, DOUBLE=(ON|OFF),
  187.     HEADER=(ON|OFF), FOOTER=(ON|OFF), SEPERATE=(ON|OFF),
  188.     BLOCKNUMBER=(ON|OFF), TAB=<n>, TO=<filename>, PREFS=<filename>,
  189.     PRINTERTYPE=(HP_DESKJET|OTHER_INKJET), ICONX=<ix>, ICONY=<iy>,
  190.     WINDOWX=<wx>, WINDOWY=<wy>
  191.  
  192. To start MiserPrint from Workbench
  193. - doubleclick its icon.
  194. - click the text file you wish to print and shift-doubleclick MiserPrint.
  195. - set the project icon of a text to MiserPrint and doubleclick it.
  196.  
  197. More details are in the `CLI' section.
  198.  
  199. 4.3. Gadgets
  200. ------------
  201.  
  202. The Option Gadgets
  203. ------------------
  204.  
  205.     'Papersize'
  206.         With  this  gadget  you  can select the papersize that is used.
  207.         (DIN  A4  is  the  default,  because it is the standard size in
  208.         Germany.)
  209.  
  210.     'Block'
  211.         You can choose between three text arrangements:
  212.         - 1x1: one big block
  213.         - 1x2: two blocks, which are formatted in two columns
  214.         - 2x2: four little blocks, normally four normal pages on one sheet
  215.  
  216.     'Font'
  217.         The HP-Deskjet 500 has two built-in nonproportional fonts:
  218.         - Courier (6 point, 20 cpi)
  219.         - LetterGothic (6 point, 24 cpi)
  220.  
  221.     'LPI'
  222.         A slider gadget allows you to select the lines per inch between
  223.         8 and 16.
  224.  
  225.     The  two text gadgets 'Lines' and 'Cols' show you the dimensions of
  226.     one block.
  227.     
  228.     'Select Pages'
  229.         After  a  file  scan  you are able to select the first and last
  230.         page  that  you  want to print. The text gadget below shows the
  231.         first  and last page.
  232.         
  233.         Both  sides  or  only the odd respectively the even ones can be
  234.         selected. !!! Don't blame me if something went wrong. !!!
  235.  
  236.     'Formfeed'
  237.         If this option is enabled, the text after a formfeed is printed
  238.         on a new block.
  239.  
  240.     'ESC'
  241.         With  this option you can print some ANSI-ESC-sequences. I have
  242.         implemented  italics,  underline  and  boldface. The others are
  243.         filtered out.
  244.  
  245.     'Quality'
  246.         Three qualities can be selected:
  247.         - Draft: the fastest print
  248.         - LQ: my favourite mode
  249.         - LQBold: perhaps somebody will use it
  250.  
  251.     'Double'
  252.         This  option  enables the printing on both sides of the sheets,
  253.         so  that you can print 8 normal pages on one sheet (if block is
  254.         set  to  4).  First  the  even  pagenumbers are printed, then a
  255.         requester invites you to rotate the sheets before the odd pages
  256.         are   printed.  If  your  printout  is  redirected  to  a  file
  257.         MiserPrint  saves  the even pagenumbers to <filename>.1 and the
  258.         odd  ones  to  <filename>.2,  you  must  copy the files in this
  259.         sequence  to par: or ser: for a later printout. Don't copy them
  260.         to prt:!!!
  261.  
  262.     'Tab'
  263.         The  'getline'  function  of MiserPrint exchanges the tabs with
  264.         the  number  of  spaces  you entered in the tab gadget, because
  265.         MiserPrint  can't  use the tabulators of the printer. Otherwise
  266.         you get a wrong formatted printout.
  267.  
  268.     'Header'
  269.     'Footer'
  270.         A  header  or  footer  will  be printed on every sheet. You can
  271.         define  the  look of them. It supports some printf- or tex-like
  272.         expressions:
  273.  
  274.         %f      the filename without the path
  275.         %d1     the current date (15-Sep-93)
  276.         %d2     the current date (15.09.93)
  277.         %d3     the current date (09/15/93)
  278.         %t1     the current time (17:25)
  279.         %t2     the current time (05:25 PM)
  280.         %n      the pagenumber
  281.         %tn     the total number of pages
  282.         \hfill  fills  a  line  with spaces until the line has the full
  283.                 length
  284.  
  285.         Examples:
  286.         
  287.         "%f \hfill %n"
  288.         "%f \hfill %n / %nt"
  289.         "%f \hfill %d1 \hfill %t1 \hfill %n"
  290.         "\hfill - %n - \hfill"
  291.         "\hfill %n"
  292.  
  293.     'Seperate'
  294.         You  can  print a thin horizontal line between the blocks. This
  295.         option can only be used with the 2x2 blocks.
  296.  
  297.     'Block #'
  298.         On  the  bottom  of each block the number of this block will be
  299.         printed.
  300.  
  301. The String Gadgets
  302. ------------------
  303.  
  304.     'Filename'
  305.         You  can  select  a  file  by  clicking  the  getfile  image (a
  306.         filerequester  appears)  or  by  entering  the  filename in the
  307.         string gadget.
  308.  
  309.     'Port'
  310.         The  cycle  gadget allows you to print directly to your printer
  311.         (your  printer  preferences are used) or to a file. The getfile
  312.         image  and  the  string gadget are only activ when the printout
  313.         to a file is selected.
  314.  
  315. The Action Gadgets
  316. ------------------
  317.  
  318.     'Edit'
  319.         To  edit  the  file  you  can click this button and the command
  320.         'c:ed <filename>' is executed. You can also set the environment
  321.         variable  EDITOR to your preferable editor. I have done this by
  322.         'setenv EDITOR tools:ed -sticky' to use CygnusEd.
  323.     
  324.     'FileInfo'
  325.         The  file  is  scanned  and a requester shows some informations
  326.         about it.
  327.     
  328.     'Preview'
  329.         A  preview window is opened and the last page is displayed. You
  330.         can  move through the document with the four buttons on the top
  331.         or  with  the  cursor keys. Click the closing gadget or use the
  332.         ESC key to exit the preview.
  333.     
  334.     'Print'
  335.         If this button is clicked, the file will be printed.
  336.  
  337.     The  'FileInfo'  and 'Print' command can be aborted by clicking the
  338.     closing gadget.
  339.  
  340.     MiserPrint  doesn't  copy  the  whole file to memory but stores the
  341.     file  positions of the pages in a list. I chose this method to save
  342.     memory.
  343.  
  344. 4.4. Menu
  345. ---------
  346.  
  347. Project
  348. -------
  349.  
  350.     'Open...'
  351.         This command is used to load an old configuration.
  352.  
  353.     'Save As...'
  354.         You can save your actual configuration with this command.
  355.  
  356.     'About'
  357.         Just try it.
  358.  
  359.     'Iconify'
  360.         The  main  window  is closed and an appicon is displayed on the
  361.         workbench (see `CLI' section).
  362.  
  363.     'Quit'
  364.         If  you want to exit the program, execute this command or click
  365.         the closing gadget.
  366.  
  367. Edit
  368. ----
  369.  
  370.     'Reset to defaults'
  371.         My defaults are used.
  372.  
  373.     'Last Saved'
  374.         Resets the configuration to the last saved one.
  375.  
  376.     'Restore'
  377.         MiserPrint uses the configuration on startup.
  378.  
  379. Settings
  380. --------
  381.  
  382.     'HP Deskjet'
  383.         The  checkmark is set if your printer is a Hewlett Packard. The
  384.         printer takes the sheets from the bottom.
  385.         Other inkjets have a different paper feeding from the top side.
  386.         For  this reason the sequence of printing is wrong and you have
  387.         to toggle the checkmark.
  388.  
  389. 5. Acknowledgments
  390. ==================
  391. Thanks to the following people:
  392.  
  393. - Matt Dillon for DICE.
  394.  
  395. - Jan  van  den  Baard  for  GadToolsBox,  which  was  used  to  design
  396.   MiserPrint's GUI.
  397.  
  398. - Stephan Sⁿrken for Text2Guide.
  399.  
  400. - The  users  of MiserPrint who send me bug reports or suggestions.
  401.   Thanks for your picture postcards, letters and donations.
  402.  
  403. - Alexander Aulbach for beta testing and some good ideas.
  404.  
  405. - Denis Galiana and Peter Popanda for beta testing, some ideas and the
  406.   nice icons.
  407.  
  408. - Peter Simons for mailing me some mungwall and enforcer hits.
  409.  
  410. 6. History
  411. ==========
  412.  
  413. V1.14   The 'PREFS' Workbench tooltype didn't work correctly.
  414.         (bug report: Mark Gotz)
  415.         
  416.         Changed  the NewLookMenu handling. Menu background and text had
  417.         the same color under some circumstances (both 2.x and 3.x).
  418.         (bug report: Anthony J. Moringello and Rolf Damm)
  419.         
  420.         The  total number of pages '%tn' are available in the header or
  421.         footer string.
  422.         (suggestion: Frank Tischendorf) 
  423.  
  424. V1.13   Did you ever want to print only the even or odd pages?
  425.         (suggestion: Denis Galiana and Peter Popanda)
  426.  
  427.         Modified the print functions and added the printer type option.
  428.         (suggestion: Peter Popanda)
  429.  
  430.         Replaced a command that caused trouble with non-HP-printers.
  431.  
  432.         Some minor modifications.
  433.  
  434. V1.12   The  last  line of text wasn't printed if there was only an EOF
  435.         and no linefeed in this line.
  436.         (bug report: Robert Hamberger)
  437.  
  438.         After the printer has finished printing it is reseted.
  439.         (suggestion: Tom Duncan)
  440.  
  441.         Added AppWindow and AppIcon.
  442.         (suggestion: Denis Galiana)
  443.  
  444.         Fixed a bug in my memory allocation function.
  445.  
  446.         Added IconX, IconY, WindowX and WindowY.
  447.  
  448. V1.11   Removed the 'NOGUI' switch in the CLI. Has anybody used it?
  449.         
  450.         I found a bug in the IFF read function and removed it.
  451.  
  452.         There were one mungwall and two enforcer hits in a beta version.
  453.         (bug report: Peter Simons)
  454.  
  455. V1.10   NOT RELEASED!
  456.  
  457.         Removed the 'Really quit MiserPrint?' requester.
  458.     
  459.         I  forgot  to  take an empty page of paper, if you selected the
  460.         double  mode  and  there  was  an odd number of pages. For this
  461.         reason the sequence of the printout was wrong.
  462.         (bug report: Ulrich Zukowski)
  463.         
  464.         If  you  click  the  formfeed or double gadget the file will be
  465.         scanned the next time again.
  466.         (bug report and suggestion: Ulrich Zukowski)
  467.         
  468.         MiserPrint  uses the 'printer.device'. There is a timeout, e.g.
  469.         if your printer is offline or out of paper. You are able to use
  470.         a printer spooler.
  471.         (suggestion: Alexander Aulbach)
  472.         
  473.         I  changed  the  print  functions,  so  that  you  can abort it
  474.         quicker.
  475.         
  476.         The ANSI-ESC-sequence "<esc>[0m" selects the normal font.
  477.         (suggestion: Ulrich Zukowski)
  478.         
  479.         Have  you ever tried to print some underlined lines? The result
  480.         wasn't nice. I corrected these functions.
  481.         
  482.         Now you can print a footer.
  483.         (suggestion: Denis Galiana)
  484.         
  485.         MiserPrint stores its data in an IFF file, but it reads the old
  486.         configuration files too.
  487.         
  488.         You are able to choose the pages you want to (re)print.
  489.         (suggestion: Denis Galiana)
  490.  
  491.         A  horizontal  seperation line and the number of each block can
  492.         be printed.
  493.         (suggestion: Marcel DuruflΘ)
  494.  
  495. V1.01   There was a bug in the requester of the doublesided printout.
  496.         (bug report: Alexander Aulbach and Ulrich Zukowski)
  497.  
  498. V1.0    First release.
  499.