home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PROGRAMS / UTILS / DOS_HELP / DICE372.ZIP / DICE.DOC < prev    next >
Encoding:
Text File  |  1987-12-07  |  18.1 KB  |  491 lines

  1. DICE.EXE - DOS Interactive Command Editor version 3.72               Page 1
  2.  
  3.  
  4.                                  TABLE OF CONTENTS
  5.         1       INTRODUCTION . . . . . . . . . . . . . . . . . . . . 1
  6.         2       OPERATION  . . . . . . . . . . . . . . . . . . . . . 1
  7.         2.1       Display And Help . . . . . . . . . . . . . . . . . 2
  8.         2.2       Command Arguments  . . . . . . . . . . . . . . . . 2
  9.         2.3       Command Line And Buffer Editing  . . . . . . . . . 3
  10.         2.4       Tag And Buffer Operations  . . . . . . . . . . . . 4
  11.         2.5       Technical  . . . . . . . . . . . . . . . . . . . . 7
  12.         3       PROGRAM USE AND ACKNOWLEDGMENTS  . . . . . . . . . . 8
  13.  
  14.  
  15. APPENDIX A      SUMMARY OF UPDATES
  16.  
  17.         A.1     VERSION 3.72 UPDATED FROM 3.71 . . . . . . . . . . A-1
  18.         A.2     VERSION 3.71 UPDATED FROM 3.70 . . . . . . . . . . A-1
  19.         A.3     VERSION 3.70 UPDATED FROM 3.60 . . . . . . . . . . A-2
  20.  
  21.  
  22.  
  23.    Copyright (C) 1986,87 Eric S. Adams
  24.  
  25.  
  26.  
  27.  
  28. 1  INTRODUCTION
  29.  
  30.      DICE.EXE (DOS Interactive Command Editor) is a DOS command editor
  31. which enables more efficient entry of DOS commands.  It features:
  32.  
  33.      1.  Enhanced editing capability of DOS command line.
  34.      2.  Stacks previously entered DOS commands which can be  recalled
  35.          to the command line.
  36.      3.  Supports tag, save  and  recall  of  command  strings  and/or
  37.          argument strings.
  38.      4.  Display of tagged arguments, commands and stacked commands.
  39.      5.  Help function that shows a summary of DICE.EXE  commands  and
  40.          startup command line arguments.
  41.  
  42.  
  43.  
  44.  
  45. 2  OPERATION
  46.  
  47.      After DICE.EXE is invoked, command entry is much like that of DOS
  48. with the the added features listed above.
  49.  
  50.      At startup time  it  attempts  to  read  a  file  containing  the
  51. contents  of  the  argument buffers, command buffers and command stack
  52. previously created by using the buffer save  function  (<Alt>S).   The
  53. default  name  for  the  data  file  is  "DICE370.DAT" and the default
  54. directory is the current directory at the time DICE is  started.   The
  55. name  and  directory can also be specified by defining the environment
  56. variable DICEDAT.  If the file does not exist, the  buffers  are  left
  57. empty.   A  specified  command  can be executed at startup if desired.
  58. See a $Cxxxx command line argument.
  59. DICE.EXE - DOS Interactive Command Editor version 3.72          Page 2
  60.  
  61.  
  62.      If DICE.EXE waits for a key for about 15 minutes or so,  it  will
  63. clear  the  screen.   It  does  this  by  clearing  display page 3 and
  64. selecting it.  When a key is pressed, then the  display  is  restored.
  65. Note,  the  screen  is  not  cleared from within applications run from
  66. DICE.  The screen blank feature can be disabled or the idle  time  can
  67. be changed by using a $bnn command line argument when dice is invoked,
  68. (see the section on command prompt).
  69.  
  70.  
  71.  
  72. 2.1  Display And Help
  73.  
  74.      The buffers and command stack display  is  selected  by  pressing
  75. either F2 or <Alt>B and help is selected by pressing either the F1 key
  76. or <Alt>H.
  77.  
  78.  
  79.  
  80. 2.2  Command Arguments
  81.  
  82.      DICE.EXE generates it's own command prompt which is configured by
  83. specifying  command  arguments  when  the  program  is  invoked.   The
  84. DICE.EXE command arguments are as follows:
  85.  
  86.      1.  $nnn - display attribute of  the  prompt,  command  line  and
  87.          DICE.EXE displays.
  88.      2.  $$ - puts a dollar sign in the prompt string.
  89.      3.  $_ - does a carriage return/line feed (NOTE,  more  than  one
  90.          return/line  feed  in  a  prompt  will  cause  the top of the
  91.          buffers display to be scrolled off the screen).
  92.      4.  $Axy - sets the command delimiter and  command  line  comment
  93.          character.  The defaults for these characters are a comma and
  94.          semicolon.
  95.      5.  $Bnn - sets the idle time in minutes before screen  blanking,
  96.          nn  =  idle  time  in minutes.  If nn = 0, screen blanking is
  97.          disabled.
  98.      6.  $Cttt - executes saved command buffer  with  tag  "ttt"  upon
  99.          startup  of  DICE.EXE,  the  tag  must  be  terminated by any
  100.          non-alphanumeric character.
  101.      7.  $d - puts the current date in the prompt string.
  102.      8.  $g - puts in the ">" character.
  103.      9.  $l - puts in the "<" character.
  104.     10.  $n - puts in the drive letter.
  105.     11.  $p - puts the current drive and directory into the prompt.
  106.     12.  $t - puts the time of day into the prompt.
  107.     13.  $v - inserts the DOS version number into the prompt.
  108.     14.  ASCII characters go into the prompt string unaltered.
  109.  
  110. DICE.EXE - DOS Interactive Command Editor version 3.72          Page 3
  111.  
  112.  
  113.      For example, if DICE.EXE is invoked as follows:
  114.  
  115.    EXAMPLE:    DICE.EXE $10$Cpon $d $t $p $_Ready$g$s30
  116.  
  117. The display will be in light green (CGA  color  10)  and  the  command
  118. buffer  with  the tag "pon" will be executed at start up.  The command
  119. stack size will be 30 commands and the prompt for command entry format
  120. will be as follows:
  121.  
  122.    Wed, Oct 1,1986  2:00:30.01pm  C:\COM
  123.    Ready>_
  124.  
  125.  
  126.  
  127.  
  128.  
  129. 2.3  Command Line And Buffer Editing
  130.  
  131.      The following list  summarizes  the  editing  functions  for  the
  132. command buffers:
  133.  
  134.      1.  Left arrow - moves cursor left one character.
  135.      2.  <Ctrl> Left arrow - moves cursor left one word.
  136.      3.  Right arrow - moves cursor right one character.
  137.      4.  <Ctrl> Right arrow - moves cursor right one word.
  138.      5.  Home - moves to the start of the command line.
  139.      6.  End - moves to the end of the command line.
  140.      7.  Up arrow - moves command/argument pointer up one position.
  141.      8.  PgUp - moves pointer up to the command  or  argument  buffers
  142.          section.
  143.      9.  Down  arrow  -  moves  command/argument  pointer   down   one
  144.          position.
  145.     10.  PgDn - moves the command pointer down to the command stack or
  146.          command buffers.
  147.     11.  <Ctrl>PgUp - scrolls arguments or commands up 5.
  148.     12.  <Ctrl>PgDn - scrolls arguments or commands down 5.
  149.     13.  <Esc><Esc> - exits from DICE.EXE and returns  to  normal  DOS
  150.          operation.
  151.     14.  Del - deletes the character at the cursor.
  152.     15.  Backspace - deletes the character in front of the cursor.
  153.     16.  Ins or <Alt>I - toggles the edit mode between insert mode and
  154.          overstrike mode.
  155.     17.  Toggle command - F3 or <Alt>T alternately clears the  command
  156.          line  and moves the command or argument at the pointer to the
  157.          command line.
  158.     18.  <Alt>K - Deletes from the cursor to the end of the command.
  159.     19.  A Semicolon is a command line delimiter and can  be  used  to
  160.          include  comments  in  the  saved  command  buffers (with the
  161.          expense of using more memory).  For example:
  162.  
  163.             CD C:\MYDIR         ; Change to my directory
  164.  
  165. DICE.EXE - DOS Interactive Command Editor version 3.72          Page 4
  166.  
  167.  
  168.     20.  A comma is a  command  delimiter  and  can  be  used  to  put
  169.          multiple commands on a single command line or command buffer.
  170.          For example:
  171.  
  172.             C:,CD C:\MYDIR       ; go to drive c and change to my directory
  173.  
  174.  
  175.               The comment character can be changed at startup with the
  176.          $A  command  line  argument.   See  the  section  on  command
  177.          arguments.
  178.  
  179.               The comment character can be overridden by entering  two
  180.          of  them, if it is required as an argument to a command.  For
  181.          example,
  182.  
  183.                      msc myfile.c ;;
  184.  
  185.  
  186.               This command will result in a single  semicolon  at  the
  187.          end  of the command.  In other words, the command sent to DOS
  188.          will be:
  189.  
  190.                      msc myfile.c ;
  191.  
  192.     21.  A comma is a  command  delimiter  and  can  be  used  to  put
  193.          multiple commands on a single command line or command buffer.
  194.          For example:
  195.  
  196.                      C:,CD C:\MYDIR       ; go to drive c and change to my directory
  197.  
  198.  
  199.               The  command  delimiter  character  can  be  changed  at
  200.          startup  with  the $A command line argument.  See the section
  201.          on command arguments.
  202.  
  203.               This character can also be entered as an argument  to  a
  204.          command by entering two of them.  For example,
  205.  
  206.                      msc myfile.c ,, ;;
  207.  
  208.  
  209.               This command will put  a  single  comma  followed  by  a
  210.          single semicolon in the command line passed to DOS.
  211.  
  212.  
  213.  
  214.  
  215. 2.4  Tag And Buffer Operations
  216.  
  217.      The  following  describes  the  command   and   argument   buffer
  218. operations.
  219.  
  220.      The buffers and command stack can be displayed by pressing <Alt>b
  221. or  by  pressing  the  F2  key.  The pointer can be moved by using the
  222. PgUp, PgDn, Up arrow and Down arrow keys.
  223. DICE.EXE - DOS Interactive Command Editor version 3.72          Page 5
  224.  
  225.  
  226.      Command buffers and tags are added to the command buffers list by
  227. entering a 1 to 4 alphanumeric character tag followed by an equal sign
  228. and the command, then press <Alt>c.  For example:
  229.  
  230.    ps = cd c:\project\source  <Alt>C
  231.  
  232. Will enter the command "cd c:\project\source" into the command buffers
  233. list.   Typing "ps<Enter>" will now execute a change directory (cd) to
  234. the directory c:\project\source.
  235.  
  236.      The buffer contents can be saved to the  data  file  on  disk  by
  237. pressing <Alt>S.
  238.  
  239.      You can search  the  command  buffers  list  by  entering  a  tag
  240. followed by an equal sign and then pressing the <Alt>C for example, if
  241. the above command tag was entered, then entering the following:
  242.  
  243.    ps =<Alt>C
  244.  
  245. Will change the command line to:
  246.  
  247.    ps = cd c:\project\source
  248.  
  249.  
  250.      Argument buffers and tags are added to the argument list  in  the
  251. same  way  that  command  buffers  are  added except that an <Alt>a is
  252. pressed.  For example:
  253.  
  254.    ps = c:\project\source <Alt>a
  255.  
  256. Will enter the argument "c:\project\source" into the argument  buffers
  257. list.  Typing "<space>ps<Alt>L" will cause the tag "ps" to be replaced
  258. by the literal "c:\project\source"  on  the  command  line.   When  an
  259. argument  tag  is typed on the command line, it must be preceded by an
  260. non-alphanumeric character (normally a space).  This is  so  that  the
  261. program can figure out where the tag begins.
  262.  
  263.      You can search the  argument  buffers  list  by  entering  a  tag
  264. followed by an equal sign and then pressing the <Alt>A for example, if
  265. the above command tag was entered, then entering the following:
  266.  
  267.    ps =<Alt>A
  268.  
  269. Will change the command line to:
  270.  
  271.    ps = c:\project\source
  272.  
  273.  
  274.      Command buffer tags must be  terminated  by  a  space,  comma  or
  275. <Return>.   When  a tagged command is processed, the remaining command
  276. line is appended to it.  For example if the tag "d" has been added  to
  277. the command buffers list as follows:
  278.  
  279.    d=dir<Alt>c
  280.  
  281. DICE.EXE - DOS Interactive Command Editor version 3.72          Page 6
  282.  
  283.  
  284. Then the following command will perform a directory of all  the  *.asm
  285. files:
  286.  
  287.    d *.asm<Enter>
  288.  
  289.  
  290.      Command buffers will also process arguments.  For example,  if  a
  291. command is saved as:
  292.  
  293.    cs = msc %1 ;;<Alt>C
  294.  
  295. Then entering "cs myfile" will be translated as the following command:
  296.  
  297.    msc myfile ;
  298.  
  299.  
  300.  
  301.      Command buffers can be nested.  For  example,  if  the  following
  302. command has been added to the command buffers list as follows:
  303.  
  304.    pur=del *.bak, del *.lst<Alt>c
  305.  
  306.  
  307.      Then the following command buffer and tag could be created (using
  308. the "ps" tag created in an earlier example):
  309.  
  310.    psp = ps,pur <Alt>C    ;purge source directory.
  311.  
  312.  
  313.      Typing  "psp"  <Enter>  will  change  the  current  directory  to
  314. c:\project\source and delete the files *.bak and *.lst.
  315.  
  316.      Command strings can be echoed to the screen prior to execution by
  317. pressing  <Alt>E.   Pressing  <Alt>E again turns off the command echo.
  318. For example, if <Alt>E is pressed before the  command  psp  (from  the
  319. previous  example)  is executed, the following command strings will be
  320. shown on the screen as they are executed:
  321.  
  322.    cd c:\project\source
  323.  
  324.    del *.bak
  325.  
  326.    del *.lst
  327.   
  328.  
  329.      A command or argument buffer can be deleted as follows:  press F2
  330. or  <Alt>B  to  select  the  buffers  display, move the pointer to the
  331. command or argument and tag you wish to delete by  using  PgUp,  PgDn,
  332. <Ctrl>PgUp,  <Ctrl>PgDn  and  the  up  and down arrow keys.  Now press
  333. <Alt>D.  To update the buffers file, you can press <Alt>S.
  334.  
  335.      The command stack and buffers are saved in the  file  defined  by
  336. the  environment  variable  DICEDAT.  If this variable is not defined,
  337. the the file "DICE370.DAT"  in  the  default  directory  at  the  time
  338. DICE.EXE  was  invoked  is used.  The buffers and command stack can be
  339. written to the file by pressing <Alt>S  or  the  buffers  and  command
  340. stack can be filled from the file by pressing <Alt>F.
  341. DICE.EXE - DOS Interactive Command Editor version 3.72          Page 7
  342.  
  343.  
  344.      For example, if the following line is in the  autoexec.bat  file,
  345. DICE can then be started from any subdirectory and it will use the the
  346. file "c:\dice.dat" for storing the command and argument buffers.
  347.  
  348.    SET DICEDAT=c:\dice.dat
  349.  
  350.  
  351.  
  352.  
  353. 2.5  Technical
  354.  
  355.      DICE.EXE uses the  DOS  int  21  EXEC  function  to  execute  DOS
  356. commands, batch jobs or run executable files.  This function brings in
  357. part of the DOS file  command.com  from  disk  and  uses  the  current
  358. environment including the path.  This has the following affects:
  359.  
  360.      1.  The set and path commands will only set  the  environment  or
  361.          path   until   the  command  is  finished,  after  which  the
  362.          environment returns to what it was before  the  command.   If
  363.          you  use  the  set  or path functions in a batch job, it will
  364.          remain until the batch job is complete.  If you want  to  use
  365.          set  or  path to permanently change the environment, you must
  366.          exit the DICE first.
  367.      2.  Executing commands is slower.  This isn't too bad on  systems
  368.          with  a  bootable  hard  disc,  but can be annoying on floppy
  369.          based systems.  A possible solution to this is to create  RAM
  370.          disk, copy command.com to it and set the environment variable
  371.          COMSPEC so that command.com will be read from the RAM disk.
  372.  
  373.  
  374.      DICE.EXE is not a TSR (terminate and stay resident), therefore if
  375. it  is  executed  from  your  autoexec.bat file, it should be the last
  376. command.
  377.  
  378.      Maximum command tag nesting is limited to 10 levels or  until  an
  379. internal  buffer  used  for  processing commands overflows.  In either
  380. case, an error message is displayed  and  the  command  processing  is
  381. terminated.
  382.  
  383.      Depending on the number of command and argument buffers  in  use,
  384. DICE.EXE  will use about 23k of memory and another 3k or so is used by
  385. Command.com each time a command is executed.
  386. DICE.EXE - DOS Interactive Command Editor version 3.72          Page 8
  387.  
  388.  
  389. 3  PROGRAM USE AND ACKNOWLEDGMENTS
  390.  
  391.      The DICE.EXE program and  DICE.DOC  manual  are  intended  to  be
  392. copied and/or distributed for non-commercial use only.
  393.  
  394.      If you're using the DICE.EXE program and  find  it  useful,  your
  395. contribution  ($10  suggested)  would be greatly appreciated.  Also if
  396. you have comments or suggestions for the program, please mail them  to
  397. the  following  address  and  they will be reviewed and considered for
  398. future revisions.
  399.  
  400.    Eric Adams
  401.    29284 Willow Lane
  402.    Wickliffe, Ohio
  403.               44092
  404.  
  405.  
  406.      I  thank  all  users  and  contributors  to  this  program,  most
  407. especially  the engineering people at Gould RSD in Cleveland for their
  408. encouragement and support in it's development.  I  also  give  special
  409. thanks  to  my  Creator  and  God,  Jesus Christ for the capability to
  410. develop programs such as this.
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.                               APPENDIX A
  424.  
  425.                           SUMMARY OF UPDATES
  426.  
  427.  
  428.  
  429.      The following an update summary since version 3.60.
  430.  
  431.  
  432.  
  433. A.1  VERSION 3.72 UPDATED FROM 3.71
  434.  
  435.  
  436.      1.  Added command echo toggle ( <alt>E command ).
  437.      2.  Added save buffers on exit prompt when program is exited.
  438.      3.  Added command arguments (%1 through %0) capability to  tagged
  439.          commands.
  440.      4.  Added   environment   variable   support   to   define    the
  441.          command/argument buffer path and file.
  442.      5.  Added an override  for  the  command  delimiter  and  comment
  443.          characters.
  444.      6.  Added set character capability for the command delimiter  and
  445.          comment characters.
  446.      7.  Added user configurable command stack size.
  447.      8.  Changed to skip leading white space in front of  commands  or
  448.          tags.
  449.      9.  Fixed bug in calculating screen idle time before blank.
  450.  
  451.  
  452.  
  453.  
  454. A.2  VERSION 3.71 UPDATED FROM 3.70
  455.  
  456.  
  457.      1.  Fixed bug in nested command tags.
  458.      2.  Fixed bug in prompt when current directory  is  displayed  at
  459.          the root.
  460.      3.  <Alt>C and <Alt>D if only a tag and equal sign are displayed,
  461.          do  a  search  for  the  tag  and put the command or argument
  462.          string on command line.
  463.      4.  Improved the help.
  464.      5.  $Bnn Command  line  argument  to  DICE  to  turn  off  screen
  465.          blanking  after  time  of  onus, also provide time for screen
  466.          blanking.
  467.  
  468. SUMMARY OF UPDATES                                            Page A-2
  469.  
  470.  
  471. A.3  VERSION 3.70 UPDATED FROM 3.60
  472.  
  473.  
  474.      1.  The command buffers are now in dynamically  allocated  memory
  475.          and no longer limited to 10.
  476.      2.  The  "undelete  buffers"  have  been  changed  to   "argument
  477.          buffers"  and also put into allocated memory and therefore no
  478.          longer limited to just 3.
  479.      3.  The command buffers are no longer selected with  the  <shift>
  480.          function   keys,   instead   they   are   selected  using  an
  481.          alpha-numeric character tag which you assign.
  482.      4.  Argument buffers are also given  an  alpha-numeric  character
  483.          tag.
  484.      5.  Most functions are now invoked by pressing the Alt key and  a
  485.          letter  rather  than  a  function  key.   The letter keys are
  486.          easier to remember and are less likely to get moved around on
  487.          future keyboards.
  488.      6.  The pop garbage functions have been taken out to save on code
  489.          space, since they didn't seem to get used much.
  490.  
  491.