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