home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / q / quickirc / !QuickIRC / !Help < prev    next >
Encoding:
Text File  |  1996-10-28  |  8.7 KB  |  283 lines
  1.  
  2.  
  3.         #####                             #####  #####     ######
  4.        #     #           #                  #    #    #   #
  5.       #       #                   #  #      #    #    #   #
  6.       #       #   #   #  #  ####  # #       #    #####    #
  7.       #    #  #   #   #  #  #     ##        #    # #      #
  8.        #     #    #   #  #  #     # #       #    #  #     #
  9.         ##### #    ###   #  ####  #  #    #####  #   ##    ######
  10.         
  11.         
  12.         
  13.              A Command Macro Program For Internet Relay Chat
  14.            
  15.            
  16.            
  17.            Author :
  18.            
  19.                     David Robinson,
  20.                     6 St James Road,
  21.                     Torpoint,
  22.                     Cornwall.
  23.                     PL11 2BQ
  24.            
  25.                     E-Mail:  software@zephryus.demon.co.uk
  26.                     
  27.                     
  28.                     
  29.  
  30. CONTENTS
  31. --------
  32.  
  33. 1. About QuickIRC
  34. 2. Requirements
  35. 3. Legal Stuff
  36. 4. Setting up QuickIRC
  37. 5. Editing Nicknames,Channels,User Names and Countries
  38. 6. Using QuickIRC in an IRC session
  39. 7. Bugs and Problems including 'file not found'
  40.  
  41.  
  42.  
  43.  
  44. 1. About !QuickIRC
  45. ~~~~~~~~~~~~~~~~~~
  46.  
  47. QuickIRC is a shareware IRC Command program. It is intended to make the
  48. entry of irc commands easier and quicker, especially if you connect to
  49. an irc server via telnet.
  50.  
  51. Its features include...
  52.  
  53. • One click entry of commands including nicknames and channels if
  54.   necessary.
  55.  
  56. • User definable lists of most frequently used nicknames and channels.
  57.  
  58. • Support for advanced CTCP irc commands such as finger and version.
  59.  
  60. • Operator commands such as Ops, Private, Secret etc
  61.  
  62. • Sends output to the currently selected irc window or icon.
  63.  
  64. • Makes issuing commands simple for even first time irc users.
  65.  
  66. • Full interactive help, often including examples.
  67.  
  68. • User definable selections of /Away reasons and /Me actions.
  69.                    
  70.                    
  71.  
  72. 2.Requirements
  73. ~~~~~~~~~~~~~~
  74. QuickIRC requires RiscOS 3.1 or later. Ideally it should be installed
  75. on a hard drive since it accesses data files from time to time whilst
  76. in use.
  77.  
  78. It will work on any system where an irc connection can be established.  
  79. It can be used with irc client programs such as IRClient, or with Telnet 
  80. sessions ( the only option available if you connect to the internet using 
  81. DoggySoft's Termite software.) It has been tested on Efnet, Undernet,
  82. Dalnet and via Telnet to irc.demon.co.uk :port 23
  83.  
  84.  
  85. 3.Legal Stuff
  86. ~~~~~~~~~~~~~
  87.  
  88. QuickIRC is Shareware, not Public Domain. This means that you can
  89. freely use, copy or distribute the program, subject to the rules
  90. below, but I retain copyright on the program.
  91.  
  92. "Freely use, copy or distribute the program" means...
  93.  
  94. You can have as many copies as you want.
  95. You do not have to pay for the software until you've tried it.
  96. You may give it away to whomsoever you like.
  97.  
  98. BUT....
  99.  
  100. You may NOT alter it then redistribute it, except for changing the
  101. user definable text files, or adding foreign language message files.
  102.  
  103. The first people to send me foreign language files that I don't yet
  104. have, get a free registered copy.
  105.  
  106. You may neither charge for it as an individual item nor as part
  107. of a compilation of software, unless you have first obtained my
  108. written permission.
  109.  
  110. If you intend placing a copy in a publically accessible archive, BBS
  111. or internet location, you must first contact me to ascertain whether
  112. you have the most recent version.
  113.  
  114. These restrictions are simply to ensure that anyone using QuickIRC
  115. gets it for little or no cost and has access to the most recent
  116. version.
  117.  
  118. If you have used !QuickIRC for a while and decide you want to keep it
  119. you should consider sending me 5 uk pounds as a registration fee.  I'm
  120. not going to force you to send me any money, but if you think it's
  121. worth it I could certainly do with the cash, and it will help to
  122. ensure that I keep writing applications :) 
  123.  
  124.  
  125.  
  126.  
  127. Setting Up QuickIRC
  128. ~~~~~~~~~~~~~~~~~~~
  129.  
  130. Essentially QuickIRC needs almost no setting up. It can be happily run
  131. in it's original state.  However, to get most benefit from using it,
  132. you should edit the nickname and channel name files to contain the
  133. names and channels you use most frequently.
  134.  
  135.  
  136. Editing Nicknames, Channels, User Names and Countries
  137. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  138.  
  139. Method 1:
  140. After loading !QuickIRC open a menu and select the last entry; 'New
  141. Channel' or 'New Nickname'.  A dialogue window will appear into which
  142. you can enter new names. Any number of new names can be entered, just
  143. click on the 'Add' button after each entry.  Entries can only be
  144. added, not deleted using this method.
  145.  
  146. Method 2:
  147.  
  148. With !QuickIRC loaded on the icon bar, load a text editor such as !Edit
  149. or !Zap
  150.  
  151. Click the mouse menu button over the QuickIRC iconbar icon, then
  152. select from:
  153.  
  154.      NickNames
  155.      Channels
  156.      User Names
  157.      Countries
  158.      Away Reasons
  159.      Actions
  160.  
  161.  
  162. QuickIRC will open an editor window containing the contents of the choosen 
  163. file.
  164.  
  165. You can now add to, delete from, or alter the contents of the file. 
  166. Closing the window and saving the file makes the alterations take effect
  167. immediately.
  168.  
  169. All entries should be on seperate lines terminated with a <RETURN>. 
  170. Channel names should begin with either a & or a #.
  171.  
  172.  
  173. Method 3:
  174.  
  175. Whilst holding down <SHIFT> double click on !QuickIRC to open the
  176. application. Go into the directory names Resources and load the
  177. desired file into a text editor such as !Edit or !Zap.
  178.  
  179.  
  180. 6. Using QuickIRC in an IRC session
  181. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  182.  
  183. a. IRC Commands:
  184.  
  185. Using QuickIRC is the same whether you have connected via a client
  186. program or via Telnet.
  187.  
  188. Load QuickIRC and it's icon will appear on the icon bar.  A window
  189. containing 30 command buttons and two display icons will appear across 
  190. the top of the screen.
  191.  
  192. Ensure that the irc client program / telnet terminal has the current
  193. input, that the caret is in the irc program window.  Clicking on
  194. any of QuickIRC's buttons will now cause the choosen command to be
  195. entered in the irc window.  Commands which require a nickname or
  196. channel name will use the names currently displayed in the Nickname
  197. and Channel display icons. Many buttons allow the use of the ADJUST
  198. button to bring up a menu of available names or options.
  199.  
  200. The Nicknames and Channel names can be changed by clicking on the menu
  201. buttons and choosing a new entry from the menu.  See "Editing
  202. Nicknames,Channels etc" for details of how to add new entries.
  203.  
  204. b. Actions:
  205.  
  206. By clicking ADJUST over the /Me button you can open the Actions
  207. Window.
  208. This contains ten user definable messages.  These are 'action' messages 
  209. which you can send by just clicking on your choosen message.
  210.  
  211. Where you see <nick> in a message, QuickIRC will substitute the
  212. currently selected nickname.  
  213.  
  214. For example, if you have "Charlie" in the Nickname display and click 
  215. on "waves to <nick>", the message entered in your irc program will be... 
  216.  
  217. /me waves at Charlie
  218.  
  219. Assuming that your irc nickname is Camilla, all other users on your irc
  220. channel will receive a message saying...
  221.  
  222. Camilla waves at Charlie.
  223.  
  224. Action messages can be edited by selecting "Actions" from the Icon Bar
  225. Menu.
  226.  
  227. c. Away Reasons
  228.  
  229. By clicking ADJUST over the /Away button you can open the Away Reasons
  230. Window.
  231. This contains ten user definable messages.  These are messages 
  232. which explain why you are not currently looking at the computer
  233. screen.
  234.  
  235. They can be edited by selecting "Away Reasons" from the Icon Bar Menu.
  236.  
  237.  
  238. Bugs and Problems
  239. ~~~~~~~~~~~~~~~~~
  240.  
  241. Well... I've tried to remove as many of the bugs as possible but
  242. somebody is bound to find some more.  Please let me know what they are
  243. and try to let me have as much info as possible about what you were
  244. doing, what QuickIRC did and what type of computer you were using.
  245.  
  246. As for problems, you will find that some of the commands are not supported 
  247. by the current version of Matthew Godbolt's !IRClient program, but this may 
  248. change with future releases.  ALL commands will work via Telnet to
  249. Demon's irc server on irc.demon.co.uk  :  port 23
  250.  
  251.  
  252. If you accidently delete or otherwise render useless either the
  253. nicknames or channels list files, QuickIRC will try to tell you
  254. politely about it.
  255.  
  256. To re-create the files open up QuickIRC and enter the Resources
  257. directory. Copy a default version from the directory called Backup.
  258. Now add your favourite channels and names to the files, one entry per
  259. line.
  260.  
  261.  
  262.  
  263.  
  264.  
  265. Acknowledgements
  266. ~~~~~~~~~~~~~~~~
  267.  
  268. This program was written using !Zap, an excellent editor by Dominic
  269. Symes.
  270.  
  271. In a twisted way, thanks to Doggysoft, for if they'd provided an irc
  272. client for Termite I would never have written this application ;->  
  273.  
  274.  
  275.  
  276. Blatent Plug
  277. ~~~~~~~~~~~~
  278.  
  279. For this and other Acorn programs, as well as various educational
  280. resources for teachers and students, try a visit to the Educational
  281. Resources Site at http://www.zephryus.demon.co.uk/education/home.html
  282.  
  283. Comments and contributions welcome :)