home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 15 / CD_ASCQ_15_070894.iso / maj / swag / reader.doc < prev    next >
Text File  |  1994-05-26  |  16KB  |  352 lines
  1.  
  2.  
  3.                               READER.EXE v2.8
  4.                            (SWAG packet READER)
  5.                                 (c) GDSOFT
  6.                                  May 1994
  7.  
  8. INTRODUCTION
  9. ------------
  10.  
  11. SWAG (SourceWare Archival Group) is a collection of source code and program
  12. examples for the PASCAL programming language. The material has been donated
  13. by  various  PASCAL  programmers  from  around  the  world,  who  desire to
  14. contribute to the advancement of  one of the greatest programming languages
  15. there is.  MANY THANKS to all  who have contributed. As  such, NO CHARGE OF
  16. ANY KIND IS PERMITTED FOR THIS WORK.
  17.  
  18. The material has been collected from various network conferences worldwide,
  19. and organized  according to subject.  New material is  added quarterly, and
  20. new SWAG  packets are available  from various BBS  sources on a  FIRST call
  21. basis. See BBS.TXT for current support sites and how your BBS can join.
  22.  
  23. GETTING STARTED
  24. ----------------
  25.  
  26. The program READER.EXE is a executable program that will allow you to read,
  27. extract or print the contents of  SWAG packets. These packets are organized
  28. according to subject, with each one containing a number of PASCAL "snipets"
  29. on that subject. In the rest of this document, I'll refer to the program as
  30. "READER".
  31.  
  32. The SWAG packets should be placed ALL together in a directory on your disk.
  33. It is recommended that you create a single directory named '\SWAG'. You can
  34. use the DOS command :
  35.  
  36.                             mkdir c:\swag
  37.  
  38. Unpack  the distribution  archives and  place  all  of the  files with  the
  39. extension of "*.SWG" in this directory along with READER.EXE.
  40.  
  41. USING THE READER
  42. ----------------
  43.  
  44. Using the  reader is really very  simple. Just execute it,  and you will be
  45. presented with a  directory of all of the .SWG  files in the directory that
  46. READER is located in. If you have .SWG files elsewhere on your disk, or for
  47. that matter, any disk on your system,  you can move around the disk to find
  48. them  by  selecting  the  ".."  file  which  will  take  you  to the PARENT
  49. directory. Use the HOME, END and the arrow keys to maneuver around.
  50.  
  51. ALSO,
  52.  
  53. The directory window  is search key sensitive. This means  that if you have
  54. .SWG files  or directories listed in  the directory box, you  can just type
  55. the name of the file you want.  For example, pressing 'A' will place you at
  56. the first  entry starting with  'A'. Press 'N',  and you will  jump the the
  57. entry with 'AN...'  if you have one. If  NOT, you will jump the  first file
  58. starting with the letter 'N'.
  59.  
  60. At the bottom  of the screen you will notice  a menu indicating some cursor
  61. and function keys :
  62.  
  63.                         F2 - GREP
  64.                         F5 - Toggle STATS
  65.  
  66.                         <ENTER> - GO
  67.                         ESC - QUIT
  68.  
  69. F2 calls  the GREP (search)  function. This is  a VERY POWERFUL  and useful
  70. function, but  in order to  use this function,  you MUST have  at least ONE
  71. .SWG file  in the directory  box, and it  MUST be highlighted  !! Place the
  72. cursor any one of the .SWG files,  and press F2. You will be presented with
  73. a prompt window :
  74.  
  75.                         SWAG Message Base Reader 2.8
  76. ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
  77. ▓▓┌ D:\SWAG\FILES\ ▓▓┌──────────── SOURCEWARE ARCHIVAL GROUP ───────────┐▓▓
  78. ▓▓│ [A:\]          │▓▓│                                                  │▓▓
  79. ▓▓│ [B:\]          ▓▓▓│ Your SWAG Support Team :                         │▓▓
  80. ▓▓│ [C:\]          │▓▓│                                                  │▓▓
  81. ▓▓│ [E:\]          │▓▓│ Gayle Davis  Goshen, Indiana  46526              │▓▓
  82. ▓▓│ ..\            │▓▓│ Kerry Sokalsky  North York, Ontario  M2P 1L2     │▓▓
  83. ▓▓│ ANSI.SWG       │▓▓│                                                  │▓▓
  84. ▓▓│ ARCHIVES.SWG   │▓▓│ About SWAG :                                     │▓▓
  85. ▓▓│ CHARS.SWG      │▓▓│                                                  │▓▓
  86. ▓▓│ CMDLINE.SWG    │▓▓│ SWAG is a collection of source code and program  │▓▓
  87. ▓▓│ COLOR.SWG      │▓▓│ examples for the PASCAL program language.   The  │▓▓
  88. ▓▓│ COM┌────────────────────── GREP SWAG Files ───────────────────────┐L │▓▓
  89. ▓▓│ COP│  Search For: CURSOR;ANSI;                                    │n │▓▓
  90. ▓▓│ CRC└──────────────────────────────────────────────────────────────┘t │▓▓
  91. ▓▓│ CRT.SWG        │▓▓│ programming platforms available today.           │▓▓
  92. ▓▓│ CURSOR.SWG     │▓▓│                                                  │▓▓
  93. ▓▓│ DATATYPE.SWG   │▓▓│ MUCH THANKS AND GRATITUDE TO ALL CONTRIBUTORS !! │▓▓
  94. ▓▓│ DATETIME.SWG   │▓▓│ NO Charge of ANY kind is permitted for this work │▓▓
  95. ▓▓└────────────────▓▓│                                                  │▓▓
  96. ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓└──────────────────────────────────────────────────┘▓▓
  97. ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓
  98.  
  99. Enter a string  to search for. You may enter  MULTIPLE items separated by a
  100. semicolon  (;). Additionally,  you can  also include  a date  in the format
  101. MM/DD/YY, and ONLY  records AFTER this date will be  included. If you enter
  102. JUST  the date,  ALL SWAG  snipets AFTER  this date  will be  included. For
  103. example,  entering CURSOR;ANSI;CRT;05/08/93  would search  the SWAG packets
  104. for  matches for  CURSOR, ANSI  and CRT  occurring AFTER 05/08/93. Entering
  105. JUST 05/08/93  at the prompt  would bring back  ALL snipets AFTER  05/08/93
  106. REGARDLESS of the subject.
  107.  
  108. Enter  an empty  string as  the search  string, and  READER will return all
  109. snipets since the LAST SWAG release.
  110.  
  111. READER will  search ALL of  the SWAG packets  in the CURRENT  directory for
  112. matches  based on  your criteria.  A processing  box will  appear, and  all
  113. occurrences of your  search string(s) or date matches will  be written to a
  114. NEW SWAG file.  Initially, this file is named GREPSWAG.SWG,  and will be in
  115. the current  directory. Upon completion of  this GREP process, you  will be
  116. asked for the  file name. Enter any name AND  directory you choose, and the
  117. file will be  RENAMED and moved to that directory.  This process allows you
  118. to  create  SWAG  files  containing  ANY  combination  of material that you
  119. please.
  120.  
  121. You can ALSO search JUST the HEADER  of the SWAG snipet. Just enter a tilde
  122. (~) character  as the FIRST character  on the search line.  For instance to
  123. find all snipets by GAYLE DAVIS, you would enter ~GAYLE DAVIS on the search
  124. line. ONLY  the header of snipets  is searched for matches.  This a way you
  125. can look at all snipets by a certain contributor. You can also use multiple
  126. search criteria  here. For instance, ~GAYLE  DAVIS;GUY MCLOUGHLIN;JOE BLOW;
  127. would bring back  everything for each of these  persons. This search method
  128. is VERY fast as on the headers have to be read.
  129.  
  130. F5 toggles the STATS function. In order  for this to work, you MUST have at
  131. least ONE  .SWG file in  the directory box,  and it MUST  be highlighted !!
  132. Place  the cursor  any one  of the  .SWG files,  and press  F5. You will be
  133. presented with an  EXPANDED directory list showing the  description of each
  134. .SWG file and the number of snipets in each.
  135.  
  136.  
  137. VIEWING, EXTRACTING, PRINTING SWAG SNIPETS
  138. ------------------------------------------
  139.  
  140. Once you have  some .SWG files in the directory  box, press <ENTER> and the
  141. package will be read and you be able to manage the SWAG snipets.
  142.  
  143. You will be  presented with a list of  all of the snipets contained  in the
  144. package with descriptions for each.
  145.  
  146. At the bottom of the screen, will be the following menu.
  147.  
  148. │                                                                          │
  149. │  F1-Help ▀     F3-Options ▀    ┘- Read  ▀    F4-Write ▀     ESC-Quit ▀  │
  150. │  ▄▄▄▄▄▄▄▄▄     ▄▄▄▄▄▄▄▄▄▄▄▄    ▄▄▄▄▄▄▄▄▄▄▄    ▄▄▄▄▄▄▄▄▄▄     ▄▄▄▄▄▄▄▄▄▄  │
  151.  
  152.  
  153.                 F1   - provides some "quick" ALT keys.
  154.  
  155.                 ┌──────────── READER : HELP ───────────┐
  156.                 │ Alt F       Find Text                │
  157.                 │ Alt S       Sort Index               │
  158.                 │ Alt T       Tag ALL                  │
  159.                 │ Alt U       UnTag ALL                │
  160.                 │ Ctl S       SHELL to DOS             │
  161.                 │ Spacebar    Tag Current              │
  162.                 │ <ENTER>     Read Item                │
  163.                 │                                      │
  164.                 │ F1          Help                     │
  165.                 │ F3          Program Options          │
  166.                 │ F4          Write Tagged Items       │
  167.                 │ ESC         Quit Program             │
  168.                 └──────────────────────────────────────┘
  169.  
  170.                 F3   - brings up the OPTIONS menu.
  171.  
  172.                 ┌──────────────────────┐
  173.                 │  About               │
  174.                 │  Sort - (ALT S)      │
  175.                 │  Spacebar Tag - ON   │
  176.                 │  Colors              │
  177.                 │  Dos Shell           │
  178.                 │  Screen Lines - 25   │
  179.                 └──────────────────────┘
  180.  
  181.                 <CR> - read the snipet
  182.                 F4   - Write TAGGED items
  183.                 ESC  - Quit
  184.  
  185.  
  186. 43/50 LINE VIDEO
  187. ----------------
  188.  
  189. You will have the capability of using 43/50 line screens if you have EGA or
  190. better.  The  option  can  be  found  in  the  OPTIONS  menu  (F3).  It  is
  191. automatically  disabled if  the user  doesn't have  the capability.  Select
  192. SCREENLINES, and if you have an EGA/VGA, you'll get 43/50 line mode.
  193.  
  194. COLORS
  195. ------
  196.  
  197. To be quite  honest, the whole business of allowing  users to change colors
  198. is quite a  problem. It adds a lot  of code to the program,  and more often
  199. than not, it is used only once  by the user. Therefore, the color selection
  200. if VERY limited.
  201.  
  202. There are four  color group choices available. LIGHTGRAY,  BLUE, CYAN, RED,
  203. GREEN and MAGENTA. Select one that you find pleasing. This will be disabled
  204. on monochrome monitors.
  205.  
  206. DOS SHELL
  207. ---------
  208.  
  209. You can shell  out to DOS from within  the READER. This ability is  here on
  210. the OPTIONS  menu. You can  ALSO do  this  at ANYTIME by  using CTRL[S] key
  211. sequence.
  212.  
  213. SORTING
  214. -------
  215.  
  216. ALT S on the main selection window  brings up the SORT box. The snipets can
  217. be sorted by :
  218.  
  219.                         ┌────────────────────────────┐
  220.                         │                            │
  221.                         │  Select Sort Field :       │
  222.                         │                            │
  223.                         │         C - CONFERENCE     │
  224.                         │         N - NUMBER         │
  225.                         │         T - TO             │
  226.                         │         F - FROM           │
  227.                         │         S - SUBJECT        │
  228.                         │                            │
  229.                         └────────────────────────────┘
  230.  
  231.  
  232. TAGGING ITEMS
  233. -------------
  234.  
  235. Snipets can be tagged by using the SPACEBAR. SPACEBAR tag can be turned OFF
  236. in the OPTIONS menu.  ALL items can be tagged with ALT  T and untagged with
  237. ALT U. Tagged items can be written to a file with F4.
  238.  
  239.  
  240. READING SNIPETS
  241. ---------------
  242.  
  243. Pressing <ENTER> on any of the snipets  allows it to be reviewed. You'll be
  244. presented with the  "snipet" screen and you can use  the menu at the bottom
  245. of the screen :
  246.  
  247. ┌────────────────────────────────────────────────────────────────────────┐
  248. │ ▀ Next(+) ▀ preV(-)  ▀ Mark  ▀ Find  ▀ Extract  ▀ Print  ▀ ESC-Quit    │
  249. │ ▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄  ▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄  ▄▄▄▄▄▄▄▄▄▄   │
  250. └────────────────────────────────────────────────────────────────────────┘
  251.  
  252. To accommodate  many of the  QWK reader  users  out there, you  can use the
  253. PLUS(+) and  MINUS(-) keys to  display the NEXT  or PREVIOUS snipet  OR the
  254. SPACEBAR key will display the NEXT  snipet. You can Mark, Find, Extract, or
  255. Print snipets. If  you have a mouse, you can  select any of these functions
  256. by using the LEFT button on any item.
  257.  
  258.  
  259. EXTRACTING SNIPETS
  260. ------------------
  261.  
  262. Snipets can be  extract to an ASCII file by  selecting and pressing the 'E'
  263. key. Enter  the filename, and  the data  with  be written out.  If the file
  264. selected is already on  your disk, you will be asked if  you want to APPEND
  265. or OVERWRITE.
  266.  
  267. WRITING TAGGED SNIPETS
  268. ----------------------
  269.  
  270. Once you  have tagged a  group of snipets,  you can write  them to an ASCII
  271. file using F4. Enter  the filename, and if it exists, you  will be asked if
  272. you want  to APPEND or OVERWRITE.  All of the tagged  items will be written
  273. sequentially.
  274.  
  275. FINDING TEXT IN SNIPETS
  276. -----------------------
  277.  
  278. You  can  use  the  (F)ind  command  to  find  text located within the SWAG
  279. snipets. This works JUST LIKE the BORLAND  PASCAL IDE. You can ALSO use the
  280. ^Q^F  key sequence  to activate  this function.  Just as  with the  IDE, ^L
  281. displays the NEXT find.
  282.  
  283. SWAG SNIPETS MARKED WITH CHECKMARK
  284. ----------------------------------
  285.  
  286. If you  see snipets with a  CHECKMARK (#251) beside them,  this indicates a
  287. NEW item  added since the LAST  update. The READER.EXE keeps  track of this
  288. and  marks  these  automatically.  The  checkmark  is  only  there for your
  289. reference.
  290.  
  291. THE READER INI FILE
  292. -------------------
  293.  
  294. Thre READER  program keeps several of  its program defaults in  an INI file
  295. (simple ASCII) in the same directory  as READER.EXE. Contained in this file
  296. are several items that you can change  to affect the way the program works.
  297. The lines in this file have the format LABEL=VALUE.
  298.  
  299. The file looks like this :
  300.  
  301.          COLOR=LIGHTGRAY       (LIGHTGRAY,BLUE,CYAN,RED,GREEN,MAGENTA)
  302.          43/50=NO              (YES or NO)
  303.          SORT=n                (nUMBER,fROM,tO,sUBJECT,cONFERENCE)
  304.          TEXTEXT=PAS           (default extension for extracted files)
  305.          EXTRACTDIR=D:\TEMP\   (default directory for extraction)
  306.          PRINTER=LPT1          (printer port [LPT1,LPT2,LPT3,LPT4])
  307.          SWAGDIR=\SWAG\FILES\  (Wherever you keep them)
  308.          SWAGADDS=YES          (Display those BBS adds at the top (YES/NO)
  309.  
  310. You can change this file using any  word processor. I think that you'll get
  311. the idea.
  312.  
  313.  
  314. COMMAND LINE USAGE
  315. ------------------
  316.  
  317. Starting with  this version of the  READER, individual SWAG packets  can be
  318. read  from  the  DOS  command  line.  Simple  type READER swagfilename. For
  319. example, you can look at all of the snipets in ANSI.SWG by typing :
  320.  
  321.                            READER ANSI.SWG <ENTER>
  322.  
  323. You don't really need to enter the  extension, as the READER will append it
  324. for you.  If the .SWG  files are not  in the current  directory READER will
  325. look for them somewhere on your current PATH.
  326.  
  327. XX3402 ENCODED FILES
  328. --------------------
  329.  
  330. Many  of the  SWAG snipets  contain code  that has  been encoded  using Guy
  331. Mcloughlin's XX3402  encoder. This has  been done due  to the necessity  to
  332. include OBJ  code in the snipet,  and this allows us  a way to do  it. What
  333. this fine  program does is to  create an ASCII encoded  file containing the
  334. BINARY data.  You need to  "CUT" these items  from the snipet,  giving it a
  335. unique name, and  decode it using XX3402. It's really  an easy thing to do.
  336. Once you cut your file out, just execute from the DOS command line :
  337.  
  338.                         XX3402 d yourfilename
  339.  
  340. Magically, the file  needed to compile the snipet will  appear !! It's just
  341. that easy. See the file included  with the SWAG distribution XX3402.ZIP for
  342. complete instructions, and  the COMPLETE SOURCE CODE to  this fine program.
  343. Thanks GUY for letting us use XX3402 for SWAG.
  344.  
  345. We  hope that  you find  the READER   easy to  use, and  the SWAG  material
  346. valuable in development of your PASCAL programs.
  347.  
  348. ENJOY !!!!! and GOOD PROGRAMMING !!!
  349.  
  350. Gayle Davis AND Kerry Sokalsky
  351. SWAG Support Team
  352.