home *** CD-ROM | disk | FTP | other *** search
/ World of A1200 / World_Of_A1200.iso / programs / printer / printfiles / printfiles.doc < prev    next >
Encoding:
Text File  |  1995-02-27  |  21.7 KB  |  620 lines
  1. *********************************************************************
  2. *                         PrintFiles                                *
  3. *                        Version 0.91e                               *
  4. *                                                                   *
  5. *               Copyright © 1992 by K.Klingbeil                     *
  6. *********************************************************************
  7.  
  8. Note: If you paid more than 5 $US/DM/£UK for a disk including PrintFiles
  9. your dealer is a thief and you're a fool!
  10.  
  11. *********************************************************************
  12. DISCLAIMER
  13. The author cannot be held liable for the  suitability or  accuracy
  14. of this manual  and/or  the  program(s)  it  describes.   Any  damage
  15. directly  or indirectly caused by the use or misuse of  this manual
  16. and/or the  program it describes is the sole responsibility of the
  17. user her/him self.
  18. *********************************************************************
  19.  
  20.  
  21. *********************************************************************
  22. DISTRIBUTION:
  23. PrintFiles, © Copyright 1992 K.Klingbeil. All rights reserved. This
  24. Program is FREEWARE so no financial donations are required ( but welcome ).
  25. This   program  may  be  freely  distributed  as  long  as all source code,
  26. documentation and executable remain unchanged and are included  with the
  27. distribution. Also no profit is to be made  by  selling  this  program.
  28.  
  29.  
  30. *********************************************************************
  31. *               Contents of this manual                             *
  32. *********************************************************************
  33.  
  34. 1. Introduction
  35. 2. Installation
  36.    2.1 Requirements
  37.    2.2 Installation
  38. 3. Quickstart
  39. 4. How to use PrintFiles
  40.    4.1. The printer icon
  41.    4.2. The control window
  42.         4.2.1 open the control window
  43.         4.2.2 close the control window
  44.         4.2.3 the settings of the control window
  45.    4.3. The prefs window
  46.         4.3.1 open the prefs window
  47.         4.3.2 close the prefs window
  48.         4.3.3 the settings of the prefs window
  49.  
  50. 5. The Arexx-Port
  51.    5.1. Command summary of the Arexx-Port
  52. 6. Starting Printfiles
  53.    6.1. Usage from CLI/Shell
  54.    6.2. Usage from Workbench
  55. 7. Notes
  56.  
  57. *********************************************************************
  58. *                      1. Introduction                              *
  59. *********************************************************************
  60.  
  61. PrintFiles is designed to replace the Printfiles-command distributed
  62. with your Workbench disk. Unlike the original printfiles it is more
  63. user-friendly and offers you much more possibilities , e.g. Headlines,
  64. date,time...
  65.  
  66. The features are:
  67.  
  68.     - Printer Icon on the Workbench.
  69.       To print a File simply drag its icon onto the printer icon.
  70.     - A print list of unlimited size.
  71.     - Files are also inserted into the print list by dragging their
  72.       icons into the control window.
  73.     - You can print headlines, baselines, date, time, filename,
  74.       page numbers and line numbers.
  75.     - You can set your printer to draft/lq quality.
  76.     - Arexx-Port with 23 commands gives you full control over Printfiles.
  77.     - Saves its preferences as Arexx-Scripts
  78.     - Prints Icon Images
  79.  
  80. Try it !
  81.  
  82. *********************************************************************
  83. *                    2. Installation                                *
  84. *********************************************************************
  85.  
  86. 2.1 Requirements
  87.     Printfiles runs only under OS 2.04 with system libraries V37+.
  88.     Printfiles uses only about 50K memory so that it will run even on
  89.     512K Amigas. Harddisk and/or additional memory are not required, but
  90.     useful.
  91.  
  92. 2.2 Installation
  93.     Printfiles needs no complex installation procedures. Just copy the
  94.     program into your c: or WBStartup directory.
  95.     If you want to use the Arexx-Port of Printfiles, be sure that the
  96.     RexxMaster Process is running before you attempt to run Printfiles.
  97.     Printfiles will not work if the Workbench is closed, so be sure that
  98.     you start PrintFiles after the LoadWB command.
  99.  
  100.     Note: if you run Printfiles multiple, an Arexx-Port exists only in
  101.     the first program.
  102.  
  103.     To start Printfiles automatically at Startup you can:
  104.        a. add the line 'PrintFiles' to the File s:user-startup
  105.        b. copy Printfiles into the WBStartup Drawer.
  106.           In this case you may add the ToolType DONOTWAIT to the
  107.           PrintFiles icon.
  108.  
  109. *********************************************************************
  110. *                     3. Quickstart                                 *
  111. *********************************************************************
  112.  
  113. This chapter gives you an example how to use Printfiles.
  114.  
  115.      Step 1 . Turn your printer on.
  116.      Step 2 . Doubleclick the Printfies icon or type
  117.               'PrintFiles'[return] into a shell window
  118.      Step 3 . Now you have an additional printer icon  on the
  119.               Workbench
  120.      Step 4 . Drag the icon of this .doc File on the Printer icon
  121.               and it will be printed.
  122.      Step 5 . Open the control window by double-clicking on the
  123.               printer icon.
  124.      Step 6 . Now You see the control window with the print list in
  125.               the center of the window
  126.      Step 7 . Drag more icons on the printer icon or into the control
  127.               window to insert them into the print list. you can also
  128.               insert files by typing the names into the StringGadget under
  129.               the list. To select files from a Filerequester click the
  130.               Request-Button.
  131.      Step 8 . Select some buttons, e.g. Date,Time ...
  132.      Step 9 . Click the Print-button and the whole list will be printed.
  133.      Step 10. After the print select the quit-button or the Close-Gadget
  134.               of the window. A requester will appear.
  135.      Step 11. Select the quit-button of the Requester.
  136.  
  137.  
  138. *********************************************************************
  139. *                     4. How to use Printfiles                      *
  140. *********************************************************************
  141.  
  142. The main Element in PrintFiles is the print list. The main operation
  143. in PrintFiles is to insert filenames into this list and print a  list.
  144. You can insert names in several ways: At Startup by the commandline or
  145. selected icons, by dragging icons onto the printer icon or into the
  146. control window, by using FileRequster or the Arexx-Port.
  147.  
  148. 4.1 The printer icon
  149.     PrintFiles adds a printer icon to the workbench. You can insert
  150.     files by dragging icons onto the printer icon.
  151.     If the control window is closed, this files are immediately printed.
  152.     If the window is open, they are added at the end of the list.
  153.  
  154. 4.2 The control window
  155.     This window contains all settings for the printer. It can be opened
  156.     or closed as you like and it remembers its position on re-opening.
  157.     NOTE: If you use a NTSC-machine check chapter 2.1 !
  158.  
  159.     4.2.1 Opening the control window
  160.           The window is normally closed at startup. You can open it
  161.           a. at startup  (see also chapter 6)
  162.              - from CLI/Shell by using option -w.
  163.              - from Workbench by using the TOOL TYPE
  164.                WINDOW=<left edge><top edge>.
  165.  
  166.           b. at runtime
  167.              - by double-clicking on the printer icon.
  168.              - by selecting the Item 'Printfiles' in the
  169.                Workbench-Tool-Menu.
  170.              - by sending the command 'openwindow <left edge><top edge>'
  171.                to the Arexx-Port of Printfiles. (see also chapter 5)
  172.  
  173.     4.2.2 Closing the control window
  174.           - Double-click on the printer icon
  175.           - Select the Item 'Printfiles' in the Workbench-Tool-Menu.
  176.           - Send the command 'closewindow' to the Arexx-Port of Printfiles.
  177.             (see also chapter 5)
  178.  
  179. *********************************************************************
  180. *                          5. Settings                              *
  181. *********************************************************************
  182.  
  183. The setting of the control window are ( top down ):
  184.  
  185.       -Prefs
  186.         AREXX    : openwindow prefs <LeftEdge><TopEdge>
  187.         opens the printer preferences window at <leftedge><topedge>
  188.  
  189.       -about
  190.         AREXX    : version
  191.         Displays a requester containing the version number
  192.  
  193.       -Button date/Time/File
  194.         AREXX    : date on/off
  195.                    time on/off
  196.                    file on/off
  197.         CLI      : -d -t -n
  198.         TOOL TYPE: FLAGS=d FLAGS=t FLAGS=n
  199.         If one of these buttons is checked,  additional headline with
  200.         the requested information is generated.
  201.  
  202.        -Stringgadget headline/footline
  203.         AREXX    : headline  [...] sets headline  string
  204.                    footline [...] sets footline string
  205.         TOOL TYPE: headline=[...] footline=[...]
  206.         If a string is set, it will be printed on the top/foot of each
  207.         page.
  208.  
  209.        -Pagenumbers
  210.         AREXX    : page on/off
  211.         CLI      : -p
  212.         TOOL TYPE: FLAG=p
  213.         If checked, the string *** Page: xxxxx *** will be printed
  214.         on the foot of each page. Additionally, at the end of a file
  215.         the count of pages of this file is printed.
  216.  
  217.        -LineNumbers
  218.         AREXX    : line on/off
  219.         CLI      : -l
  220.         TOOL TYPE: FLAGS=l
  221.         If checked, each line will have a number.
  222.  
  223.        -FF/Page
  224.         AREXX    : fpage
  225.         CLI      : -c
  226.         TOOL TYPE: FLAGS=c
  227.         If checked, printfiles generates a form feed after each page.
  228.  
  229.        -Form Feed
  230.         AREXX    : ff on/off
  231.         CLI      : -f
  232.         TOOL TYPE: FLAGS=f
  233.         If checked, a Form Feed is printed after each file.
  234.  
  235.        -Request
  236.         Displays a FileRequester and adds the choosen file to
  237.         the list.
  238.  
  239.        -Remove
  240.         AREXX    : remfile  remfile <File>
  241.         If you click onto a filename in the list, this file will be
  242.         displayed in the stringgadget beneath the remove-button.
  243.         If you then click this button, the file is removed from the
  244.         list. If the stringgadgets contains no name, the last file
  245.         of the list is removed.
  246.  
  247.        -Print
  248.         AREXX    : print
  249.         Begins printing the list. While Printing, this gadget is disabled.
  250.         You can perform all other functions like adding files, removing
  251.         files and so on. All changes are immediately recognized.
  252.         NOTE: It depends on the size of the printer buffer how fast the
  253.               changes will appear on the paper !
  254.  
  255.        -Quit  (and CloseGadget of the window)
  256.         AREXX    : quit
  257.         If the program is currently printing it will request you to abort
  258.         or continue the print.
  259.         If the program is not printing it will request you to quit the
  260.         program or to close the window (see chapter 4.2.1 and 4.2.2)
  261.         NOTE: the Arexx command will not display a requester !
  262.  
  263. 4.3. The Prefs Window
  264.  
  265.   4.3.2 Opening the prefs window
  266.         - click the 'Prefs' button in the control window
  267.         - send the 'openwindow prefs <Leftedge><TopEdge>' command to
  268.           the Arexx-Port.
  269.   4.3.3 Closing the prefs window
  270.         - click the closegadget of the prefs window
  271.         - send the 'closewindow prefs' command to
  272.           the Arexx-Port.
  273.   4.3.3 Settings of the prefs Window
  274.  
  275.         -button Draft/Lq
  276.          AREXX     : draft
  277.                      lq
  278.          TOOL TYPE : FLAGS=a
  279.                      FLAGS=q
  280.          CLI       : -a -q
  281.          Set the print quality to draft or lq
  282.  
  283.         -button 6 lines/inch  8 lines/inch.
  284.          AREXX     : 6li
  285.                      6li
  286.          TOOL TYPE : FLAGS=6
  287.                      FLAGS=8
  288.          CLI       : -6 -8
  289.          Set the spacing to 1/6 inch or 1/8 inch.
  290.  
  291.         -button 10cpi/12cpi/15cpi
  292.          AREXX     : 10cpi
  293.                      12cpi
  294.                      15cpi
  295.          TOOL TYPE : FLAGS=0
  296.                      FLAGS=2
  297.                      FLAGS=5
  298.          CLI       : -0 -2 -5
  299.          Set the pitch to Normal (10cpi) / Elite (12cpi) / condensed (15cpi).
  300.  
  301.         -stringgadget Lines/page
  302.          AREXX     : lines <number>
  303.          TOOL TYPE : LINES=<number>
  304.          Print <number> lines on each page.
  305.  
  306.         -stringgadget Left Margin
  307.          AREXX     : lmargin <number>
  308.          TOOL TYPE : LMARGIN=<number>
  309.          Set the left margin to column <number>
  310.  
  311.         -stringgadget Right Margin
  312.          AREXX     : rmargin <number>
  313.          TOOL TYPE : RMARGIN=<number>
  314.          Set the right margin to column <number>
  315.  
  316.         -button Print
  317.          same as Print-button in the control window.
  318.  
  319.        --------------------------------------------------
  320.        the following gadgets are to choose, which information
  321.        will be saved as an Arexx-Script.
  322.        the flags are for the saveprefs-command (in the Arexx-chapter)
  323.        --------------------------------------------------
  324.        - Comments   adds comments to the arexx script
  325.                     flag : '-c' turns this option on
  326.                     flag : '-C' turns this option off
  327.        - Files      adds the filenames of the print list
  328.                     flag : '-f' on
  329.                     flag : '-F' off
  330.        - Windows    adds openwindow commands for both windows
  331.                     flag : '-w' on
  332.                     flag : '-W' off
  333.        - Start      adds a startup code which tries to launch the
  334.                     PrintFiles program if it isn't already running
  335.                     flag : '-s' on
  336.                     flag : '-S' off
  337.        - Reset      adds a Reset command
  338.                     flag : '-r' on
  339.                     flag : '-R' off
  340.        - Print      adds a print command
  341.                     flag : '-p' on
  342.                     flag : '-P' off
  343.        - Icon       saves an Icon
  344.                     flag : '-i' on
  345.                     flag : '-I' off
  346.        - Head/Footline   saves the current Head/Footline
  347.                     flag : '-l' on
  348.                     flag : '-L' off
  349.        --------------------------------------------------
  350.  
  351.         -button Save
  352.          AREXX     : saveprefs <filename> <-flags>
  353.          Saves the current setting  as an Arexx-Script.
  354.          flags are (see above)
  355.          -cfwsrpil
  356.  
  357. *********************************************************************
  358. *                      5. The Arexx-Port                            *
  359. *********************************************************************
  360.  
  361. The Arexx-port of Printfiles is named 'PRINTFILES'
  362.  
  363. 5.1. Command summary
  364.  
  365.     - clear
  366.       Returns     : nothing
  367.       Arguments   : none
  368.       Clears the print list.
  369.  
  370.     - closewindow <which>
  371.       Returns     : nothing
  372.       Arguments   : control      // close control window
  373.                     prefs        // close prefs window
  374.       Closes the specified  window. If the window is currently closed, the
  375.       command is ignored.
  376.  
  377.  
  378.     - date <on><off>
  379.       Returns     : nothing
  380.       Arguments   : on or off
  381.       sets/clears the date-button
  382.  
  383.     - draft
  384.       Returns     : nothing
  385.       Arguments   : none
  386.       Sets the printer to draft mode.
  387.  
  388.     - file <on><off>
  389.       Returns     : nothing
  390.       Arguments   : on or off
  391.       sets/clears the filename-button.
  392.  
  393.     - ff <on><off>
  394.       Returns: none
  395.       Arguments   : on or off
  396.       sets/clears the FormFeed-button.
  397.  
  398.     - fpage <on><off>
  399.       Returns     : nothing
  400.       Arguments   : on or off
  401.       sets/clears the button FF/Page
  402.  
  403.     - icon <none | text | image | all>
  404.       return      : nothing
  405.       Arguments   : string
  406.       determines the print mode for icons
  407.        none  : Icons are ignored
  408.        text  : print a text info (similar to the workbench info command)
  409.        image : print Image (if your printer is able to print graphics)
  410.        all   : print both text and image
  411.  
  412.     - insfile <filename>
  413.       Returns     : nothing
  414.       Arguments   : filename
  415.       Adds the <filename> to the print list
  416.  
  417.     - line <on><off>
  418.       Returns     : nothing
  419.       Arguments   : on or off
  420.       sets/clears the LineNumber-button.
  421.  
  422.     - lines <zahl>
  423.       Returns     : nothing
  424.       Arguments   : number
  425.       <number> lines per page will be printed.
  426.  
  427.     - lmargin <number>
  428.       Returns     : nothing
  429.       Arguments   : number
  430.       Sets the left  margin to column #<number>
  431.  
  432.     - lq
  433.       Returns     : nothing
  434.       Arguments   : none
  435.       Sets the printer to NLQ mode.
  436.  
  437.     - openwindow <which> <left edge> <top edge>
  438.       Returns     : nothing
  439.       Arguments   : <which> control  //open the control window
  440.                             prefs    //open the prefs window
  441.                     <left>  number
  442.                     <right> number
  443.       Opens the specified  window at <left edge> <top edge>.
  444.       If the edges doesn't fit on the screen the window
  445.       will be adjusted, e.g. 'openwindow control 10000 10000' will
  446.       place the window in the right bottom edge of the screen.
  447.       If no numbers are given, the window will be opened on
  448.       the position where it was closed.
  449.       if the window is already open, the command is ignored.
  450.  
  451.     - page <on><off>
  452.       Returns     : nothing
  453.       Arguments   : on or off
  454.       sets/clears the Pagenumber-button.
  455.  
  456.     - print
  457.       Returns     : nothing
  458.       Arguments   : none
  459.       Starts printing the list.
  460.  
  461.     - prog <none | text | icon | all>
  462.       return      : nothing
  463.       Arguments   : string
  464.       determines the print mode for program files
  465.        none : ignore programs
  466.        text : print a TextInfo (similar to the shell command list)
  467.        icon : print the icon (if the program has one) in the selected print
  468.               mode for icons.
  469.        all  : print both text and icon
  470.  
  471.     - remfile <filename>
  472.       Returns: "NOT-IN-LIST"     if the filename isn't in the list
  473.                "LIST_EMPTY"      if the list was empty
  474.                ""                o.k.
  475.       Arguments   : filename
  476.       Removes the file <filename> from the list.
  477.       if no filename is given the last file of the list is removed.
  478.  
  479.     - reset
  480.       Returns     : nothing
  481.       Arguments   : none
  482.       Clears all buttons, clears the list and sets the printer to
  483.       draft mode.
  484.  
  485.     - rmargin <number>
  486.       Returns     : nothing
  487.       Arguments   : number
  488.       Sets the right margin to column #<number>
  489.  
  490.     - saveprefs <filename> <-flags>
  491.       Returns     : nothing
  492.       Arguments   : strings
  493.       if a filename is given, the current settings are saved as
  494.       an Arexx-script.
  495.       The flags are described in -chapter 4.3.3 Save-
  496.  
  497.     - status
  498.       Returns     : "PRINTING" if Printfiles is currently printing
  499.                     "WAITING"  if PrintFiles isn't printing
  500.       Arguments   : none
  501.  
  502.     - time <on><off>
  503.       Returns: none
  504.       Arguments   : on or off
  505.       sets/clears the time-button.
  506.  
  507.     - headline <string>
  508.       Returns     : nothing
  509.       Arguments   : string
  510.       Sets the footline string.
  511.  
  512.     - quit
  513.       Returns     : nothing
  514.       Arguments   : none
  515.       if PrintFiles is currently printing, the print will be aborted.
  516.       if PrintFiles isn't printing, the program will be quit.
  517.       NOTE: No requesters are displayed !
  518.  
  519.     - version
  520.       Returns     : Version string  (e.g. "Version 0.9e")
  521.       Arguments   : none
  522.  
  523.  
  524.  
  525. *********************************************************************
  526. *                   6. Starting PrintFiles                          *
  527. *********************************************************************
  528.  
  529. 6.1. Usage from Shell/CLI
  530.      printfiles -<flags> file file  ....
  531.      There is no need to 'run' Printfiles.
  532.  
  533.      The following flags are supported:
  534.  
  535.      -t sets the time-button
  536.      -f sets the formfeed-button
  537.      -n sets the filename-button
  538.      -d sets the date-button
  539.      -p sets the pagenumber-button
  540.      -l sets the linenumber-button
  541.      -c sets the CR/LF-button
  542.      -a sets the draft-button (Default)
  543.      -q sets the NLQ-button
  544.      -w open the control window at startup
  545.      -0\
  546.      -2 > set the print pitch to 10cpi/12cpi/15cpi
  547.      -5/
  548.      -6\
  549.      -8/  set the spacing to 1/6 inch or 1/8 inch
  550.  
  551.      The flags can be given as single (e.g. printfiles -w -p -f)
  552.      or grouped (e.g. printfiles -wpf)
  553.  
  554.      All names without hyphen are treated as filenames and are
  555.      added to the print list. If you have specified filenames on
  556.      the command line, they will be printed immediately after
  557.      startup.
  558.  
  559. 6.2. Usage from Workbench
  560.      TOOL TYPES are:
  561.  
  562.      FLAGS= see chapter 6.1.
  563.             Unlike to the CLI you should have only one FLAGS-field.
  564.             (only the first is evaluated !)
  565.  
  566.      WINDOW=<left edge> <top edge>
  567.             Opens the control window (see also chapter 5.1 - openwindow)
  568.  
  569.      LINES=<number>
  570.             <number>lines will be print on each page
  571.             (see chapter 5.1. - lines)
  572.  
  573.      HEADLINE=<string>
  574.             The headline string is set to <string>
  575.             (see chapter 5.1. - headline)
  576.  
  577.      FOOTLINE=<string>
  578.             The footline string is set to <string>
  579.             (see chapter 5.1. - footline)
  580.  
  581.      RMARGIN=<number>
  582.             Sets the right margin to column #<number>
  583.             (see chapter 5.1. - rmargin)
  584.  
  585.      LMARGIN=<number>
  586.             Sets the left margin to column #<number>
  587.             (see chapter 5.1. - lmargin)
  588.  
  589.      You can add files to the list by extended selection with the
  590.      program icon and file icons.
  591.      All selected files are added to the print list and will be
  592.      printed immediately after startup.
  593.  
  594.  
  595. *********************************************************************
  596. *                         7. Notes                                  *
  597. *********************************************************************
  598.  
  599. PrintFiles is Copyright ©1992 K.Klingbeil, All Rights Reserved. There
  600. are 2 Versions, 0.9d in german and 0.9e in english.
  601. Printfiles was programmed with SAS/C 5.10b on an A2000 with 3MB Memory,
  602. A2091 SCSI-Controller and Quantum LPS40 under OS 2.04 (Kick 37.175).
  603.  
  604. Bug reports,  suggestions, criticism, money, jewellery and other gifts
  605. to
  606.  
  607.  
  608.                          Karlheinz Klingbeil
  609.                          Elzstr. 42
  610.  
  611.                          W-7809 Gutach
  612.                          Federal Republic of Germany
  613.  
  614.  
  615. And now: Have Fun !!!
  616.  
  617. *********************************************************************
  618.  
  619.  
  620.