home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / DICE401.ZIP / DICE.DOC next >
Text File  |  1989-07-26  |  15KB  |  375 lines

  1.    DOS Interactive Command Editor                                  Page 1
  2.  
  3.  
  4.                                  TABLE OF CONTENTS
  5.  
  6.            1       INTRODUCTION . . . . . . . . . . . . . . . . . . . . 1
  7.            2       GETTING STARTED  . . . . . . . . . . . . . . . . . . 1
  8.            3       OPERATION  . . . . . . . . . . . . . . . . . . . . . 2
  9.            3.1       To Exit DICE . . . . . . . . . . . . . . . . . . . 2
  10.            3.2       Help . . . . . . . . . . . . . . . . . . . . . . . 2
  11.            3.3       Command Line Editing . . . . . . . . . . . . . . . 2
  12.            3.4       Display And Buffer Operations  . . . . . . . . . . 3
  13.            3.4.1       Command Stack  . . . . . . . . . . . . . . . . . 4
  14.            3.4.2       Command Buffers  . . . . . . . . . . . . . . . . 4
  15.            3.4.3       Argument Buffers . . . . . . . . . . . . . . . . 6
  16.            3.5       Command Prompt . . . . . . . . . . . . . . . . . . 7
  17.            4       PROGRAM AND DOCUMENTATION USAGE  . . . . . . . . . . 7
  18.  
  19.  
  20.  
  21.       Copyright (C) 1986,89 Eric S. Adams
  22.  
  23.  
  24.  
  25.  
  26.    1  INTRODUCTION
  27.  
  28.         DICE (DOS Interactive Command Editor) is a command line editor.
  29.    It provides features which enable more efficient entry of typed-in
  30.    commands for DOS or OS/2 full screen command mode.  It's features are:
  31.  
  32.         1.  Enhanced editing capability for the DOS and OS/2 command
  33.             line.
  34.         2.  Saves command line commands on a stack as they are entered.
  35.         3.  Supports tag, save and recall of often used commands and
  36.             arguments.
  37.         4.  Display of tagged arguments, commands and stacked commands.
  38.         5.  Help function that shows a summary of DICE commands.
  39.  
  40.  
  41.  
  42.  
  43.    2  GETTING STARTED
  44.  
  45.         The easiest way to start using DICE is to run the STRTDICE.BAT
  46.    file under DOS or the STRTDICE.CMD file under OS/2 full screen command
  47.    mode.  These procedures will start either the DOS version or the OS/2
  48.    version of DICE.  The DOS executable is DICE.EXE and the OS/2
  49.    executable is DICE2.EXE.  At this point, a prompt and command line
  50.    appear on the screen and command entry is much like that of DOS or
  51.    OS/2 full screen command mode with added features.
  52.    DOS Interactive Command Editor                                  Page 2
  53.  
  54.  
  55.    3  OPERATION
  56.  
  57.         The following sections describe the operation and features of
  58.    DICE.
  59.  
  60.  
  61.  
  62.    3.1  To Exit DICE
  63.  
  64.         If you want to exit DICE, press <Alt>X (hold the "Alt" key down
  65.    while pressing the "X" key).  You will then be asked whether or not
  66.    you want to save your commands and buffers.  Pressing the "Y" key will
  67.    cause DICE to exit, pressing the "S" key will save the command stack
  68.    and buffers to a file and then exit or pressing any other key will
  69.    continue.  The location and name of the file used to store the command
  70.    stack and buffers is described in the section "Display and Buffer
  71.    Operations".
  72.  
  73.  
  74.  
  75.    3.2  Help
  76.  
  77.         You can get help displays of the DICE commands and startup
  78.    parameters by pressing <Alt>H or the F1 key.  The first screen gives a
  79.    short description of the DICE commands.  If you press "Y" when this
  80.    screen is displayed, a short description of the DICE startup command
  81.    line arguments is displayed.
  82.  
  83.  
  84.  
  85.    3.3  Command Line Editing
  86.  
  87.         The following list summarizes the basic editing functions for the
  88.    DICE command line:
  89.  
  90.         1.  Left or Right arrow - moves cursor one character.
  91.         2.  <Ctrl>Left or <Ctrl>Right arrow - moves cursor one word.
  92.         3.  Home - moves to the start of the command line.
  93.         4.  End - moves to the end of the command line.
  94.         5.  Del - deletes the character at the cursor.
  95.         6.  Backspace - deletes the character in front of the cursor.
  96.         7.  Ins or <Alt>I - toggles the edit mode between insert mode and
  97.             overstrike mode.
  98.         8.  <Alt>K - Deletes from the cursor to the end of the command.
  99.         9.  Toggle command - <Alt>T (or F3) alternately clears the
  100.             command line and moves the command or argument at the pointer
  101.             to the command line.  (The pointer is described in the
  102.             section "Display and Buffer Operations").
  103.    DOS Interactive Command Editor                                  Page 3
  104.  
  105.  
  106.        10.  A Semi-colon is a command line delimiter and can be used to
  107.             include comments in the saved command buffers.  For example:
  108.  
  109.                CD C:\MYDIR         ; Change to my directory
  110.  
  111.             If you want to actually enter a semi-colon on the command
  112.             line, type two semi-colons together.  For example:
  113.  
  114.                masm myfile.asm;;
  115.  
  116.             This example will become "masm myfile.asm;".
  117.        11.  A comma is a command delimiter and can be used to put
  118.             multiple commands on a single command line or command buffer.
  119.             For example:
  120.  
  121.                C:,CD C:\MYDIR       ; go to drive c and change to my directory
  122.  
  123.             If you want to actually enter a comma on the command line,
  124.             type two commas together.  For example:
  125.  
  126.                masm myfile.asm,,;;
  127.  
  128.             This example will become "masm myfile.asm,;".
  129.  
  130.  
  131.  
  132.  
  133.    3.4  Display And Buffer Operations
  134.  
  135.         To display the Command Stack and tagged commands and arguments,
  136.    press <Alt>B (buffers display).
  137.  
  138.         The following commands are used to move the buffer pointer.  Note
  139.    that these commands are in effect even if the buffers are not being
  140.    displayed.
  141.  
  142.         1.  Up or down arrow - moves command/argument pointer up or down
  143.             one position.
  144.         2.  PgUp - scrolls arguments or commands up 5.
  145.         3.  PgDn - scrolls arguments or commands down 5.
  146.         4.  <Alt>N - moves the pointer to the next buffer group.
  147.         5.  <Ctrl>PgUp - moves the pointer up to the command or argument
  148.             buffers section.
  149.         6.  <Ctrl>PgDn - moves the pointer down to the command stack or
  150.             command buffers.
  151.  
  152.  
  153.         Each time DICE is started, it attempts to read the buffer
  154.    information from a disk file.  The buffers can be written to this file
  155.    by pressing <Alt>S (save buffers).  The information can also be read
  156.    from the file by pressing <Alt>F (fill buffers).  The file that is
  157.    used is identified by environment variables.  The DOS version uses the
  158.    environment variable "DICEDAT" and the OS/2 version uses the variable
  159.    "DICE2DAT" to identify the file to use.  For example, if you want to
  160.    use a file called "DICE.DAT" in a directory called "c:\util", you can
  161.    setup the environment variable as follows:  "set
  162.    DICEDAT=c:\util\dice.dat".  Note that environment variables cannot be
  163.    DOS Interactive Command Editor                                  Page 4
  164.  
  165.  
  166.    set from within DICE.
  167.  
  168.         If the environment variable does not exist, then the DOS version
  169.    of DICE uses a file named "DICE370.DAT" and the OS/2 version will use
  170.    a file named "DICE2.DAT".  The default files will be located in the
  171.    directory that was the current directory at the time DICE was started.
  172.  
  173.  
  174.  
  175.    3.4.1  Command Stack -
  176.  
  177.         As commands are entered and executed, they are pushed onto the
  178.    command stack.  The command stack can be displayed along with the
  179.    other buffers by pressing <Alt>B.  Previously entered commands are
  180.    moved back to the command line as the pointer is moved up or down
  181.    through the stack (using the up or down arrow key).  You can also push
  182.    a command from the command line onto the stack without executing it by
  183.    pressing <Alt>P (push).  When a command is pushed onto the stack, one
  184.    of the other commands in the stack is removed.  If an identical
  185.    command exists within the stack, it is removed, otherwise the command
  186.    at the top of the stack is removed.
  187.  
  188.  
  189.  
  190.    3.4.2  Command Buffers -
  191.  
  192.         The command buffers contain saved commands that can be executed
  193.    by entering a user defined pneumonic of 1 to 4 characters.  For
  194.    example, changing the current directory to "c:\project\source" can be
  195.    done by entering the command "cd c:\project\source".  You can define a
  196.    command called "ps" to do this by typing in the following:
  197.  
  198.       ps=cd c:\project\source<Alt>C
  199.  
  200.    This will enter the command and pneumonic into memory.  If you want to
  201.    save it to disk, press <Alt>S.
  202.  
  203.         You may delete this defined command from the command buffers list
  204.    by moving the pointer to the command (using <Alt>N, Up and Down arrow
  205.    keys) and pressing <Alt>D.
  206.  
  207.         You can search the command buffers list by entering a tag
  208.    followed by an equal sign and then pressing the <Alt>C for example, if
  209.    the above command tag was entered, then entering the following:
  210.  
  211.       ps=<Alt>C
  212.  
  213.    Will change the command line to:
  214.  
  215.       ps=cd c:\project\source
  216.  
  217.    DOS Interactive Command Editor                                  Page 5
  218.  
  219.  
  220.         Command buffer tags must be terminated by a space, comma or
  221.    <Return>.  When a tagged command is processed, the remaining command
  222.    line is appended to it.  For example if the tag "d" has been added to
  223.    the command buffers list as follows:
  224.  
  225.       d=dir<Alt>c
  226.  
  227.    Then the following command will perform a directory of all the *.asm
  228.    files:
  229.  
  230.       d *.asm<Enter>
  231.  
  232.  
  233.         Command buffers can be nested.  For example, if the following
  234.    command has been added to the command buffers list as follows:
  235.  
  236.       pur=del *.bak, del *.lst<Alt>c
  237.  
  238.  
  239.         Then the following command buffer and tag could be created (using
  240.    the "ps" tag created in an earlier example):
  241.  
  242.       psp = ps,pur <Alt>C    ;purge source directory.
  243.  
  244.  
  245.         Typing "psp" <Enter> will change the current directory to
  246.    c:\project\source and delete the files *.bak and *.lst.
  247.  
  248.         Command buffers also support argument passing using the %1 - %9
  249.    variables in a manner similar to batch or command files.  For example,
  250.    if the command is defined as follows:
  251.  
  252.       pur=del %1*.bak,del %1*.lst
  253.  
  254.    Entering "pur project" will delete all project*.bak and project*.lst
  255.    files.
  256.  
  257.         Command strings can be echoed to the screen as they are being
  258.    executed by pressing <Alt>E.  Pressing <Alt>E again turns off the
  259.    command echo.  For example, if <Alt>E is pressed before the command
  260.    pur (from the previous example) is executed, the following command
  261.    strings will be shown on the screen as they are executed:
  262.  
  263.       del project*.bak
  264.  
  265.       del project*.lst
  266.  
  267.    DOS Interactive Command Editor                                  Page 6
  268.  
  269.  
  270.    3.4.3  Argument Buffers -
  271.  
  272.         Argument buffers can be used to store frequently used command
  273.    arguments.  Stored arguments can be entered on the command line by
  274.    typing the user defined argument tag followed by <Alt>L or <Ctrl>L.
  275.  
  276.         Argument buffers and tags are added to the argument list in the
  277.    same way that command buffers are added except that an <Alt>A is
  278.    pressed.  For example:
  279.  
  280.       ps=c:\project\source<Alt>a
  281.  
  282.    Will enter the argument "c:\project\source" into the argument buffers
  283.    list.  Typing "<space>ps<Alt>L" will cause the tag "ps" to be replaced
  284.    by the literal "c:\project\source" on the command line.  When an
  285.    argument tag is typed on the command line, it must be preceded by an
  286.    non-alphanumeric character (normally a space).  This is so that the
  287.    program can figure out where the tag begins.  If you wanted to list
  288.    the directory for c:\project\source, then the following could be
  289.    entered:
  290.  
  291.       dir ps<Ctrl>L
  292.  
  293.    When the <Ctrl>L is pressed, the command line becomes:
  294.  
  295.       dir c:\project\source
  296.  
  297.    Now when <Enter> is pressed, the directory will be displayed.
  298.  
  299.         Arguments can be deleted from the argument buffers by moving the
  300.    pointer to the argument and tag and pressing <Alt>D.
  301.  
  302.         You can search the argument buffers list by entering a tag
  303.    followed by an equal sign and then pressing the <Alt>A for example, if
  304.    the above command tag was entered, then entering the following:
  305.  
  306.       ps=<Alt>A
  307.  
  308.    Will change the command line to:
  309.  
  310.       ps=c:\project\source
  311.  
  312.    DOS Interactive Command Editor                                  Page 7
  313.  
  314.  
  315.    3.5  Command Prompt
  316.  
  317.         DICE generates it's own command prompt which is configured by
  318.    specifying command arguments when the program is invoked.  The DICE
  319.    command arguments are as follows:
  320.  
  321.         1.  $nnn - display attribute of the prompt, command line and
  322.             DICE displays.
  323.         2.  $$ - puts a dollar sign in the prompt string.
  324.         3.  $_ - does a carriage return/line feed.
  325.         4.  $bnn - sets the idle time in minutes before screen blanking.
  326.             If nn = 0, screen blanking is disabled.  This feature is not
  327.             supported in the OS/2 version.
  328.         5.  $cttt - executes saved command buffer with tag "ttt" upon
  329.             startup of DICE, the tag must be terminated by any
  330.             non-alphnumeric character.
  331.         6.  $d - puts the current date in the prompt string.
  332.         7.  $g - puts in the ">" character.
  333.         8.  $l - puts in the "<" character.
  334.         9.  $n - puts in the drive letter.
  335.        10.  $p - puts the current drive and directory into the prompt.
  336.        11.  $t - puts the time of day into the prompt.
  337.        12.  $v - inserts the DOS or OS/2 version number into the prompt.
  338.        13.  ASCII characters go into the prompt string unaltered.
  339.  
  340.  
  341.         For example, if DICE is invoked as follows:
  342.  
  343.       EXAMPLE:    DICE $10$Cpon $d $t $p $_DOS$g
  344.  
  345.    The display will be in light green (CGA color 10) and the command
  346.    buffer with the tag "pon" will be executed at start up.  The prompt
  347.    for command entry format will be as follows:
  348.  
  349.       Wed, Oct 1,1986  2:00:30.01pm  C:\COM
  350.       DOS>_
  351.  
  352.  
  353.  
  354.  
  355.    4  PROGRAM AND DOCUMENTATION USAGE
  356.  
  357.    The programs DICE.EXE and DICE2.EXE and the manual DICE.DOC are
  358.    intended to be copied and/or distributed for non-commercial use only.
  359.    The programs and documentation come without warranty of any kind
  360.    either expressed or implied.
  361.  
  362.         If you're using DICE and find it useful, you should register your
  363.    copy.  The registration fee is $5.00 per copy.  To register, send your
  364.    name, address and $5.00 to the location listed below.  Also if you
  365.    have comments or suggestions for the program, please mail them and we
  366.    will consider them for future revisions.
  367.  
  368.       DICE Software Factory
  369.       29284 Willow Lane
  370.       Wickliffe, Ohio
  371.                  44092
  372.  
  373.  
  374.  
  375.