home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 636.lha / EnvPrint_v1.50 / EnvPrint.doc.pp / EnvPrint.doc
Encoding:
Text File  |  1992-05-12  |  17.0 KB  |  478 lines
  1.  
  2.                              +---------------+
  3.                              | EnvPrint 1.50 |
  4.                              +---------------+
  5.  
  6.                   Written by Stefan Zeiger in 1991 & 1992
  7.                         © 1991 by ! WIZARD WORKS !
  8.  
  9. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  10.                         This program is SHAREWARE.
  11.                         ~~~~~~~~~~~~~~~~~~~~~~~~~~
  12.         It may only be distributed under the following conditions :
  13.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14.    - No profit is made with it.
  15.    - All files remain together in their original form.
  16.    - If you include this program in program library disks, the per-disk-fee
  17.      may not be more than US$ 6 or DM 10.
  18.    - This condition is only for Germany, Austria, Switzerland :
  19.      DIESES PROGRAMM DARF NICHT VON MITGLIEDERN DER 'SCHWARZEN LISTE' KOPIERT
  20.      WERDEN.
  21.  
  22.                  IF YOU HAVE DECIDED TO USE THIS PROGRAM,
  23.                      YOU MUST PAY THE SHAREWARE FEE OF
  24.                     US$ 10 / DM 20 / 6 POUNDS STERLING.
  25.                   THEN YOU ARE A REGISTERED USER AND GET
  26.                INFORMED ABOUT FUTURE RELEASES OF "EnvPrint".
  27.                  SEND YOUR MONEY TO THE ADDRESS AT THE END
  28.                                OF THIS FILE.
  29.  
  30. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  31.  
  32.  
  33.  
  34.  
  35.                                 Important :
  36.                                 ~~~~~~~~~~~
  37.           YOU NEED THE "REQ.LIBRARY" IN THE "LIBS:" DIRECTORY !!!
  38.   IF YOU WANT TO USE THE AREXX PORT, YOU NEED THE "REXXSYSLIB.LIBRARY" IN
  39.         THE "LIBS:" DIRECTORY AND YOU MUST HAVE STARTED "REXXMAST".
  40.     ( IN AN OS2.04 SYSTEM, AREXX IS NORMALLY STARTED BY DEFAULT IN THE
  41.                             STARTUP-SEQUENCE )
  42.  
  43.  
  44.  
  45.                              Getting started :
  46.                              ~~~~~~~~~~~~~~~~~
  47. EnvPrint is a handy tool for printing envelopes for letters. It can be started
  48. from either CLI or Workbench. So, let's go...
  49.  
  50.  
  51.  
  52.  
  53.                            The address gadgets :
  54.                            ~~~~~~~~~~~~~~~~~~~~~
  55. You can enter the source and destination addresses in the string gadgets of the
  56. EnvPrint window. The first two lines of each address are for the Name. If you
  57. only need one line, use the second gadget. You can also enter a comment in the
  58. comment gadget at the bottom of the window.
  59.  
  60.  
  61.  
  62.  
  63.                           The "action" gadgets :
  64.                           ~~~~~~~~~~~~~~~~~~~~~~
  65. At the right side of the window are some gadgets to perform various actions :
  66. "Load" and "Save" are used to load and save addresses or comments (S. = source,
  67. D. = destination, C. = comment). "Clear all" clears all gadgets on the EnvPrint
  68. window. "Swap" swaps the source and destination addresses. And last but not
  69. least : "Print" : This function prints the addresses and the comment onto an
  70. envelope. If you answer the requester with "FRONT", both source and destination
  71. addresses will be printed on the front side of the envelope. "FRONT & BACK"
  72. prints the destination address on the front side and the source address on the
  73. back side of the envelope. The comments are always printed on the front side.
  74. You can cancel the printing job by clicking on the "Cancel" gadget in a
  75. requester. If you use "FRONT & BACK", you will be asked for both sides, so
  76. that you can e.g. print just the source address on the back side by answering
  77. the "FRONT" requester with "Cancel" and the "BACK" requester with "Ok".
  78.  
  79.  
  80.  
  81.  
  82.                                 The menus :
  83.                                 ~~~~~~~~~~~
  84. Project   About...                    <Same as gadget>
  85.           Save prefs                  Save prefs to 's:EnvPrint.prefs'
  86.           Quit...                     <Same as gadget>
  87. Disk      Load source...              <Same as gadget>
  88.           Load destination...         <Same as gadget>
  89.           Load comment...             <Same as gadget>
  90.           Save source...              <Same as gadget>
  91.           Save destination...         <Same as gadget>
  92.           Save comment...             <Same as gadget>
  93.           Delete file...              Delete a file
  94. Edit      Swap                        <Same as gadget>
  95.           Clear...                    <Same as gadget>
  96. Print     Both on front...            Print everything onto the front side
  97.           Source on front...          Print only source onto front side
  98.           Destination on back...      Print destination onto back side
  99.           Front & Back                <The last menu items ones combined>
  100. Format    Lines before source...      Number of lines before source address
  101.           Source offset...            Number of spaces at the left of source
  102.           Lines after source...       -- " --
  103.           Comment offset...           -- " --
  104.           Lines after comment...      -- " --
  105.           Destination offset...       -- " --
  106.           Lines before backside...    -- " --
  107.           Backside offset...          -- " --
  108. Preset    DIN C 6                     Set prefs for german 'DIN C 6' format
  109.           US Standard                 I'm not sure if this works correct.
  110.                                       If you have envelopes, that you would
  111.                                       like to have as a preset in this menu,
  112.                                       send me your prefs file, an example of
  113.                                       the envelope (with addresses and a
  114.                                       comment printed on it), and the official
  115.                                       name of the envelope format.
  116.  
  117.  
  118.  
  119.  
  120.                             Startup procedure :
  121.                             ~~~~~~~~~~~~~~~~~~~
  122. When you start EnvPrint, it will first try to load its configuration file
  123. (s:EnvPrint.prefs). If this file does not exist, or it has a wrong format,
  124. because it's from an earlier version of EnvPrint, a requester will come up
  125. telling you what went wrong. You should then select 'Save prefs...' from the
  126. 'Project' menu, and the next time you start EnvPrint, this configuration will
  127. be loaded. After searching for the prefs file, EnvPrint tries to load the
  128. default source address (s:EnvPrint.source). This is useful for users without
  129. ARexx to load their home address automatically. If you have ARexx, I recommend
  130. to use EnvPrint's ARexx startup file (REXX:startup.evp). This offers much more
  131. flexibility, because you can not only load the source address, but also e.g.
  132. set the "comment" to your preferred default (e.g. "By Air Mail"). Finally the
  133. ARexx startup file is executed, and then EnvPrint enters the normal, inter-
  134. active mode.
  135.  
  136.  
  137.  
  138.  
  139.                              Printing format :
  140.                              ~~~~~~~~~~~~~~~~~
  141. Normally the first line of an address is printed "condensed". If
  142. this line is empty, the second line is printed condensed. If you add the
  143. name of a country in the 5th gadget, this will be printed "underlined". The
  144. telephone number (6th gadget) is certainly only used in the source address,
  145. and then also only if you print the source address on the FRONT side of the
  146. envelope. The country is also only printed onto the front side, because many
  147. printers can't start printing right at the top of an envelope and the space
  148. on the upper part of an envelope's back side is usually not very big.
  149.  
  150. The best way to learn how EnvPrint works, is to load two of the addresses
  151. in the directory "EnvPrint/Addresses" and a comment from "EnvPrint/Comments",
  152. and print this on an envelope (or just a sheet of paper).
  153.  
  154.  
  155.  
  156.  
  157.                          Adjusting your printer :
  158.                          ~~~~~~~~~~~~~~~~~~~~~~~~
  159. Additional information for users of the « STAR LC 24-10 » printer :
  160. If you want to print onto envelopes, you should move the printer head two
  161. steps farther away from the paper than with normal paper.
  162.  
  163. This is certainly also necessary with many other printer.
  164.  
  165.  
  166.  
  167.  
  168.                              The ARexx port :
  169.                              ~~~~~~~~~~~~~~~~
  170. The ARexx  port of EnvPrint  is called  "EVP_Host". If  you execute a
  171. script  with "rx"  (e.g. "rx version.evp")  you have  to set the port
  172. with  the "address" command  (i.e. "address 'EVP_Host'"). The  script
  173. "rexx:startup.evp" is  automatically executed  with "EVP_Host" as its
  174. default port if  EnvPrint finds ARexx installed while starting up. If
  175. you start EnvPrint twice with  ARexx, only the first call will open a
  176. port. The second  call tells you  by a requester, that it wasn't able
  177. to install a port and it continues in non-ARexx mode. If ARexx is not
  178. installed, EnvPrint works also in non-ARexx mode, but it doesn't come
  179. up with  a requester,  because it  would be  very annoying  for users
  180. without ARexx to answer a requester everytime they start EnvPrint.
  181.  
  182. To  demonstrate  the  use of  the  ARexx commands  of EnvPrint,  I've
  183. included some example scripts  in the "REXX" drawer.  If you want to
  184. use them, you have to start EnvPrint and then  enter the CLI and exe-
  185. cute a command like "rx scriptfile.evp".
  186.  
  187.  
  188.  
  189.  
  190.                              ARexx Commands :
  191.                              ~~~~~~~~~~~~~~~~
  192. EnvPrint 1.50 knows 28 ARexx command.  This is a list of all commands
  193. in alphabetical order, followed by the function descriptions.
  194.  
  195. about .................................... Show the ABOUT requester
  196. clear .................................... Clear the fields
  197. evpreq ................................... Show a requester
  198. loadc .................................... Load comment
  199. loadd .................................... Load destination
  200. loads .................................... Load source
  201. printba .................................. Print back side
  202. printboth ................................ Print both on fromt side
  203. printfr .................................. Print front side
  204. quit ..................................... Quit EnvPrint
  205. savec .................................... Save comment
  206. saved .................................... Save destination
  207. saves .................................... Save source
  208. setco .................................... Set comment
  209. setd1 .................................... Set field 1 of destination
  210. setd2 .................................... Set field 2 of destination
  211. setd3 .................................... Set field 3 of destination
  212. setd4 .................................... Set field 4 of destination
  213. setd5 .................................... Set field 5 of destination
  214. setd6 .................................... Set field 6 of destination
  215. sets1 .................................... Set field 1 of source
  216. sets2 .................................... Set field 2 of source
  217. sets3 .................................... Set field 3 of source
  218. sets4 .................................... Set field 4 of source
  219. sets5 .................................... Set field 5 of source
  220. sets6 .................................... Set field 6 of source
  221. swap ..................................... Swap source and detination
  222. version .................................. Get version string
  223.  
  224.  
  225. IMPORTANT
  226.             If a command or function fails, it returns with an error
  227.             code of 10.
  228.  
  229.             In the below descriptions all unnecessary keywords are
  230.             left out. E.g. if the "SYNOPSIS" is just the same as the
  231.             "NAME", the "SYNOPSIS" is left out.
  232.  
  233.  
  234. ;--------------------------------------------------------------------
  235.  
  236. NAME
  237.             about
  238.  
  239. DESCRIPTION
  240.  
  241.             The command "about" opens EnvPrint's ABOUT requester and
  242. waits for the user to answer it.
  243.  
  244. ;--------------------------------------------------------------------
  245.  
  246. NAME
  247.             clear
  248.  
  249. DESCRIPTION
  250.  
  251.             "clear" clears the 6 source gadgets, the 6 destination
  252. gadgets and the comment gadget. In contrast to the "Clear" gadget in
  253. the EnvPrint window, this command does *NOT* ask, if you really want
  254. to clear everything.
  255.  
  256. ;--------------------------------------------------------------------
  257.  
  258. NAME
  259.             evpreq
  260. SYNOPSIS
  261.             evpreq <string>
  262.  
  263. DESCRIPTION
  264.  
  265.             "evpreq" displays a requester with the <string> in it and
  266. waits for the user to answer it.
  267.  
  268. EXAMPLE
  269.             evpreq "Press <R> to quit"
  270.             quit
  271.  
  272. ;--------------------------------------------------------------------
  273.  
  274. NAME
  275.             loadc, loadd, loads
  276. SYNOPSIS
  277.             load(c|d|s) <filename>
  278.  
  279. DESCRIPTION
  280.  
  281.             "loadc" loads a comment from disk; "loadd" loads an add-
  282. ress into the "destination" fields, "loads" loads an address into the
  283. source fields.
  284.  
  285. RETURNS
  286.             If these commands fail, they set the return code to 10.
  287. EXAMPLE
  288.             loads "addresses/Stefan Zeiger"
  289.             loadd "addresses/Carsten Raufuß"
  290.             loadc "comments/Air Mail"
  291. SEE
  292.             savec, saved, saves
  293.  
  294. ;--------------------------------------------------------------------
  295.  
  296. NAME
  297.             printba, printboth, printfr
  298. SYNOPSIS
  299.             print(ba|both|fr) <(device|file)>
  300.  
  301. DESCRIPTION
  302.  
  303.             These commands print the addresses and the comment that
  304. are currently loaded. "printba" prints the back side, "printfr" the
  305. front side of a double-sided envelope; "printboth" prints the front
  306. side of a single-sided envelope. The envelope must already be in-
  307. serted, because the print commands don't wait with a requester, but
  308. instead start printing at once.
  309.  
  310. RETURNS
  311.             These commands set the return value to 10 if they can't
  312. open the specified device/file.
  313.  
  314. EXAMPLE
  315.             ¹) printboth "prt:"
  316.             ²) printfr "ram:front"
  317.                printba "ram:back"
  318.  
  319. ;--------------------------------------------------------------------
  320.  
  321. NAME
  322.             quit
  323.  
  324. DESCRIPTION
  325.  
  326.             "quit" quits EnvPrint and shuts down the ARexx port with-
  327. out asking the user by a requester.
  328.  
  329. RETURNS
  330.             When "quit" returns, the ARexx port "EVP_Host" does not
  331. exist anymore, so sending a command to it will produce an error of
  332. the ARexx interpreter.
  333.  
  334. ;--------------------------------------------------------------------
  335.  
  336. NAME
  337.             savec, saved, saves
  338. SYNOPSIS
  339.             save(c|d|s) <filename>
  340.  
  341. DESCRIPTION
  342.  
  343.             The save commands save the source address ("s"), the des-
  344. tination address ("d") and the comment ("c") to the specified file.
  345.  
  346. RETURNS
  347.             If these commands fail, they set the return code to 10.
  348. EXAMPLE
  349.             savec "ram:my very own comment"
  350. SEE
  351.             loadc, loadd, loads
  352.  
  353. ;--------------------------------------------------------------------
  354.  
  355. NAME
  356.             setco
  357. SYNOPSIS
  358.             setco <string>
  359.  
  360. DESCRIPTION
  361.  
  362.             "setco" sets the comment to the specified string.
  363. EXAMPLE
  364.  
  365. SEE
  366.             setd1, setd2, setd3, setd4, setd5, setd6
  367.             sets1, sets2, sets3, sets4, sets5, sets6
  368.  
  369. ;--------------------------------------------------------------------
  370.  
  371. NAME
  372.             setd1, setd2, setd3, setd4, setd5, setd6
  373. SYNOPSIS
  374.             setd(1|2|3|4|5|6) <string>
  375.  
  376. DESCRIPTION
  377.  
  378.             "setd..." sets the specified field (1-6) of the destina-
  379. tion address to the specified string.
  380.  
  381. EXAMPLE
  382.  
  383.             setd1 "! Wizard Works !"
  384.             setd2 "Stefan Zeiger"
  385.             setd3 "Seligenstädter Weg 24"
  386.             setd4 "D-W-8756 Kahl"
  387.             setd5 "Western Germany"
  388.             setd6 "Voice: (49)-6188-2525"
  389. SEE
  390.             sets1, sets2, sets3, sets4, sets5, sets6
  391.             setco
  392.  
  393. ;--------------------------------------------------------------------
  394.  
  395. NAME
  396.             sets1, sets2, sets3, sets4, sets5, sets6
  397. SYNOPSIS
  398.             sets(1|2|3|4|5|6) <string>
  399.  
  400. DESCRIPTION
  401.  
  402.             "sets..." sets the specified field (1-6) of the source
  403. address to the specified string.
  404.  
  405. SEE
  406.             setd1, setd2, setd3, setd4, setd5, setd6
  407.             setco
  408.  
  409. ;--------------------------------------------------------------------
  410.  
  411. NAME
  412.             swap
  413.  
  414. DESCRIPTION
  415.  
  416.             "swap" does exactly the same as clicking on the "Swap"
  417. gadget in EnvPrint's window; it swaps the source and the destina-
  418. tion gadget.
  419.  
  420. ;--------------------------------------------------------------------
  421.  
  422. NAME
  423.             version
  424.  
  425. DESCRIPTION
  426.  
  427.             The function "version" returns the version string of the
  428. EnvPrint program. This is the same as using the Shell's "version"
  429. command, i.e. "version EnvPrint full".
  430.  
  431. RETURNS
  432.             If you turn on the "results" option, this function will
  433. return EnvPrint's version in the variable "result".
  434.  
  435. EXAMPLE
  436.             options results
  437.             version
  438.             say result
  439.  
  440. ;--------------------------------------------------------------------
  441.  
  442.  
  443.  
  444.  
  445.                           Technical information :
  446.                           ~~~~~~~~~~~~~~~~~~~~~~~
  447.                  THIS PROGRAM WAS WRITTEN WITH SAS/C 5.10.
  448.  
  449.  
  450.  
  451.  
  452.     CU (See you :-) ,
  453.  
  454.             Stefan.
  455.  
  456.  
  457.  
  458. -----------------------------------------------------------------------------
  459.  
  460.    STANDARD MAIL :     ! WIZARD WORKS !
  461.                        Stefan Zeiger
  462.                        Seligenstaedter Weg 24
  463.                        D-W-8756 Kahl
  464.                        West Germany
  465.  
  466.            VOICE :     ++49-(0)6188-2525
  467.  
  468.          MAILBOX :     ++49-(0)69-5975113
  469.                        "The Hitchhiker" (H.T.H.) in Frankfurt
  470.                        300-14400 bps, 8/N/1, 24h online
  471.                        Username : "STEFAN"
  472.  
  473.            EMAIL :     AmNet    : STEFAN;HTH
  474.                        Fido     : STEFAN%HTH.AMN 2:247/12.5
  475.                        Zerberus : STEFAN%HTH@AMNET.ZER
  476.  
  477. -----------------------------------------------------------------------------
  478.