home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / OFFLINE / WINK110.ZIP / WINK.DOC < prev    next >
Text File  |  1992-12-04  |  18KB  |  539 lines
  1.  
  2.  
  3.  
  4. ┌────────────────────────────────────────────────────────────────────────────┐
  5. │ ╔════════════════════════════════════════════════════════════════════════╗ │
  6. │ ║                                                                        ║ │
  7. │ ║                           QWK as a WINK  ;-)                           ║ │
  8. │ ║                                                                        ║ │
  9. │ ╚════════════════════════════════════════════════════════════════════════╝ │
  10. │                                                                            │
  11. │                                                                            │
  12. │                        Copyright 1992 Keith Ford                           │
  13. │                                   __                                       │
  14. │                                  /  \                                      │
  15. │                                  \__/                                      │
  16. │                                  [__]                                      │
  17. │                                                                            │
  18. │                               Micro Magic                                  │
  19. │                                                                            │
  20. └────────────────────────────────────────────────────────────────────────────┘
  21.  
  22.  
  23.  
  24. ┌───────────────────┐
  25. │ TABLE OF CONTENTS │
  26. └───────────────────┘
  27.  
  28. INTRODUCTION
  29. FEATURES
  30. MANIFEST
  31. QUICK START
  32. REGISTERING
  33. WHERE TO FIND WINK
  34. CONTACTING THE AUTHOR
  35. VERSION NUMBERS
  36. PROGRAM DETAILS
  37. - WINK.HLP
  38. - MULTILINE SUPPORT
  39. - RUNNING LOCAL OR STANDALONE
  40. - AREA NAMING
  41. - WHERE WINK LOOKS FOR FILES
  42. - USING WINK COMMAND LINE ARGUMENTS
  43. - WHICH FILES ARE MODIFIED
  44. - MENU DESCRIPTION
  45. - WINK.CFG FORMAT
  46. - WINK.USR FORMAT
  47. THE AUTHOR
  48. FUTURE PLANS
  49. COMMON QUESTIONS
  50. FOR THE TECHNO HUMOR IMPAIRED
  51.  
  52.  
  53.  
  54. ┌──────────────┐
  55. │ INTRODUCTION │
  56. └──────────────┘
  57.  
  58. WINK is a door for the Opus CBCS.  WINK provides your users access to
  59. messages using the QWK mail format.  It is very tightly intergrated
  60. with Opus, making it easy to set up for you and easy to operate for
  61. your users.
  62.  
  63. What does WINK cost?  The same as my other Opus programs OBUL, OASWAP,
  64. and ARKALOG.  Nothing.  WINK is free software in the Opus tradition.
  65. Enjoy it and please report any "features-of-ill-repute" to the author.
  66.  
  67. There is a registration option mentioned later in this document.
  68.  
  69.       
  70.  
  71. ┌──────────┐
  72. │ FEATURES │
  73. └──────────┘
  74.  
  75. The following is a list of the major features found in WINK.  If you
  76. would like to see something added to this list, contact the author.
  77.  
  78. - works with Opus 1.1x and up
  79. - supports multiline/multitask usage
  80. - works with any com port via FOSSIL
  81. - runs remote and local
  82. - runs stand alone if last login was local
  83. - sysop defined file archivers
  84. - sysop defined transfer protocols
  85. - handles messages of any size
  86. - no door/drop file needed, pulls info from Opus files
  87. - checks privileges & locks for area access
  88. - checks privileges & locks for edit access
  89. - prevents forged messages
  90. - prevents adding messages to readonly areas
  91. - private message posted in public area is made public
  92. - filenames can be task number tagged
  93. - generates echotoss.log file
  94. - update all last read pointers
  95. - does not download authored messages
  96. - commands can be stacked
  97. - new pine scent with no greasy residue
  98.  
  99.  
  100.  
  101. ┌──────────┐
  102. │ MANIFEST │
  103. └──────────┘
  104.  
  105. WINK.HIS     - release history & quick upgrade instructions
  106. WINK11.EXE   - the Opus 1.1x executable
  107. WINK17.EXE   - the Opus 1.7x/1.8x/1.9x executable
  108. WINK.CFG     - quick start configuration file
  109. WINK_CFG.DOC - docs for configuration file
  110. WINK.DOC     - this documentation
  111. WINK.HLP     - sample intro screen
  112.  
  113. You may have a package that contains only one executable.
  114.  
  115.  
  116.  
  117. ┌─────────────┐
  118. │ QUICK START │
  119. └─────────────┘
  120.  
  121. If you are upgrading from the last release, you should read
  122. WINK.HIS for quick upgrade instructions.
  123.  
  124. If you are installing WINK for the first time, then follow
  125. these instructions.
  126.  
  127. - copy all files to your Opus directory
  128. - rename the appropriate EXE version to WINK.EXE
  129. - edit WINK.CFG and follow directions listed there
  130. - add an Opus menu option, for example:
  131.   _OUTSIDE  Normal  "WINK" = DOS c:\opus\wink.exe
  132. - time to rock-n-roll (Rush preferred)
  133.  
  134. NOTE:  The quick start CFG file requires that PKZIP,
  135.        PKUNZIP, and DSZ be located in your PATH.
  136.  
  137.  
  138.  
  139. ┌─────────────┐
  140. │ REGISTERING │
  141. └─────────────┘
  142.  
  143. If you decided to send a monetary donation to the author you will:
  144.  
  145. - receive a special version of the WINK Door which
  146.   adds a plaque proclaiming your registered support
  147.  
  148. - receive express attention in submitted bug fixes
  149.   and any enhancements that you request
  150.  
  151. - receive beta releases of new versions and planned
  152.   new support utilities
  153.  
  154. - see to it that WINK development continues for the
  155.   enjoyment of future generations of Cool Shades
  156.  
  157. - receive a registration program to auto register
  158.   future releases
  159.  
  160. - get that warm fuzzy feeling
  161.  
  162. To register WINK, send a contribution of 10-25 $US to the author.
  163. Be sure to select a shipping option from the list below and include
  164. a copy of the SYSOP variable from the SYSTEM SECTION of your Opus
  165. BBS.CTL file.
  166.  
  167. This name will be used as the registration key.  It will also be
  168. placed in the QWK control file that is sent to your users and
  169. will also be placed on your registration plaque.  If this name
  170. is incorrect, please include an explanation.
  171.  
  172.         SYSTEM SECTION
  173.         %
  174.         SYSOP    Keith Ford
  175.         %
  176.  
  177. When selecting a shipping option, be sure to include ALL the needed
  178. information such as passwords, phone numbers, addresses, etc.
  179.  
  180. The shipping options are many.  Please pick one.
  181.  
  182. - uuencode and email (preferred)
  183.   [ need your Internet email address]
  184.  
  185. - file attach to your Fidonet node
  186.   [ need your net address]
  187.  
  188. - login to your bbs and upload
  189.   [ need login/password/filearea with upload privileges ]
  190.  
  191. - snail mail
  192.   [ need your address ]
  193.  
  194. - personal delivery
  195.   [ need your car ]
  196.  
  197.  
  198.  
  199. ┌────────────────────┐
  200. │ WHERE TO FIND WINK │
  201. └────────────────────┘
  202.  
  203. Majore releases will be placed into SDSOPUS.
  204.  
  205. The authors bbs, Micro Magic (1:373/12), will always have the latest
  206. for FREQ or download on first call.
  207.  
  208. For those with Internet/UUCP email access, you can WINK uuencoded and
  209. emailed to you.  Send email to server@ingr.com with "HELP" in the
  210. subject line for more information.
  211.  
  212. Michael Goddard, of BCH BBS in Canada (1:163/140), has also made WINK
  213. available for those with anonymous ftp capabilities.  The site name is
  214. m.ehd.hwc.ca [142.4.8.13].
  215.  
  216.  
  217.  
  218. ┌───────────────────────┐
  219. │ CONTACTING THE AUTHOR │
  220. └───────────────────────┘
  221.  
  222. BBS NAME:  Micro Magic
  223. BBS PHONE: +1 205 830 2362
  224. MODEM:     USR DS - HST/V32bis
  225. FREQ:      (see VERSION NUMBERS)
  226. FIDONET:   1:373/12
  227. INTERNET:  sysop@umagic.fidonet.org
  228. SNAIL:     203 Creek Trail, Madison, AL, 35758
  229. ICBM:      34 44 18 N / 86 35 19 W
  230.  
  231. WINK will always be available on Micro Magic.  See the VERSION NUMBERS
  232. section of this text for file request information.
  233.  
  234.  
  235.  
  236. ┌─────────────────┐
  237. │ VERSION NUMBERS │
  238. └─────────────────┘
  239.  
  240. The following Magic names and filenames are strongly recommended.  If you
  241. choses to make WINK available on your system, please attempt to follow
  242. this naming convention.  I'm not being a stinker about it, I just think
  243. it will be easier for others use if it is consistent.
  244.  
  245. Magic Names
  246. WINKBETA - current betas of all executables & associated files
  247. WINK     - all production executables & associated files
  248. WINK11   - Opus 1.1x only production executables & associated files
  249. WINK17   - Opus 1.7x only production executables & associated files
  250.  
  251. Filenames have changed, the now use the formula:
  252. "WINK" + <Version#> + <Opus-ID>
  253.  
  254. Current list of Opus-IDs
  255.  '#' - betas
  256.      - all Opus versions (no Opus-ID)
  257.   A  - Small memory model for Opus 1.1x
  258.   B  - Small memory model for Opus 1.7x
  259.  
  260. The version number of WINK will always be a 3 digit hexadecimal number,
  261. X.Y.Z, where X, Y, & Z are defined as follows.
  262.  
  263.  X - major change, if you use this EXE you MUST change your
  264.      CFG file according to the release notes
  265.  
  266.  Y - new features, you can use this EXE without changing your
  267.      CFG file, but to use the new features you may need to change
  268.      your CFG file according to the release notes
  269.  
  270.  Z - bug fix, simply replace the executable and read the
  271.      relese notes
  272.  
  273. When WINK runs, the tear line it adds will include this version number.
  274. If it is a beta WINK, a 'b' will be appended, as in "1.1.0b".
  275.  
  276. For version 1.0.1, the filename would be WINK101.ZIP.
  277. For Opus 1.1x, version 1.0.0, the filename would be WINK100A.ZIP.
  278. WINKBETA may be WINK105#.ZIP
  279.  
  280.  
  281.  
  282.  
  283. ┌─────────────────┐
  284. │ PROGRAM DETAILS │
  285. └─────────────────┘
  286.  
  287. WINK.HLP:
  288. ---------
  289. This file is optional, but if used it must be placed in the directory
  290. where WINK starts.  You can edit this file as you need.  It's contents
  291. are shown to the user when they enter the WINK door.  It can be used
  292. to introduce WINK, explain what QWK is, or whatever.
  293.  
  294.  
  295. MULTILINE SUPPORT:
  296. ------------------
  297. WINK read the Opus PRM file for much of its information.  If you have a
  298. multiline system, you will have multiple PRM files.  For WINK to work,
  299. it must be told where the PRM file is located.  You can do this with
  300. the OPUS environment variable or with the -PRM command line parameter. 
  301. For more information on where WINK looks for files, read the section
  302. named "WHERE WINK LOOKS FOR FILES" in this text.
  303.  
  304. Any filename specified with WINK that contains a # or ## will
  305. be modified such that the # or ## is replaced with the hexadecimal
  306. task number.  If these files are not found, the name is modified
  307. again to exclude the task numbers.  If task number is decimal 10,
  308. then WINK##.CFG would be WINK0A.cfg, then WINK.CFG.  Therefore, when
  309. you start WINK for the first time, it will create a WINK01.USR file,
  310. based upon the task number.  If you rename this to WINK.USR, and place
  311. it in the Opus directory, all lines can share it.
  312.  
  313.  
  314. RUNNING LOCAL OR STANDALONE:
  315. ----------------------------
  316. When in one of these modes, WINK places <bbsid>.QWK in the temporary
  317. directory and looks for <bbsid>.REP there too.  The temporary directory
  318. is found in the PRM file or from the WINK -TMP command line argument.
  319.  
  320. WINK reads the LASTUSER record, so running STANDALONE will run as if
  321. that person were logged on.  Use OPUS -K if you need to change the
  322. LASTUSER record to be yours.
  323.  
  324.  
  325. AREA NAMING:
  326. ------------
  327. The name of a message area is limited to 10 characters.  In Opus 1.1x,
  328. the first 10 characters of the message area name are used.  In Opus
  329. 1.7x, the first area name definition in the CTL file is used.  Opus allows
  330. you to define this area name two different ways.
  331.  
  332. (#1)   AREA   0001   Meadow
  333.  
  334. (#2)   AREA   0002
  335.        NAME   Meadow
  336.  
  337.  
  338. WHERE WINK LOOKS FOR FILES:
  339. ---------------------------
  340. look for OPUS environment variable pointing to PRM
  341. check command line parameters:
  342.   -log    : path to LOG file
  343.   -prm    : path to bbs PRM file (overrides environment variable)
  344.   -sys    : directory containing area definitions SYS
  345.   -lastus : directory containing LASTUS file
  346.   -opus   : directory of OPUSROOT (echotoss, 1.1x LASTUS)
  347.   -tmp    : directory for temporary work files TMP
  348.   -cfg    : path to wink CFG file
  349.   -usr    : path to wink USR file
  350. if PRM and !OPUSROOT, form OPUSROOT from PRM by stripping PRM filename
  351. else if !PRM and OPUSROOT, form PRM from OPUSROOT plus bbs.prm
  352. if !PRM, use current directory
  353. if !LOG, get from PRM
  354. if !LASTUS, 1.1x uses opusroot & 1.7x looks in PRM
  355. if !TMP, get from PRM, append WINKxx.TMP
  356. if !SYS, get from PRM
  357.   1.1x looks for SYSTEMxx.DAT files
  358.   1.7x looks for sysmsg.dat
  359. if !CFG, look in current directory
  360. if !USR, look in current directory
  361. echotoss.log uses
  362.   1.1x - opusroot
  363.   1.7x - get from PRM
  364.  
  365.  
  366. USING WINK COMMAND LINE ARGUMENTS:
  367. ----------------------------------
  368. For example, to use a separate log file and a different
  369. temporary directory than Opus:
  370.  
  371.   wink -log c:\tmp\wink.log -tmp r:\tmp
  372.  
  373.  
  374. WHICH FILES ARE MODIFIED:
  375. -------------------------
  376. wink##.usr
  377. lastus##.dat
  378. last read files
  379.  - user.dat (Opus 1.1x)
  380.  - LASTREAD (Opus 1.1x, Opus 1.7x if requested in BBS.PRM)
  381.  - LREAD.DAT (Opus 1.7x)
  382.  
  383.  
  384. MENU DESCRIPTION:
  385. -----------------
  386. C........user configuration for packer & protocol 
  387. #........toggle area # on and off
  388. #f.......toggle flag f for area # on and off
  389.          (only P flag supported for Personal messages)
  390. L........list available message areas
  391. L#.......list available message areas starting with #
  392. LS.......list selected message areas
  393. LS#......list selected message areas starting with #
  394. D........download QWK packet
  395. DP.......override area flags, download only personal messages
  396. DA.......override area flags, download all messages
  397. U........upload REP packet
  398. Q........quit back to the bbs
  399. G........goodbye and logoff now
  400. =........credits
  401. *........registration plaque
  402. ?........help
  403.  
  404.  
  405. WINK.CFG FORMAT:
  406. ----------------
  407. See WINK_CFG.DOC file for this information.
  408.  
  409.  
  410. WINK.USR FORMAT:
  411. ----------------
  412. You should not need to worry about this file.  If something goes
  413. wrong, you can edit it by hand to an extent.  Following is the
  414. format for a record in this file.  This record is repeated for
  415. each active WINK user.
  416.  
  417. User Name
  418. userflags
  419. crc-of-packer-menu-text
  420. crc-of-protocol-menu-text
  421. area# flags
  422. area# flags
  423. area# flags
  424.  
  425.  
  426.  
  427. ┌────────────┐
  428. │ THE AUTHOR │
  429. └────────────┘
  430.  
  431. What would you like to know?  My name is Keith Ford.  I'm a 3-year-old
  432. dad (heaven help me).  I like chocolate, the DragonLance series, and
  433. hard rock/metal music (Rush, Cinderella, Def Leppard, LA Guns).  My
  434. bbs iron is a 386SX-16, 4 Megs, 200 Meg HD, DAK CDROM, and USR DS.
  435. I've run Opus since 4/90 and operate a UUCP/Fidonet gateway with
  436. UFGATE, all under DESQview.  I still don't have a 3.5" floppy drive,
  437. but I once had a Toyota 4WD.  I can do the Time Warp.  God bless.
  438.  
  439. Other software available from the author.
  440.  
  441. OBUL    - Generate a .BBS file that presents a menu to a caller.
  442.           This menu is based upon a list of bulletins provided
  443.           by the sysop.  Any bulletins which have been modified
  444.           since the user last visited, are marked on the menu.
  445.           This works for Opus 1.1x and up.
  446.  
  447. ARKALOG - Archive a log file with date embedded in the filename.
  448.           Such as OLOG9210.LZH would be my Opus log for the 10th
  449.           month of 1992.  This program also has a day of the week
  450.           check to automate weekly functions.  It will work with
  451.           any Opus, or any bbs.
  452.  
  453. OASWAP  - In Opus 1.1x message & file areas are tied together.
  454.           OASWAP will allow you to swap between areas the message
  455.           or file information independently of one another.  This
  456.           works with Opus 1.1x only.
  457.  
  458.  
  459.  
  460. ┌──────────────┐
  461. │ FUTURE PLANS │
  462. └──────────────┘
  463.  
  464. - sysop defined menu coloring
  465. - sysop defined area names
  466. - sysop exclusion of certain message areas
  467. - multiple language using '~'
  468. - menu option to set/reset last read pointers
  469. - sysop defined NEWFILES generation command
  470. - use PEEK privs/locks for private in public echos
  471. - handle area number greater than 255
  472. - send messages that match a search string
  473. - use Opus origin lines
  474. - use Opus menu help level
  475. - reduce memory requirements
  476. - allow it to operate as a vacation mail catcher
  477. - define a place to dump bad messages
  478. - implement ADD/DROP/REQUEST
  479. - add capability to use Netmail
  480. - add file locking to user.dat
  481. - user switch to send no-mail packets
  482. - flag to send messages user has written
  483.  
  484.  
  485.  
  486. ┌──────────────────┐
  487. │ COMMON QUESTIONS │
  488. └──────────────────┘
  489.  
  490. Q.  I'm having problems.  What do I do?
  491.  
  492. A.  Look at your log file and see what WINK is thinking.  Use this
  493.     information and the section of the docs that describe where WINK
  494.     finds files to see if you can fix your problem.  If not, send as
  495.     much information as possible to the author for review.
  496.  
  497.  
  498. Q.  I log into line #1 and everything works fine.  Then I log into
  499.     line #2 and WINK says I'm a new user.  Why?
  500.  
  501. A.  When you run WINK the first time, if not told differently, it
  502.     attempts to open WINK##.USR.  This fails since it does not exists.
  503.     It then attempts to open WINK.USR, which also fails.  Then it
  504.     opens WINK##.USR again as a new file.  So, your user information
  505.     was originally put into WINK01.USR, then you logged onto line #2
  506.     and WINK create WINK02.USR.  To get around this, rename WINK01.USR
  507.     to WINK.USR and delete other WINK##.USR files.  Then, all tasks
  508.     will use WINK.USR.
  509.  
  510.  
  511. Q.  I appear to be running out of memory.
  512.  
  513. A.  If you have a large number of message areas, WINK may be running
  514.     out of memory using the Small Memory Model.  Ask the author for a
  515.     Medium Memory Model version.  If WINK simply won't fit in memory,
  516.     you might try using an EXIT ## to run WINK without Opus loaded or
  517.     use the Opus Child program to swap Opus to disk.
  518.  
  519.  
  520. Q.  WINK says I have some message areas that I removed from my BBS.CTL
  521.     file earlier?
  522.  
  523. A.  Apparently, for Opus 1.1x, SALT does not delete old SYSTEM##.DAT
  524.     files for message areas that have disappeared.  (via John Emmert)
  525.  
  526.  
  527.  
  528. ┌───────────────────────────────┐
  529. │ FOR THE TECHNO HUMOR IMPAIRED │
  530. └───────────────────────────────┘
  531.  
  532. An emoticon is a small figure (icon) comprised of ASCII characters
  533. used to denote and emotion.  Many emoticons depict a face and require
  534. you to tilt your head (or monitor) to the left (or right).  The ";-)"
  535. is an emoticon representing a winking face, to denote humor,
  536. understanding, sarcasm, and such.  So there you have it, or not.  ;-)
  537.  
  538. -kef/MM-
  539.