home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / DPIRC17.ZIP / DPIRC.TXT < prev    next >
Text File  |  1998-03-10  |  24KB  |  464 lines
  1.                               *** DPIRC 1.7 ***
  2.           Part of the DPNET series: Internet Software for PowerBBS
  3.  
  4.                               by Detlef Pleiss
  5.  
  6.                Internet:   det@goliath.de
  7.                Compuserve: 74101.755
  8.  
  9.                Download and Online Order:
  10.                Internet:   http://dpsoft.powerbbs.com
  11.                            http://www.abacus2.com
  12.                Compuserve: GO PBBS
  13.  
  14.                Online Support Mailing List:
  15.                to subscribe send a message to majordomo@mail.msen.com with
  16.                "subscribe dpsoft" in the body (no quotes)
  17.  
  18. ====================================================================
  19. Files included in package:
  20. DPIDENT.EXE  - IDENT Server, 16 bit version
  21. DPID32.EXE   - IDENT Server, 32 bit version
  22. DPIRC.DLL    - BBS side DLL for ANSI and GUI, 16 bit version
  23. DPIRC32.DLL  - BBS side DLL for ANSI and GUI, 32 bit version
  24. DPIRC2.PA    - Caller side GUI DLL
  25. DPIRC.ICO    - Icon for PowerGenerator Screens
  26. DPIRC.INI    - Configuration File
  27. DPIRC2.INI   - Default Configuration for the PA GUI DLL
  28. DPIRCHLP.TXT - the ANSI Help File
  29. IRCHELP.ZIP  - extensive IRC help in POW and TXT format
  30.                contributed by Daniel Arkey, thanks Dan!
  31. POWRCHAT.RTF - Introduction to the Global PowrCHAT Network
  32. DPIRC.TXT    - This File
  33. DPSOFT.TXT   - Information about DP Software Products
  34. FILE_ID.DIZ  - Description for BBS File Lists
  35. UPGRADE.TXT  - Upgrading from earlier Versions
  36. ====================================================================
  37.  
  38. The Basics of DPIRC
  39.  
  40. DPIRC lets your users take part in the global online chat network called
  41. IRC. Realtime chat covering a vast area of topics with thousands of people
  42. online.
  43.  
  44. Only requirement besides a running PowerBBS is a working
  45. Windows Socket TCP/IP stack, a WINSOCK.DLL (WSOCK32.DLL for 32 bit). The type
  46. of connection to your Internet provider doesn't matter, even a dialup
  47. connection does the job. DPIRC can call a batch file of your choice in
  48. order to establish a connection on demand. This document does not explain how
  49. to get your TCP/IP stack up and running. For that you need to refer to the
  50. documentation of the TCP/IP software you're using or to your internet
  51. provider.
  52.  
  53. On startup the ANSI version of DPIRC will place the user on a default server
  54. and channel (IRC name for chat rooms) of your choice. She can start chatting
  55. right away. Most online commands are just like in the local chat rooms,
  56. while experienced IRC users can still type in commands the way they're used
  57. to. The GUI version presents the caller with a configurable choice of server
  58. addresses and channel names, so going online is just a matter of a few mouse
  59. clicks. The GUI version can handle up to 10 channels plus 10 private chats
  60. simultaneously.
  61.  
  62. ====================================================================
  63.  
  64. Installation
  65.  
  66. If you run 16 bit Windows, copy DPIDENT.EXE to your PowerBBS home directory.
  67. If you run Windows95 or NT, you may want to copy DPID32.EXE to your PowerBBS
  68. home directory instead. Except if your BBS nodes run on a LAN, connected to
  69. the Internet through a Proxy server. In that case read the chapter
  70. "DPIDENT.EXE / DPID32.EXE" below. Whenever this manual talks about
  71. DPIDENT.EXE, the same is true for DPID32.EXE. Both programs are the same, just
  72. 16 bit versus 32 bit.
  73. If you run the 16 bit version of PowerBBS, copy DPIRC.DLL to your PowerBBS
  74. home directory. If you run the 32 bit version of PowerBBS, copy DPIRC32.DLL to
  75. your PowerBBS home directory and there rename it to DPIRC.DLL.
  76. Copy DPIRCHLP.TXT to your PowerBBS home directory.
  77. Copy DPIRC2.INI to your PowerBBS home directory.
  78. Copy DPIRC.INI to your \windows home directory. On networked BBS's have a copy
  79. of \windows\dpirc.ini on each machine!
  80. Copy DPIRC2.PA to your POWERBBS\SOURCE directory.
  81. On one of your PGen screens add a command to run DPIRC as a PA DLL. The
  82. command reads "O-DPIRC.DLL". You may want to use DPIRC.ICO for the icon.
  83. Using CONFIG add the command to run DPIRC as ANSI DLL to one of your ANSI
  84. menus. Start DPIDENT.EXE (DPID32.EXE) and keep it running in the background.
  85. Now you're ready to go ahead and start playing with DPIRC.
  86. Make sure your Windows Socket TCP/IP stack is running and online (or first
  87. read the paragraph about dial-up support).
  88.  
  89. ====================================================================
  90.  
  91. The Global PowrCHAT Network
  92.  
  93. The default configuration as it comes with the DPIRC distribution connects the
  94. caller to the Global PowrCHAT Network, where he can meet callers of other
  95. PowerBBS systems. For further information on the Global PowrCHAT Network
  96. please read the file PowrCHAT.RTF as enclosed in this distribution.
  97.  
  98. ====================================================================
  99.  
  100. Running the Program and Customization - ANSI
  101.  
  102. On startup DPIRC establishes a connection to the IRC server named in the
  103. DefaultServer= line of DPIRC.INI. The server displays the "Message of the Day"
  104. (MOTD). Then the user will be placed automatically on the channel named in the
  105. DefaultChannel= line of DPIRC.INI. If that channel didn't exist beforehand, it
  106. will be created at that moment. If set, the topic of that channel and a list of
  107. persons online will be displayed. After that text typed by other people
  108. on that channel will appear on screen. As soon as the user starts typing a ">"
  109. prompt appears and the user may type her message or command. Pressing the
  110. return key sends the message to the channel or issues the command. Channel
  111. input is halted until a message or command is completed.
  112.  
  113. All commands start with a slash "/" character. Input starting with a different
  114. character is sent to the channel. Messages to the channel cannot start with a
  115. slash.
  116.  
  117. The following commands are implemented in DPIRC (command characters are not
  118. case sensitive):
  119.  
  120. /?                 displays the online help as given in DPIRCHLP.TXT.
  121.  
  122. /Q                 closes the connection to the server and quits DPIRC.
  123.  
  124. /W                 (or just pressing enter) displays a list of people online
  125.                    in the current channel.
  126.  
  127. /J <#channel>      leaves the current channel and joins the named
  128.                    channel. Names of public IRC channels start with a "#"
  129.                    character. In case the user forgets to type the initial
  130.                    "#" it will be inserted by DPIRC automatically.
  131.  
  132. /L                 displays a list of channels available on the current server
  133.                    and how much people are online on each channel.
  134.  
  135. /N <name>          changes nickname to <name>
  136.  
  137. /S <server:port>   switches to a different server. Parameter is the name
  138.                    (or IP number) of the server to connect to. Optionally a
  139.                    colon ":" followed by the port number to connect to (all
  140.                    without spaces in between) may be added. The default port
  141.                    number for IRC servers is 6667. In case no port number is
  142.                    given, a connection to port 6667 is established. The same
  143.                    channel like on the old server will be joined on the new
  144.                    server.
  145.  
  146. /A <text>          sends <text> as an action to the current channel
  147.  
  148. /<name>; <text>    sends <text> to <name> privately. <text> is sent to <name>
  149.                    only and not to the public channel.
  150.  
  151. Users familiar with command driven IRC may use the usual commands (like /WHOIS
  152. etc.). (Definition of these commands can be found in RFC 1459)
  153. Everything starting with a slash "/" is sent as a command to the
  154. server (or as a private message to another user), not as a message to the
  155. channel.
  156.  
  157. The IRC server all users get connected to initially is set by means of the
  158. DefaultServer= entry in DPIRC.INI. You should choose an IRC server
  159. near to you, in Internet terms. In Windows95 you can use the "tracert" command
  160. to find out about the number of "hops" between you and another machine like an
  161. IRC server.
  162.  
  163. Another entry in DPIRC.INI required for the ANSI version is
  164. DefaultChannel= , which names the channel your users are sent to on startup.
  165. It is up to you what to enter here. You may want to enter something that's
  166. related to the main topic of your BBS or just form "your own" channel, in that
  167. everytime a user of your BBS goes IRC this channel will be created if it
  168. didn't exist beforehand.  Another approach to the DefaultChannel= entry is
  169. watching out for a well known, existing, busy channel that will engage your
  170. users in a lively discussion immediately (i.e.  #flirt :)
  171.  
  172. The other customization related entries in DPIRC.INI are:
  173.  
  174. DefaultColor= PBBS code of the text color to be used by DPIRC.
  175.  
  176. Joined=       Message text to announce new people joining the current channel.
  177.               Text is prefixed by the name of that person.
  178.               Setting this entry to "none" disables the message entirely.
  179.  
  180. Parted=       Message text to announce people leaving the current channel.
  181.               Text is prefixed by the name of that person.
  182.               Setting this entry to "none" disables the message entirely.
  183.  
  184. LeftIRC=      Message text to announce people leaving IRC at all.
  185.               Text is prefixed by the name of that person.
  186.               Setting this entry to "none" disables the message entirely.
  187.  
  188. Private=      Text to announce a message as private. Text is inserted between
  189.               the name of the sender of that message and the ">" prompt.
  190.  
  191. You may change the help file DPIRCHLP.TXT to whatever you want. You may
  192. use the PBBS color codes within that file.
  193.  
  194. ====================================================================
  195.  
  196. Running the Program and Customization - PA GUI
  197.  
  198. On startup DPIRC shows it's main dialog, consisting of a text area, the server
  199. combo box, two buttons, LIST and JOIN, and the nickname edit box plus change
  200. button. The text area will display general commands and messages, the server's
  201. message of the day and any messages DPIRC doesn't handle otherwise. Only on
  202. first startup DPIRC retrieves the default configuration as given in the
  203. DPIRC2.INI in your \powrbbs directory. You can configure up to 10
  204. default server addresses and channel names for your GUI callers. If you didn't
  205. supply a DPIRC2.INI file, DPIRC creates one based on the DefaultServer= and
  206. DefaultChannel= entries in DPIRC.INI. After the first startup DPIRC at the
  207. PowerAccess side keeps track of the last 10 server addresses and channel names
  208. a caller visited.
  209. In the server field the user may type in a server address, or just use the
  210. given default, and by pressing the connect button connect to that server.
  211. Both other buttons, LIST and JOIN will pop up another dialog, the channel
  212. dialog. Pressing the JOIN button will only pop up that dialog, while LIST
  213. also issues the command to list all available channels. Closing the main
  214. dialog box will shut down DPIRC. After connecting to the IRC server, the
  215. nickname edit box shows the user's nickname which is derived from her name on
  216. the BBS. Once connected to a server the user can change her nickname by typing
  217. in a new one in the nickname edit box and then pressing the "change" button.
  218. On the channel dialog, the channel selection works the same way like the
  219. server selection. A channel name can be typed in, pressing the JOIN button
  220. will join that channel. Default is the last channel visited. DPIRC keeps
  221. track of the last 10 channels visited. The LIST command is the same as for the
  222. main dialog.
  223. On completion of a LIST command, the text area of the channel dialog displays
  224. the available channels. Channelname, number of people in that channel and (if
  225. set) TOPIC of that channel are displayed. Double clicking a channel in the
  226. text area will join that channel.
  227. JOINing a channel will pop up another dialog for that channel. The window
  228. title will name what channel the dialog refers to. The largest text area of
  229. the channel dialog displays the ongoing chat on that channel. To the right is
  230. the list of people (nicknames) on that channel. At the bottom of that dialog
  231. you can type in what you want to submit to that channel. Pressing Return or
  232. the Send button will send the text you typed in to the channel. Pressing the
  233. "as Action" button sends your typing as an action you perform (just try it to
  234. get how it works). Closing a channel dialog box will make you leave that
  235. channel.
  236. In order to initiate a private chat with someone double click her
  237. nick name in the names list (at the right). A private chat dialog box very
  238. similar to the channel dialog box will pop up. The title of the dialog shows
  239. to whom it refers. Text sent / actions performed from that window will be sent
  240. privately to that person only. If someone else initiates a private chat with
  241. you, a private chat dialog box refering to that person will be opened
  242. automatically.
  243. The private chat dialog box also contains a "Who is it?" button that retrieves
  244. the login information related to that nickname and displays it inside the
  245. private chat area. Opening a private chat dialog and using the "Who is it?"
  246. button does not yet send any information to the nickname in question, only the
  247. send / action buttons do so. So you can safely double click a nickname in a
  248. channel and retrieve her login information without actually disturbing the
  249. user.
  250.  
  251. ====================================================================
  252.  
  253. Logging into IRC Servers
  254.  
  255. The most critical part of getting DPIRC to work is the initial login to the
  256. IRC server. This login takes two commands to the server that are issued by
  257. DPIRC automatically.
  258. The first command defines the user's nickname (her chatname). DPIRC uses
  259. the first 9 characters of the user's internet address to determine the user's
  260. nickname. This works, wether you have internet email installed or not. As
  261. nicknames have to be unique throughout IRC it may happen that another IRC user
  262. owns that nickname already. In that case DPIRC will add a number to the
  263. nickname until one is found that is accepted by the server. Nicknames in DPIRC
  264. are limited to 9 characters length.
  265. The second command issued by DPIRC when logging into an IRC server consists of
  266. user name, client name, server name and user's real name. The username DPIRC
  267. sends to the server is the user's internet email address without the "@..."
  268. domain part. This works wether you have internet email installed on your
  269. system or not. The client name is the internet name of the BBS machine.
  270. DPIRC tries to determine that name automatically on startup. In case this
  271. attempt fails and you get error messages while logging into an IRC server you
  272. may set this name by means of the LocalHost= entry in DPIRC.INI. If this entry
  273. is set DPIRC will use it and not try to determine your machine's internet name
  274. automatically. The server name is either the DPIRC.INI DefaultServer= entry
  275. or the name given by a user's /S - command.  By default the real name entry
  276. generated by DPIRC when logging into an IRC server will be the same like the
  277. user name entry. In case you have internet email installed you may want to set
  278. the Domain= line of DPIRC.INI to your internet email domain (i.e.
  279. osna.winnet.de). In this case the user's full internet email address on your
  280. system will be given as real name parameter.  This information can be
  281. retrieved from other IRC users by means of the /WHOIS command. In case you
  282. don't want it or don't have internet email installed just leave the Domain=
  283. entry of DPIRC.INI empty.
  284.  
  285. ====================================================================
  286.  
  287. DPIDENT.EXE / DPID32.EXE
  288.  
  289. Most IRC servers require verification of the login data using the
  290. Identification Protocol (as defined in RFC 1413). DPIDENT.EXE (32bit version:
  291. DPID32.EXE) is a a server for that protocol and has to be running in the
  292. background in order to make this verification (and thus the login) succeed.
  293. DPIDENT is the same for DPIRC, DPLINK and DPPP. Just one copy of DPIDENT per
  294. machine works for multiple nodes running the named programs. You may want to
  295. put it in your autostart/startup group/folder. Just make sure DPIDENT is
  296. running before a user tries to connect to an IRC server that requires
  297. Identification Protocol verification. Data exchange between applications and
  298. DPIDENT takes place using the file DPIDENT.INI in your \windows home
  299. directory. If you have a DPIDENT.INI in your PowerBBS home directory from an
  300. older version, you may delete it. You don't need to touch this file but as
  301. long as no application (DPIDENT, DPPP, DPIRC or DPLINK) is running, you may
  302. delete this file (i.e. during daily maintenance).
  303. If your BBS runs on a LAN, connected to the Internet through a Proxy server,
  304. DPIDENT can not answer Identification Protocol requests if it is running on
  305. the LAN machines, that do not have a direct Internet connection. In that case
  306. there is no need to have it running on the LAN machines, but instead have a
  307. copy of DPIDENT running in the background on the Gateway machine, the one that
  308. runs the Proxy server, the one that has the actual Internet connection. As in
  309. that configuration, DPIDENT does not know about the users who logged on to the
  310. different BBS nodes, you need to tell it a user name that it should use to
  311. answer *all* incoming Identification Protocol requests. In order to so, create
  312. a file DPIDENT.INI in the \windows home directory on the Gateway machine,
  313. where DPIDENT is running. Using any text editor, like Notepad, enter two lines
  314. in that file that read:
  315.  
  316. [DPIDENT]
  317. fixedid=<ident response>
  318.  
  319. For <ident response> insert whatever identification DPIDENT should send out,
  320. i.e. an abbreviation for your BBS name.
  321.  
  322. ====================================================================
  323.  
  324. Dial-Up Support
  325.  
  326. DPIRC supports dialup connections to your provider in that you can specify the
  327.  
  328. Dialup= path to batch file called on connection requests
  329.  
  330. parameter in DPIRC.INI. This batch file is called everytime a caller wants
  331. to connect to a server. The purpose is to initiate a dialup connection in
  332. case your Windows Socket stack doesn't dial-on-demand. If you don't need it
  333. just leave this parameter empty.
  334. During dial-up the "please wait" message taken from the
  335.  
  336. PleaseWait=  message to be displayed during dial-up
  337.  
  338. entry in DPIRC.INI is displayed to the caller.
  339.  
  340. ====================================================================
  341.  
  342. Proxy Support
  343.  
  344. DPIRC supports transparently running through a Proxy server. If your BBS runs
  345. multiple nodes on multiple machines on a LAN, while only one of these machines
  346. has an actual Internet connection, you may be running a Proxy server on that
  347. machine. A Proxy server is the sort of software that most often is advertised
  348. like "connect your entire LAN to the Internet with only one dialup account".
  349. When going through a proxy, DPIRC connects to IRC servers using the Telnet
  350. gateway of your Proxy server. So your Proxy must support forwarding Telnet
  351. connections. It is not necessary to configure special TCP bridges or something
  352. on the Proxy for DPIRC. When going through the Proxy, DPIRC does not
  353. connect to IRC servers directly, but first to the Telnet port of the Proxy
  354. server. It assumes to receive some sort of prompt which it answers by sending
  355. the Internet address of the IRC server to connect to. Per default it
  356. automatically adds a ":6667" to the server name, so it connects to the default
  357. IRC port. In order to activate Proxy support, you need to fill in these entries
  358. in DPIRC.INI:
  359.  
  360. ProxyAddress=   IP address (on the LAN) of your Proxy server
  361. ProxyPrompt=    text DPIRC waits for before sending the IRC server address
  362. ProxyConnected= text from the Proxy server to announce a successful connect
  363.  
  364. DPIRC then connects to the given "ProxyAddress", waits for the given
  365. "ProxyPrompt" and then sends the given server address plus port to the Proxy.
  366. After it receives the "ProxyConnected" message from the Proxy server it then
  367. continues to work with the IRC server as usual.
  368.  
  369. ====================================================================
  370.  
  371. Overview of DPIRC.INI Parameters
  372.  
  373. [DPIRC]
  374. DefaultServer=  server to connect to on startup
  375. DefaultChannel= channel to be joined on startup
  376. DefaultColor=   textcolor to be used
  377. LocalHost=      internet name of BBS computer (default: retrieve automatically)
  378. Domain=         email domain of your system (optional)
  379. Joined=         message text to announce people joining the current channel
  380. Parted=         message text to announce people leaving the current channel
  381. LeftIRC=        message text to announce people leaving IRC at all
  382. Private=        text to annotate messages sent to the user privately
  383. DialUp=         path to batch file called on every connection
  384. PleaseWait=     message to be displayed during dial-up
  385. ProxyAddress=   IP address (on the LAN) of your Proxy server
  386. ProxyPrompt=    text DPIRC waits for before sending the IRC server address
  387. ProxyConnected= text from the Proxy server to announce a successful connect
  388.  
  389. ====================================================================
  390.  
  391. Further Reading
  392.  
  393. RFC 1413 Identification Protocol
  394. RFC 1459 Internet Relay Chat Protocol
  395. http://www.irchelp.org
  396. IRC channel #irchelp
  397.  
  398. ====================================================================
  399.  
  400. Registration and Disclaimer
  401.  
  402. DPIRC is shareware. It is neither free, nor freeware nor in the public domain.
  403. The unregistered version may be distributed freely in its unaltered form.
  404. This software is provided as is. Detlef Pleiss disclaims all warranties,
  405. either expressed or implied, including but not limited to implied warranties
  406. of merchantability, fitness for a particular purpose. In no event will
  407. Detlef Pleiss be liable to you for damages, including any loss of data,
  408. profits, lost savings, or other incidental or consequential damages arising
  409. out of your use or inability to use the software. Use at your own risk.
  410.  
  411. The unregistered version of DPIRC will hang up on the user after some time.
  412. An "unregistered" message will appear on screen before hanging up.
  413. This restriction and the message will vanish after applying your registration
  414. code to DPIRC.
  415.  
  416. Online registration is available at
  417. http://addons.powerbbs.com/pleiss.htm
  418. and
  419. http://www.abacus2.com
  420. and via Compuserve GO SWREG, ID 11805.
  421. Registration fee is $20. After registering you'll receive a registration code
  422. that is valid for your name and your BBS's name. If registering at
  423. Compuserve, please additionally send Compuserve mail to 74101.755 stating
  424. which program you registered, your name and your BBS's name, as this
  425. information will be needed anyway. Registration can not be transferred. If
  426. either name or BBS name change a new registration is required.
  427.  
  428. ====================================================================
  429.  
  430. History of DPIRC:
  431.  
  432. v 1.0 - released: Jun 4 1996
  433.         first public release
  434. v 1.1 - released: Jun 9 1996
  435.         now displays NICK and USER commands
  436.         added support for changing nicknames
  437.         enforced 9 character nickname limit
  438.         added support for actions in channel
  439. v 1.2 - released: Aug 5 1996
  440.         added 32 bit version
  441.         added GUI client
  442. v 1.3 - released: Aug 9 1996
  443.         added nickname change to GUI client
  444. v 1.4 - no public release
  445. v 1.5 - no public release
  446. v 1.6 - released: Sep 13 1996
  447.         fixed 32bit version info for PA GUI DLL download
  448.         fixed login problems with some servers
  449.         DPIDENT: fixed problem with request format of some servers
  450.         added WHOIS request to GUI client
  451.         transmitting DefaultChannel entry to first time GUI users
  452. v 1.7 - released: Mar 10 1998
  453.         fixed login problem with some servers
  454.         fixed problem with large channel listings
  455.         channel operator status changes now display in nick name listing
  456.         DPPP compatibility
  457.         moved INI location to \windows
  458.         made "Joined", "Parted" and "LeftIRC" messages optional
  459.         now displays channel topics in window titles
  460.         added the ability to send arbitrary server commands
  461.         added Proxy support to DPIRC and DPIDENT
  462.         added DPIRC2.INI default configuration for GUI
  463.         added information on the Global PowrCHAT Network
  464.