home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / misc_utils / quickreq / quickreq.doc < prev    next >
Text File  |  1991-02-14  |  9KB  |  210 lines
  1.  
  2.  
  3.                                    QuickReq
  4.                                 ==============
  5.  
  6.                            (c) 1991 by Markus Aalto
  7.  
  8.                                  Version: 2.0
  9.  
  10. ***************************************************************************
  11.  
  12. This product is public domain! You may copy this product to anyone as long
  13. as it's made free of charges. Only insignificant copying fee, not more than
  14. 5$, is accepted. Also you may not change in any way files included. The
  15. complete list of files comes after this notice! Also, I am !NOT! in any
  16. situation responsible for damages made by this program or accesory files.
  17. If you for some reason want to include this program into any commercial
  18. Amiga product, you may do that. But only the executable code (QuickReq) is
  19. allowed to be included.
  20.  
  21. List of files included:
  22.  
  23. These files belong under the copyright notice!
  24. QuickReq                - Program file
  25. QuickReq.doc            - This document file
  26. QuickReq.c              - C source file for this program
  27. QuickReq.History        - Programs history
  28.  
  29. These files don't belong under the copyright notice!
  30. README              - Short introductory for this program
  31. Examples/text1      - Example text 1
  32. Examples/text2      - Example text 2
  33. Examples/TestScript - Short example script-file!
  34.  
  35. ***************************************************************************
  36.  
  37. INTRODUCTION
  38. -------------
  39.  
  40. QuickReq is an ask-utility to replace the crude version found from
  41. AmigaDOS. Althought there are several similar programs out there, they all
  42. have lacked few important features (unfortunately this program also lacks
  43. some features of those programs). The ability to use long files for multiple
  44. rows of text in a requester and support for overscan displays have been
  45. rare. This is why QuickReq was originally designed. As I mentioned before,
  46. QuickReq lacks few nice options from other similar programs but I'm
  47. planning to support some of them later. Please infor me what you would
  48. like to see in QuickReq.
  49.  
  50. USAGE
  51. ------
  52.  
  53. To use QuickReq you don't need anything else but the executable code. It
  54. has no .info file, because it was originally designed to be used from CLI.
  55. It should also work from Workbench with IconX or similar program. This is
  56. something I haven't tested. Because QuickReq is a CLI-program I also made
  57. it residentable. This has been achieved by using the 'cres.o'-objectfile
  58. while linking, instead of 'c.o'. Now copy QuickReq to somewhere into your
  59. path (maybe to c-directory) and then you are ready to use it.
  60.  
  61. Write QuickReq to get some help! The following text prints to your screen.
  62.  
  63. QuickReq V2.0 (c) 1991 by Markus Aalto
  64. USAGE: QuickReq <Question> [<True>] <False> [OPTIONS] or
  65.                 <FileName> [OPTIONS]
  66. OPTIONS:
  67.            -C  = Text centering
  68.            -B  = DisplayBeep
  69.            -L  = Large view
  70.            -W# = Width
  71.            -H# = Height
  72.            -P# = Pen color
  73.  
  74.  
  75. QUESTION
  76. Question is the requester text. For example you want to ask if the user
  77. wants to load workbench, then the question text could look like
  78. this.
  79.  
  80. "Do you want to load Workbench?"
  81.  
  82. Of course you can write anything you want but this was just an example.
  83. Also you can use much longer texts than screens width is and QuickReq knows
  84. how to cut lines. Height and width of this text is limited only by screens
  85. size. In here you can also use "FORCE LINE BREAK"-character to make your
  86. linebreaks where ever you need them. The "FORCE LINE BREAK"-character
  87. is same as backslash '\'.
  88.  
  89. TRUE
  90. True is the first BOOL-gadget text. By pressing its gadget (left one)
  91. QuickReq returns error number 0 to CLI or SHELL. Usually this text is
  92. something like "Yes", "True" or "Retry". But of cource you can write what
  93. ever you like. This text has maximum height of 1 char and width is about
  94. half the screens width. This is really an optional text and if you choose
  95. not to use this, then only the FALSE-text gadget (see further for
  96. FALSE-text) will be displayed.
  97.  
  98. FALSE
  99. This is the second BOOL-gadget text. By pressing its gadget (right one)
  100. QuickReq returns error number 5 (WARN) to CLI or SHELL. This is easy to
  101. check out from script files using WARN option in IF command. This text has
  102. same limits as TRUE-text has.
  103.  
  104. FILENAME
  105. If you want to use longer texts, particularly in Question text, then you
  106. should make a file which contains all the information for requester. For
  107. QuickReq you just make an text file with your favourite text editor and
  108. pass the filename to program, and that's all you have to do. I haven't
  109. tried very long files but the maximum size should be limited only by
  110. your available memory. Of course it is senseless to use very big
  111. redirection files because all the text won't fit into the screen.
  112. Redirection file option has priority over argument line options. So if you
  113. specify windows width to 150 in argument line (-w150) and redir. file has
  114. the same option with value 300 (-w300) then your window will be 300 pixels
  115. wide. Same goes to -H and -P options. Also if you have specified redirection
  116. file in a redirection file, then error message will be displayed and
  117. program execution is terminated.
  118.  
  119. OPTIONS
  120. There are six of them. And they may be specified in argument line or in
  121. redirection file.
  122.  
  123. -C      ...     Centers the Question text.
  124.  
  125. -B      ...     Makes DisplayBeep in ActiveScreen. Before activating
  126.                 Requester.
  127.  
  128. -L      ...     Forces to use as big screen as available. In other words, if
  129.                 you have a WorkBench with 1024*1280 resolution then QuickReq
  130.                 opens really big requester for you. Of course this works
  131.                 only if you have enough text specified, or you are also
  132.                 using -W and/or -H options.
  133.  
  134. -W#     ...     If you want to force your requesters width to some value #,
  135.                 then you can use this option. If you, for some reason,
  136.                 specify requester width smaller or wider than possible,
  137.                 then this value will be ignored and 'Illegal window size'-
  138.                 text is displayed. This means that requester is still
  139.                 showed but QuickReq computes its own width value.
  140.  
  141. -H#     ...     If you want to force requesters height to value #, then use
  142.                 this option. The rules concerning use of this option, are
  143.                 the same as in -W option.
  144.  
  145. -P#     ...     Specify new FrontPen color. If the new FrontPen color is the
  146.                 same as the default BackPen color, then the BackPen color is
  147.                 automatically changed to the new color. This works with all
  148.                 possible colors current OS is suporting (of course, only if
  149.                 you have your WB-screen deep enough).
  150.  
  151.  
  152. Bugs
  153. -----
  154.  
  155. With kickstart versions 1.3 and smaller, you get really weird windows if you
  156. specify -L option and -W# with number # being larger than 1024. I used
  157. MegaWb to make my WB-screen as big as 1404*560 (Yes, I have 1 MB-Chip-Agnus)
  158. and then used -L and -W#. If # was bigger than 1024 then screen went quite
  159. messy and I think that this is a error in Intuition, and is propably
  160. repaired in WB2.0! Because this isn't really a bug I let it be there.
  161. Problem should arise only with very large screens, and with WB2.0 it should
  162. work correctly. At the moment I haven't got access to WB2.0 and I wasn't
  163. able to test QuickReq with it but there shouldn't be any problems. I you
  164. have any please infor me about them!
  165.  
  166. Examples
  167. ---------
  168.  
  169. Try these examples to see what happens. There are also couple of example
  170. files which you can load as redirection files in Examples Directory.
  171. Don't be suprised by the Examples/Text2 because QuickReq uses the same
  172. function to render requesters as OS does, and so it's possible to make
  173. very similar requesters as you have seen in AmigaDOS.
  174.  
  175. QuickReq -p3 "Do you want to load workbench?" " Yes! " " No! "
  176.  
  177. QuickReq -cw300p1 "Look\How\Nicely\QuickReq\Centers\The\Text!" Agreed
  178.  
  179. QuickReq -h200 -b -c Examples/Text1
  180.  
  181. QuickReq Examples/Text2
  182.  
  183. There is an example script in Examples directory called TestScript. It
  184. should give you a small idea about QuickReq and it's usefulness! Just
  185. Execute it to see what happens.
  186.  
  187. Future
  188. -------
  189.  
  190. In future I'm planning to make this program better, but before I can start
  191. developing any new options I would like to hear what you really need
  192. from Requester-program. Do you want to use your own fonts instead of Topaz-
  193. 8? Or do you want to use BOLD, Underline and Italics? So if you have any
  194. wishes, please send me a letter. But remember that QuickReq is now smaller
  195. than 5 Kbytes, so if you want it to be a small utility then be reasonable
  196. with your wishes. Of course it would be nice to use your own iff-pictures as
  197. backgrounds but after including that to my little program it wouldn't be so
  198. little anymore. Please let me know, what you want! I also want to hear
  199. about bugs you have possibly encountered while using QuickReq. There
  200. shouldn't be any but we can't be sure, can we?
  201.  
  202. Happy QuickReqing!!!
  203.  
  204. My Internet address:    s37732v@puukko.hut.fi   (BTW I prefer email! :^)
  205.  
  206. Home address:           M. Aalto
  207.                         Lemmmenkuja 1
  208.                         01230 Vantaa
  209.                         Finland
  210.