home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / comms_networking / irclient / !IRClient / Scripts / Docs / ReleasNote < prev   
Encoding:
Text File  |  1997-01-30  |  16.1 KB  |  526 lines
  1. THIS RELEASE v1.19
  2. ============
  3. Major historical changes:
  4.   v1.13 DCC Chat works safely
  5.   v1.14 DCC Send seems to work safely, and has filetype added on end
  6.   v1.15 Restructured the Magrathea directories
  7.   v1.16 Dependancy checking added
  8.   v1.17 Restructured the Scripts directory to be /just/ Magrathea
  9.         Released to Dave Thomas and Matthew Godbolt
  10.   v1.18 Additional overloads to make 'hooks' easier.
  11.         Examples.AutoGreet sent out to Stuart Bruce, Vince Hodd, and
  12.         Stuart Winter. FTP added.
  13.         Released to Dave Thomas, Alex Howarth and Chris Johns for
  14.         testing and comments. COMPLETE release, including IRClient 0.27.
  15.   v1.19 Work done whilst Matt and over the intermediate weeks :
  16.         Memory leaks fixed, indirected procedure calls added, menus made
  17.         script definable. Internal directory now required as Internal.Boot
  18.         is now the initial script. Internal.Menus defines the main menus,
  19.         overloadable to add new entries at relevant points.
  20.         Wimp messages added and made use of with ExtEdit library (simple
  21.         controller - no saves, no returns). Wildcards fixed.
  22.         DCC ditched and started from scratch using indirected functions
  23.         and a simpler programming interface (new structure too).
  24.         Scheduler made redundant.
  25.         
  26.   
  27. Structure of directory :
  28.  
  29. Scripts :
  30. |
  31. +-Internal :
  32. |    Contains many internal routines for providing 'base' facilities
  33. |    The majority of these should be veneers for the main script functions
  34. |
  35. +-Default :
  36. |    Scripts and resources which are explicitly loaded by Magrathea on startup.
  37. |    Mostly these are required routines and support for simple things
  38. |
  39. +-Docs :
  40. | |  Documentation for the complete release of Magrathea.
  41. | |
  42. | +-Disclaimer :
  43. | |    Disclaimers for the various extension modules and resources
  44. | |    This may be moved to their respective directories in future
  45. | |
  46. | +-Prog :
  47. |      Programming hints, guides and reminders for myself and others
  48. |      This is NOT guarenteed to be up to date. Not yet anyhow.
  49. |
  50. |
  51. +-Examples :
  52. |    Any example code that people have put together along with a description
  53. |    of how it works.
  54. |
  55. +-Magrathea :
  56. |    The main engine for Magrathea.
  57. |    This script will load each of the Default scripts and initailise them,
  58. |    before scanning the Modules directory for extensions. The bulk of IRC
  59. |    proper is processed here.
  60. |
  61. +-Modules :
  62. |    Extension scripts reside in here, either as a single basic file with
  63. |    the script name, or as a directory with the script name and basic file
  64. |    with the name !Module. Resources should only be stored in these
  65. |    directories. A means will eventually be provided for generating help
  66. |    from within these. Files which require others to be loaded previously
  67. |    should include a !Depend file in their directory containing the names
  68. |    of those modules which it depends on. These should be modules whose
  69. |    functions it uses, or overloads.
  70. |
  71. +-Obsolete :
  72. |    Scripts which are no longer required, or are no longer being supported
  73. |    will reside in here. Their use is not recommended. The retention is for
  74. |    posterity and... well... you never know :-)
  75. |
  76. +-User :
  77.      The user specific directory.
  78.      This contains two types of file, those which are user editable, and
  79.      those which are generated by the scripts to describe the users
  80.      preferences. Currently there is no distinction between these; this
  81.      may change in a future release.
  82.      Basically, this directory should be able to be left static from one
  83.      update to the next. 
  84.  
  85.  
  86. The Scripts themselves are described below :
  87.  
  88.  
  89. *******************************************************************************
  90. **                            Internal Modules                               **
  91. *******************************************************************************
  92.  
  93.  
  94. Boot
  95. ----
  96. Author    : Matthew Godbolt
  97. Version   : v1.00 (04 Jan 1997)
  98. Synopsis  : Initial script to be loaded. This should start the internal modules
  99.             and then call the main script.
  100. Commands  : none
  101. Overloads : none
  102. ToDo      : none
  103. Bugs      : None
  104.  
  105.  
  106. Constants
  107. ---------
  108. Author    : Matthew Godbolt
  109. Version   : v1.00 (04 Jan 1997)
  110. Synopsis  : Provides values which will be passed between IRClient and the
  111.             scripts.
  112. Commands  : none
  113. Overloads : none
  114. ToDo      : none
  115. Bugs      : None
  116.  
  117.  
  118. Menus
  119. -----
  120. Author    : Matthew Godbolt & Justin Fletcher
  121. Version   : v1.04 (18 Jan 1997)
  122. Synopsis  : Provides framework for providing menus and adding to existing menus
  123. Commands  : none
  124. Overloads : PROCOverload_AddMenuEntries(menu$)
  125.             FNOverload_UnknownWindowMenu(display$,menu$)
  126.             PROCOverload_InputBoxMenu(display$)
  127.             PROCOberload_UnknownMenu(menu$)
  128. ToDo      : Incorporate stuff from Matts 0.32
  129. Bugs      : None
  130.  
  131.  
  132. *******************************************************************************
  133. **                             Default Modules                               **
  134. *******************************************************************************
  135.  
  136. Config
  137. ------
  138. Author    : Justin Fletcher
  139. Version   : v1.01 (26 Sep 1996)
  140. Synopsis  : Provides configuration support via /config and configures the
  141.             standard stuff.
  142. Commands  : /config [<module> [<option> [<value]]]
  143. Overloads : PROCOverload_ConfigCommand
  144.             FNOverload_ConfigModName
  145.             PROCOverload_ConfigOptions
  146. ToDo      : Needs removing and all configuration moving directly to Config+
  147. Bugs      : None
  148.  
  149.  
  150. Dependency
  151. ----------
  152. Author    : Justin Fletcher
  153. Version   : v1.06 (27 Dec 1996)
  154. Synopsis  : Provides dependancy checking and module loading for the extension
  155.             modules.
  156. Commands  : none
  157. Overloads : none
  158. ToDo      : Nothing I can think of
  159. Bugs      : None
  160.  
  161.  
  162. GDBM
  163. ----
  164. Author    : Justin Fletcher
  165. Version   : v1.02 (20 Aug 1996)
  166. Synopsis  : Provides simple databasing mechanism which is easier to use than
  167.             direct file access. Stores configuration options.
  168. Commands  : none
  169. Overloads : none
  170. ToDo      : Add routines to list current members of db
  171. Bugs      : If <IRClient$Dir> changes then the DB can't be found and will
  172.             always return "" or "**NOFILE**"
  173.  
  174.  
  175. Magrathea
  176. ---------
  177. Author    : Various, mostly Justin Fletcher, Matthew Godbolt and Alex Howarth
  178. Version   : N/A (See above for Magrathea release)
  179. Synopsis  : The main engine behind IRClient. Provides most / commands and
  180.             ctcp's and gives support via Overload_ routines for easier hooks.
  181. Commands  : lots !
  182. Overloads : PROCInitialiseModule
  183.             PROCShutdownModule
  184.             PROCConnecting
  185.             FNOverload_ScriptInfo
  186.             PROCOverload_DisplaySelected
  187.             PROCOverload_UserLine
  188.             PROCOverload_UnknownCommand
  189.             PROCOverload_UnknownCTCPReply
  190.             PROCOverload_UnknownCTCPRequest
  191.             FNOverload_ListCTCP
  192.             PROCOverload_On_Kick
  193.             PROCOverload_On_Part
  194.             PROCOverload_On_Nick
  195.             PROCOverload_On_Quit
  196.             PROCOverload_On_Join
  197.             PROCOverload_On_Say
  198.             PROCOverload_On_Notice
  199.             PROCOverload_ServerResponse
  200.             FNOverload_AboutToSay
  201. ToDo      : God only knows...
  202. Bugs      : I'm not sure if notify from bots works
  203.  
  204.  
  205. Utils
  206. -----
  207. Synopsis  : Provides utilities which may be relied on by all modules
  208. Commands  : none
  209. Overloads : none
  210. To Do     : nothing
  211. Bugs      : none
  212.  
  213.  
  214. *******************************************************************************
  215. **                            Extension Modules                              **
  216. *******************************************************************************
  217.  
  218. AutoGreet
  219. ---------
  220. Author    : Justin Fletcher
  221. Version   : v1.03 (30 Dec 1996)
  222. Synopsis  : Example script to show how to do simple automated greets
  223. Commands  : none
  224. Overloads : none
  225. Depends   : Scheduler
  226. ToDo      : nothing
  227. Bugs      : none known
  228.  
  229.  
  230. Colours
  231. -------
  232. Author    : Justin Fletcher, based on an idea by Stuart Bruce
  233. Version   : v1.00 (24 Dec 1996)
  234. Synopsis  : Provides a means of introducing some colour into conversations
  235. Commands  : none
  236. Overloads : none
  237. Depends   : none
  238. ToDo      : nothing
  239. Bugs      : none known
  240.  
  241.  
  242. DCC 
  243. ---
  244. Author    : Justin Fletcher
  245. Version   : v1.10 (18 Jan 1997)
  246. Synopsis  : Provides simple interface to DCC operations, including listing
  247.             connections, closing them and managing the list.
  248. Commands  : /dcc List|Close <number>
  249. Overloads : PROCOverload_UnknownDCCCommand
  250.             PROCOverload_UnknownDCCRequest
  251.             PROC<base>_Connected(handle,private)
  252.             PROC<base>_Incoming(handle,private,bytes)
  253.             PROC<base>_Closed(handle,private)
  254.             PROC<base>_Error(handle,private)
  255.             FN<base>_Status(handle,private,flags)
  256. Depends   : none
  257. ToDo      : Write some support modules !
  258. Bugs      : none known
  259.  
  260.  
  261. Email
  262. -----
  263. Author    : Justin Fletcher
  264. Version   : v1.00 (20 Aug 1996)
  265. Synopsis  : Provides a simple email database
  266. Commands  : none
  267. Overloads : none
  268. Depends   : none
  269. ToDo      : Re-write it completely - it's only a temporary measure
  270. Bugs      : You can't list who is in the database
  271.  
  272.  
  273. ExtEdit
  274. -------
  275. Author    : Justin Fletcher
  276. Version   : v1.01 (07 Jan 1997)
  277. Synopsis  : Provides a means of handling External edit sessions
  278. Commands  : none
  279. Overloads : none
  280. Depends   : none
  281. ToDo      : implement 'save-to' and other such calls.
  282. Bugs      : not known - still experimental
  283.  
  284.  
  285. FloodProt
  286. ---------
  287. Author    : Justin Fletcher
  288. Version   : v1.03 (27 Sep 1996)
  289. Synopsis  : Provides flood protection for messages sent from IRC
  290. Commands  : none
  291. Overloads : none
  292. Depends   : none
  293. ToDo      : not sure really... ideas ?
  294. Bugs      : none known - try it live ?
  295.  
  296.  
  297. FTP
  298. ---
  299. Author    : Justin Fletcher
  300. Version   : v1.05 (03 Jan 1997)
  301. Synopsis  : Provides a means of FTPing files to and from remote sites
  302. Commands  : /ftp [Close|<host> [<user> [<password>|- [<directory>]]]]
  303. Overloads : PROCOverload_UnknownFTPCommand
  304.             PROCOverload_FTPResponse
  305.             PROCOverload_UnknownFTPResponse
  306.             PROCOverload_FTPDataConnection
  307.             PROCOverload_FTPDataError
  308.             PROCOverload_FTPDataIncoming
  309. Depends   : none
  310. ToDo      : ensure that it works 'live'
  311. Bugs      : seems ok live, but loses connection sometime with 'can't connect
  312.             to port'.
  313.  
  314.  
  315. Headlines
  316. ---------
  317. Author    : John Wright, with modifications by Justin Fletcher
  318. Version   : v1.02 (11 Sep 1996)
  319. Synopsis  : Provides a means of seeing news headlines from Press Association
  320. Commands  : /headlines
  321. Overloads : none
  322. Depends   : none
  323. To Do     : colours maybe ? Reformat some of it a bit ?
  324.             Seems to work ok though
  325. Bugs      : none
  326.  
  327.  
  328. Help
  329. ----
  330. Author    : Justin Fletcher
  331. Version   : 1.01 (28 Sep 1996)
  332. Synopsis  : Provides simple help interface within IRClient.
  333. Commands  : /help <filename>
  334. Overloads : none
  335. Depends   : none
  336. ToDo      : Write loads of help
  337.             Get rid of the :END kludge
  338.             Add some more useful : commands
  339. Bugs      : The programming section looks a mess
  340.             You can't go up directories from filenames
  341.             Most of the main IRC commands haven't been updated
  342.  
  343.  
  344. HTTP
  345. ----
  346. Author    : Justin Fletcher
  347. Version   : v1.10 (27 Dec 1996)
  348. Synopsis  : Provides a means of reading HTML whilst online using IRClient.
  349. Commands  : /http <page>|<number>|links|back
  350. Overloads : none as yet
  351. Depends   : none
  352. To Do     : Add <pre> tag support (HTML level 1, I think)
  353.             Add support for display of files which are not text/html, plus
  354.             recognition of such files
  355.             Support for multiple authentication realms over sessions.
  356. Bugs      : Links longer than 512 chars will crash the program, as will text
  357.             of that length.
  358.             Menus can be unstable if they are being build whilst the page is
  359.             coming in.
  360.  
  361. Identd
  362. ------
  363. Author    : Matthew Godbolt
  364. Version   : v1.00 (unknown)
  365. Synopsis  : Provides Identd support for IRClient
  366. Commands  : none
  367. Overloads : none
  368. Depend    : none
  369. To Do     : Nothing
  370. Bugs      : none known
  371.  
  372.  
  373. List
  374. ----
  375. Author    : Justin Fletcher
  376. Version   : v1.00 (13 Aug 1996)
  377. Synopsis  : Provides additional facility to list the channels by using a
  378.             seperate connection.
  379. Commands  : /list [<wildcards>] [-min <number>] [-max <number>]
  380. Overloads : none
  381. Depends   : none
  382. To Do     : Check that it actually does work
  383. Bugs      : none
  384.  
  385.  
  386. Logs
  387. ----
  388. Author    : Justin Fletcher
  389. Version   : v1.04 (28 Sep 1996)
  390. Synopsis  : Provides the facility to log channel and chats to files
  391. Commands  : none
  392. Overloads : none
  393. Depends   : none
  394. To Do     : not sure
  395. Bugs      : if directories get deleted things mess up...
  396.  
  397.  
  398. Motd
  399. ----
  400. Author    : Matthew Godbolt
  401. Version   : v1.01 (24 Dec 1996)
  402. Synopsis  : Provides the nice IRClient MOTD as supplied by TheMoog's webpage.
  403. Commands  : none
  404. Overloads : none
  405. Depends   : none
  406. To Do     : nothing
  407. Bugs      : none
  408.  
  409.  
  410. Notify
  411. ------
  412. Author    : Alex Howarth, with modification by Justin Fletcher
  413. Version   : v0.06 (28 Sep 1996)
  414. Synopsis  : Provides notification of users presence on IRC.
  415. Commands  : /notify [[+|-]<user>|*|?]
  416. Overloads : none
  417. Depends   : none
  418. To Do     : Find a way of making it check every so often, using CallBacks.
  419. Bugs      : none
  420.  
  421.  
  422. OnTV
  423. ----
  424. Author    : Justin Fletcher
  425. Version   : v1.01 (02 Sep 1996)
  426. Synopsis  : Provides a nice interface to the OnTVNow daemon I've got.
  427. Commands  : /ontv
  428. Overloads : none
  429. Depends   : none
  430. To Do     : Nothing
  431. Bugs      : none
  432.  
  433.  
  434. QOTD
  435. ----
  436. Author    : Justin Fletcher
  437. Version   : v1.00 (27 Dec 1996)
  438. Synopsis  : Fetches Quote Of The Day messages from servers
  439. Commands  : /qotd <host>
  440. Overloads : none
  441. Depends   : OnTV
  442. To Do     : find out which servers actually support this feature, other than
  443.             just my TelnetD.
  444. Bugs      : none
  445.  
  446.  
  447. Samples
  448. -------
  449. Author    : Justin Fletcher
  450. Version   : v1.02 (28 Sep 1996)
  451. Synopsis  : Provides facility for sound samples to be played using David
  452.             Radfords SamplePlayer module, on particular event
  453. Commands  : none
  454. Overloads : none
  455. Depends   : none
  456. To Do     : Tie in functions other than just start up, beep and pinging
  457. Bugs      : seems to kill RiscPC's if the built in player is used...
  458.  
  459.  
  460. SMTP
  461. ----
  462. Author    : Justin Fletcher
  463. Version   : v1.07 (26 Dec 1996)
  464. Synopsis  : Provides a means of sending email (and currently my only means)
  465.             whilst online.
  466. Commands  : /mail [Resend]
  467. Overloads : none
  468. Depends   : Email
  469. To Do     : Add line editing, deletion
  470.             External edits when finished
  471. Bugs      : Failures which require re-coding mean that the message is lost.
  472.  
  473.  
  474. *******************************************************************************
  475. **                            Obsolete Modules                               **
  476. *******************************************************************************
  477.  
  478. Scheduler
  479. ---------
  480. Author    : Justin Fletcher
  481. Version   : v1.03 (28 Sep 1996)
  482. Synopsis  : Simple scheduling using overloads on IRCLine and UserLine.
  483.             Will sort schedule list.
  484. Commands  : None
  485. Overloads : PROCOverload_CallBack
  486. ToDo      : Fix the CallEvery code !
  487. Bugs      : This really needs to be replaced by code directly callable in
  488.             IRClient. However, this is actually quite nice :-)
  489. Reason    : Scheduler functions are now handled by IRBasic much more
  490.             efficiently.
  491.  
  492.  
  493. DCC 
  494. ---
  495. Author    : Justin Fletcher, based on original code by Matthew Godbolt
  496. Version   : v1.04 (01 Jan 1997)
  497. Synopsis  : Provides simple interface to DCC operations, including listing
  498.             connections, closing them and managing the list.
  499. Commands  : /dcc List|Chat <nick>|Close <number>
  500.             /me whilst in =windows
  501. Overloads : PROCOverload_UnknownDCCCommand
  502.             PROCOverload_UnknownDCCRequest
  503.             FNOverload_DCCStatus
  504.             FNOverload_DCCClose
  505. Depends   : none
  506. ToDo      : none
  507. Bugs      : Shouldn't really send |M at end of lines
  508. Reason    : Becoming too awkward to develop due to the way the structure has
  509.             grown and the fact that DCC Send failed most of the time when
  510.             'live' for no adequately explained reason even though it works
  511.             fine locally.
  512.  
  513.  
  514. DCCSend
  515. -------
  516. Author    : Justin Fletcher
  517. Version   : v1.05 (28 Sep 1996)
  518. Synopsis  : Provides facility to DCC Send files to other users.
  519. Commands  : /dcc Send <nick> <file>
  520.             /dcc Get <number>
  521. Overloads : none
  522. Depends   : DCC
  523. ToDo      : Add DCC Close for GET's
  524. Bugs      : Seems to fail by sending the ip address wrongly...
  525. Reason    : See DCC.
  526.