home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / STR28.ZIP / STR.DOC < prev    next >
Text File  |  1993-06-29  |  12KB  |  270 lines

  1.  
  2.  
  3.                                 STR 2.8
  4.  
  5.          Memory-resident (TSR) string and file pasting program
  6.  
  7.                                   by
  8.                                Bob Eyer
  9.                              [73230,2620]
  10.                   Internet: 73230.2620@compuserve.com
  11.  
  12.                             June 29, 1993
  13.  
  14.  
  15.      Syntax
  16.      ------
  17.      STR [lines F=file C=cpt D=delayticks] [/U]
  18.  
  19.      Run  batch job: Ctrl-Backslash
  20.      Stop batch job: Ctrl-Esc
  21.  
  22.      Edit hot-key:   Ctrl-Backspace
  23.       -  COLOR x selects edit-window colour
  24.       -  ENTER selects and pastes string
  25.       -  Esc key exits without pasting
  26.       -  Ctrl-Home clears all strings
  27.       -  C=cpt, D=delayticks
  28.  
  29.  
  30.      If no parameter is given, STR simply returns the help screen above
  31.      without going resident.
  32.  
  33.  
  34.      Parameters may be entered in any order.
  35.  
  36.      lines         A positive integer setting the number of strings  to
  37.                    allocate  in  memory.   If  this  parameter  is  not
  38.                    mentioned, STR defaults lines to 10.  The maximum is
  39.                    determined  by  all  free  memory  less  40K, and is
  40.                    limited to a maximum  300  lines  in  the  shareware
  41.                    version (PFL may store as many as 6000 lines).
  42.  
  43.                    Where the user loads an ASCII file  whose  linecount
  44.                    exceeds this parameter, STR will ignore the excess.
  45.  
  46.                    May not be changed within edit mode.
  47.  
  48.      F=file        The name of the file containing a list of strings to
  49.                    read  by  STR.   Lines  should  be  set  higher than
  50.                    file's linecount.
  51.  
  52.                    Linelength in this file is limited to  the  size  of
  53.                    the  edit buffer - 60 characters.  Lines longer than
  54.                    60  will  be truncated to 60.  (PFL has 80-character
  55.                    lines).
  56.  
  57.                    Where  STR  stores  a  blank  line containing only a
  58.                    carriage return (read by nearly  all  editors  as  a
  59.                    null  line), it inserts a single blank prior to this
  60.                    sequence.   The  reason  for this is to avoid having
  61.                    STR kick the user out of edit mode in the middle  of
  62.                    a  message  upload  when  the  user is logged into a
  63.                    remote BBS mail area.  (Most BBS messagebase editors
  64.                    terminate an edit session on entry of a single  null
  65.                    line.)
  66.  
  67.                    May not not be changed within edit mode.
  68.  
  69.      C=cpt         Sets the number of characters per tick STR allocates
  70.                    for  pasting  to  the  underlying  application.  The
  71.                    default for cpt  is  13.   The  allowable  range  is
  72.                    1-15.    Assuming   delayticks  is  zero  (see  next
  73.                    parameter), STR's output speed can  thus  be  varied
  74.                    from  about 180 baud to about 2700 baud.  Increasing
  75.                    delayticks will,  of  course,  reduce  output  speed
  76.                    below this range.
  77.  
  78.                    This  parameter  may  be  changed  'on  the  fly' by
  79.                    entering 'c=x' (where x = 1,  2,  etc)  within  edit
  80.                    mode.   This  feature  allows the user to change the
  81.                    way STR injects characters to  the  keyboard  buffer
  82.                    without  having  to unload STR and start over with a
  83.                    new command line sequence.
  84.  
  85.      D=delayticks  The  number of CPU ticks to be skipped as STR pastes
  86.                    lines to the underlying  application.   The  default
  87.                    for delayticks is 0; that is, no tick is skipped.
  88.  
  89.                    Because  STR  pastes  lines  by injecting characters
  90.                    into  the  keyboard  buffer, the injection speed may
  91.                    exceed the rate at which the underlying  application
  92.                    can  receive information from the console.  This may
  93.                    especially be a problem when using STR to type  text
  94.                    to  a  remote  BBS  editor  to  which  the  user  is
  95.                    connected at a low  baud  rate.   When  the  problem
  96.                    occurs, STR may 'missfire' or overrun the underlying
  97.                    application.
  98.  
  99.                    To  correct  this   problem,   simply   stop   batch
  100.                    processing     (Ctrl-Esc),     enter    edit    mode
  101.                    (Ctrl-Backspace),  find  a  blank  line,  and  enter
  102.                    delayticks   in   the  window  using  your  standard
  103.                    commandline syntax:
  104.  
  105.                    D=delayticks
  106.  
  107.                    Recommended values: 1, 2, or 7.  Then hit Esc to get
  108.                    out of edit and start your  batch  job  again  using
  109.                    Ctrl-Backslash.
  110.  
  111.                    STR injects characters to the keyboard buffer at the
  112.                    default  rate  of  13  characters   per   CPU   tick
  113.                    [cpt=13].   This  speed  is  equivalent to about 236
  114.                    characters  per  second--just   about   2400   baud.
  115.                    Generally,  STR's  default of zero delayticks should
  116.                    be right for this speed.  Use 2 for 1200 baud and  7
  117.                    for 300 baud.
  118.  
  119.                    The  reader  should be informed that the standard PC
  120.                    keyboard buffer has a  capacity  of  15  characters.
  121.                    WARNING:  DO NOT USE THIS PROGRAM WITH TSRs DESIGNED
  122.                    TO MODIFY THE CAPACITY OF THE KEYBOARD BUFFER.
  123.  
  124.      /U            Unloads STR from memory.
  125.  
  126.                    Not available within edit mode.
  127.  
  128.      ╔══════════  Added Features of PFL (Paste Full List)  ═══════════╗
  129.      ║                                                                ║
  130.      ║          - Line delay control parameter                        ║
  131.      ║          - Choice of timer interrupts                          ║
  132.      ║          - Application selector                                ║
  133.      ║          - Makes available all free memory                     ║
  134.      ║          - Uses 80-character lines                             ║
  135.      ║                                                                ║
  136.      ║          See SHARE.TXT for ordering instructions.              ║
  137.      ║                                                                ║
  138.      ╚════════════════════════════════════════════════════════════════╝
  139.  
  140.      Discussion
  141.      ----------
  142.      The primary purpose of STR is to provide a way of uploading a text
  143.      file to a remote BBS messagebase where the user has no better  way
  144.      of  doing  such  a  job.   The  user familiar with Boyan, Telix or
  145.      Procomm will know how to upload messages to a message base without
  146.      using  this  program.   However,  in  certain   situations,   such
  147.      facilities  may  not  be  available.   For example, when uploading
  148.      description information to Compuserve from within  OZBEXT,  so  as
  149.      upload a binary file using Quick-B protocol.
  150.  
  151.      Although STR can also be used to paste files to a local standalone
  152.      editor, such a use is not recommended.  The main structural reason
  153.      is  that  most  editors have far more efficient methods of pasting
  154.      files to another disk file than by  direct  use  of  the  keyboard
  155.      buffer.   There  is no advantage in having STR do such a job where
  156.      there exist other means do it more efficiently.
  157.  
  158.      Further,  most editors have some means of remembering where to put
  159.      the cursor when the next line is typed after  a  carriage  return,
  160.      and  this  position  is  usually  not  column 1.  As a result, the
  161.      attempt to paste to many editors may result in text  being  forced
  162.      over  to  the  right  of  the  screen in an uncontrollable manner,
  163.      unless lines of the pasted text begin at column 1.
  164.  
  165.      There is the additional difficulty that many editors either do not
  166.      use  the  carriage  return to mark the end of a line, or use it to
  167.      set up line insertion  rather  than  line  following.   Experiment
  168.      shows  a  large  variety  of different responses to the ENTER key,
  169.      from editor to editor, even though each is designed to create only
  170.      ASCII text files within the DOS environment.
  171.  
  172.  
  173.      The enhanced retail version of this program is called  PFL  (short
  174.      for  Paste  Full  List).   PFL  supports  a  number  of  different
  175.      specialised environments  (such  as  the  ROSCOE  DOS-to-mainframe
  176.      editor); moreover, it features full use of memory to store as many
  177.      as 6000 lines of text, 80-character lines, and an expanded list of
  178.      control options.
  179.  
  180.      See SHARE.TXT for ordering details.
  181.  
  182.      Edit Mode
  183.      ---------
  184.      In edit mode, Ctrl-Home clears all  strings,  if  desired.   Since
  185.      this  Ctrl-Home  is  INTERNAL  to  the  edit  window,  it does not
  186.      interfere with the Ctrl-Home used in some communications programs.
  187.  
  188.      Typing  each string followed by the Up or Down cursors enters what
  189.      was typed into the STR array.  The number  of  the  entry  appears
  190.      above  the  edit  window  to  the extreme left.  The backspace key
  191.      operates as normal, as does the Home, End,  PgUp,  and  PgDn  keys
  192.      (except that the Pg keys skip 10 lines instead of 24 or 25).
  193.  
  194.      STR uses the End key to put the cursor at the  first  space  after
  195.      the  end of the line in the window, the Home key to put the cursor
  196.      at the extreme left of the line, and the Tab key  spaces  over  10
  197.      positions in the edit field.
  198.  
  199.      ENTER   pastes   the  string  in  the  window  to  the  underlying
  200.      application, but does not delete it from memory.
  201.  
  202.      You  may  also  enter  certain command line statements within edit
  203.      mode.  These are C=cpt and D=delayticks (see above).
  204.  
  205.  
  206.      Exercise
  207.      --------
  208.      Try using edit mode to type in a batch file called SAM.BAT.  Start
  209.      by loading STR with, say, 20 lines, as follows:
  210.  
  211.      STR 20
  212.  
  213.      Maybe your batch file has only 5 lines, which you  enter  manually
  214.      using  the Ctrl-Backspace hotkey and your cursor pad.  When you're
  215.      finished, return to DOS by using your Esc key (plus extra carriage
  216.      return), then enter
  217.  
  218.      COPY CON SAM.BAT
  219.  
  220.      and hit the Ctrl-\ hotkey to load SAM.BAT from STR.
  221.  
  222.      When finished enter Ctrl-Z to return to DOS.
  223.  
  224.      Before  unloading STR, re-enter the COPY CON environment using NUL
  225.      as your device, thus -
  226.  
  227.      COPY CON NUL
  228.  
  229.      Then use your Ctrl-Backspace key to get into  edit  mode,  find  a
  230.      blank  line,  and change your characters-per-tick parameter to C=1
  231.      and your delayticks to D=6.  Now hit Esc and then Ctrl-\ to  rerun
  232.      your file in batch mode.  Notice the difference on the screen.
  233.  
  234.      COLOR
  235.      -----
  236.      The  numbers  to  use  for  Color  are determined by the following
  237.      chart:
  238.  
  239.                   Back     Fore   Bright Fore
  240.                   ----     ----   -----------
  241.      Black           0        0    8
  242.      Blue           16        1    9
  243.      Green          32        2   10
  244.      Cyan           48        3   11
  245.      Red            64        4   12
  246.      Magenta        80        5   13
  247.      Brown          96        6   14
  248.      White         112        7   15
  249.  
  250.      Use  of  0  (black  on black) is always converted to 112 (black on
  251.      white) by STR.
  252.  
  253.      The correct COLOR number is found merely by adding the  Foreground
  254.      number  to  the  Background  number  desired.  For example, Bright
  255.      Green on Blue background is 10 + 16 = 26.
  256.  
  257.      Avoid setting COLOR above  127.   Values  above  that  limit  will
  258.      produce blinking displays.
  259.  
  260.      In  my  estimation the COLORs best for the eye are 10, 11, 14, 15,
  261.      26, 27, 30, 31, 74, 75, 78, 79 and 112.  But you  may  have  other
  262.      ideas.   Example,
  263.  
  264.      COLOR 75
  265.  
  266.      sets the window to Bright Cyan on a Red background.
  267.  
  268.      -------------------------
  269.      End of documentation.
  270.