home *** CD-ROM | disk | FTP | other *** search
/ Share Gallery 1 / share_gal_1.zip / share_gal_1 / LA / LA030.ZIP / PIE.DOC < prev    next >
Text File  |  1991-03-01  |  15KB  |  425 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6. Programmer's Integrated Environment Version 2.0
  7. Copyright (C) 1991, twentysomething Software
  8.  
  9.  
  10. LICENSE
  11.  
  12.     Programmer's Integrated Environment (PIE) is Copyright (C)
  13.     1991 by twentysomething Software. This software must be
  14.     treated like a book, in that the registered copy of this
  15.     software may not be used in more than one computer at the
  16.     same time (Just like you can't read the same book in two
  17.     different places at the same time). You are granted
  18.     authorization to make archival copies of this software for
  19.     the sole purpose of backing up this software to protect your
  20.     investment.
  21.  
  22.     Unregistered copies of this program may be freely distributed,
  23.     no fee may be charged except for the cost of duplication of the
  24.     complete unregistered version.
  25.  
  26.  
  27. DISCLAIMER
  28.  
  29.     twentysomething Software makes no warranty of any kind,
  30.     either express or implied, including but not limited to
  31.     implied warranties of merchantability and fitness for a
  32.     particular purpose, with respect to this software and
  33.     included documentation. In no event shall twentysomething
  34.     Software be liable for any loss of profit or any other
  35.     commercial damage, including but not limited to special,
  36.     incidental, consequential or other damages, arising out of
  37.     the use, or inability to use this program, even if
  38.     twentysomething Software has been advised of the possibility
  39.     of such damage.
  40.  
  41.  
  42. TRADEMARKS
  43.  
  44.     IBM PC, IBM PC-XT, IBM PC-AT, IBM PS/2 are trademarks of
  45.     International Business Machines Corporation. QuickBASIC and
  46.     MS-DOS are trademarks of Microsoft Corporation. Turbo Pascal,
  47.     Turbo C, Turbo Assembler, and Turbo Debugger are trademarks
  48.     of Borland International.  All other product names are
  49.     trademarks of their manufacturers.
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72. TO REGISTER Programmer's Integrated Environment
  73.  
  74.     This software product and manual are being distributed under
  75.     the USER SUPPORTED SOFTWARE concept (SHAREWARE).  The
  76.     software and manual are not in the public domain.  Shareware
  77.     means you are permitted to try the program for a limited
  78.     period of time (usually 30 days), after that period of time
  79.     you are required to register the software.
  80.  
  81.     To register this software, print the file REGISTER.PIE and
  82.     fill it out, then send it to:
  83.  
  84.         twentysomething Software
  85.         16744 James St.
  86.         Holland  MI  49424
  87.  
  88.     To print REGISTER.PIE, type "COPY REGISTER.PIE PRN" and press
  89.     enter (don't type "") at the DOS prompt.
  90.  
  91.     Registration of PIE will provide you with:
  92.  
  93.         - Registered version of PIE V2
  94.         - A free editor (Dan's Editor)
  95.         - Low-cost upgrades to future versions
  96.         - Shipping and handling
  97.  
  98. Files Included:
  99.  
  100.     README       - Program Information
  101.     INSTALL.EXE  - PIE Installation program
  102.     REGISTER.PIE - Registration Form to be printed
  103.     PIE.DOC      - This file
  104.     PIE2(U).EXE  - Program file, U = Unregistered Version
  105.     PIE_???.CFG  - Configuration files, examples included
  106.     E.EXE        - Dan's Editor, registered version only!
  107.     EDITOR.HLP   - Help file for Dan's Editor
  108.     E.CFG        - Editor configuration file
  109.  
  110.  
  111. Program Description
  112.  
  113.     The purpose of Programmer's Integrated Environment (PIE) is
  114.     to provide an interface for most compiled programming
  115.     languages.  It allows a programmer to edit, compile, link,
  116.     test, and debug a program using a simple menu.  PIE is an
  117.     interface between the editor, command line compiler, linker,
  118.     and debugger, if all of these are available (an editor is
  119.     supplied with the registered version of PIE).  It has been
  120.     used successfully with Turbo Pascal 6.0, Turbo C 2.0, Turbo
  121.     Assembler 2.0, and QuickBASIC 4.5.
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138. Documentation Notes
  139.  
  140.     First a word about this documentation.  PIE is intended for
  141.     use by programmer's who are experienced with the basics of
  142.     DOS.
  143.  
  144.         C:\TP\PAS\MYFIRST.PAS
  145.  
  146.         PATH=C:\DOS;C:\UTIL
  147.  
  148.     For instance, if you know that the first line means that the
  149.     file MYFIRST.PAS is on the C drive (C:), in the subdirectory
  150.     \TP\PAS, and in fact \PAS is a subdirectory of \TP.  Also, if
  151.     you know that PAS is the file extension part of the file
  152.     MYFIRST.PAS.  And, if you know that the second line will set
  153.     the PATH environment variable to allow programs in the \DOS
  154.     or \UTIL of the C drive to be run from almost any drive or
  155.     directory.  If you knew all of that, then you are ready for
  156.     this program and the documentation.
  157.  
  158.  
  159.     This does not mean that PIE is difficult to work with, in
  160.     fact it provides a simple, straight forward interface to
  161.     handle typically larger programming projects.  PIE was
  162.     created because the author was tired of running into "Out of
  163.     Memory" type compiler errors within the integrated
  164.     environments supplied with most popular languages, and then
  165.     having to return to the command line compiler, then testing,
  166.     then debugging, then re-editing.  Too much time was wasted
  167.     typing in command line options, switching between
  168.     directories, etc.
  169.  
  170.  
  171. Program Requirements
  172.  
  173.     PIE requires a minimum of 512K of RAM on an MS-DOS compatible
  174.     computer, a hard disk, and of course, a programming language.
  175.     Also, PIE will use EMS memory for swapping, if EMS is not
  176.     available, swapping will be done to disk.
  177.  
  178.  
  179. Program Installation
  180.  
  181.     To install PIE, run the program INSTALL.EXE.
  182.  
  183.  
  184. Running PIE
  185.  
  186.     To run PIE, go to the drive and directory where PIE is
  187.     installed, end enter PIE2(U) at the command line.
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203. Entering a Source File
  204.  
  205.     PIE is able to act as an interface for more than one
  206.     programming language.  To do this it creates a configuration
  207.     file for each language based on the file extension of the
  208.     source file (.BAS for BASIC, .PAS for Pascal, .C for C,
  209.     etc.).  If there is a sample configuration file for the
  210.     entered source file, it will be used, this will most likely
  211.     need to be changed.  To change this configuration file, enter
  212.     a source file with a wildcard character (?,*) in it, when the
  213.     list of files is displayed, select any file as a source file,
  214.     at the main menu, select Setup.  Then edit the configuration
  215.     file for your system, press Ctrl and enter, and respond with
  216.     a Y to save the configuration.
  217.  
  218.     The first screen encountered when PIE is run will ask for a
  219.     source file name including an extension.  First, a couple of
  220.     rules, the source file name must not be an empty field, it
  221.     may include wildcard characters (*,?), but not in the file
  222.     extension part of the file name.  If you do include a
  223.     wildcard character, a list of files will be displayed, and
  224.     the source file may be selected from this list.  A note about
  225.     the files displayed in this list, ALL files and directories
  226.     in the source file directory will be displayed, this allows
  227.     access to files other than those with a file extension as
  228.     entered. For example, if you want to edit a Pascal include
  229.     file (INC extension).  Also, selecting a directory will move
  230.     you to that directory, this allows you to edit files anywhere
  231.     on the specified drive.  Now, if this is the first time you
  232.     have entered a file with this extension, you will need to
  233.     setup a configuration file before going to the main menu.
  234.  
  235.  
  236. Setting Configuration Files
  237.  
  238.     If no configuration file is found for the entered file
  239.     extension, or Setup is selected from the Main Menu, the
  240.     configuration screen will be presented.
  241.  
  242.     The first field will ask for the drive and directory where
  243.     source files will be found and stored.  Example: Source files
  244.     for Turbo Pascal are stored in the C: drive, \TP\PAS
  245.     directory, the entry for this would be "C:\TP\PAS" (do not
  246.     include the "").
  247.  
  248.     The next field ask for a path.  This will add what is entered
  249.     to the DOS environment PATH specification.  This is useful if
  250.     any of the programs PIE runs, in turn runs another program.
  251.     An example of this is Turbo C command line compiler, which
  252.     runs the Turbo C linker.  An entry in this field should
  253.     conform to the rules for specifying a PATH in DOS.  If more
  254.     than one directory is entered, seperate them with a semicolon
  255.     (;). Example: The directories C:\TC, and C:\TD need to be
  256.     added to the PATH specification.  The entry for this would be
  257.     "C:\TC;C:\TD", alternatively, if the current drive is the C:
  258.     drive the entry could be "\TC;\TD" (again, do not include
  259.     "").
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.     The EDITOR: field accepts the drive and directory and
  271.     filename of the desired editor.  If for instance, the editor
  272.     supplied with PIE is desired, this entry may look like
  273.     "C:\PIE\E.EXE", where C: is the drive, and \PIE\ is the
  274.     directory where the editor E.EXE is found.  It is not
  275.     necessary to use the editor supplied with PIE (Dan's Editor),
  276.     any editor may be used, even the editor supplied with the
  277.     appropriate programming language may be used.  In fact often
  278.     times the editor supplied with a programming language offers
  279.     many help features not available with any other editor. Next
  280.     is the PARAMS: field for the Editor, when PIE runs the
  281.     editor, it assembles the command line equivalent of
  282.     EditorEntry+SourceFile+EditorParams. For example, if
  283.     MYFIRST.BAS is the source file, C:\PIE\E.EXE is the editor
  284.     entry, and /B /C is the entry for editor params, PIE runs;
  285.  
  286.     C:\PIE\E.EXE MYFIRST.BAS /B /C
  287.  
  288.     If your editor requires any parameters before the SourceFile,
  289.     enter those in the EDITOR: field.
  290.  
  291.     COMPILER: field is the same as the EDITOR: field except, of
  292.     course the drive, directory, and complete file name for the
  293.     compiler are entered here.  If any parameters need to be
  294.     entered before the source file name, they should be entered
  295.     in this field. The PARAMS: field for the compiler is the same
  296.     as the params field for the editor, any parameters that would
  297.     be entered after the source file name from the command line,
  298.     are entered here.
  299.  
  300.     The LINKER: field will contain the drive, directory, and file
  301.     name of the linker.  Not all programming languages have a
  302.     linker, so this field may be left blank.  The entry for the
  303.     PARAMS: field for the linker uses the same logic as the
  304.     editor and compiler entries.  One difference with the linker,
  305.     only the source name (no file extension) is used when this is
  306.     run. Most linkers default to an .OBJ extension.  The command
  307.     line entry would look like this if using the above example;
  308.  
  309.     C:\QB\LINK.EXE MYFIRST /B /C
  310.  
  311.     DEBUGGER: and the PARAMS: entry use the same logic as the
  312.     entries for the linker.
  313.  
  314.     The RUN DIR: field accepts the drive and directory where the
  315.     executable file will be after it is compiled/linked, this
  316.     allows the program to be run (tested), the RUN EXT: field
  317.     requires the extension of the executable file, usually this
  318.     is EXE, but may be COM.
  319.  
  320.     If everything is complete, press ^Enter (^Enter means to
  321.     press and hold the Ctrl key and then press Enter).  You will
  322.     be asked if you want to save the configuration to disk,
  323.     respond by pressing the Y key.
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336. Main Menu
  337.  
  338.     Here is the easy part, the screen contains a menu in the
  339.     middle of the screen.  The top center border of the menu will
  340.     contain the name of the source file.  From this menu, may be
  341.     selected any options with a corresponding entry in the
  342.     configuration file. For instance, if no linker was entered at
  343.     the setup screen, the Link option cannot be selected.  To
  344.     edit the source file, press the E key, or use the up and down
  345.     arrow keys to highlight Edit, and press enter.  When you are
  346.     done editing the file and you want to compile the program,
  347.     press C for Compile.  Once the program is compiled you may
  348.     have to link it, press L.  To test the program press R for
  349.     Run, if there are any errors you may wish to debug the
  350.     program, press D for Debug.  If you found an error, return
  351.     from the debugger and press E again to Edit the source file.
  352.  
  353.     If the editor, compiler, linker, or debugger fail to run
  354.     properly, press S to change the configuration for the current
  355.     language extension.  Most problems can be solved by verifying
  356.     the correct drive, directory, and complete filename are
  357.     entered. Other problems may require lengthy parameters to
  358.     specify where necessary units, or libraries can be found.  To
  359.     cut down on the size of the PARAM: entries, most compilers,
  360.     linkers, or debuggers use a configuration file for the
  361.     setting of default parameters.  Check your documentation for
  362.     information on this topic.
  363.  
  364.     If you want to work on a different program, press N for New
  365.     Source. This will bring up the same request for a source file
  366.     as appears at the beginning of the program.
  367.  
  368.     Press O for a temporary exit to the operating system, when
  369.     finished type EXIT at the prompt and press enter.
  370.  
  371.     When you are done working with PIE, press Q for Quit, and PIE
  372.     will terminate.
  373.  
  374.  
  375. Other Topics
  376.  
  377.     The best way to use PIE, is to use it for all of your
  378.     programming needs.  Most integrated environments provided
  379.     with programming languages provide the capabilities to edit,
  380.     compile, and debug smaller programs.  For the EDITOR: field,
  381.     specify the appropriate program, then use all of its
  382.     capabilities along with PIE.  For example, if you are
  383.     programming in QuickBASIC, go ahead and start PIE and enter a
  384.     source file with a BAS extension.  Be sure that the
  385.     QuickBASIC integrated environment is specified as the
  386.     EDITOR:. Now press E for Edit, this brings you to the
  387.     integrated environment where you may edit the file, get help,
  388.     check syntax, and if the program is not too large, run the
  389.     program.  If the program is too large, exit from the
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.     integrated environment and back to PIE, where the compiler,
  403.     linker, and other options may be used.  This provides the
  404.     best of both worlds, the advantages of an integrated
  405.     environment, and the ability to easily work with large
  406.     programs.
  407.  
  408.  
  409. To Get Help
  410.  
  411.     Help is available in several different forms, first is the
  412.     mailing address:
  413.  
  414.         twentysomething Software
  415.         16744 James St.
  416.         Holland  MI  49424
  417.  
  418.     Also, members of CompuServe may leave mail for
  419.     72421,1072.  GEnie members may leave mail for DJN.
  420.  
  421.     Phone support is available by calling (616) 399-6855, but
  422.     hours are limited to late morning to early afternoon on
  423.     weekdays, and weekends.
  424.  
  425.