home *** CD-ROM | disk | FTP | other *** search
/ C!T ROM 2 / ctrom_ii_b.zip / ctrom_ii_b / PROGRAM / UTILS / SHELL-92 / SHELL92.DOC next >
Text File  |  1992-07-07  |  17KB  |  443 lines
  1.         Shell-92   Copyright 1992 by James P. Habel Jr.
  2.  
  3.  
  4.   PURPOSE OF PROGRAM
  5.   ------------------
  6.  
  7.     Shell-92 is intended to be an aid to programmers who are now
  8. compiling their programs from the command line. This program will
  9. eliminate the need for repetitive typing of filenames and switches
  10. each time you compile your programs. It also allows you to use your
  11. favorite editor to edit your source files. You can instantly switch
  12. between your editor, compiler, debugger and linker with the press
  13. of a couple keys, effectively eliminating the need for the command
  14. line at all. Shell-92 can also be used as a replacement for some
  15. IDEs when you begin seeing that dreaded message, < OUT OF MEMORY >.
  16.  
  17.   FEATURES
  18.   --------
  19.  
  20.     - Easy to configure ( NO special text files to create, the program
  21.        does it all for you )
  22.  
  23.     - Accepts up to 6 filenames that you would normally have to type
  24.        at the command line each time you go to compile. Once the pro-
  25.        gram is configured this process now takes 2 key presses.
  26.  
  27.     - Accepts up to 15 switch directives that you toggle on an off
  28.        with a press of the space bar.
  29.  
  30.     - Easily configured to use your favorite editor, debugger and
  31.        linker.
  32.  
  33.     - Includes a 15 line batch file editor to create those small batch
  34.        files that you always seem to need when writing programs.
  35.  
  36.     - Delete files, print files, change directories and run ANY program
  37.        on your HD from easy to use menus.
  38.  
  39.     - Easily configure any five seperate programs to run from a menu
  40.        with the press of a single key.
  41.  
  42.     - MANY more features !
  43.  
  44.  
  45.    FILES INCLUDED
  46.    --------------
  47.  
  48.    shell92.doc  - The file you are now reading.
  49.  
  50.    shell92.exe  - The file name you type at the command line to
  51.           run the program.
  52.  
  53.  
  54.  
  55.    GENERAL INSTRUCTIONS
  56.    --------------------
  57.  
  58.      Install-92 can be run from any directory on your hard disk.
  59. Changing back and forth between directories is easily accomplished
  60. via a menu. Therefore only one copy of Install-92 is needed to run
  61. many different configurations. Whenever you save a configuration
  62. the information will be stored in the current directory. Also when-
  63. ever you change to a different directory the new configuration for
  64. the new directory will be read into the program. If no configuration
  65. file is found in the directory you change to then the program de-
  66. faults will be used.
  67.  
  68.   KEY USAGE
  69.   ---------
  70.  
  71.   Menus -
  72.      Up Arrow    - Move cursor bar up.
  73.      Down Arrow  - Move cusor bar down.
  74.      Enter       - Select highlighted entry.
  75.      Right Arrow - Next menu to right.
  76.      Left Arrow  - Next menu to left.
  77.      ESC         - Abort menu and return to top bar menu.
  78.  
  79.  ( You may also select an option from a menu by pressing the highlighted
  80.    letter for the option you wish to use. )
  81.  
  82.  
  83.   Data -
  84.      Up Arrow    - Go up one field.
  85.      Down Arrow  - Go down one field.
  86.      CTRL- Left  - Move cursor one character to left.
  87.      CTRL- Right - Move cursor one character to right.
  88.      Home        - Go to first field.
  89.      End         - Go to last field.
  90.      ESC         - Abort data entry OR show options menu.
  91.      F3          - Save data to disk.
  92.  
  93.  
  94.   INSTRUCTIONS FOR ALL MENU ITEMS
  95.   -------------------------------
  96.  
  97.   <<    FILES    >>
  98.   -----------------
  99.  
  100.    File Names - This is the place where you configure the program to
  101.    ----------   meet your programming needs. Two different types of
  102.    file names need to be entered here, file names that will make your
  103.    programming quicker and paths that the program needs to find certain
  104.    files.
  105.  
  106.       Main file name - This file will usually be the name of the source
  107.                file that you will be editing most often.
  108.  
  109.       Execute file name- This file will usually be the name of the file
  110.              that will be created as a result of compiling
  111.              your source files.
  112.  
  113.       Include files (1-5) - You may enter the names of 5 different file
  114.                 names here if your compiler expects include
  115.                 files to be typed at the command line.
  116.  
  117.        ( Assemblers usually need include files for example while pascal
  118.      compilers don't. If your compiler doesn't use include files
  119.      then be sure to leave all 5 of these lines BLANK ! )
  120.  
  121.       Command.com Path - This is the complete path to your systems
  122.              command.com file. On a lot of systems this will
  123.              be   C:\DOS\COMMAND.COM
  124.  
  125.       Text editor Path - Enter the complete path of the text editor that
  126.              you plan to use to edit your source files. If
  127.              you plan to use EDLIN then this will usually be
  128.              C:\DOS\EDLIN.COM
  129.  
  130.       Linker Path      - Enter the path to your linker if you plan to
  131.              use one. The default path is C:\DOS\LINK.EXE
  132.  
  133.       Compiler Path    - Enter the complete path to your compiler here.
  134.              For example, C:\QP\QPL.EXE if you plan to use
  135.              the QuickPascal compiler. Remember if your
  136.              compiler also runs from it's own IDE you need
  137.              the name of the command line compiler NOT the
  138.              name of the IDE !
  139.  
  140.       Default Extension- Examples :
  141.                 Compiler              Enter
  142.                 --------              -----
  143.                 Basic                 .bas
  144.                 Pascal                .pas
  145.                 C                     .c
  146.                 Assembly              .asm
  147.  
  148.       Debugger         - Enter the complete path to the debugger that
  149.              you plan to use here. The default for this line
  150.              will be  : C:\DOS\DEBUG.COM
  151.  
  152.    Program Names - Use this option to enter up to 5 different programs
  153.    -------------   that you would like to run from a menu with the press
  154.    of a single key. They can be any programs that are located anywhere
  155.    on your hard disk. For each program you need to enter at least 2
  156.    items, the title of the program that you would like to appear on the
  157.    menu and the complete path to the program on your hard disk. The 3rd
  158.    entry for the command line is optional and would contain any items
  159.    that you would normally type after the file name when running a
  160.    program from the command line.
  161.  
  162.    Switch Settings - This is where you toggle any switches that you may
  163.    ---------------   have configured previously off and on. Simply move
  164.    the cursor to the switch you want to change with the arrow keys then
  165.    use the space bar to toggle the switch off and on. If a check mark
  166.    shows in the box then that switch is on, otherwise it will be off.
  167.    For more information about configuring switches see the information
  168.    about the MISC menu.
  169.  
  170.    Set Directory - Use this option to change to any directory you wish.
  171.    -------------   First delete the current directory name with the
  172.    delete key then type in the name of the directory that you wish to
  173.    change to. Press ENTER to change to the new directory. If the new
  174.    directory does not exist, the name of the current directory will be
  175.    re-displayed. Remember that you can store different configurations
  176.    in different directories. The first thing the program will do when
  177.    you change directories is read the new configuration into the pro-
  178.    gram. If no configuration files are found then the program will use
  179.    the program defaults.
  180.  
  181.    Delete Files - This option allows you to delete files easily from
  182.    ------------   a menu. After selecting the file to delete press Y
  183.    to delete the file or  N  to leave the file intact.
  184.  
  185.    Print Files - Use this option to print any file to your printer.
  186.    -----------   This option does not use any special printing meth-
  187.    ods so it is best used to print text files.
  188.  
  189.  
  190.  
  191.         [     A note about PICK, CHOOSE and LIST     ]
  192.  
  193.     These 3 options appear on most menus and are explained below.
  194.  
  195.     CHOOSE - Choose allows you to enter any file name that you wish
  196.          by simply typing the FULL path to the file on the line
  197.          provided.
  198.  
  199.     LIST   - List allows you to select a file name from the current
  200.          directory. Only the files with the extension shown on
  201.          the menu will be listed.
  202.  
  203.     PICK   - Pick will allow you to select ANY file name from ANY
  204.          directory from an easy to use menu. To change direct-
  205.          ories simply move the cursor to highlight the desired
  206.          directory and press enter.
  207.  
  208.  
  209.   <<    EXEC    >>
  210.   ----------------
  211.  
  212.      Main File - This option will execute the file name that you
  213.      ---------   specified when you configured the program. If
  214.      you did not specify an execute file name then this option
  215.      will do nothing.
  216.  
  217.      Choose - This option will execute any program that you type
  218.      ------   on the line provided. You must supply the FULL path
  219.      to the file or you will get a error message.
  220.  
  221.      Pick - Use this option to execute ANY file from ANY directory
  222.      ----   by simply selecting the file name from the menu.
  223.  
  224.      1  List  COM - Presents a menu of all COM files that can be
  225.      ------------   executed in the current directory.
  226.  
  227.      2  List  EXE - Presents a menu of all EXE files that can be
  228.      ------------   executed in the current directory.
  229.  
  230.      3  List  BAT - Presents a menu of all BAT files that can be
  231.      ------------   executed in the current directory.
  232.  
  233.      If you configured up to 5 different programs to run from this
  234.      menu with a single key stroke they will appear where the solid
  235.      lines appear in the menu.
  236.  
  237.        No matter which of the above methods you use to execute a
  238.    program remember that the program MUST end with one of the
  239.    following extentions  :  COM, EXE or BAT
  240.  
  241.  
  242.  
  243. <<    /Edit    >>
  244.   ----------------
  245.  
  246.      Main File - This option will allow you to edit the file name
  247.      ---------   that you specified when you configured the program.
  248.      If you did not specify a main file name then this option will
  249.      do nothing.
  250.  
  251.      Choose - This option will aloow you to edit any file that you type
  252.      ------   on the line provided. You must supply the FULL path
  253.      to the file or you will get a error message.
  254.  
  255.      List - This option will display all the files in the
  256.      ----   current directory ending with the extension that you
  257.      specified when configuring the program. Simply select the
  258.      file that you wish to edit.
  259.  
  260.      Pick - Use this option to edit ANY file from ANY directory
  261.      ----   by simply selecting the file name from the menu.
  262.  
  263.      If you configured the names of any include files they will
  264.      appear at the end of this menu instead of the solid lines.
  265.  
  266.  
  267.   <<    Comp    >>
  268.   ----------------
  269.  
  270.      Main File - This option will allow you to compile the file name
  271.      ---------   that you specified when you configured the program.
  272.      If you did not specify a main file name then this option will
  273.      do nothing.
  274.  
  275.      Choose - This option will allow you to compile any file that you type
  276.      ------   on the line provided. You must supply the FULL path
  277.      to the file or you will get a error message.
  278.  
  279.      List - This option will display all the files in the
  280.      ----   current directory ending with the extension that you
  281.      specified when configuring the program. Simply select the
  282.      file that you wish to compile.
  283.  
  284.      Pick - Use this option to compile ANY file from ANY directory
  285.      ----   by simply selecting the file name from the menu.
  286.  
  287.      Any include files that you configured will appear on the menu
  288.      instead of the solid lines. Only the include file that you
  289.      select will be compiled.
  290.  
  291.      If you configured the names of any include files they will
  292.      be included in the compilation just as if you had typed them
  293.      on the command line, except as per the above paragragh.
  294.  
  295.  
  296.   <<    Link    >>
  297.   ----------------
  298.  
  299.      Execute Linker - This option will run the linker program that
  300.      --------------   you specified when you configured Shell-92.
  301.      If you didn't specify one the program will default to:
  302.      C:\DOS\LINK.EXE
  303.  
  304.      Cancel - This will return you to the main menu bar.
  305.      ------
  306.  
  307.  
  308.    <<   Debug    >>
  309.    ----------------
  310.     ( All options on this menu will run the debugger that you
  311.       specified on the Set File Names screen. The following
  312.       options will select the name of the file that you wish
  313.       to debug.                                             )
  314.  
  315.  
  316.       Main File - If you specified an execute file name when you
  317.       ---------   configured Shell-92 then that file name will
  318.       appear here, if not then this option will run your debugger
  319.       without specifing a file name.
  320.  
  321.       Choose - With this option you can type in the FULL path of
  322.       ------   the file you want to debug.
  323.  
  324.       1  COM files - This will list all the COM files in the
  325.       ------------   current directory. Simply select the COM
  326.       file that you want to debug.
  327.  
  328.       2  EXE files - This will list all the EXE files in the
  329.       ------------   current directory. Simply select the EXE
  330.       file that you want to debug.
  331.  
  332.       Pick - Here you can select ANY file from ANY directory
  333.       ----   to debug.
  334.  
  335.  
  336.    <<   Misc    >>
  337.    ---------------
  338.  
  339.       System Info - This option will display various information
  340.       -----------   such as the time of day, free disk space etc.
  341.  
  342.       Change Colors - Use this option to change all the program
  343.       -------------   colors to your liking.
  344.  
  345.       Batch File Editor - This option will invoke the mini batch
  346.       -----------------   file editor descibed below.
  347.  
  348.  
  349.             Batch File Editor
  350.             -----------------
  351.  
  352.     This utility is great for writing small batch files of up to
  353.     15 lines in length. To create a new batch file select the CREATE
  354.     BATCH FILE option from the presented menu. To edit an existing
  355.     batch file select EDIT BATCH FILE and all the batch files that
  356.     are located in the current directory will be displayed. Select
  357.     the file that you wish to edit and press ENTER. The editor will
  358.     then appear. Once you are in the editor the ESC or F3 keys will
  359.     bring up the options menu which is :
  360.  
  361.        SAVE FILE - This will save the file that you are current-
  362.        ly working on and then exit to the main bar menu.
  363.  
  364.        ABORT CHANGES - This will NOT save any changes you made
  365.        since loading the current file, and then exit to the main
  366.        bar menu.
  367.  
  368.        INSERT LINE - This will insert a blank line at the current
  369.        cursor location and move all lines below it down one line.
  370.  
  371.        DELETE LINE - This will delete the line that the cursor is
  372.        located on and move all lines below it up one line.
  373.  
  374.       The following keys are functional while editing a file  :
  375.  
  376.        Insert, delete, all arrow keys, ctrl-right, ctrl-left,
  377.        home, end, and F7.
  378.  
  379.        The F7 function key will allow you to use all 256 IBM char-
  380.        acters in your batch files. Simply press F7 and type the
  381.        numerical code for the character you want to display and
  382.        press ENTER.
  383.  
  384.  
  385.       Configure Switches - This option will allow you to configure
  386.       ------------------   up to 15 different switches for your
  387.       compiler. These switches can then be toggled on and off by
  388.       using the Set Switches option from the Files menu. This will
  389.       help save time as each switch would normally have to typed at
  390.       the command line each time you went to compile your program.
  391.       You can give each switch any title you want but the switch
  392.       itself should be entered exactly as you would type it on the
  393.       command line. When you are done entering your switches press
  394.       F3 to save them to disk, then when you run the program the
  395.       next time the switches will load automaticly.
  396.  
  397.  
  398.    <<   \Dos    >>
  399.    ---------------
  400.  
  401.      Shell to DOS - This option will shell you out to the DOS
  402.      ------------   command line where you can use any DOS
  403.      commands that you would normally use. Type EXIT when you
  404.      want to return to Shell-92.
  405.  
  406.     <<   Quit    >>
  407.     ---------------
  408.  
  409.      Quit Program - Use this option when you are done with
  410.      ------------   Shell-92 and wish to return to DOS.
  411.  
  412.  
  413.    REGISTRATION
  414.    ------------
  415.  
  416.        If after trying Shell-92 for awhile and you find it useful
  417.    enough to keep using you must register it with me. To register
  418.    please send one dollar ($1.00) along with your name and address
  419.    to :
  420.  
  421.        James P. Habel Jr.
  422.        645 West Vine Street
  423.        Lancaster, PA 17603
  424.  
  425.     You will not recieve another disk if you register the program
  426.     as you already have in your possession the complete program.
  427.     If can can't find a dollar to send, don't worry, you can still
  428.     register by sending your name and address. Any questions, comments
  429.     or suggestions about the program just drop me a line at :
  430.  
  431.     Home      -  717-291-4637
  432.     Delphi    -  JHABEL
  433.     Prodigy   -  HGVR05A
  434.  
  435.     Thanks and hope to be hearing from you !
  436.  
  437.     ( PS - If anybody  wants the PASCAL source code ( lots of home
  438.        grown routines ) let me know and I'll gladly send it to you.
  439.        About 3 bucks would be appreciated to cover disk and mailing
  440.        costs.                                                        )
  441.  
  442.  
  443.