home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 1995 December / SOFM_Dec1995.bin / pc / dos / utility / isam / bruce509.doc next >
Text File  |  1995-10-31  |  21KB  |  426 lines
  1. BRUCE509.DOC                         1                         Revised: 09/11/95
  2.  
  3. --------------------------------------------------------------------------------
  4.                               Contact information
  5.  
  6. For the following routines:  AV,  BFIND,  COPSINCE,  DATES,  DIRCOMP,  DIRTOTAL,
  7. FILL, FIXTEXT, FORTUNE, PAGINATE, READINIT, and READMAKE-created files:
  8.  
  9.                 Bruce Guthrie
  10.                 Wayne Software
  11.                 113 Sheffield St.
  12.                 Silver Spring, MD 20910
  13.  
  14.                 fax: (301) 588-8986
  15.  
  16. For the following routines:  CHANGE, CONVERT, FILUPDAT, ISAMFIND/ISAMMAKE, READ,
  17. READY, and SPLITREC:
  18.  
  19.                 Bruce Guthrie
  20.                 Room H-4885
  21.                 U.S. Dept of Commerce/ESA/STAT-USA
  22.                 Washington, DC 20230
  23.  
  24.                 fax: (202) 482-2164
  25.                 voice: (202) 482-3234
  26.  
  27.                 E-Mail: bguthrie@doc.gov
  28.  
  29. Foreign users:  Please provide  an  Internet-reachable  e-mail  address  in  all
  30. correspondence if you have any hope of getting a reply!  Internet e-mail is  the
  31. preferred method of contact for all  other  users  as  well.   America  On-Line,
  32. CompuServe, and Prodigy all offer Internet e-mail access so get with it!
  33.  
  34. Since these programs are typically "freeware"  (with  the  exception  of  people
  35. trying to make money from them instead of me), they generate maybe $100/year  in
  36. revenue for me.  As such, my ability to afford  wonderful  customer  support  is
  37. somewhat restricted.   Please  do  not  leave  messages  saying  "Call  me  long
  38. distance".  Also, please be specific  about  what  problems  you  encounter  and
  39. include command-line inputs as well as any control  or  INI  files  that  you're
  40. using.
  41.  
  42. The "production" releases of these programs are posted  directly  by  me  (Bruce
  43. Guthrie, the author) on the Simtel ftp site at ftp.coast.net.  More  information
  44. about locations at this site is provided later.  People are encouraged to upload
  45. them to bulletin board systems but I do not upload them to BBS's myself.
  46.  
  47. Standard disclaimer in this society:  Wayne Software disclaims all warranties as
  48. to this software, whether express or implied, including without  limitation  any
  49. implied  warranties  of  merchantability,  fitness  for  a  particular  purpose,
  50. functionality, data integrity or protection.
  51.  
  52.  
  53. BRUCE509.DOC                         2                         Revised: 09/11/95
  54.  
  55. --------------------------------------------------------------------------------
  56.                                   Introduction
  57.  
  58. This documentation provides some overview information on a number  of  utilities
  59. that have been posted by Wayne Software.  All  programs  described  herein  were
  60. written by Bruce Guthrie.  Most are distributed with a Wayne Software copyright.
  61. Others were written for the U.S. Department of Commerce.  All are free  for  use
  62. provided relevant documentation is kept with the programs, no changes  are  made
  63. to the programs or documentation, and  they  are  not  bundled  with  commercial
  64. programs or charged for separately.
  65.  
  66. CHANGE, CONVERT, FILUPDAT, ISAMFIND/ISAMMAKE, READ, and  SPLITREC  are  excluded
  67. from the commercial-packaging restriction.  These programs are owned by the U.S.
  68. Department of Commerce and may be re-distributed without restriction.
  69.  
  70. People who need to bundle AV, BFIND, COPSINCE, DATES, DIRCOMP,  DIRTOTAL,  FILL,
  71. FIXTEXT, FORTUNE, PAGINATE, READINIT, or READMAKE files in  commercial  packages
  72. other than shareware/freeware collections must pay a  $50  registration  fee  to
  73. "Wayne Software" at the following  address.   READMAKE-created  files  are  also
  74. subject to this limitation.  I  don't  expect  to  make  any  money  from  these
  75. utilities but I don't want others to sell them instead.
  76.  
  77. This collection of utilities were compiled using Microsoft's  Visual  BASIC  for
  78. DOS 1.0 compiler.  In each  case,  Thomas  G.  Hanlin  III's  excellent  PBClone
  79. routines,  release  2.3,  provided  additional  functionality.   Since  Tom  has
  80. announced that he will be dropping support for his  PBClone  routines  to  allow
  81. himself to spend time on a real life,  future  directions  for  my  routines  is
  82. uncertain.  The basic routines should be able  to  be  maintained  indefinitely;
  83. we'll see.  I keep thinking that I should be doing Windows programming but  it's
  84. hard to get psyched up for that when you think of Windows as a computer virus.
  85.  
  86. Each of the utilities are separately described in a like-named *.DOC file.  This
  87. documentation (BRUCEymm.DOC--the file release date is  indicated  by  the  "ymm"
  88. parameter) serves to summarize the various utilities.
  89.  
  90. Most of the routines have defaults that  can  altered  by  using  initialization
  91. files (inifiles).  These are described in the appropriate  documentation.   (One
  92. thing about *.INI files; if you don't  have  one,  it's  in  your  interests  to
  93. specify the "/-I" parameter.  Otherwise, the program searches  your  entire  DOS
  94. path looking for the file.)
  95.  
  96. Wayne Software also writes programs, batch files, and sets up menu  systems  for
  97. people on a for-fee basis.  If you desire this service, contact  Wayne  Software
  98. at the address specified above.
  99.  
  100.  
  101. BRUCE509.DOC                         3                         Revised: 09/11/95
  102.  
  103. --------------------------------------------------------------------------------
  104.                             The programs themselves
  105.  
  106. The utilities are uploaded with a ZIP name that includes the year and  month  of
  107. the release in a "ymm" format ("409" is September 1994 version).  The files  are
  108. posted directly by the author to the Simtel archives at  ftp.coast.net  and  are
  109. available via anonymous ftp through that site.  Users are encouraged to post the
  110. files on bulletin boards and such but, again, the author directly posts only  to
  111. the Simtel archives.
  112.  
  113. If you're using a version of the programs that's more  than  a  year  old,  it's
  114. almost always the case that there's a newer version.  Please check the ftp  site
  115. for an update.  Alternatively, send $10 made out  to  "Wayne  Software"  to  the
  116. Wayne Software address above and I'll send you everything on diskette.  (If  you
  117. need anything other than 3.5" high density, specify that too please.)
  118.  
  119. The current version of each program  is  documented  below.   In  addition,  the
  120. Simtel subdirectory name, the Simtel one-line description, and the regular short
  121. file description (from the *.DIZ file) are provided for each of the programs.
  122.  
  123. This listing is current as of the September 1995 (509) release.
  124.  
  125. SimTel/msdos/arcutil/
  126. av509.zip       Archive view: Free ZIP etc directory viewer
  127.  
  128. AV.EXE:  Archive directory viewer.  Presents list of files in archive (ZIP, ARC,
  129. etc) and lets you sort as desired.  Also allows resetting of the file date based
  130. on the archive's contents.
  131.  
  132. SimTel/msdos/textutil/
  133. bfind501.zip    Boolean FIND command (BFIND BEGIN & END)
  134.  
  135. BFIND.EXE:  Allows Boolean-type FIND requests.  For example, find any line  with
  136. one string AND another one, or any line with one string OR another.
  137.  
  138. SimTel/msdos/textutil/
  139. chang509.zip    Change strings in text files
  140.  
  141. CHANGE.EXE:  Processes change commands in files.  Files can be of any  size  and
  142. type (e.g.  binary or text) and are processed  quickly.   Up  to  thirty  change
  143. commands can be processed in a single pass.  Also  provides  ability  to  remove
  144. trailing spaces from text files.
  145.  
  146. SimTel/msdos/spredsht/
  147. convr505.zip    Convert dBase, ASCII-delim, fixed, 1-2-3
  148.  
  149. CONVERT.EXE and SPLITREC.EXE:   Converts  between  data  formats:   FROM  dBase,
  150. ASCII-delimited (typically commas between fields and quotes around strings), and
  151. fixed field TO Lotus WKS, ASCII-delimited, dBase, and fixed  field.   Additional
  152. SPLITREC program is primarily intended for handling mainframe-derived data  sets
  153. (which don't use CR/LF to indicate records), typically copied to the PC  from  a
  154. tape; splits up the logical records into physical records.
  155.  
  156. SimTel/msdos/dirutil/
  157. cops509.zip     Copies files modified since given date
  158.  
  159. COPSINCE.EXE:  Copies all files modified since a given date.  Primarily used for
  160. making sure you have a back-up of stuff and also to  copy  updated  programs  to
  161.  
  162. BRUCE509.DOC                         4                         Revised: 09/11/95
  163.  
  164. another place.  Lets you define your own groupings of files if desired.
  165.  
  166. SimTel/msdos/batutil/
  167. dates507.zip    Warns you in advance of birthdays etc
  168.  
  169. DATES.EXE:  Program that warns you in advance when an  event  like  a  birthday,
  170. anniversary, or holiday is coming up.  The idea is to give you  advance  warning
  171. so you can send a card or get out of town in time.
  172.  
  173. SimTel/msdos/dirutil/
  174. dirco509.zip    Updates files based on source directory
  175.  
  176. DIRCOMP.EXE:  Similar in some ways to DOS's REPLACE command but adds ability  to
  177. delete extra files in the  destination  subdirectory,  copy  hidden  and  system
  178. files, and prepare a report showing  inconsistencies.   Is  frequently  used  by
  179. network administrators to update workstation files.
  180.  
  181. SimTel/msdos/dirutil/
  182. dirto505.zip    Directory lister and totaller
  183.  
  184. DIRTOTAL.EXE:  Prepares report showing files in subdirectory or  drive.   Allows
  185. some restriction requests (show only files with  date  greater  than  a  certain
  186. value).  Similar to Norton's FF and Ray Van Tassle's WIZ  command  (which  is  a
  187. great program but it doesn't work on network or CD-ROM discs) in some  ways  but
  188. presents a more formal report.  Also allows you to look for duplicate file names
  189. and search by attributes or dates.
  190.  
  191. SimTel/msdos/diskutil/
  192. fill506.zip     Stuffs as many files as possible on disk
  193.  
  194. FILL.EXE:  Program designed to move files off to floppy  diskettes,  taking  the
  195. biggest files first and skipping those that won't fit.  Also provides option  of
  196. splitting large files up, creating a status report, and other features.
  197.  
  198. SimTel/msdos/dirutil/
  199. filup503.zip    Copy updated files based on a control list
  200.  
  201. FILUPDAT.EXE:  Program which compares a selected list of files in a source  path
  202. against those in another path and copies those that have been updated.   Similar
  203. to DOS' REPLACE command but works from a stored list of files and can handle any
  204. number of directories.
  205.  
  206. SimTel/msdos/textutil/
  207. fixtx509.zip    Translate text file characters en masse
  208.  
  209. FIXTEXT.EXE:  Program which applies a user-definable character-translation table
  210. to a text file.  Can allow you to convert graphics  characters  to  their  ASCII
  211. equivalents, lowercase letters to uppercase letter, etc.  Can also  be  used  to
  212. translate DOS text files to Mac or Unix text files and  vice  versa.   Can  also
  213. expand tabs, remove trailing spaces, and remove backspaces.
  214.  
  215. SimTel/msdos/batutil/
  216. fortn411.zip    Fine-tunes DOS FOR command w/options
  217.  
  218. FORTUNE.EXE:  A tuner-upper for the DOS FOR command.   Generates  a  batch  file
  219. which does all those wildcard things you wished FOR could do (like  "FORTUNE  IN
  220. (*.BAS) DO RENAME %A %2*.*" to remove parts of file names).   Lets  you  do  all
  221. sorts of things including distinguishing file name roots from  their  extensions
  222.  
  223. BRUCE509.DOC                         5                         Revised: 09/11/95
  224.  
  225. as well as incrementing file names by specified values.
  226.  
  227. SimTel/msdos/textutil/
  228. isamf509.zip    Full-text searching help desk documents
  229.  
  230. ISAMFIND.EXE and ISAMMAKE.EXE:  Programs that work  in  conjunction  to  provide
  231. full-text searching of text files.  This is useful for helpdesk applications and
  232. other functions where you want to search  for  files  and  retrieve  the  "best"
  233. document that matches your search criteria.
  234.  
  235. SimTel/msdos/textutil/
  236. pagin509.zip    Paginates text (headers, indexes, sorting...)
  237.  
  238. PAGINATE.EXE:  Reformats text files with  imbedded  formatting  codes.   Handles
  239. things like titles,  footers,  indexes,  alignment,  justification,  multicolumn
  240. listings,  etc.   Also  provides  support  for   imbedding   tabular   data   in
  241. ASCII-delimited or dBase formats which can be imbedded  and/or  sorted  in  your
  242. reports.
  243.  
  244. SimTel/msdos/textutil/
  245. read509.zip     Free viewer, also make any text self-viewing
  246.  
  247. READ.EXE,  READY.EXE,  READINIT.EXE,  and  READMAKE.EXE:   Text  file   browsing
  248. utilities.  READ--Supports marking, copying text,  reading  Unix  and  Mac  text
  249. files, etc.  Handles with files of 16,000 lines or less (approx 800,000  bytes).
  250. READY--truncates or wraps lines over 80 characters in length but  handles  files
  251. of an unlimited number of lines.  READMAKE--Takes an ASCII-text file  and  makes
  252. it self-viewable (using a READ clone).
  253.  
  254.  
  255. BRUCE509.DOC                         6                         Revised: 09/11/95
  256.  
  257. --------------------------------------------------------------------------------
  258.                                 Revision history
  259.  
  260. Detailed revision histories for the programs are only maintained  for  the  last
  261. three releases.  After that, you get the major revision summaries only  for  the
  262. next three releases.  After that, you get almost nothing.   No  one  reads  this
  263. junk anyway, right?  Programmer types like to put in it in just to justify  what
  264. they've been doing over the last couple of years.
  265.  
  266. -------------- (full detail; revisions made 1 to 3 months ago)
  267. Release 95/09:
  268.  
  269.   All  programs:   Switched  documentation  to  include   page   headers,   full
  270.   justification, etc.  I'm using the PAGINATE command (which  has  never  gotten
  271.   the attention I thought it deserved) for all of the  documentation  now.   Was
  272.   relatively easy to implement too!
  273.  
  274.   AV:  Fixed a number of bugs related to being in  non-page  (/-P)  mode.   Also
  275.   fixed up a bug which ignored the "Q" (quit) option.
  276.  
  277.   CHANGE:  Added wildcard specs for the input file.
  278.  
  279.   COPSINCE:  Maintenance release.  Been over a year since  it  came  out  and  a
  280.   number of things have been modified in terms of documentation and *.INI files.
  281.  
  282.   DIRCOMP:  Made screen colors configurable.
  283.  
  284.   FIXTEXT:  Maintenance release.  Been over a year  since  it  came  out  and  a
  285.   number of things have been modified in terms of documentation and *.INI files.
  286.  
  287.   ISAMFIND/ISAMMAKE:   Made  the  /Fcorename  parameter  optional  in  ISAMMAKE;
  288.   defaults to something based on the /Cctlfile parameter.  Dropped  support  for
  289.   input formats (FI=format string) and renamed output formats (FO=format string)
  290.   to be just F=format string.  Dropped support for  /STOP  and  /CONT  parms  in
  291.   ISAMMAKE. Completely changed the documentation for ISAMMAKE so it now actually
  292.   makes some sense.  Added support for combining files  to  be  processed  in  a
  293.   single file using a /SPLIT=splitstring parameter when the file  is  read;  you
  294.   can combine a thousand files as one and  just  have  something  like  </TITLE>
  295.   separating them.  Changed a number of defaults.   Added  support  for  showing
  296.   either the filename or the first line instead of a filled-in file description.
  297.   Added /VP1=parms and /VP2=parms to the ISAMFIND command; allowing you to  pass
  298.   in the desired viewing parameters.  Some  tinkering  with  colors  and  status
  299.   indicators.  Several changes made in the READY.EXE program were to  accomodate
  300.   changes in the ISAMFIND program.
  301.  
  302.   PAGINATE:  Added support for the output file name  in  titles,  footers,  etc.
  303.   Also allowed the replacement fields in titles, footers, etc to be  a  specific
  304.   field width to insure that they end up more  uniformly  presented.   Fixed  up
  305.   bugs with the /-HTML command.
  306.  
  307.   READ:  Modified program so Alt-xxx keys work for searching just  in  case  you
  308.   want to search for non-ASCII characters.  Fixed some problems  with  searching
  309.   for short (1 character or less) strings in  reverse.   Fixed  a  lock-up  that
  310.   happened when you asked for "next" search and there wasn't anything to  search
  311.   for yet. Allowed the program to read a file called "HELP" (used to bring up /?
  312.   help).
  313.  
  314.   READY:  Added line processing ranges (e.g.  only read the  first  100  lines).
  315.  
  316. BRUCE509.DOC                         7                         Revised: 09/11/95
  317.  
  318.   Added /AFTERP=string and /AFTERF=string  options.   Fixed  a  bug  when  doing
  319.   "next" search  when  no  previous  search  was  specified.   Fixed  bug  which
  320.   prevented the program from finding the text in the first line.
  321.  
  322. Release 95/07:
  323.  
  324.   All programs:  Now allow the *.INI files to be combined  into  one  file  with
  325.   named blocks.  This lets you avoid having multiple *.INI files  all  over  the
  326.   place. They also all recognize a SET BG=filespec environmental parameter which
  327.   lets you define the *.INI file once and be done with it.
  328.  
  329.   All programs that allowed  &Hxx  codes:   Changed  the  way  that  these  were
  330.   detected by the programs.  The subroutine's a little more  efficient  now  and
  331.   the subroutine now figures that the hex codes  end  with  the  first  pair  of
  332.   characters that don't match the list of valid hex  codes.   So  "&H00Go"  will
  333.   take the first four characters as being \000 and then "Go" will be there.   In
  334.   keeping with the older version, the first space  after  a  hex  code  will  be
  335.   dropped by the routine (presumed to be a delimiter only).  Also note that  any
  336.   occurence of "&H" will disappear from your strings; use &\072 or something  if
  337.   you really need that string.
  338.  
  339.   AV:  Kept running into system maximums with the program so switched  to  using
  340.   ISAM files to store file members.  As a result, can  handle  archives  of  any
  341.   size but it's slower.  Added sorting option for path  plus  file  name.   Also
  342.   added the ability to specify a filter so only members with certain strings  in
  343.   their member names will show up.
  344.  
  345.   DATES:  Added the ability to include imbedded decimal codes in the file.  This
  346.   is primarily of use if you want multi-line items to be displayed.  It can also
  347.   be used to alter the color of the line within the  line  itself.   There's  an
  348.   example in the documentation using this technique to draw a (crappy) little US
  349.   flag for patriotic events.  Added the ability to have a day repeat each  month
  350.   such as "XX/10/XX Mortgage due".
  351.  
  352.   DIRCOMP:  Program was ignoring /ATTR=xxx  requests.   Modified  program  so  a
  353.   detailed summary report shows up on the screen (not just in the status  file).
  354.   Also added support for *.INI files.  (The whole time I was doing this,  I  was
  355.   reminded of the fact that I had dropped this program a  couple  of  years  ago
  356.   because I didn't think anyone would find a use for it.)
  357.  
  358.   ISAMMAKE/ISAMFIND:  Lots of debugging done.   Changed  ISAMFIND  so  it  would
  359.   prompt you for more search words if none  provided.   Fixed  a  problem  which
  360.   prevented the program from running correctly if you didn't  have  EMS.   Added
  361.   READY.EXE to the ZIP file and switched it to be the default text viewer.  This
  362.   works well with the fact that READY  supports  text  highlighting  now.   This
  363.   change required that the /READ and /-READ parameters be dropped; a new  /-VIEW
  364.   option have been added instead.
  365.  
  366.   PAGINATE:  Didn't work if you didn't have EMS.  Also  fixed  a  problem  which
  367.   caused an overflow stack error if you ran the demo.
  368.  
  369.   READ and READMAKE:  Made it so you could leave off color  settings  after  you
  370.   set the number of them you want to change.   For  example,  "/COLOR=150"  will
  371.   change the text color but leave the others as they were.
  372.  
  373.   READMAKE:  Fixed a bug which sometimes gave  you  "permission  denied"  errors
  374.   when trying to view the help screen.
  375.  
  376.  
  377. BRUCE509.DOC                         8                         Revised: 09/11/95
  378.  
  379.   READY:  Added tab expansion.  For long lines, added /TRUNCATE, /SPLIT,  /WRAP,
  380.   and /INDENT=n options.  Added ability to highlight up to 10  words  throughout
  381.   the text.  Added ability to Ctrl-PgUp/Ctrl-PgDn among  up  to  100  documents.
  382.   Added support for /COLOR=nnn etc,  /PORT=port,  /Iinitfile,  /-I,  /MONO,  and
  383.   /COLOR parms.  READY defaults to reading the READ.INI file  (if  present)  and
  384.   just ignores any parameters READY doesn't directly support.   Similarly,  READ
  385.   and READMAKE *.INI files can include READY-specific parameters and  these  are
  386.   ignored by those programs.
  387.  
  388. -------------- (kind of terse; revisions made 4 to 6 months ago)
  389. Release 95/06:
  390.  
  391.   FILL:  Added /LETTER and /-LETTER parameters.
  392.  
  393.   ISAMMAKE:  Added option of reading the first line of the file to provide the
  394.   file description.
  395.  
  396.   READ:  Tossed in READY text-file viewer too.
  397.  
  398. Release 95/05:
  399.  
  400.   MULTICOL:  Dropped.
  401.  
  402. -------------- (real terse)
  403. Release 94/12:
  404.   New:  PAGINATE.
  405.  
  406. Release 94/11:
  407.   New:  ISAMFIND/ISAMMAKE.
  408.  
  409. Release 94/06:
  410.   New:  DATES.
  411.  
  412. Release 94/02:
  413.   New:  FORTUNE.
  414.  
  415. Release 94/01:
  416.   New:  COPSINCE and FIXTEXT.
  417.  
  418. Release 93/03:
  419.   New:  AV and READINIT.
  420.  
  421. Release 93/01:
  422.   First release posted on SIMTEL (Internet).
  423.   New:  The DEMO System (shareware and not part of normal package).
  424.  
  425. 
  426.