home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / dev / asm / tbsource / logger / final / logger.doc < prev   
Text File  |  1993-12-21  |  8KB  |  290 lines
  1.  
  2. 04/09-92            Logger V1.05
  3.  
  4. Updated: 04/09-92 - for version 1.05 - Preliminary docs
  5.                         
  6.  Copyright (C) Tomi Blinnikka 1992, All Rights Reserved.
  7.                     ^^^^^^^^^^^^^^^^^^^^
  8. This program is SHAREWARE. This means that you can copy it and give it
  9. to all your friends, upload it to a BBS or include it in a PD-library
  10. (FISH etc.). BUT (!!!) if you use this program frequently you must 
  11. pay $5 - $10. The other restrictions are: all of the files must be 
  12. included in their original form without additions, deletions, or 
  13. modifications of any kind and it IS NOT TO BE SOLD. THIS INCLUDES 
  14. GERMAN PD DEALERS. If you wish to use this program for commercial 
  15. purposes, you need written permission. The Logger program is 
  16. provided "AS IS" without warranty of any kind, and the author is not 
  17. responsible for any damage this software may or may not do.
  18.  
  19.  
  20. TABLE OF CONTENTS
  21. ~~~~~~~~~~~~~~~~~
  22. 1. What does it do?
  23.  
  24.    - Short description of what this program does and/or does not do.
  25.  
  26. 2. What do you need?
  27.  
  28.    - A list of software/hardware needed.
  29.  
  30. 3. Compatibility
  31.  
  32.    - A list of computers this program works on.
  33.  
  34. 4. How to run it
  35.  
  36.    - Instructions on starting the program and what arguments it takes.
  37.  
  38. 5. Using Logger
  39.  
  40.    - A short description of all functions
  41.  
  42. 6. Hints & tips
  43.  
  44.    - Hints & tips. Other programs to enhance using Logger etc.
  45.  
  46. 7. Problems
  47.  
  48.    - Possible problems you may run into.
  49.  
  50. 8. Error messages
  51.  
  52. 9. Versions
  53.  
  54.    - A list of all versions. The newest first.
  55.  
  56. 10. Future versions
  57.  
  58. 11. Bugs
  59.  
  60.    - List of bugs found.
  61.  
  62. 12. ShareWare fee
  63.  
  64.    - More information on the ShareWare fee.
  65.  
  66. 13. BetaTesters
  67.  
  68.    - A list of betatesters.
  69.  
  70. 14. 'Registered' users
  71.  
  72.    - A list of users that have payed the ShareWare fee.
  73.  
  74. 15. Bug reports etc.
  75.  
  76.    - How to contact the author
  77.  
  78.  
  79. 1. WHAT DOES IT DO?
  80. ~~~~~~~~~~~~~~~~~~~
  81. Logger is a Yet-Another-Pseudo-Security-System (YAPSS), but this it is also
  82. a touch more useful, since it allows users to use your Amiga through any
  83. device. This means you can have as many users using your Amiga as you wish
  84. (only the hardware limits the amount of simultanous users). It also has the
  85. capability of answering the phone, so logons through modems are also
  86. possible.
  87.  
  88. 2. WHAT DO YOU NEED?
  89. ~~~~~~~~~~~~~~~~~~~~
  90. You'll need an Amiga computer (see compatibility list), with Kickstart
  91. 2.04 (version 37 or higher).
  92.  
  93. 3. COMPATIBILITY
  94. ~~~~~~~~~~~~~~~~
  95. Logger will work on any Commodore Amiga, running on Kickstart
  96. 2.04 or higher. This includes the following: A500(+), A600, A1000, A2000,
  97. A2500/20, A2500/30, A3000 (16 MHz or 25 Mhz model). The program SHOULD
  98. work on any upgrades (based on the Amiga Development Guidelines, see
  99. Amiga ROM Kernel Reference Manual (Release 2): Includes and Autodocs,
  100. introduction) and future A4000-series. Logger works with all internal
  101. modems (I have a Supra 2400zi) and extra serial boards that support 
  102. the normal device commands.
  103.  
  104. 4. HOW TO RUN IT
  105. ~~~~~~~~~~~~~~~~
  106. You can run the program from a CLI/SHELL/etc. but you can't hang an icon on
  107. it and start it from the Workbench.
  108.  
  109. To run the program, run Logger from your CLI/SHELL/etc. with the desired 
  110. commands and options. Please note that since I haven't written a proper
  111. parser, you MUST give the options in order.
  112.  
  113. USAGE: Logger [-1 | -2 | -3] [-l | -d] [-s Number] [Unit] [Device]
  114.                                                                     
  115.        Where: [-1] log login failures
  116.               [-2] log correct logins
  117.               [-3] log all logins
  118.               [-l] is for local mode
  119.               [-d] for dumb mode (no hayes commands sent)
  120.               [-s Number] speed to use
  121.               [Unit] is the unit number
  122.               [Device] is the device name
  123.                                                                     
  124.        Default: [Device] is serial.device
  125.                 [Unit] is 0
  126.  
  127.  
  128.     or use
  129.  
  130.     1> Logger ? | -? | h | -h
  131.  
  132.     for the above command line options and copyrights.
  133.  
  134. 4.1 Local mode
  135. ~~~~~~~~~~~~~~
  136. Local mode allows you to login from a CLI/Shell window. This command line
  137. option excludes all others. It will automatically turn on dumb mode, so no
  138. Hayes commands are sent.
  139.  
  140. 4.2 Dumb mode
  141. ~~~~~~~~~~~~~
  142. When this is set, no Hayes commands are sent to the device. It also stops
  143. the program from waiting for RINGS and CONNECTS.
  144.  
  145. 4.3 Speed to use
  146. ~~~~~~~~~~~~~~~~
  147. This describes the speed to use on the device. The device will be opened
  148. with this as the default speed.
  149.  
  150. 4.4 Log login failures
  151. ~~~~~~~~~~~~~~~~~~~~~~
  152. Writes all failed logins to GETTY:Logger.log. The 'GETTY:' will most likely
  153. be changed to 'LOGGER:'.
  154.  
  155. 4.5 Log correct logins
  156. ~~~~~~~~~~~~~~~~~~~~~~
  157. Logs all correct logins to GETTY:Logger.log. The 'GETTY:' will most likely
  158. be changed to 'LOGGER:'.
  159.  
  160. 4.6 Log all logins
  161. ~~~~~~~~~~~~~~~~~~
  162. Logs all incorrect and correct logins to GETTY:Logger.log. The 'GETTY:'
  163. will most likely be changed to 'LOGGER:'.
  164.  
  165. 4.7 Unit number
  166. ~~~~~~~~~~~~~~~
  167. Specifies the unit number of the device. Doesn't apply when local mode is
  168. used.
  169.  
  170. 4.8 Device name
  171. ~~~~~~~~~~~~~~~
  172. Specifies device to be used.
  173.  
  174.  
  175. 5. USING LOGGER
  176. ~~~~~~~~~~~~~~~
  177. To actually use logger you will also need the following programs: PassWd,
  178. Finger (optional), W (optional), Uptime (optional) and Lock (optional).
  179.  
  180. 5.1 PassWd
  181. ~~~~~~~~~~
  182. PassWd is the program that makes and upholds the password file.
  183.  
  184. Examples:
  185.  
  186. 1. Logger -3 -s2400 0 modem0.device   
  187.  
  188. 2. RUN >NIL: Logger -1 -d -s38400 0 serial.device
  189.  
  190. 3. Logger -l
  191.  
  192.  
  193. 6. HINTS & TIPS
  194. ~~~~~~~~~~~~~~~
  195. 7. PROBLEMS
  196. ~~~~~~~~~~~
  197. Logger won't hangup if the DTR is dropped, or if the users suddenly hangs
  198. up...
  199.  
  200. 8. ERROR MESSAGES
  201. ~~~~~~~~~~~~~~~~~
  202. The Logger program will display necessary error messages. I HATE
  203. PROGRAMS THAT DON'T TELL WHAT-THE-HELL IS GOING ON! That clear? If
  204. Logger doesn't give any output, something is seriously wrong or
  205. I was lazy :).
  206.  
  207. 9. VERSIONS
  208. ~~~~~~~~~~~~
  209. Version Size    Date     Description
  210. ----------------------------------------------------------------------
  211. 1.05     7316    04/09/92 Log now opened just before writing to it and
  212.              closed when finished.
  213.  
  214. 1.04    ~7000    15/08/92 Bugfix-version.
  215.  
  216. 1.03    ~7000    14/08/92 Added log.
  217.              BUGS: Didn't give correct device to command to
  218.                    start.
  219.  
  220. 1.02     ????    09/08/92 Added speed selection.
  221.  
  222. 1.01     ????    08/08/92 Bugfix-version.
  223.  
  224. 1.00     ????    01/08/92 Lotsa bugs left in code. Wouldn't log user on
  225.              properly.
  226.  
  227. 0.00a-    ????    ??/??/92 Wrote the program basics and main routines.
  228. 0.99a
  229.  
  230. 10. FUTURE VERSIONS
  231. ~~~~~~~~~~~~~~~~~~~
  232. Future version will have real docs and some additions. Bug fixes are also
  233. welcome.
  234.  
  235. 11. BUGS
  236. ~~~~~~~~
  237. Logger has been run with enforcer and mungwall. It will be run with devmon
  238. as soon as I can find it again :). In other words, I haven't found any
  239. bugs, so this part in the docs is totally useless! :)
  240.  
  241. 12. SHAREWARE FEE
  242. ~~~~~~~~~~~~~~~~~
  243. As of version 1.05, Logger is ShareWare. I am not asking for a huge
  244. amount of money so I hope I will get some response. The fee is only $5 to
  245. $10 (USD), or whatever that happens to make at the moment you're reading
  246. this, in german marks (DM). If you're from Finland a sum of 20 FIM to 50
  247. FIM is great (Yeah, so what if I changed the $10 to $12 ? You Finnish guys
  248. don't have to pay so much for postage :)
  249.  
  250. 13. BETATESTERS 
  251. ~~~~~~~~~~~~~~~
  252. (Thank you all who betatested Logger. Thanks go to...)
  253.  If you wish to become a betatester contact me at one of the
  254. addresses below. If a betatester wishes to be anonymous or the the opposite,
  255. wishes their full name to be listed, please let me know!
  256.  
  257. 14. 'REGISTERED' USERS
  258. ~~~~~~~~~~~~~~~~~~~~~~
  259. No one has paid the shareware fee, but anyone who does will get their
  260. name here.
  261.  
  262. 15. BUG REPORTS ETC...
  263. ~~~~~~~~~~~~~~~~~~~~~~
  264. Please send donations, bug reports, and list of features you would like to
  265. have included in future versions to
  266.  
  267. Tomi Blinnikka
  268. Syystie 10
  269. 00780 Helsinki
  270. FINLAND
  271.  
  272. Contact me at the address above or on the following BBS:
  273.  
  274. MITS +358-0-458 2066 (MITS - Microdata International Telecomm Service)
  275. MITS +358-0-458 2077
  276. MITS +358-0-458 2088 (Sec. level 40 or higher ONLY) 
  277.  
  278. Email me at 'docbliny@mits.mdata.fi' or catch me on the #amiga conference
  279. on IRC!
  280.  
  281.  
  282. "...trademark of Xerox Corporations. Reading legal mush can turn your
  283. brain to guacamole! Epson is registered trademark of Epson America
  284. ..." -Amiga RKRM Includes & AutoDocs, fourth page.
  285.  
  286.  
  287.                         Tomi Blinnikka
  288.  
  289.                         docbliny@mits.mdata.fi
  290.