home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / ezirc12o.zip / install.zip / README.TXT < prev   
Text File  |  1997-12-26  |  19KB  |  466 lines
  1.    EZ IRC for OS/2 Warp     version 1.2o beta
  2. =====================================================================
  3.  
  4. This program is distributed in the hope that it will be useful,
  5. but WITHOUT ANY WARRANTY.
  6. (c) Copyright Roger Bess  1996,  All Rights Reserved.
  7.  
  8. ============ SUMMARY of some PMirc commands, more details below=========
  9. /m  nickname your message       = to send a private message to a nickname.
  10. /me   your message  = Specifies an action.
  11. /ping nickname    = ping a nickname               (or use the pulldown window)
  12. /ver  nickname    = query a nicknames version             ""
  13. /whois  nickname  = query a nicknames additional data.    ""
  14. /who  channel     = list the users on a channel.          ""
  15. /nick newnickname = To change your nickname.
  16. /join channel     = joins a channel
  17. /ignore nickname duration = ignores  "nickname" for  "duration" seconds.
  18. /ignore  (no parameters) = display the nicks currently being ignored.
  19. /dccsend nickname file = to send a file to nickname. dccsend nick c:\file
  20. /flood num interval restoreseconds = if num CTCP's are received in
  21.                        interval time, the filter out for restoreseconds
  22.  
  23. /ctcp nickname command  for most other ctcp commands.
  24. /clear    (to clear the window)
  25. /rejoin on|off (to set automatic channel rejoin on kick)
  26.  
  27. Almost all of the IRC commands specified in RFC1459 are supported.
  28. Simply prefix the command with a '/'.  For example.
  29.  
  30. /TOPIC #channel :your topic        will change the channels topic.
  31.                                   (or use the channel options window)
  32. Other hot keys:
  33. - copy/paste            (ctrl-insert/shift-insert or ctrl-c/ctrl-p)
  34. - hot key toggle through channel and private windows  (ctrl-x, ctrl-tab)
  35. - retreive commands                     (ctrl-uparrow/ctrl-downarrow)
  36.  
  37. =====================================================================
  38. Changes in 1.2o,
  39. - /clear command
  40. - more channel search options, and channel search fix
  41. - /rejoin command
  42. - fixed bug to allow script to work if a nickname has a | in it
  43. - fixed bug in logging. (filenames with multiple .s in them)
  44. - allow multiple line select for copy
  45. - allow numeric IP address instead of server name
  46. - allow joining channels from scripts
  47. - now show the command on the screen from scripts.
  48. - 5 second timer on initial copyright screen.
  49. - allow password on server connect..  format=  irc.server.com:port:password
  50. =====================================================================
  51. Changes in 1.2j,
  52. - Flood control setting on setup
  53. - Line wrap on word boundries
  54. - Name change to EZirc.
  55. - Sound support
  56. - allow socket addr per irc server address. use format   irc.server.net:6667
  57. - DCC functions can now be used on machines with multiple interfaces.
  58. - automatic nickname changing to add ^ if nickname is in use.
  59. - enhanced channel listing performance.
  60. - fixed /join with password for protected channels
  61. - Do not allow PING/VERSION to autolaunch windows.
  62. - Save last irc server:portnumber  to allow easier reconnecting.
  63. - Tile windows (for 4 window tile)
  64. - channel/nick logging to seperate files
  65. - Alias command support via rexx script
  66. - A few other minor fixes..
  67. =====================================================================
  68. Changes in 1.2
  69. - Added ignore function (with an ignore duration paramater)
  70. - Add command line /dccsend command
  71. - Seperate window task list
  72. - Flood detection for CTCP commands
  73. - fixed nickname changing problem
  74. - moved whoishere, stopscroll buttons to floating menu (more room for text
  75. - System  menu on all windows
  76. - DCC receive will now overwrite file if it previously existed. (prompt)
  77. - Beep on private option now applies to DCC chat
  78. - Fixed 'bogus' characters appearing in DCC chat
  79. - Improved the line wrapping. (still not 'perfect' though)
  80. - Fixed script problem where long commands from the script get truncated.
  81. - A primitive logging mechinasm
  82. - Suppress unprintable characters, (mIRC 4.7 color codes)
  83. - other small fixes and enhancements.
  84.  
  85. =====================================================================
  86. Changes in 1.10
  87. - Script support
  88. - Window fonts/colors cleaned up giving PMirc a new look.
  89. - Delete 'menu only' window, and put menu on the pmirc general window
  90. - Display current server in pmirc title bar.
  91. - automatically rejoin channels after disconnect/reconnect to server
  92. - show longer lists on setup, and connect to server dialogs.
  93. - fixed identd problem
  94. - DCC send size configurable
  95. - Windows added to Task List (ctrl-esc) *disabled in 1.11*
  96. =====================================================================
  97. Changes in 1.09b
  98. - DCC send/receive fix
  99. - optimize channel list
  100. =====================================================================
  101. Changes in 1.09
  102. - can configure multiple servers                (options->setup)
  103. - auto reconnect to server if disconnected      (options->setup)
  104. - extra msg's supported for AWAY, KICK, and SERVER DISCONNECT (options->setup)
  105. - Color support for foreground/backround colors (options->colors)
  106. - notify interval is user configurable          (options->setup)
  107. - default DCC path is configurable              (options->setup)
  108. - copy/paste                    (ctrl-insert/shift-insert or ctrl-c/ctrl-p)
  109. - hot key toggle through channel and private windows  (ctrl-x, ctrl-tab)
  110. - retreive commands                     (ctrl-uparrow/ctrl-downarrow)
  111. - other small improvements
  112.  
  113. Remember the 2nd mouse button,  it does wonders.  :)
  114.  
  115. =====================================================================
  116. Changes in 1.08
  117. - various fixes
  118. - DCC send, receive and chat now supported.
  119. - /ctcp  now is supported, format is /ctcp nickname command
  120. - can now stop window scrolling
  121.  
  122. =====================================================================
  123. Changes in 1.07
  124. - various fixes
  125. - Change font is now support
  126. - Line wrapping based on window size
  127. - Automatic refresh of the user list window
  128. - Auto launch window option on incomming private message
  129. - user list and channel list windows can be closed
  130. - /join is enabled from the command line, (autolaunches a window)
  131. - Setup is now through options->setup. you never need to edit the .ini file
  132.  
  133. =====================================================================
  134.  
  135.  
  136. The only files related to this program are
  137. PMIRC.EXE    =  The executable file
  138. PMIRC.INI    =  an INI file (optional)
  139.  
  140. Here is basic operation and commands for PM IRC.
  141.  
  142. The first option to select is 'Connect To Server'
  143.  
  144. Once your connected into the server, you can now Join channels or
  145. execute the various commands of IRC..
  146. -----------------------------------------------------------------------
  147. To join a channel do one of the following.
  148.  
  149.   - select  Channels->Join Channel
  150.      enter the channel name.
  151.  
  152.   - In the Channel List window,
  153.      click on a channel to hilight it, then click the 2nd mouse button for
  154.      a pull down menu..
  155.  
  156.  - at the command line type /join #channel
  157.       This will launch a window and join the channel.
  158.  
  159. -----------------------------------------------------------------------
  160. To leave a channel.
  161.  
  162.   - Press the Quit button on the window.
  163.  
  164. -----------------------------------------------------------------------
  165. To list channels
  166.   - select Channels->List Channels.
  167.      you will be prompted for a channel search string.
  168.  
  169.   This will list all channels that have the 'search string' in the channel
  170.   name. If the search string is left blank, ALL channels will be displayed.
  171.   Note, while the channel list is being sent from the server, you will not
  172.   be able to send/receive other messages from users.
  173.  
  174.   - Select Channels->Preferred Channels
  175.  
  176.    This will query only the channels specified in the .ini file. See below
  177.    more details.
  178. -----------------------------------------------------------------------
  179.  
  180. To Save your window positions and sizes.
  181.   Go to Options->Save Window Positions.
  182.  
  183. -----------------------------------------------------------------------
  184. To show the users on a channel,
  185.    - From the channel list window, select a channel and press the 2nd mouse
  186.      button, and select 'who is here'
  187.      = The results of this who is displayed in the 'General Window'
  188.  
  189.    - From a channel window, press the 'Who is Here' button.
  190.      = The results are displayed in a seperate window associated with this
  191.        channel.
  192.  
  193. -----------------------------------------------------------------------
  194. Options from the channel users window, press the 2nd mouse button,
  195. after selecting a line.
  196.    Most of these options can be selected from ANY window now via the
  197.    2nd button after selecting a line with a nickname at the beginning
  198.     channel options = Brings up dialog window to change channel options.
  199.                       (you must have operator status @ to do this)
  200.   Private  = Start a new window, messages to from this window are only
  201.              sent to the  nickname selected.
  202.  
  203.   DCC Chat = Start a private DCC chat session. (this is usually faster
  204.              and more secure that normal private chat)
  205.  
  206.   Whois    = does a /whois command on the selected nickname,
  207.              results on displayed on the general window.
  208.  
  209.   Ping     = Ping selected nickname
  210.  
  211.   Version  = Query the nicknames version.
  212.  
  213.   op/deop/kick/ban/unban =  perform operation on the selected nickname.
  214. =======================================================================
  215. Other Commands:
  216.  
  217. /m  nickname your message       = to send a private message to a nickname.
  218. /me   your message  = Specifies an action.
  219. /ping nickname    = ping a nickname               (or use the pulldown window)
  220. /ver  nickname    = query a nicknames version             ""
  221. /whois  nickname  = query a nicknames additional data.    ""
  222. /who  channel     = list the users on a channel.          ""
  223. /nick newnickname = To change your nickname.
  224.  
  225. /ctcp nickname command  for most other ctcp commands.
  226.  
  227. Almost all of the IRC commands specified in RFC1459 are supported.
  228. Simply prefix the command with a '/'.  For example.
  229.  
  230. /TOPIC #channel your topic        will change the channels topic.
  231.                                   (or use the channel options window)
  232. ===================================================================
  233.  Font support:
  234.  Starting with 1.07, you can go to options->font to change the font.
  235.  PMIRC will for the most part cut/wrap lines so they stay on the screen
  236.  without having to use the horizontal scroll bar.  Depending on the
  237.  font you choose, the success of this wrapping changes.. I've seen
  238.  cases with some proportional fonts, that they don't take advantage of
  239.  the entire screen width.
  240. ===================================================================
  241. Auto refresh of the 'who is here' list, and the BAN function.
  242. - When you click the 'who is here' on a channel, it bring ups
  243.   a window with the list of users, plus some additional information.
  244.  
  245.   As users  join, leave, or change nicks, this list is automatically
  246.   updated.. BUT, only the nickname is displayed..
  247.  
  248.   If you want to 'BAN' a user from the channel, and they don't
  249.   have the 'additional' information, click the 'who is here' to
  250.   manually refresh the list, then u can select that nick, and
  251.   perform the 'BAN' function.
  252.  
  253.  
  254. =====================================================================
  255. DCC commands:
  256.  
  257.  To send a file via DCC:
  258.   a. Go to the menu  Users->DCC Send
  259.   b. type in the nickname of the user you want to send to
  260.   c. select the file name.
  261.   d. Hit send.
  262.   e. when the transfer is complete, hit ok.
  263.  or
  264.  type at the command line
  265.  dccsend nickname filename   eg. dccsend climbn c:\temp\file.txt
  266. -------------------
  267.  To start a DCC chat session.
  268.   a. select Users->DCC chat
  269.   b. type in the nickname.
  270.  or.
  271.   on most windows,
  272.   a. hilight the line with the users nickname.
  273.   b. press the 2nd mouse button, and select DCC Chat
  274. ------------------
  275.  To Receive DCC files.
  276.   a. Be sure that Receive DCC is enabled under Options->setup
  277.   b. A dialog box will be displayed to prompt for a local
  278.     filename of were to put the file.
  279.   c. hit receive.
  280.   d. when the transfer is complete, hit ok.
  281. -------------------
  282.  
  283. ===================================================================
  284. identd:
  285.  Many irc servers require that identd be supported on the client.
  286.  PM IRC automatically starts identd when connecting to a server.
  287.  
  288. ===================================================================
  289. INI file options.
  290.  
  291.    Note: The INI file never needs to be edited by hand.
  292.    go to  options->setup
  293.  
  294. The following options are specified when you connect to a server.
  295.  
  296. server=irc server name   = specify the name of your irc server
  297. port=6667                = irc port
  298. realname=your real name  =
  299. userid=your userid      =
  300.  
  301. To get notified which of your friends are on IRC, I have a notify list.
  302. Specify a list of nicknames to be checked for.  Every 10 minutes, the
  303. client will display those in this list that are currently connected in.
  304.  
  305. notify=nick1 nick2 nick3
  306.  
  307.   To avoid having to do a 'List Channels' which can take a *very*
  308.   long time to get the full response to, there is now a 'Preferred
  309.   channels' option in the 'Channels' menu. This will only query the
  310.   channels put on the preferred_channels line in the .ini file.
  311.   The format is:
  312.  
  313.  
  314.   preferred_channels=#channel1 #channel2 #channel3
  315.  
  316.   The window positions can now be saved in the .ini file
  317.   Unfortuately, there are cases where if you 'Save Window Positions'
  318.   multiple times, the .ini file can get corrupted, (only slightly).
  319.   I recommend that the window options be at the bottom of the .ini file.
  320.   Below is the format of the lines, and how to create them under 'Options'.
  321.   I intend to fix this corruption problem sometime..
  322.  
  323.   main_window=4 1 400 50
  324.   general_window=4 33 519 192
  325.   channel_list_window=508 12 143 221
  326.   channel_window=4 254 522 221
  327.   whois_window=524 253 119 226
  328.  
  329.   There are general messages that are not directly associated with a
  330.   channel. These messages can either be displayed in the 'top' window
  331.   or the 'general' window.  To display to the top window, add the
  332.   following line to the .ini file
  333.  
  334. default_to_top_window=yes
  335.  
  336.   For private messages directed to you, they will either go
  337.   a. to the window of that nickname, (if u have one open).
  338.   b. to the 'top' most window, if u have
  339.  
  340. default_private_to_top_window=yes
  341.  
  342.   c. to the 'general window'
  343.  
  344.     autolaunch_private_window=yes
  345.      when this is enabled, when someone send you a private message, it
  346.      will automatically bring up a private window for that user if none
  347.      exists.
  348.  
  349. =====================================================================
  350. SCRIPT SUPPORT
  351. PMirc V1.10 provides the tools to allow users to
  352.  - Start any REXX program based on a string of text received.
  353.  - Execute an IRC command as returned by the executed REXX program.
  354.  
  355.  The script support requires 2 types of files.
  356.  The first file specifies a list of REXX commands and search strings.
  357.  
  358. -----------------------------------
  359.  PMIRC.SCR
  360.    This file will contain lines of the following format
  361.  
  362.    <filename.cmd> <search text string>
  363.  
  364.    filename = REXX program to execute
  365.    search text string =  when this text is received from the irc server
  366.    it will execute the REXX program specified as 'filename'
  367.  
  368. Use a  : in the first column for comments
  369.  
  370. Example of a line PMIRC.SCR
  371. :this is a comment
  372. playsnd.cmd SOUND
  373. joinch.cmd  is joining channel
  374.  
  375. This will execute the joinch.cmd REXX script when the string 'is joining channel'
  376. is seen.
  377.  
  378. IMPORTANT:
  379.  After making a change to the PMIRC.SCR file, goto options->setup.  This will
  380.  cause the PMIRC.SCR file to be re-read into PMIRC so your changes will take
  381.  affect.
  382.  
  383. ----------------------------------
  384. The second type of file is the REXX scripts that are specfied in the PMIRC.SCR
  385. file.
  386.  
  387. <filename.cmd>
  388.  This is REXX file that will have input of the following arguements.
  389.  <channel or nickname> <full line of text that was received that caused this
  390.                         file to get executed>
  391.  
  392.  
  393. The 'return' statement at the end of the rexx program can contain
  394. any command or text that a user would normally enter on the command line
  395. in PMirc. If the return has no arguement, the script will not execute
  396. any IRC command or text.
  397.  
  398. To return multiple commands or text, use the symbol | (vertical bar) to seperate
  399. the different commands.
  400.  
  401. resultstr = 'First command or text string|Second command or text string'
  402.  
  403. ----------------------------
  404. Example 1 of REXX script. (issuing a command)
  405. This REXX script is executed as a result of the text
  406.  *** MyNick is joining channel #chatzone6 ***
  407.  
  408.  
  409. /* First line must be a comment line*/
  410. parse arg channel asteriks nickname restoftext
  411. resultstr = '/whois '||nickname||'|Welcome '||nickname||' to channel '||channel
  412. return resultstr
  413.  
  414.  
  415.              ^^^^^^^^^^^^^^^^^^    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  416.               first command        second command
  417. The resultstr will be  /whois MyNick  to execute a /whois command on
  418. everyone who joins a channel while your there. It will also send a
  419. message to that user saying welcome to the channel.
  420. -----------------------------
  421. Example 2 (playing a sound)
  422. /*This will play a sound when some issues the                */
  423. /* command  /CTCP channel SOUND asound.wav                   */
  424. /* note that there is no arguement on the 'return' statement */
  425. parse arg channel nickname ctcp sound
  426. sound = substr(sound,1,length(sound)-1)
  427. 'start CALL play file=c:\mmos2\sounds\'sound
  428. return
  429. ------------------------------
  430.  
  431. More notes on scripts.
  432.  - Text that YOU type will NOT cause a script to get executed. This will
  433.    will help prevent some nasty loops that a user might create.
  434.  
  435.  - to test your own scripts, you can /msg yourself in many cases.
  436.  
  437.  - The REXX script can be as complex or as simple as you want it to be.
  438.    Be careful with scripts that are too complex as they could slow the
  439.    performance.
  440.  
  441.  - Watch for 'search strings' that are too generic or will cause the
  442.    rexx script to get executed more than desired. This can also cause
  443.    performance degradation.
  444.  
  445.  - If calling another rexx program from within this rexx program, you
  446.    need to use the 'call' command. In some cases I use the 'start' command
  447.    so that this rexx script can return control back to PMirc while the
  448.    other rexx script executes. (The sound playing script is an example
  449.    of this).
  450.  
  451.  - If you see a line REXX Error RC=   this is because there is
  452.    either a pmirc.scr file that is pointing to a rexx file that can't
  453.    be found, or there is a problem in the REXX script itself.
  454.  
  455. =====================================================================
  456. This program is distributed in the hope that it will be useful,
  457. but WITHOUT ANY WARRANTY.
  458. =====================================================================
  459.  
  460. Please send any comments to
  461.  
  462. rndbess@ibm.net
  463.  
  464. When I'm on IRC, I always go by the nickname  climbn. Look me up if you
  465. have questions.
  466.