home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 December / simtel1292_SIMTEL_1292_Walnut_Creek.iso / msdos / pgmutl / cpe41.arc / CPEMAN.TXT < prev    next >
Text File  |  1989-10-17  |  17KB  |  676 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.                           Compiler Programming Environment
  33.                                      Version 4.1
  34.                     Copyright (c) 1987-89, Pedro P. Polakoff III
  35.                                  All Rights Reserved
  36.  
  37.  
  38.                             CPE Version 4.1 Users Manual
  39.  
  40.  
  41.  
  42.           1  Copyright Notice
  43.  
  44.  
  45.           The Compiler Programming Environment is Copyright (c) 1987 -
  46.           1989, Pedro P. Polakoff III and 3P Software. The distribution or
  47.           alteration of this software is a violation of the copyright laws
  48.           of the United States. Copying this software, other than for
  49.           archive purposes is strictly forbidden and is also a violation of
  50.           the software copyright.
  51.  
  52.  
  53.           2  License
  54.  
  55.  
  56.           As a registered owner of CPE you are granted a license to use
  57.           this software in a manner similar to a book. This means that you
  58.           may use CPE on any computer system so long as no possibility
  59.           exists that it could be in use by two or more people or exist on
  60.           two or more computer systems at the same time. CPE may be used in
  61.           a network development system as long as it does not exist on any
  62.           other computer system at the same time and the registered owner
  63.           of the software is the owner of the hosting computer system. The
  64.           Shareware version of CPE may only be used for a period of 10 days
  65.           before registration is required. No license other than granting
  66.           you the privilege of evaluating this software is provided with
  67.           regards to the unregistered, shareware, version.
  68.  
  69.  
  70.           3  Warranty
  71.  
  72.  
  73.           CPE is warranted for defects in workmanship and shipping only. No
  74.           other warranty either expressed or implied shall apply to this
  75.           software. The author and 3P Software does not warrant the ability
  76.           of the software to perform for any specific purpose other than
  77.           that which it was designed for. Neither the author, nor 3P
  78.           Software, shall be responsible for any claims due to failure of
  79.           this software to perform it's intended function.
  80.  
  81.  
  82.           4  System Requirements
  83.  
  84.  
  85.           CPE requires an IBM compatible computer with a minimum of 128K of
  86.           Random Access Memory (RAM). CPE will detect and use any type of
  87.           video adapter and mouse. Command line switches allow for override
  88.           of the default video settings used by CPE. CPE requires the use
  89.           of DOS 3.0 or later.
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.                                         - 2 -
  100.  
  101.  
  102.                             CPE Version 4.1 Users Manual
  103.  
  104.  
  105.  
  106.           5  Overview of Functions
  107.  
  108.  
  109.           CPE was designed to provide the compiler language programmer with
  110.           a complete integrated programming environment to work in. CPE
  111.           integrates your favored editor, compiler, linker, make utility,
  112.           debugger and two optional utilities into a complete programming
  113.           environment similar to that now used by Borland International in
  114.           all of their products. CPE is unlimited in the combinations of
  115.           the utilities that it supports and may be reconfigured for any
  116.           combination of the utilities required for the programming job.
  117.           CPE allows for project management and the use of compiler command
  118.           files, link files, make files and error files.
  119.  
  120.  
  121.           6  Distribution Files
  122.  
  123.  
  124.           CPE is normally distributed in self-extracting ZIP file format.
  125.           The standard CPE ZIP/EXE file contains the following files:
  126.  
  127.           CPE.EXE        This is the CPE program itself.
  128.  
  129.           CPEHIST.TXT    This is the CPE revisions history file containing
  130.                          the information regarding changes in CPE by the
  131.                          version number.
  132.  
  133.           CPEREG.TXT     This is the Shareware product registration form.
  134.  
  135.           CONFIG.CPE     This is a sample configuration file. It is the
  136.                          only one usable by the CPE until it is registered.
  137.  
  138.           CPEPROJ.PRJ    This is a sample project file. It is the only one
  139.                          usable by CPE until it is registered.
  140.  
  141.           README.TXT     Last minute instructions
  142.  
  143.  
  144.           7  Installation
  145.  
  146.  
  147.           When installing CPE we recommend that you copy the program file
  148.           CPE.EXE to a directory that is included in your search path. By
  149.           doing so you will be able to invoke the use of CPE from any other
  150.           directory or path on your computer system. The only file required
  151.           by CPE for it's operation is the actual program file itself. When
  152.           you have registered your copy of CPE a registration file will be
  153.           created. This registration file must be in your search path and
  154.           should be in the same directory as the CPE.EXE file itself.
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.                                         - 3 -
  164.  
  165.  
  166.                             CPE Version 4.1 Users Manual
  167.  
  168.  
  169.  
  170.           8  Starting CPE
  171.  
  172.  
  173.           CPE allows command line parameters to override or change it's
  174.           actions on start up. Without any command line parameters CPE will
  175.           default to using the current hardware video adapter and the
  176.           default configuration (CONFIG.CPE) and project (CPEPROJ.PRJ)
  177.           files if they are present in the current directory. By the use of
  178.           the command line parameters you may have CPE use black & white
  179.           mode, alternate configuration and/or project files and an
  180.           alternate work file. Following is a table of CPE command line
  181.           parameters;
  182.  
  183.                           Table 1: Command Line Parameters
  184.  
  185.                ┌──────────┬──────────┬───────────────────────────────────┐
  186.                │ Syntax #1│ Syntax #2│       Function                    │
  187.                ├──────────┼──────────┼───────────────────────────────────┤
  188.                │ -m       │ /m       │ Forces use of Black & White mode  │
  189.                │ -c<name> │ /c<name> │ Loads <name> as configuration     │
  190.                │ -p<name> │ /p<name> │ Loads <name> as project           │
  191.                │ -w<name> │ /w<name> │ Sets Work file to <name>          │
  192.                │ -b       │ /b       │ Use BIOS screen writes            │
  193.                │ -s       │ /s       │ CGA Snow control toggle           │
  194.                ┴──────────┴──────────┴───────────────────────────────────┘
  195.  
  196.           You may provide a complete drive,path and file name with both the
  197.           -p and -c parameters. If you do provide a drive & path with a -c
  198.           or -p parameter, CPE will remember the full path when you are
  199.           saving the files again. CPE will not allow the use of the -p and
  200.           -c parameters until it has been registered.
  201.  
  202.           The file name given with a -w parameter will override the file
  203.           name that was stored in the project file. You may provide a
  204.           wildcard value with a -w parameter, in which case CPE will
  205.           display a directory and prompt for the file name on startup.
  206.           Following are some sample CPE startup commands;
  207.  
  208.                C:> CPE -m -p\etc\myfile.prj -c\bin\msc.cpe
  209.  
  210.                C:> CPE -wnewfile.c
  211.  
  212.                C:> CPE -pnew.prj -w*.prg
  213.  
  214.           CPE will verify all command line parameters and will report any
  215.           errors or duplicates to you and then exit with the dos errorlevel
  216.           set to one (1). If there are no errors in the CPE start up
  217.           commands CPE will begin it's operation with the parameters that
  218.           you have passed to it or it will use the default values.
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.                                         - 4 -
  228.  
  229.  
  230.                             CPE Version 4.1 Users Manual
  231.  
  232.  
  233.  
  234.           9  Mouse Commands
  235.  
  236.  
  237.           CPE will use a Microsoft compatible mouse for menu selections and
  238.           operation. Moving the mouse will move the CPE menu selection bar
  239.           or the cursor in a window. Pressing the LEFT button will select
  240.           from a menu or emulate the ENTER key. Pressing the RIGHT button
  241.           will cancel a selection or emulate the ESCAPE key.
  242.  
  243.  
  244.           10  Command Macros
  245.  
  246.  
  247.           The power and flexibility of CPE comes from it's processing all
  248.           commands with a specialized macro system. By the use of these
  249.           macros in configuring CPE you may adapt CPE to work with any
  250.           combination of programming utilities. CPE will use the following
  251.           macros in the execution of it's commands:
  252.  
  253.                                    Table 2: Macros
  254.  
  255.           $@             Expands to the full name of the file currently
  256.                          stored as the work file.
  257.  
  258.           $*             Expands to the root file name of the currently
  259.                          stored work file.
  260.  
  261.           $L             Expands to the full name of the currently stored
  262.                          linker file.
  263.  
  264.           $C             Expands to the full name of the currently stored
  265.                          compiler file.
  266.  
  267.           $M             Expands to the full name of the currently stored
  268.                          make file.
  269.  
  270.           $E             Expands to the full name of the currently stored
  271.                          errors file.
  272.  
  273.           $<             This Macro will prompt for a user input of a
  274.                          file-name.
  275.  
  276.  
  277.           The following command macro samples will help you to use and
  278.           understand the macro system:
  279.  
  280.           Compiler Commands:  cl /c /Oailt /Zi $@
  281.                               clipper $@ -l
  282.                               masm $ >$E
  283.  
  284.           Linker Commands:    link $*.obj+core.obj,$*.exe,$*.map,mylib
  285.                               link $*,,,mylib;
  286.  
  287.           Make Commands:      make -f$M
  288.  
  289.  
  290.  
  291.                                         - 5 -
  292.  
  293.  
  294.                             CPE Version 4.1 Users Manual
  295.  
  296.  
  297.  
  298.                               make $M
  299.  
  300.           Editor Commands:    vedit $@
  301.                               vedit $<
  302.                               vedit $M
  303.  
  304.           Debugger Commands:  dbu.exe
  305.                               td $*.exe
  306.                               cv $*.exe
  307.  
  308.           As these examples show the combinations of commands using the
  309.           macro system is virtually unlimited.
  310.  
  311.  
  312.           11  Configuration File
  313.  
  314.  
  315.           The configuration file is merely a collection of CPE macros
  316.           stored for later retrieval and use. The macros for Compiler,
  317.           Linker, Make Utility, Editor, Debugger and the two optional
  318.           utilities are stored in a disk file that may be altered and
  319.           reused by CPE to configure it for different combinations of these
  320.           utilities. You may want to construct a different configuration
  321.           file for each compiler language that you work with, or even for
  322.           different memory models and options that you may use with each
  323.           compiler.
  324.  
  325.           To edit a configuration you would select "Options" from the main
  326.           menu and then complete each of the macro entries from the sub-
  327.           menu items. You do not need to supply all of the options, only
  328.           those that you will be using are required.
  329.  
  330.           To Save a configuration you would select the sub-menu option
  331.           "Save setup" and CPE will prompt you for the full path and name
  332.           of the configuration file. You my accept the current name or
  333.           "CONFIG.CPE" if no name was given, or you may supply a full path
  334.           and name to save the configuration as.
  335.  
  336.           Retrieving a configuration is similar to saving except that all
  337.           of the macros currently used by CPE will be overwritten by the
  338.           new configuration macros. If you provide a wildcard in the file
  339.           name, CPE will display a directory of all files that match the
  340.           waildcard so that you may choose the file to load.
  341.  
  342.  
  343.           12  Project Maintenance
  344.  
  345.  
  346.           CPE allows you to maintain a project file for each programming
  347.           task. The project file will contain the names of the associated
  348.           Work file, Make file, Linker file, Compiler file and Errors file.
  349.           These files names are used via the macro system in the commands
  350.           stored in your configuration files. Saving and retrieving a
  351.  
  352.  
  353.  
  354.  
  355.                                         - 6 -
  356.  
  357.  
  358.                             CPE Version 4.1 Users Manual
  359.  
  360.  
  361.  
  362.           project file is exactly the same as the saving or retrieving of a
  363.           configuration file.
  364.  
  365.  
  366.           13  Registration
  367.  
  368.  
  369.           When you register CPE you will receive a special code from 3P
  370.           software and the instructions for entering the code to register
  371.           your software.  Once the code is validated a registration file
  372.           will be created that will change this and all future versions of
  373.           CPE into a fully functional registered version. Please do not
  374.           loose your code. In the event the registration file should be
  375.           corrupted or lost you will need the code to re-register CPE. If
  376.           you do happen to loose your code, you may contact 3P Software for
  377.           a new code.
  378.  
  379.  
  380.           14  Updates & Revisions
  381.  
  382.  
  383.           Due to the nature of CPE's registration updates are as easy to
  384.           get as the original version was. Just locate the latest revision
  385.           of CPE on any of the following BBS systems and download your
  386.           update. Once you have registered one version, all versions that
  387.           you download are registered.
  388.  
  389.                         Table 3: Systems carrying CPE updates
  390.  
  391.                    ┌────────────┬──────────────────────────────┐
  392.                    │ System     │ Location                     │
  393.                    ├────────────┼──────────────────────────────┤
  394.                    │ Compuserve │ IBMPRO,NANFORUM,PROGFORUM    │
  395.                    │ GEnie      │ DBMS,IBMPC                   │
  396.                    └────────────┴──────────────────────────────┘
  397.  
  398.           You may also download updates to CPE from any local BBS system
  399.           from which you may have received your original version.
  400.  
  401.  
  402.           15  Support & Service
  403.  
  404.  
  405.           As a registered owner of CPE you may contact 3P software for
  406.           support and service at the following address or phone number:
  407.  
  408.                     3P Software
  409.                     1827 Kendrick Street
  410.                     Philadelphia, PA 19152-1829
  411.                     (215) 725-6068
  412.           Telephone support is available Monday - Saturday from 10:00am to
  413.           10:00pm Eastern time.
  414.  
  415.  
  416.  
  417.  
  418.  
  419.                                         - 7 -
  420.  
  421.  
  422.                             CPE Version 4.1 Users Manual
  423.  
  424.  
  425.  
  426.           You may also contact the program author via E-Mail at the
  427.           following system addresses:
  428.  
  429.                     Compuserve:    73157,2412
  430.                     GEnie:         PPP3
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.                                         - 8 -
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.                                     Contents
  497.  
  498.  
  499.                   1  Copyright Notice  . . . . . . . . . . . . . . . 2
  500.                   2  License . . . . . . . . . . . . . . . . . . . . 2
  501.                   3  Warranty  . . . . . . . . . . . . . . . . . . . 2
  502.                   4  System Requirements . . . . . . . . . . . . . . 2
  503.                   5  Overview of Functions . . . . . . . . . . . . . 3
  504.                   6  Distribution Files  . . . . . . . . . . . . . . 3
  505.                   7  Installation  . . . . . . . . . . . . . . . . . 3
  506.                   8  Starting CPE  . . . . . . . . . . . . . . . . . 4
  507.                   9  Mouse Commands  . . . . . . . . . . . . . . . . 5
  508.                   10  Command Macros . . . . . . . . . . . . . . . . 5
  509.                   11  Configuration File . . . . . . . . . . . . . . 6
  510.                   12  Project Maintenance  . . . . . . . . . . . . . 6
  511.                   13  Registration . . . . . . . . . . . . . . . . . 7
  512.                   14  Updates & Revisions  . . . . . . . . . . . . . 7
  513.                   15  Support & Service  . . . . . . . . . . . . . . 7
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.                                           i
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582.  
  583.  
  584.  
  585.  
  586.  
  587.  
  588.  
  589.  
  590.  
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598.  
  599.  
  600.  
  601.  
  602.  
  603.  
  604.  
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.                                          ii
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618.  
  619.  
  620.  
  621.  
  622.  
  623.  
  624.                                      Tables
  625.  
  626.  
  627.                Table 1: Command Line Parameters  . . . . . . . . . . 4
  628.                Table 2: Macros . . . . . . . . . . . . . . . . . . . 5
  629.                Table 3: Systems carrying CPE updates . . . . . . . . 7
  630.  
  631.  
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.  
  671.  
  672.  
  673.  
  674.  
  675.                                          iii
  676.