home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 15 / CDACTUAL15.iso / cdactual / program / basic / QBFE10.ZIP / QBFRONT.HLP < prev    next >
Encoding:
Text File  |  1987-06-21  |  22.9 KB  |  501 lines

  1. QuickBASIC Front End - v.1.0 - 06/21/87 - Help screens
  2.  
  3. This program is a development utility for QuickBASIC (QB) programmers.
  4.  
  5. QBFront  allows  you to edit, compile and link programs from a single,
  6. special purpose menu. The editor you use is your choice,  by  entering
  7. the  commands  to  run  the editor in the "Editor name" space. You can
  8. modify all of  the  parameters  that  affect  the  compiling  process,
  9. including   optional   command  line  switches,  object,  and  library
  10. filenames. This information can be stored in a disk  file  for  quick,
  11. repeated editing, compiling and linking sessions.
  12.  
  13. QBFront can be distributed free of charge to anyone. A small charge as
  14. a  copying fee is allowed, up to $10. The copyright on this program is
  15. to prevent despicable persons from trying to make money  off  my  hard
  16. work.  I  also  don't want anyone else releasing "their" version of my
  17. program. Suggested modifications are welcome,  but  let  me  implement
  18. them.
  19.  
  20. Since  QBFront is "user-supported software", that means it is NOT free
  21. software. A mere $15 registration fee will ease your conscience  about
  22. using  it, and allow you to harass me over the phone. I know I've sent
  23. more money for programs that don't save me nearly as  much  time.  For
  24. another  measly $25, I'll even send you a copy of the source code. The
  25. source code is copyrighted, so if you intend to  use  my  routines  or
  26. sub-programs  in  a  program  for  distribution,  please make sure you
  27. surround them with enough original code to call the program your own.
  28.  
  29. For those noble people who see fit to reward me for my  insanity,  you
  30. may mail your contribution to:
  31.  
  32.     Electronic Applications Development
  33.     P.O. Box 5264
  34.     Valdosta, GA 31603-5264
  35.  
  36. If  I  do  well  from this and my other efforts (fat chance!), my name
  37. will become known like Jim Button's! Then we will all  know  that  $15
  38. was  too  much,  so  send  what you think the program is worth (yes, I
  39. accept pennies). Enough plea for money, on with the instructions....
  40.  
  41. It is assumed that the user is familiar with QuickBASIC version  2  or
  42. higher,  and  you  will probably need to refer to the manual to aid in
  43. the use of this program. The instructions for the separate compilation
  44. method are a bit skimpy, so you will need to do  some  experimentation
  45. to  determine  what  options to use. Some of the command line switches
  46. seem to work backward from what may be expected, and  QBFront  follows
  47. the conventions of the compiler's menu.
  48.  
  49. The  program  is  invoked  by running the batch file called "QBF.BAT".
  50. QBFront sets up another batch file called  "QBRUN.BAT"  that  contains
  51. the  instructions  to  perform  the function. For all functions except
  52. "Quit to system", QBRUN calls QBF to restart  the  sequence.  A  basic
  53. outline  of  QBFront's operations is shown on a later page of the help
  54. screens.
  55.  
  56. When the program first runs, it loads in parameters from a file called
  57. "QBFRONT.PAR". If the file does not exist, it is created with  default
  58. parameters. The parameters are shown on the right side of the screen.
  59.  
  60. There are three basic groupings of parameters:
  61.  
  62. The top section of the screen shows the name of the source  code  that
  63. we are working with. The name of the editor is shown on the next line,
  64. just  as  it would be called from the DOS prompt. The last information
  65. is the current default drive and the space remaining on the disk.
  66.  
  67.  
  68. The next section deals with the  parameters  associated  with  the  QB
  69. compiler.  This  information  is  translated  into command line option
  70. switches whenever the compiler is invoked.
  71.  
  72.  
  73. The last section contains the information for setting up  the  command
  74. line  for  the linker, including the object and library files to read,
  75. and the names of the .EXE and .MAP files to create.
  76.  
  77. The line editor:
  78.  
  79. The text parameters are entered using QBFront's line editor. The  line
  80. editor  places bars at either limit of the line, and changes the color
  81. of the entry area. The following keys are use to edit the entry:
  82.  
  83. - RETurn ends the entry. Whatever text is on the entry line is entered.
  84. - INSert toggles the insert mode, which is shown by the type of bar
  85.    at the right end of the entry line.
  86. - BKSPace deletes one character to the left.
  87. - DELete & ^BKSP delete one character to the right.
  88. - ^T deletes one word to the right.
  89. - ^Y deletes the entire entry.
  90. - HOME goes to the beginning of the entry.
  91. - END goes to the right end of the line.
  92. - ESCape restores the line to its original entry.
  93.  
  94. Note that insert mode is toggled off when you reach the end of the
  95. entry (bug avoidance).
  96.  
  97. On the left side of the opening screen is the Main Menu,  which  looks
  98. like this:
  99.  
  100.    ┌[ - Main Menu - ]──┐      A highlighted bar will indicate the
  101.    │                   │      current selection. An option can be
  102.    │ 1-Help screens    │      selected in one of three ways:
  103.    │ 2-Save parameters │
  104.    │ 3-Load parameters │    1 - Use the up and down cursor control
  105.    │ 4-Edit parameters │        keys to move the bar to the desired
  106.    │ 5-QBASIC direct   │        selection, and press RETURN.
  107.    │ 6-Run editor      │    2 - Press the corresponding number key
  108.    │ 7-Disk directory  │        to move the bar directly to the entry
  109.    │ 8-Subprg manager  │        desired, and press RETURN.
  110.    │ 9-Exit QBFront    │    3 - Press the corresponding function key
  111.    │ 0-Compile source  │        to immediately execute the desired
  112.    └───────────────────┘        selection.
  113.  
  114.  
  115.       Each of the functions is outlined on the following pages.
  116.  
  117.     1-Help screens
  118.  
  119. This  option  brings  up  these help screens. This text is stored in a
  120. file called "QBFRONT.HLP". The program pauses at the end of each page,
  121. and will continue to the next page,  if  any,  at  any  keystroke.  To
  122. return  to  the  opening  screen  at  any  time while reading the help
  123. screens, press ESC.
  124.  
  125. This file is basically a text file, and can be copied to  the  printer
  126. with  the  command  "COPY  QBFRONT.HLP  PRN" at the system prompt. But
  127. because it is formatted for screen viewing, the printer output is less
  128. than perfect.
  129.  
  130. Because the program is all menu  driven,  with  help  prompts  at  the
  131. bottom  and  on the left side of the screen, it shouldn't be necessary
  132. to have printed instructions.
  133.  
  134.     2-Save parameters
  135.  
  136. This option saves the currently displayed parameters to a file  called
  137. "QBFRONT.PAR".  Any  parameters  previously  saved in the file will be
  138. overwritten.
  139.  
  140. This function is redundant since it is also automatically  called  any
  141. time  you  select a function that exits the program, if you previously
  142. selected an option to change any parameters.
  143.  
  144. You will be asked if you want to save the current parameters.  If  you
  145. do  not  save the parameters, the program will still use the displayed
  146. parameters for the function, but the next time the program is run, you
  147. will be returned to last saved parameters.
  148.  
  149. Whenever the prompt " Save current parameters? (Y/N) "  is  displayed,
  150. you can abort and return to the Main Menu by pressing ESC.
  151.  
  152.  
  153.     3-Load parameters
  154.  
  155. This option loads the parameters in "QBFRONT.PAR" and displays them on
  156. the screen.
  157.  
  158. Be  careful  with this option, as it overwrites the current parameters
  159. on the screen.
  160.  
  161.  
  162. Future plans include the ability to have a separate parameter file for
  163. each program you write, with  the  filename  selected  from  a  pop-up
  164. window.
  165.  
  166.     4-Edit parameters
  167.  
  168. This  option  allows you to enter the name of the source code, and the
  169. command to execute the editor, and the other  options.  While  editing
  170. these parameters, the PG UP will take you back to the first entry, and
  171. the PG DN key will return you to the menu.
  172.  
  173. For  the source code, it is not necessary to enter the file extension,
  174. if it is to be ".BAS". The program will automatically add  the  ".BAS"
  175. extension   when   needed.   If  the  file  is  on  another  drive  or
  176. subdirectory, enter the complete pathname.
  177.  
  178. For the editor name, enter the complete  path  specification  for  the
  179. editor,  but do not enter the file extension. This entry should be the
  180. same as the command that you would enter to run the  editor  from  the
  181. DOS prompt. For automatic return to QBFront, this must not be the name
  182. of  a  batch  file.  If you need to run your editor from a batch file,
  183. create a new  one  that  calls  QBF.BAT  instead  of  exiting  to  the
  184. operating system or elsewhere.
  185.  
  186.     4-Edit parameters (cont.)
  187.  
  188. The options in the center section are for the compiler.
  189.  
  190. First,  the  cursor  will  be positioned on the "Library files" entry.
  191. Enter the library file to be included for use in the interactive mode.
  192.  
  193. Next, enter the size of the communications receive buffer, if any.  By
  194. leaving  a  `0',  the  option will not be implemented, and the default
  195. buffer size will be used.
  196.  
  197. The last nine entries are toggles. They are toggled with the space bar
  198. or the left and right arrow keys. An entry toggled to "ON" corresponds
  199. to an `X' on the QB compile menu, and not necessarily the presence  or
  200. absence  of  a  command  line  switch. You may have to experiment with
  201. these a bit.
  202.  
  203.      4-Edit parameters (cont.)
  204.  
  205. The  five text options at the bottom of the screen are for the linker.
  206.  
  207. Remember that none of these options requires a file  extension,  since
  208. the  linker will determine the proper extension by its position on the
  209. command line. It is best to join multiple entries on each line with  a
  210. plus sign (+).
  211.  
  212. The  .EXE  filename  is  filled  in automatically from the source code
  213. filename, but can be changed to suit your needs.
  214.  
  215.  
  216.     5-QBASIC direct
  217.  
  218. This is the option to enter the interactive  mode  of  QuickBASIC.  It
  219. sets  up  the  command using the information in the QB options area of
  220. the screen, and the source code name. Once in QB, you may perform  any
  221. actions desired. When you exit QB, you will be returned to QBFront.
  222.  
  223. This is the only place the QuickBASIC options Library file is used. It
  224. allows  you  to  include  a  .EXE type command addition for use in the
  225. interactive mode. Note that the setting of  the  debugging  option  is
  226. ignored  here,  as QB always turns on debugging upon entry, regardless
  227. of the /D command line switch. Also note that the "Stand alone" option
  228. will not create a self-standing .EXE file from the  interactive  mode,
  229. which is one of the main reason I wrote this program.
  230.  
  231.     6-Run editor
  232.  
  233. When  you  select  this  option,  QBFront  will  run  the commands for
  234. executing your editor, as entered in the source  information  area  of
  235. the  screen.  The command line will consist of the text entered as the
  236. editor name, a space, and the text entered as the source code. If  the
  237. source code name has no extension, ".BAS" will be added.
  238.  
  239. This  command  line is written to "QBRUN.BAT" which is then run. QBRUN
  240. will then re-enter QBFront by running  "QBF.BAT"  when  you  exit  the
  241. editor.
  242.  
  243. I used this option for creating this file by entering "QBFRONT.HLP" as
  244. the  source  code name, hitting F6, and then answering "N" to the save
  245. parameter prompt. That way, I didn't have to re-enter the source  code
  246. name when I return to QBFront.
  247.  
  248.     7-Disk directory
  249.  
  250. This simply gives you a look at the disk directory. I plan to use this
  251. routine in future versions for selecting filenames for entry into some
  252. of  the  options,  but  for now it is presented in it's crude form. An
  253. arrow will appear in the upper left corner of the directory display if
  254. there are more than ten files in the directory. Using the arrow  keys,
  255. or the PG UP and PG DN keys, you can browse through the filenames. ESC
  256. or RET, etc., will return you to the main menu.
  257.  
  258.     8-Subprg manager
  259.  
  260. The  Sub-program  manager  is not implemented in this version. Some of
  261. the planned features include:
  262.  
  263.   - A sub-program documentation database and editor
  264.   - Cross reference listing to show what calls what
  265.   - A  "pre-scan"  function  to  insure  all  CALL's  actually   have
  266.     sub-program to call
  267.   - A library file manager (there's a nice looking,  but   buggy   one
  268.     by someone else out there  already)
  269.   - Most anything else that you users want (write me and let me know!)
  270.  
  271. This is my first major QuickBASIC project,  so  I'm  still  trying  to
  272. decide  what  I need (suggestions gratefully accepted). I do know that
  273. the sub-programs can quickly become hard to manage when the calls  get
  274. two  or  more levels deep. I hope to have large portions of this ready
  275. by the end of 1987 (register and find out as soon as it is ready).
  276.  
  277.      9-Exit QBFront
  278.  
  279. This selection brings up an option menu  that allows you to choose how
  280. QBFront is exited. This menu looks something like this:
  281.  
  282. ┌[Exit menu]────────┐   The selections are:
  283. │                   │
  284. │ 1-External Menu   │   1 - Runs a program or batch file called "MENU".
  285. │ 2-QuickBASIC      │   2 - Enters QBASIC with parameters shown.
  286. │ 3-DOS prompt      │   3 - Exits to the system prompt.
  287. │ 4-Abort Exiting   │   4 - Returns to the Main Menu.
  288. │ 5-yourprog        │   5 - Runs the program shown in the Linker
  289. └───────────────────┘       "EXE filename" section (if any).
  290.  
  291. Selection  2  is identical to the "QB direct" option on the main menu.
  292. I'll decide some day where I want it.
  293.  
  294. Selection 4 is for those who panic easily, or are too  lazy  to  reach
  295. for the ESC key, which does the same thing.
  296.  
  297. Selections are made in the same manner as on the Main Menu.
  298.  
  299.     0-Compile source
  300.  
  301. This option sets up QBRUN.BAT to run the compiler and linker using the
  302. parameters shown on the main screen. This is the option  that  QBFront
  303. "lives" for. All of the entered parameters are used, except for the QB
  304. options  Library  files.  I have had problems doing separate compiling
  305. using the Library files tied into the compiler itself. Any  additional
  306. functions used should be implemented with object or library files that
  307. are added in during linking.
  308.  
  309. The  batch  file  will pause before re-entering QBFront, so you have a
  310. better chance of reading any error messages that may occur.
  311.  
  312. Since the compiler erases the output object file, the linker will skip
  313. linking with an error if the compiler finds a severe error.
  314.  
  315. ┌───────┐         Basic Outline of QBFront operation
  316. │       v start
  317. │   ╔══════════╗                   ╔════════════════════╗  ┌───────────┐
  318. │   ║ QBF.BAT  ║                   ║    QBFRONT.EXE     ║  │   key:    │
  319. │   ╠══════════╣    run QBFRONT    ╠════════════════════╣  ├───────────┤
  320. │   ║ QBFRONT  ║ >───────────────> ║ sets up commands & ║  │prog. flow:│
  321. │   ╟──────────╢                   ║ writes them to the ║  │ ────────> │
  322. │   ║ QBRUN    ║ <───────────────< ║ QBRUN.BAT file     ║  │data flow: │
  323. │   ╚══════════╝    exit QBFRONT   ╚════════════════════╝  │ ........> │
  324. │        │     ......................:                     └───────────┘
  325. │        │     :   QBFRONT writes
  326. │        V     V   to this file           ╔══════════════════════════╗
  327. │   ╔═══════════════╗                     ║      user commands       ║
  328. │   ║ QBRUN.BAT     ║                     ╠══════════════════════════╣
  329. │   ╠═══════════════╣   run commands      ║ this could be the QBASIC ║
  330. │   ║ user commands ║ >─────────────────> ║ compiler, a text editor, ║
  331. │   ╟───────────────╢                     ║ back to system, or back  ║
  332. │   ║ QBF           ║ <─────────────────< ║ to any program called    ║
  333. │   ╚═══════════════╝   back for more     ║ "MENU" (batch or other)  ║
  334. │(loop)  │                                ╚══════════════════════════╝
  335. └────────┘
  336.  
  337.     Troubleshooting:
  338.  
  339. - PROBLEM:  QBFront  does  not execute any external functions such  as
  340. "Run editor" or "Compile source",  but instead just drops back to  the
  341. operating  system.
  342. - FIX: QBFront must be run by executing the batch file QBF. This batch
  343. file calls QBRUN.BAT when you exit QBFront.  If you accidentally enter
  344. QBFront  directly,  just run QBRUN when you find yourself back at  the
  345. operating system prompt. QBRUN will execute the selected function, and
  346. will run QBF to return you to QBFront,  unless you selected the  "Quit
  347. to system" function.
  348.  
  349. - PROBLEM:  The  operating system issues a "File not found" error when
  350. the "External Menu" exit option is selected.
  351. -  FIX:   QBFront   sets  up  QBRUN to execute "MENU" when you  choose
  352. this option.  This  is to accommodate those people who  have  their
  353. systems set up on a menu program. You can create a batch  file  called
  354. "MENU.BAT"  with  either  some  dummy  command  (i.e.  "CLS"),  or the
  355. commands to perform some function you want  to  execute  upon  leaving
  356. QBFront.
  357.  
  358.     Troubleshooting: (cont.)
  359.  
  360. - PROBLEM:  All of the compiler,  linker,  object, library, and source
  361. files won't fit on floppies,  and QBFront won't pause for me to change
  362. diskettes.
  363. - FIX:  Get  a  hard  drive!  Aside from that,  there are a  few  more
  364. options. Use of a RAMDisk could solve some problems, or the batch file
  365. QBF.BAT  can  be edited to pause after  running  QBFront,  and  before
  366. running QBRUN.  Editing QBRUN is useless,  since QBFront overwrites it
  367. for each external function. I will work with registered users and beta
  368. testers to make the program configurable for floppy systems.
  369.  
  370. - PROBLEM:  I  keep  getting error messages  during  compiling,  etc.,
  371. and/or the programs I write lock-up or error-out when I run them.
  372. - FIX:  RYFM (Read Your 'Favorite' Manual). QBFront only sequences the
  373. editing and compiling sequences, it does not do any of the "real" work
  374. for  you.  It is NOT a replacement for knowledge about the  QuickBASIC
  375. compiler, but simply a tool to alleviate the tedious, repeated command
  376. entries required for separate compiling and linking. You still need to
  377. understand what is going on.
  378.  
  379.     Troubles that won't happen:
  380.  
  381. There are three files associated with QBFront that don't need to be on
  382. the default disk.
  383.  
  384. The .PAR file will be created for you, if needed.
  385.  
  386. The .HLP and .PMT (help & prompt, respectively) files are not  needed,
  387. and  the  program doesn't crash without them. So, once you have gotten
  388. familiar with the operation of QBFront, you can delete them.
  389.  
  390. Another file not needed is the QBFRONT.HIS file. I  ask  that  you  DO
  391. modify  this  file, and update the .ARC file with it. This is just for
  392. curiosity, not to track down un-registered users. Please add when  and
  393. where  you  got  the  program  before you upload it. I feel it will be
  394. interesting to see the travels of this, or any other program.
  395.  
  396.     Miscellaneous:
  397.  
  398. You can edit QBF.BAT to perform other functions. For instance, I added
  399. "SET  LIB=LIB\"  at  the  beginning  of QBF.BAT, so that the version 3
  400. linker will look in the LIB sub-directory for the library files.  Just
  401. remember  to keep the basic structure, and keep in mind that QBRUN.BAT
  402. usually calls QBF.BAT to re-enter QBFront.
  403.  
  404. There is little way to prevent "disk full" errors, but you  can  enter
  405. the  drive designation to most of the options. Also, by entering "NUL"
  406. as the .MAP filename, your can save some disk space.
  407.  
  408.  
  409.  
  410.  
  411.     About QuickBASIC Front End:
  412.  
  413. This program was developed for two reasons.  First, I do not like QB's
  414. built-in  editor.  Even if were better that my normal editor,  I still
  415. would not want to have to learn and stay familiar with another editor.
  416. Next,  there  is no way to compile a stand-alone program  with  linked
  417. object  and  library files from QB's interactive  mode.  For  me,  the
  418. interactive  mode  is useful only for fine-tuning certain  algorithms,
  419. and limited debugging.
  420.  
  421.  
  422.  QuickBASIC is a copyrighted program from the Microsoft Corporation.
  423.  
  424.          QuickBASIC Front End was written by Earl A. Daniels
  425.        Copyright (c) 1987, Electronic Applications Development
  426.  
  427. QuickBASIC  Front  End  was written in  QuickBASIC  version  3,  using
  428. functions  from ADVBAS version 3.3,  and other miscellaneous  routines
  429. picked-up and developed through the years.
  430.  
  431.     The future of QuickBASIC Front End:
  432.  
  433. As  a user-supported program,  QBFront's future lies mainly with  it's
  434. users.  It  will be the user feedback and monetary support  that  will
  435. determine  what  it  will eventually become.  My plans at  the  moment
  436. include multiple parameter files, having scrolling menus for selecting
  437. source, object and library filenames.
  438.  
  439. I  want to expand the support for multiple  sub-directories,  allowing
  440. serious developers have more organization for their hard drives. Since
  441. the program was written on a hard drive system,  using it on a floppy-
  442. based  system  will be awkward at best,  and I will make  changes  for
  443. floppy users, if the demand exists (from registered users).
  444.  
  445. Also  down the road,  I hope to incorporate a auto-scan function  that
  446. will  scan the source file(s),  and set the necessary option  switches
  447. for  you.  This  would be most helpful for  compiling  programs  being
  448. converted from interpreted BASIC, or programs written by others.
  449.  
  450. I  am open to suggestions and ideas,  and ultimately,  the users  will
  451. decide what features will be incorporated or expanded.
  452.  
  453.      Licensing agreement:
  454.  
  455. This is a "user-supported" program. It is released as "shareware", and
  456. registration will be only $15. For an additional $25, registered users
  457. can get the latest version, complete with source code.
  458.  
  459. Send to the address on the second page, or to  my home address:
  460.        Earl Daniels
  461.        1406 Iola Drive
  462.        Valdosta, GA  31602
  463. phone: (912) 244-0950 or (912) 244-2919
  464.  
  465. To  protect myself from those wishing to make money from  my  program,
  466. and   from  unauthorized  versions  of  the  program  being  released,
  467. QuickBASIC Front End is copyrighted.  This copyright does not  prevent
  468. free distribution of the program in un-modified,  executable form, but
  469. does prohibit distribution of the source code or modified versions.
  470.  
  471. TO PROFESSIONAL PROGRAMMERS: You know how much  work  is  involved  in
  472. writing a program, so you know how much support is appreciated. Also I
  473. don't  mind  my routines being "borrowed" for your programs! REGISTER!
  474. I'm sure the program will pay for itself in saved time.
  475.  
  476.     About ME (Earl Daniels)
  477.  
  478. I am a long-time (?) (10 yrs) computer hacker. I was a  hacker  before
  479. the  label  "hacker"  was  considered  a  bad name. Although I started
  480. programming in Microsoft BASIC ("in-ROM") on my Ohio  Scientific  C1P,
  481. it  took  a  version  like  QuickBASIC to get me back to BASIC. I am a
  482. systems designer, and generally specialize in getting PC's to  perform
  483. background  tasks,  such  as monitoring and control. Since QB can have
  484. direct access to assembly-language routines that  are  performing  the
  485. background functions, it suits itself well to my needs. The "ON event"
  486. capabilities also enhance my applications (monitoring the monitoring?)
  487.  
  488. Although I consider myself basically a hardware person, I obviously do
  489. some  programming  too,  but don't yet have enough notches cut to call
  490. myself a "computer programmer"!
  491.  
  492. I  welcome  correspondence  at  the address above or via the Valdosta
  493. State College RBBS at (912) 333-5975, 24hrs, 3/12/24, 8N1. The  SYSOP,
  494. Paul  Worth,  is  providing the "home" for QBFront End, so drop by and
  495. leave a line or two.....
  496.  
  497.                      --- end of help screens ---
  498. 
  499.  
  500.  
  501.