home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / ircdor15.zip / ircdoor.doc < prev    next >
Text File  |  1997-02-07  |  36KB  |  851 lines
  1.  
  2.  
  3. IRCDOOR 1.50 Manual
  4. Copyright (c) 1996 by Andrew Eigus
  5.  
  6.  
  7.                    Table of Contents
  8.  
  9.  
  10.             1.  ...Introduction
  11.  
  12.         2.  ...Software and Hardware requirements
  13.  
  14.         3.  ...License agreement
  15.  
  16.         4.  ...Disclaimer
  17.  
  18.         5.  ...Installation instructions
  19.  
  20.             6.  ...IRC commands supported by IRCDOOR/2
  21.  
  22.             7.  ...IRCDOOR/2-specific commands
  23.  
  24.         8.  ...Comments
  25.  
  26.             9.  ...Registration information
  27.  
  28.         10. ...IRCDOOR/2 distribution information
  29.  
  30.             11. ...Contact information
  31.  
  32.  
  33.  
  34.  
  35.  
  36.     1.    Introduction
  37.  
  38.     What is IRC?
  39.  
  40.     IRC stands for "Internet Relay Chat". It was originally
  41.     written by Jarkko Oikarinen (jto@tolsun.oulu.fi) in 1988.
  42.     Since starting in Finland, it has been used in over 60
  43.     countries around the world. It was designed as a replacement
  44.     for the "talk" program but has become much much more than
  45.     that. IRC is a multi-user chat system, where people convene
  46.     on "channels" (a virtual place, usually with a topic of
  47.     conversation) to talk in groups, or privately. IRC is
  48.     constantly evolving, so the way things to work one week may
  49.     not be the way they work the next. 
  50.  
  51.     Good, what is IRCDOOR?
  52.  
  53.     IRCDOOR/2 is an advanced 32-bit OS/2 Internet Relay Chat
  54.     client with main purpose of being able to be run from a BBS
  55.     (Bulletin Board System) as an external door program, that
  56.     would allow BBS users to IRC. Yes, it means that you could
  57.     *dramatically* increase your BBS popularity by adding IRC
  58.     service for your BBS users. Imagine a user who finds out
  59.     that something is much bigger, better and cooler than
  60.     a simple chat on BBS! Imagine a user who opens your Internet
  61.         service menu and starts a chat session on the Internet!
  62.  
  63.     The following is a brief list of features that are supported
  64.     in current version of IRCDOOR/2:
  65.  
  66.     -- natural 32-bit application capable of running simultaneously
  67.            at as many lines as you wish to register it for
  68.     -- as a BBS door supports TTY/ANSI interface
  69.     -- supports DORINFO1/DOORSYS drop-file formats
  70.     -- supports most standard IRCII 2.8 commands plus some
  71.        additional /CTCP-request commands and some specific
  72.        to IRCDOOR-only commands eg: /WHOELSE, /TIMELEFT, etc.
  73.     -- easy to setup (most options can be specified via command
  74.        line)
  75.     -- can be run in local mode too as a normal IRC client program
  76.     -- runs from any native OS/2 BBS that supports "hot" (open)
  77.        com port handles
  78.     -- flexible configuration
  79.     -- extensive Maximus BBS support (MEX code provided)
  80.     -- custom colors and other settings through config file
  81.     -- ability to be run from a DOS BBS under OS/2
  82.     -- pidentd (RFC 1413) service support
  83.  
  84.  
  85.  
  86.     2.    Software and Hardware requirements
  87.  
  88.     Requires IBM PC (80486 is recommended), Internet connection
  89.     via ethernet, SLIP/PPP etc., IBM OS/2 version 2.0 or 3.0 and
  90.     IBM IAK (Internet Access Kit) with 32-bit TCP/IP libraries
  91.     (files: TCP32DLL.DLL and and SO32DLL.DLL). The Ray Gwinn's
  92.     SIO FOSSIL driver is also recommended for better perfomance.
  93.     SIO is also necessary if you are going to run IRCDOOR from
  94.     a DOS based BBS.
  95.  
  96.  
  97.     3.    License agreement
  98.  
  99.     IRCDOOR/2 IS COPYRIGHT AND PROPERTY OF ANDREW EIGUS, AN
  100.     INDEPENDENT SOFTWARE DEVELOPER (FREELANCER). NONE OF THE
  101.     PORTIONS CONTAINED IN THE IRCDOOR/2 DISTRIBUTION PACKAGE CAN
  102.     BE RESELLED, MODIFIED, DISASSEMBLED OR REPRODUCED IN ANY WAY
  103.     WITHOUT THE AUTHOR'S PERMISSION. PERMISSION IS GRANTED TO
  104.     ANYONE TO DISTRIBUTE THE ENTIRE PACKAGE IN THE NON-MODIFIED
  105.     FORM, PROVIDED THAT ALL FILES ARE KEPT IN THE DISTRIBUTION
  106.     ARCHIVE.
  107.  
  108.     IRCDOOR/2 IS NEITHER PUBLIC DOMAIN, NOR FREEWARE. IRCDOOR IS
  109.     SHAREWARE SOFTWARE. YOU MAY EVALUATE IT FOR A TRIAL PERIOD OF
  110.         28 DAYS, AND THEN WHETHER REGISTER, OR DISCONTINUE USING IT. 
  111.  
  112.  
  113.     4.    Disclaimer
  114.  
  115.  
  116.     THIS SOFTWARE PROVIDED "AS-IS", WHICH MEANS THAT THERE IS
  117.     ABSOLUTELY NO WARRANTY PROVIDED BY THE AUTHOR. IN NO EVENT
  118.     THE AUTHOR WILL BE LIABLE TO YOU FOR ANY DAMAGES ARISING OUT
  119.     OF THE USE OF ANY PART OF THIS PROGRAM.
  120.  
  121.  
  122.     5.    Installation instructions
  123.  
  124.     Installation instructions are sub-divided in three sections.
  125.     Section 5.1 describes the door installation details for non-
  126.     Maximus BBS users, section 5.2 describes door installation
  127.         instructions for Maximus BBS, and sysops who are running a
  128.         DOS-based BBS under OS/2 should read sesction 5.3.
  129.  
  130.  
  131.     5.1    Installation for non-Maximus OS/2 BBS systems
  132.  
  133.     a) Create an empty subdirectory in your BBS [doors]
  134.        directory called IRCDOOR. Let's say i am using Lora BBS,
  135.        and a path to my door games is C:\LORA\DOORS\, so i
  136.        create a directory C:\LORA\DOORS\IRCDOOR.
  137.  
  138.     b) Unzip the distribution IRCDOOR archive to that directory,
  139.        so it would contain AT LEAST the following files:
  140.  
  141.             IRCDOOR.EXE
  142.        IRCDOOR.CFG
  143.             IRCDOOR.HLP
  144.  
  145.     c) Next, set up your BBS software for this door to be run; use
  146.        either DOOR.SYS (recommended) or DORINFO?.DEF format drop-
  147.        file. It should be created prior to running IRCDOOR by your
  148.        BBS software (see your BBS manual for details). Your BBS
  149.        software might be able to pass some information to IRCDOOR
  150.        via command-line: IRC server name, port number, etc. Even
  151.        some parameters in the drop-file can be overriden through
  152.        a command-line. See command-line switches in the Comments
  153.        section for more information about IRCDOOR/2 command line
  154.        parameters.
  155.  
  156.           Your BBS software MUST be able to pass an open com port
  157.        "handle" parameter to IRCDOOR. IRCDOOR will NOT work in
  158.        the remote mode without port handle and BBS drop file path
  159.        specified as command-line arguments. (see -p and -d options
  160.        in the command line parameters paragraph). I recommend you
  161.        to create an OS/2 command file, for example IRCDOOR.CMD,
  162.           that will run the door. Here is sample command file:
  163.  
  164.  
  165.            @echo off
  166.            cd \lora\doors\ircdoor
  167.            if "%1"=="" goto local
  168.            if "%1"=="0" goto local
  169.  
  170.            :remote
  171.        rem *** change the path below to specify a path to YOUR
  172.        rem *** drop file. In multinode environments, this usually
  173.        rem *** depends on a node number.
  174.            ircdoor -p%1 -dc:\lora\node%2\door.sys -k%2 -sirc.funet.fi -$6666
  175.            goto quit
  176.  
  177.            :local
  178.            ircdoor -l -uSysOp -nSysOp -r"My Name" -sirc.funet.fi $6666
  179.            goto quit
  180.  
  181.            :quit
  182.            cd \lora
  183.  
  184.         This small command file above will do the job. It requires
  185.        two arguments: 1 - "hot" com port handle and 2 - BBS node
  186.        number. The node number will be used to specify a target
  187.            directory (path) for/to a drop file. IRCDOOR will automatically
  188.            determine drop file type by it's name. See command line
  189.            switches for more information.
  190.  
  191.     d) Edit your STARTUP.CMD file in your system root directory
  192.        and add there the following line:
  193.  
  194.         erase c:\ircdoor_home_directory\nodeinfo.* >nul
  195.  
  196.        This command will erase old node information files from the
  197.        IRCDOOR home directory. Ircdoor_home_directory must be
  198.        replaced with the directory name where IRCDOOR/2 files are
  199.        located.
  200.  
  201.        IRCDOOR/2 creates and uses nodeinfo.* files in it's home
  202.        directory and it automatically deletes them when a user
  203.        exits the door. But if you encounter a system crash during
  204.        the time when IRCDOOR is running, you should manually
  205.        remove nodeinfo.* files from it's home directory to prevent
  206.        IRCDOOR from thinking that it is running at the moment.
  207.        That's why the best way to avoid this is to insert that
  208.        mentioned erase command above to your STARTUP.CMD file so
  209.        whenever your system reboots, old IRCDOOR node information
  210.        files will be deleted.
  211.  
  212.     There are many different types of BBS software for OS/2, and
  213.     most support passing various parameters via command line, and
  214.     most are able to write standard BBS drop-files (DOOR.SYS or
  215.     DORINFO?.DEF). If this is not your case, and you are
  216.     experiencing problems on how to setup a door, please contact
  217.     me at the address given at the bottom of this document. If
  218.     you own a DOS BBS, please see paragraph 5.3, which describes
  219.     how to setup IRCDOOR for a DOS BBS.
  220.  
  221.  
  222.     5.2    Installation for Maximus/2 3.x system
  223.  
  224.         * Assume that your Maximus directory is C:\MAX, and your doors
  225.       are in C:\MAX\DOORS. Assume that your MEX directory is
  226.       C:\MAX\M, and your MECCA directory is C:\MAX\MISC. If this
  227.       is not your case, simply replace the paths where they
  228.       appear in future.
  229.  
  230.     a) Create IRCDOOR directory under your DOORS directory:
  231.        C:\MAX\DOORS\IRCDOOR.
  232.  
  233.     b) Unzip (copy) IRCDOOR distribution files to that directory. 
  234.  
  235.     c) Copy IRC.CMD file into your Maximus directory and check if
  236.        all the paths are specified correctly in there.
  237.  
  238.     d) Copy IRC.MEX (and IRC.VM) to C:\MAX\M directory (or where
  239.        your MEX files are located)
  240.  
  241.     e) Edit MENUS.CTL and add there (where you want) something
  242.        like that:
  243.  
  244.             Mex      M\IRC          Normal    "IRC"
  245.  
  246.           so when a user selects 'I' from your Internet menu, IRC.VM
  247.        mex code will be run. IRC.VM mex code will at first create
  248.        a DOOR.SYS file in your node-dependant directory (for
  249.        single-node BBSs edit IRC.MEX so it would call DOORSYS.BBS
  250.        instead of DOORSYS2.BBS), and then will prompt a user to
  251.        choose the IRC server to use. You can manually change the
  252.           IRC.MEX file to present other (closer) IRC servers to your
  253.        BBS users.
  254.  
  255.     f) Copy DOORSYS2.MEC (and DOORSYS2.BBS) to C:\MAX\MISC
  256.        directory or wherelse your MECCA files are located. Edit
  257.        DOORSYS2.MEC if necessary to specify YOUR BBS node
  258.        directories. By default, DOORSYS2 MECCA script file will
  259.        write DOOR.SYS drop-file in C:\MAX\NODEn directory, where
  260.        'n' is an active node number. Change it if your node
  261.        directories are in different locations, or you are running
  262.        a single node BBS. If you have a single node BBS, simply
  263.        edit IRC.MEX to call DOORSYS.BBS instead of DOORSYS2.BBS,
  264.        and then edit IRC.CMD so it will pass valid path to
  265.        DOOR.SYS file.
  266.  
  267.     g) Compile IRC.MEX with MEX and DOORSYS2.MEC with MECCA (if
  268.        changes were made), compile MENUS.CTL with SILT. Last time
  269.        check whether everything is ok and all paths are correctly
  270.        specified in the files mentioned above.
  271.  
  272.     h) Edit your STARTUP.CMD file in your system root directory
  273.        and add there the following line:
  274.  
  275.         erase c:\ircdoor_home_directory\nodeinfo.* >nul
  276.  
  277.        This command will erase old node information files from the
  278.        IRCDOOR home directory. Ircdoor_home_directory must be
  279.        replaced with the directory name where IRCDOOR/2 files are
  280.        located.
  281.  
  282.        IRCDOOR/2 creates and uses nodeinfo.* files in it's home
  283.        directory and it automatically deletes them when a user
  284.        exits the door. But if you encounter a system crash during
  285.        the time when IRCDOOR is running, you should manually
  286.        remove nodeinfo.* files from it's home directory to prevent
  287.        IRCDOOR from thinking that it is running at the moment.
  288.        That's why the best way to avoid this is to insert that
  289.        mentioned erase command above to your STARTUP.CMD file so
  290.        whenever your system reboots, old IRCDOOR node information
  291.        files will be deleted.
  292.  
  293.   
  294.        Then run Maximus and check it out. If you have problems with
  295.     configuring IRCDOOR/2 for your system, first refer to the
  296.     chapter 5.1 (Installation for non-Maximus BBS systems), and
  297.     if you still have no luck, feel free to write to the author.
  298.     See the information at the bottom of this document to find
  299.     out how to reach me by electronic mail.
  300.  
  301.     5.3    Installation for a DOS-based BBS
  302.  
  303.     It is possible to run IRCDOOR/2 from a DOS BBS like Maximus (DOS),
  304.     Renegade, Remote Access, etc. The following describes what you'll
  305.     need to do to setup the door for your DOS BBS:
  306.  
  307.     a) Create an empty subdirectory in your BBS [doors]
  308.        directory called IRCDOOR. Let's say i am using Lora BBS,
  309.        and a path to my door games is C:\LORA\DOORS\, so i
  310.        create a directory C:\LORA\DOORS\IRCDOOR.
  311.  
  312.     b) Unzip the distribution IRCDOOR archive to that directory,
  313.        so it would contain AT LEAST three files:
  314.  
  315.             IRCDOOR.EXE
  316.        IRCDOOR.CFG
  317.             IRCDOOR.HLP
  318.  
  319.     c) Next, set up your BBS software for this door to be run; use
  320.        either DOOR.SYS (recommended) or DORINFO?.DEF format drop-
  321.        file. It should be created prior to running IRCDOOR by your
  322.        BBS software (see your BBS manual for details). Your BBS
  323.        software might be able to pass some information to IRCDOOR
  324.        via command-line: IRC server name, COM port number (instead
  325.            of a hot handle), etc. Even some parameters in the drop-file
  326.            can be overriden through a command-line. See command-line 
  327.            switches in the Comments section for more information about
  328.            IRCDOOR/2 command line parameters.
  329.  
  330.        Now, some important things. IRCDOOR program expects open
  331.        com port handle parameter to be specified on command line,
  332.            however, when running from within a DOS BBS, handles are
  333.            not available, thus you will need to pass a COMx port device
  334.            parameter at command line instead of a com port handle;
  335.            where 'x' is a number of a COM port device to open. 
  336.  
  337.        Below is a sample DOS batch file to do the job. It executes
  338.            IRCDOOR in either remote or local mode, and passes a COM port
  339.            device name including port number, so that IRCDOOR could open
  340.            COM port device if running in remote mode. IRCDOOR is programmed
  341.            as it can be run from within a DOS session, so here it is called
  342.            from a DOS batch file:
  343.  
  344.            @echo off
  345.            cd \lora\doors\ircdoor
  346.            if "%1"=="" goto local
  347.            if "%1"=="0" goto local
  348.  
  349.            :remote
  350.            rem *** the following command causes IRCDOOR not to use ready
  351.            rem *** port handle, but to open the COM port device.
  352.        rem *** Change the path below to specify a path to YOUR
  353.        rem *** drop file. In multinode environments, this usually
  354.        rem *** depends on a node number.
  355.            ircdoor -pCOM%1 -dc:\lora\node%2\door.sys -k%2 -sirc.nada.kth.se
  356.            goto quit
  357.  
  358.            :local
  359.            ircdoor -l -uSysOp -nSysOp -r"My Name" -sirc.funet.fi $6666
  360.            goto quit
  361.  
  362.            :quit
  363.            if exist nodeinfo.%2 erase nodeinfo.%2
  364.            rem *** back to BBS directory
  365.            cd \lora
  366.  
  367.         This small DOS batch file above will do it. It requires
  368.        two arguments: 1 - com port number and 2 - BBS node number.
  369.        COM port number is used to open a serial port device, and
  370.        the BBS node number is required to specify a full
  371.        path (including filename) to your BBS drop file. IRCDOOR will
  372.            automatically determine drop file type by it's name, therefore
  373.            the name of a drop file is required too. See command line
  374.        switches for more information about parameters.
  375.  
  376.     d) Edit your STARTUP.CMD file in your system root directory
  377.        and add there the following line:
  378.  
  379.         erase c:\ircdoor_home_directory\nodeinfo.* >nul
  380.  
  381.        This command will erase old node information files from the
  382.        IRCDOOR home directory. Ircdoor_home_directory must be
  383.        replaced with the directory name where IRCDOOR/2 files are
  384.        located.
  385.  
  386.        IRCDOOR/2 creates and uses nodeinfo.* files in it's home
  387.        directory and it automatically deletes them when a user
  388.        exits the door. But if you encounter a system crash during
  389.        the time when IRCDOOR is running, you should manually
  390.        remove nodeinfo.* files from it's home directory to prevent
  391.        IRCDOOR from thinking that it is running at the moment.
  392.        That's why the best way to avoid this is to insert that
  393.        mentioned erase command above to your STARTUP.CMD file so
  394.        whenever your system reboots, old IRCDOOR node information
  395.        files will be deleted.
  396.  
  397.     6.0 IRC commands supported by IRCDOOR/2
  398.  
  399.     The following is a list of IRCII commands currently
  400.     implemented in IRCDOOR/2:
  401.  
  402.         /LIST               Lists all current irc channels, number of
  403.                             users, and topic. (slow and can terminate
  404.                             connection on some servers)
  405.  
  406.         Example on /LIST command: /LIST -min 10
  407.  
  408.  
  409.         /NAMES              Shows the nicknames of all users on each
  410.                             channel
  411.  
  412.         /JOIN <channel>     Join the named channel. All non-commands
  413.                             you type will now go to everyone on that
  414.                             channel. Channel must start with the '#'
  415.                             character. If you are on a channel, the
  416.                             /JOIN command will also automatically
  417.                             get you out of the channel you are cur-
  418.                             rently in, and will bring you to the
  419.                             specified one.
  420.  
  421.         Example on /JOIN command:
  422.           /JOIN #usa
  423.  
  424.  
  425.         /MSG <nick> <msg>   Sends a private message to the specified
  426.                             person.  Only the specified nickname will
  427.                             see this message.
  428.  
  429.         Example on /MSG command:
  430.           /MSG Hoolio Hello Hoolio!
  431.  
  432.  
  433.         /NOTICE <params>    Params are identical as to /MSG command,
  434.                             the only difference to /MSG command is that
  435.                             /NOTICE sends a notice, not a message.
  436.  
  437.         Example on /NOTICE command:
  438.           /NOTICE Dink Here i am. :-)
  439.  
  440.  
  441.         /NICK <nick>        Change your nickname
  442.                             When you're connected, your BBS login name
  443.                             is usually taken as the default 'nickname'
  444.                             for yourself. You may wish to change this
  445.                             with this command.
  446.  
  447.         Example on /NICK command:
  448.           /NICK IRCD00R
  449.  
  450.         /QUIT or /BYE       Exits IRC.
  451.  
  452.         /HELP               Gets IRCDOOR online help menu. When using
  453.                 online IRCDOOR help system, use ENTER and
  454.                 numeric keys to navigate around. When
  455.                 IRCDOOR displays a [more] message on your
  456.                 screen, you might wish to quit listing by
  457.                 pressing ESCAPE or Q key.
  458.  
  459.         /WHO <channel>      Shows who is on a given channel,
  460.                             including nickname, user name and host,
  461.                             and realname.
  462.  
  463.         /WHOIS <nick>       Shows the "true" indentity of someone
  464.                             Use this often to make sure you know who
  465.                             you are talking to, because nicknames are
  466.                             NOT owned so any number of people could
  467.                             use a nickname.
  468.  
  469.         /WHOWAS <nick>      This command asks for information about a
  470.                             nickname which no longer exists. This may
  471.                             either be due to a nickname change or the
  472.                             user leaving IRC.
  473.  
  474.         /MODE <params>      Allows both usernames and channels to have
  475.                             their mode changed. This can be only used
  476.                             by channel operators. The <params> should
  477.                             contain valid parameters for the /MODE
  478.                             command i.e. the channel name, the
  479.                             nickname (when appropriate), and the /MODE
  480.                             command switches. The following listed are
  481.                             some most used /MODE commands:
  482.  
  483.         /MODE <channel> <+|->o <nick> - take/give the channel operator
  484.                                         privileges for the specified
  485.                                         user.
  486.         /MODE <channel> <+|->i        - change invite-only flag for
  487.                                         the specified channel.
  488.         /MODE <channel> <+|->p        - change private flag for the
  489.                                         specified channel.
  490.         /MODE <channel> <+|->s        - change secret flag for the
  491.                                         specified channel.
  492.         /MODE <channel> <+|->t        - change topic-setable flag for
  493.                                         the specified channel.
  494.         /MODE <channel> <+|->n        - set/unset no messages to
  495.                                         channel from the outside flag.
  496.         /MODE <channel> <+|->m        - change moderated channel flag
  497.                                         for the specified channel.
  498.         /MODE <channel> <+|->l <lim>  - set/unset the user limit to
  499.                                         channel.
  500.         /MODE <channel> <+|->b <user> - set/unset a ban mask to keep
  501.                                         the specified user out of the
  502.                                         channel.
  503.         /MODE <channel> <+|->v <user> - give/take the ability to speak
  504.                                        on the moderated channel.
  505.         /MODE <channel> <+|->k <pass> - set/unset a channel password.
  506.  
  507.         Examples on /MODE command:
  508.           /MODE #latvia -o Kaspariic
  509.           /MODE #gonnabe +b *!*@microsoft.com
  510.  
  511.         /KICK <params>      The KICK command can be used to forcibly
  512.                             remove a user from a channel. It 'kicks
  513.                             them out' of the channel (forced PART).
  514.                             This can only be used by channel opera-
  515.                             tors. The <params> consist of the spaced
  516.                             <channel>, <nick> and <comment> options.
  517.                             Note: the <comment> option is not
  518.                 obligate.
  519.         
  520.         Example on /KICK command: 
  521.           /KICK #ircdoor Lamer Lamers not allowed
  522.  
  523.         /INVITE <params>    The INVITE message is used to invite users
  524.                             to a channel. The <params> should consist
  525.                             from parameter <nickname>, which is the
  526.                             nickname of the person to be invited, and
  527.                             parameter <channel>, which is the target
  528.                             channel to invite the user to.
  529.  
  530.         Example on /INVITE command:
  531.           /INVITE JohnDoe #legends
  532.  
  533.         /TOPIC <params>     The TOPIC message is used to change o
  534.                             view the topic of a channel. The <params>
  535.                             can contain two parameters: the <channel>
  536.                             and the <topic>. The topic for channel
  537.                             specified in the <channel> is returned if
  538.                             there is no <topic> parameter given. If
  539.                             the topic parameter is present, the topic
  540.                             for that channel will be changed, if the
  541.                             channel modes permit this action, and if
  542.                             you are the channel operator.
  543.  
  544.         Example on /TOPIC command:
  545.           /TOPIC #switzerland Weather In Switzerland
  546.  
  547.         /PART <channel>     Lets you leave the specified channel. You
  548.                             may also use the /LEAVE command to leave
  549.                             a channel, but generally you won't need
  550.                             to use this command because /JOIN will
  551.                             automatically get you out of current
  552.                             channel and bring you to the specified one.
  553.  
  554.         /CTCP <nick> <cmd>  The /CTCP command sends a CTCP request
  555.                             to the specified user on IRC. The <cmd>
  556.                             parameter is a valid CTCP request command.
  557.  
  558.         The following are supported CTCP request commands:
  559.  
  560.     CLIENTINFO          Obtains information about other IRCDOOR/2
  561.                 internal CTCP request commands.
  562.     PING            Will generate a reply on remote's "PING"
  563.                 message.
  564.     TIMELEFT        This is internal IRCDOOR/2 CTCP command
  565.                 that let's an IRC user to query how much
  566.                 time is left for the IRCDOOR/2 user.
  567.                 This only applies to remote BBS users.
  568.     USERINFO        Obtains user information on a client. User
  569.                 information includes user's name, city,
  570.                 nickname, IRC server he is connected to,
  571.                 and IRCDOOR/2 version information.
  572.     VERSION                Obtains version information on a client.
  573.                 IRCDOOR/2 version information will be sent.
  574.  
  575.         Examples on /CTCP command:
  576.           /CTCP MisterX CLIENTINFO
  577.           /CTCP JohnDoe VERSION
  578.  
  579.  
  580.         /PING <client>      The PING message is used to test the
  581.                             presence of an active client at the other
  582.                             end of the connection. It can be used to
  583.                             ping clients, servers and nicknames.
  584.  
  585.         /VERSION <server>   The VERSION message is used to query the
  586.                             version of the server program. An optional
  587.                             parameter <server> is used to query the
  588.                             version of the server program which a
  589.                             client is not directly connected to.
  590.                             Note: for getting versions for clients,
  591.                             use the /CTCP <nick> VERSION command.
  592.  
  593.         /SERVER <params>    This command allows you to change current
  594.                             IRC server without exiting the door. This
  595.                             command may not be available if SysOp
  596.                             doesn't want to allow remote users to
  597.                             change IRC servers. The <params> consist
  598.                             of two parameters, <server> and <port>.
  599.                             <server> specifies a server to connect
  600.                             to, and <port> is an optional port number,
  601.                             or 6667 if not specified.
  602.  
  603.         Example on /SERVER command:
  604.           /SERVER irc.funet.fi 6666
  605.  
  606.  
  607.     /QUOTE <params>    The /QUOTE command lets you to send a custom
  608.                            reply to IRC server. For example, some IRC
  609.                            servers on Undernet require clients to send
  610.                            the PONG reply. With "/QUOTE PONG" command
  611.                            the PONG reply is sent back to the server.
  612.                            You may also use /QUOTE command to send any
  613.                            other commands, which are not nativaly
  614.                            supported by IRCDOOR.
  615.  
  616.  
  617.     7.0    IRCDOOR/2-specific commands
  618.  
  619.         /TIMELEFT           The /TIMELEFT command lets the user to
  620.                 check how much time left for his IRC
  621.                 session. This only applies to the remote
  622.                 BBS callers. For local callers, their
  623.                 session time is not limited.
  624.  
  625.         /WHOELSE            The /WHOELSE command lets the user to
  626.                 review who else is using IRC from the
  627.                 same BBS at that present moment.
  628.  
  629.  
  630. 8.    Comments
  631.  
  632.     -------------------------------------------------------------
  633.  
  634.     As you can see, IRCDOOR/2 is full of features that could
  635.     make your BBS users feel happy. There is lot of work spent
  636.     to make the IRCDOOR as good as it is now, and i'd like to
  637.     thank the following people who have been alpha-testing IRCDOOR
  638.     and helped me a lot:
  639.  
  640.     Bob Juge,
  641.         Andy Tarasov
  642.  
  643.     I am also thankful to my wife, Nataly, my father Longin,
  644.     and to all my friends who were understanding me why i
  645.     could not go for holidays, and for their advise on where
  646.     to go next. :)
  647.  
  648.     -------------------------------------------------------------
  649.     Some words about me: i am independent programmer and i
  650.     am interested in job opportunity in other countries.
  651.     I have experience in DOS, Windows and now OS/2 programming,
  652.     and i am looking for a company wishing to employ me at a
  653.     constant or contract job. If you could help me with this,
  654.     please let me know As Soon As Possible!
  655.  
  656.     You are    welcome to visit my WWW home page at my own WWW server:
  657.  
  658.         http://www.andrews.net.lv/~mrbyte
  659.  
  660.         The IRCDOOR home is
  661.  
  662.                 http://www.andrews.net.lv/software/ircdoor.html
  663.  
  664.     Check it out! There is also a growing FAQ list about the door.
  665.  
  666.     -------------------------------------------------------------
  667.  
  668.     IRCDOOR/2 Command-line usage:
  669.  
  670.         ircdoor [{-p<handle> -d<dpath>} | {-l}] [-h<hostname>
  671.         -n<nickname> -u<username> -r<realname> -s<server>
  672.         -$<port> -t<time> -k<node>] [flags]
  673.  
  674.     Information about parameters:
  675.  
  676.     -p<handle> specifies an open OS/2 com port "handle" to use or
  677.         a com port device name (including the port number).
  678.  
  679.         If you are going to run IRCDOOR from a OS/2 BBS, then you
  680.         should specify a open com port handle number as a parameter.
  681.     <handle> is not a number of a com port, it's a handle that the
  682.     OS returns when you open com port under OS/2. Normally an OS/2
  683.     BBS can pass a com port handle to an external program, doors,
  684.     etc. Maximus BBS software is a typical example.    However, if
  685.     your BBS software cannot pass a com port handle through 
  686.     command line (common for DOS BBS software), you will need to
  687.         pass a COM port device name directly, instead of a handle.
  688.         For example, the following command causes IRCDOOR to open
  689.         COM1 port device:
  690.  
  691.         ircdoor.exe -pCOM1 -dC:\RENEGADE\DOOR.SYS -s"irc.nol.net"
  692.  
  693.     -d<path> specifies a full path to created door drop-file.
  694.     The path SHOULD include filename too. Supported drop-files
  695.     are currently DOOR.SYS and DORINFO?.DEF. If i receive
  696.     submissions to add support for more drop-file formats, i will
  697.     be add to do so.
  698.  
  699.     The -p and -d switches specified on command line indicate that
  700.     the door should be run from a BBS, obviously in remote mode.
  701.     See sample OS/2 command file for reference.
  702.  
  703.     -l parameter indicates that the door should be run in local
  704.     mode. Note: if -p or -d (or both) are omitted, the door will
  705.     assume local mode as well. 
  706.  
  707.     -h<hostname> specifies local host name for your machine. This
  708.     is usually localhost, specified in your IAK configs. Local
  709.     host value is used to register a particular IRC user on IRC
  710.     server.
  711.  
  712.     -n<nickname> specifies nickname to use for IRC. By default,
  713.     BBS alias of a user will be read from BBS drop-file, and
  714.     used as nickname. However, it can be specified via command
  715.     line too.
  716.  
  717.     -u<username> specifies local user name on your machine. The
  718.     username and the localhost are two things that construct the
  719.     e-mail address of a IRCDOOR/2 user. If it's not specified,
  720.     username of 'ircdoor' will be used. This option is only
  721.     available in the registered version of IRCDOOR.
  722.  
  723.     -r<realname> indicates user's real name to use for
  724.     registering on IRC server. Realname (as well as nickname) is
  725.     automatically read from BBS drop-file, and presented to a
  726.     user upon the start. This option is only allowed in the
  727.     registered version of IRCDOOR.
  728.  
  729.     -s<server> indicates IRC server name or IP address to connect
  730.     to. Consider using IRC server that is closer to your location.
  731.     There are some servers provided in the IRC.MEX sample code,
  732.     but if you don't live in Scandinavian countries or Baltics,
  733.     consider using other IRC servers than those.
  734.  
  735.     -$<port> parameter is used to specify a port number for the
  736.     server. Normally, it is 6667. This is also by default.
  737.     However, you can always specify a non-standard port number
  738.     for IRC.
  739.  
  740.     -t<time> parameter specifies time (in seconds) for the IRC
  741.     session. This only works in remote mode. If your BBS software
  742.     cannot pass time value in seconds, let me know and i'll add
  743.     support for minutes. :) Note: the value is automatically
  744.     read from BBS drop-file. Override it (if you wish) from the
  745.     command line.
  746.  
  747.     -k<node> parameter specifies a BBS node number, on which
  748.     IRCDOOR is run. This parameter is only required if the node
  749.     information cannot be obtained from the BBS drop-file e.g.
  750.     DORINFO?.DEF, or IRCDOOR is running in local mode.
  751.  
  752.     Now about flags:
  753.  
  754.     Flags are used to toggle some operational stats of the
  755.     IRCDOOR/2. They are specified as a normal switch, and a
  756.     plus "+" or a minus "-" should be added to enable or
  757.     disable a particular option. The following are flags used
  758.     in current version of IRCDOOR/2:
  759.  
  760.     -o    When enabled (through -o=on/off), all remote user's input
  761.         and output will be shown on the sysop's local screen.
  762.         This is useful if you want to see who is doing what
  763.         and where on IRC, ;) but it might consume some system
  764.         resources to display the information on your screen.
  765.         This option is enabled by default.
  766.  
  767.     -------------------------------------------------------------
  768.  
  769.     If you cannot or wish not to setup IRCDOOR/2 with your BBS
  770.     software, but if you would like to see how the door looks
  771.     in practice, feel free to telnet to:
  772.  
  773.         andrews.net.lv (194.8.7.67)
  774.  
  775.     and see it with your own eyes. You might be able to figure
  776.     out whether it's fair enough to register, then.
  777.  
  778.     What are differences between the registered and unregistered
  779.     versions of IRCDOOR/2?
  780.  
  781.     The following is a list of features that are currently
  782.     disabled in the shareware version, and are fully available
  783.     when you register your copy of IRCDOOR:
  784.  
  785.        - time for the IRC session is limited to 10 minutes. The
  786.          registered version allows to change it to whatever you
  787.          want.
  788.  
  789.            - channel op's commands (/MODE, /KICK, /INVITE, /TOPIC)
  790.          and /CTCP requests aren't available in the shareware
  791.          version. They are fully available in the registered
  792.          version.
  793.  
  794.            - username and realname cannot be changed in the shareware
  795.          version. You might set them only in the registered
  796.          IRCDOOR version.
  797.  
  798.  
  799. 9.    Registration information
  800.  
  801.     As stated in the license agreement, IRCDOOR/2 is distributed
  802.     as "shareware". By this, it is meant that the IRCDOOR/2
  803.     user can use the door for a limited time of 28 days, and
  804.     then whether register, or discontinue using it.
  805.  
  806.     If you wish to register your copy of the IRCDOOR/2, please
  807.         see the file REGISTER.TXT and ORDER.FRM for registration and
  808.         order information.
  809.  
  810. 10.    IRCDOOR/2 distribution information
  811.  
  812.     Latest shareware versions of IRCDOOR/2 should be obtained from
  813.     the following sites:
  814.  
  815.         ftp.dcbalt.vernet.lv      (*)
  816.           /base2/bbsfiles/comm/bbsdoors/ircdoor/ircdor*.zip
  817.         juge.com          (*)
  818.           /ircdoor/ircdor*.zip
  819.         hobbes.nmsu.edu
  820.           /os2/network/tcpip/ircdo*.zip  or  /os2/incoming/ircdo*.zip
  821.  
  822.     IRCDOOR/2 can be file-requested across Fidonet under magic
  823.     name 'IRCDOOR' from the following nodes:
  824.  
  825.         2:5100/33  (telnet: bbs.dcbalt.vernet.lv) (*)
  826.         1:106/2000 (telnet: juge.com) (*)
  827.  
  828.     (*) - IRCDOOR/2 distribution site.
  829.  
  830. 11.    Contact information
  831.  
  832.     If you encounter problems using the door, find bugs, etc.,
  833.     please feel free to contact the author at one of the
  834.     following e-mail addresses below:
  835.  
  836.     mrbyte@andrews.net.lv,
  837.     mrbyte@dcbalt.vernet.lv,
  838.     mrbyte@unix.dcbalt.vernet.lv
  839.  
  840.         or, you can reach me on Fidonet at 2:5100/33 (my BBS), or
  841.     even telnet directly to my BBS (andrews.net.lv) and
  842.     leave a comment to the SysOp. If you wish to test the door,
  843.     you can register on my BBS as a new user and try the door
  844.     by yourself.
  845.  
  846.     Happy IRC!
  847.     Andrew Eigus (aka Mr. Byte)
  848.  
  849.     7/Feb/96
  850.  
  851. EOF