home *** CD-ROM | disk | FTP | other *** search
/ back2roots/padua / padua.7z / padua / ftp.vapor.com / amirc / old / amirc_22.lha / AmIRC_22 / AmIRC.doc < prev    next >
Encoding:
Text File  |  1998-09-26  |  112.5 KB  |  4,155 lines
  1.  
  2.  
  3. AmIRC2.1 Guide - Table Of Content
  4. *********************************
  5.  
  6. Welcome to AmIRC, the AmigaOS IRC client (Version 2.1).
  7.  
  8. Take your time to read this guide thoroughly to make yourself aquainted
  9. to the many functions and options AmIRC has to offer. This will greatly
  10. help you make the most out of your IRC experience with AmIRC!
  11.  
  12. Please don't forget to read also the Readme file included in the
  13. distribution archive.
  14.  
  15. What's new?
  16. ***********
  17.  
  18. New features in AmIRC v2.1
  19. ==========================
  20.  
  21. Added since v2.0:
  22. -----------------
  23.  
  24.    * New Single Channel Window mode allows to join multiple channels
  25.      in a single window.
  26.  
  27.    * INFO Window has an additional Levelmeter which shows the number
  28.      of unsent messages in the output queue.
  29.  
  30.    * AmIRC now also supports Contact Manager and can parse URLs from
  31.      the URL Grabber to it.
  32.  
  33.    * The Scrollback Buffer can now be limited in size via Prefs.
  34.  
  35.    * Number of Query Windows can be limited.
  36.  
  37.    * AmIRC will now use openurl.library, if found, to send the URL to
  38.      the browser.
  39.  
  40.    * AmIRC uses Vapor Update Library to check for new versions upon
  41.      startup. When a new version is available it can then be downloaded
  42.      automatically.
  43.  
  44.    * You can now Ban Multiple users at once by multi-selecting them.
  45.  
  46. Other new features:
  47. -------------------
  48.  
  49.    * Invitations are now shown in an seperate Invite requester. The
  50.      requester can be disabled from the new 'Windows' section in the
  51.      preferences.
  52.  
  53.    * The Lag-O-Meter permanently monitors and shows lag as a
  54.      three-color bar underneath the userlist. Clicking on the
  55.      Lag-O-Meter opens the Information window, which has a graphical
  56.      representation of the current lag, as well as the servername,
  57.      current lag, last two lag probes and the average lag.
  58.  
  59.    * Frequently used channels can be stored in a Favorite Channels
  60.      window from where you can join them by doubleclicking on them.
  61.  
  62.    * The new Tray window contains a button for every AmIRC window.
  63.      Windows can be closed individually by clicking on their 'Hide'
  64.      gadget. The Tray window shows number of messages in a window and
  65.      indicates new messages after iconification. (Requires MUI v3.8+)
  66.  
  67.    * Dialog windows have a Rename button to change the nick for the
  68.      window. Useful when someone re-enters IRC with a different nick.
  69.  
  70.    * Dialog and Channel windows have an [L] button to enable logging
  71.      of that windowto a file.
  72.  
  73.    * AmIRC now uses NList.mcc for it's listviews if found.
  74.  
  75.    * DCC windows now have a Cleanup button to delete all finished or
  76.      aborted transfers at once.
  77.  
  78.    * The /BACK command resets the Away state no matter what it is.
  79.  
  80.    * DCC Receive window has a Replace button to overwrite existing
  81.      files.
  82.  
  83.    * DCC Reveive window has a MIMEPrefs button to call up the
  84.      MIMEPrefs program.
  85.  
  86.    * The Auto accept DCC send? menu item allows to start incoming DCC
  87.      send requests without the need for confirmation.
  88.  
  89.    * AmIRC now uses MIMEPrefs for for viewing files.
  90.  
  91.    * AmIRC now has a Plugin API, expect many seperately developed
  92.      extension modules.
  93.  
  94.    * The Serverlist is now divided into Server Groups to allow better
  95.      organization of different servers of a network.
  96.  
  97.    * The Prefs menu has a new Windows section where can be determined
  98.      which windows will open on startup.
  99.  
  100. Copyright
  101. *********
  102.  
  103. Copyrights, author info and more
  104. ================================
  105.  
  106. AmIRC has been designed, developed and written by
  107.  
  108.          Oliver Wagner
  109.      Landsberge 5
  110.      45549 Sprockh÷vel
  111.      Germany
  112.      E-Mail: <owagner@vapor.com>
  113.      
  114.      ⌐1996-1998 Oliver Wagner
  115.      All Rights Reserved.
  116.  
  117. This document was originally written by Laurence Walton <lww@vapor.com>
  118. and modified for the 1.65 release by Oliver Wagner, including Ariel
  119. Magnum's <amagnum@ibm.net> fine ARexx guide. Updated and revised for
  120. the AmIRC v2.1 release by Frank Mosch <frankm@glo.be>.
  121.  
  122. Installer Script ⌐1995-98 Robert C. Reiswig All Rights Reserved
  123.  
  124. No part of this archive may be redistributed except with the entire
  125. contents of the original archive.
  126.  
  127. Registration
  128. ************
  129.  
  130. Registering AmIRC
  131. =================
  132.  
  133. You may use AmIRC freely for a period of up to 30 days to evaluate the
  134. package. After those 30 days, you must either register AmIRC or stop
  135. using it completely. During the trial period, AmIRC is limited to a
  136. online time of 30 minutes, besides that, no functions are disabled.
  137.  
  138. To register AmIRC, see the included registration utility and assorted
  139. documentation. It has all the necessary info and prices.  You can also
  140. register online at http://www.vapor.com/.
  141.  
  142. IRC
  143. ***
  144.  
  145. What is IRC, by the way?
  146. ========================
  147.  
  148. IRC stands for Internet Relay Chat, originally written by Jarkko
  149. Oikarinen <jto@tolsun.oulu.fi>. In a nutshell, IRC consists of a network
  150. of computers (servers) that are connected to each other via the
  151. internet or a LAN, and allow users with proper client software to
  152. connect and chat with each other. Within this network, virtual space is
  153. divided up into channels, usually with a topic of conversation, where
  154. users can talk in groups.
  155.  
  156. IRC Terms
  157. *********
  158.  
  159. Terms you might encounter
  160. =========================
  161.  
  162. Here's a list of some commonly used terms and expressions with their
  163. respective explanation:
  164.  
  165.    * Action: CTCP Action command, executed by a /ME at the
  166.      beginning of a message.
  167.  
  168.    * Ban: A channel mode set in order to prevent a user or group
  169.      of users from joining a channel.
  170.  
  171.    * Bot: Short for Robot, a Bot is a script that acts like a user,
  172.      and can execute a command upon a certain occurance.
  173.  
  174.    * Client: Software that is written for the purpose of connecting
  175.      to a server, in this case, an IRC server.
  176.  
  177.    * Channel: A group of users on IRC. A channel will have a name
  178.      (i/e, #AmIRC), and may or may not have a topic of conversation.
  179.  
  180.    * Channel Mode: The properties of a channel that allow or
  181.      disallow certain activities. Channel Modes can only be changed or
  182.      set by Channel Operators. The available channel modes are:
  183.  
  184.         - Invite Only: If active, This mode allows users to join if
  185.           they have been invited by someone in the channel.
  186.  
  187.         - Private: If active, the channel is invisible in the
  188.           global channel list.
  189.  
  190.         - Lag: The term which is used when the connection to a server
  191.           or client is delayed.
  192.  
  193.         - Limit: If active, sets a limit on the number of users
  194.           allowed to join a channel.
  195.  
  196.         - Moderated: If active, only Channel Operators and
  197.           users with voice may type input to the channel.
  198.  
  199.         - No Messaging: If active, prevents users from sending a
  200.           message to the channel until they have joined it.
  201.  
  202.         - Secret: If active, the channel is invisible until it is
  203.           joined.
  204.  
  205.         - Topic Protection: If active, only Channel Operators may
  206.           set or change the topic of a channel.
  207.  
  208.    * Channel Operator (or OP): A user who has control over a
  209.      channel.  A user who creates a channel is given Op status,
  210.      and in turn can give it to anyone else in the channel.
  211.  
  212.    * Chat Network: A network of computers that are interconnected so
  213.      that anyone on any server in the network may chat with anyone else
  214.      on any computer in that same network.  Here's some major chat
  215.      networks:
  216.  
  217.         - ARCnet: Amiga Relay Chat Network, partially running on
  218.           Amiga servers.
  219.  
  220.         - IRCnet: Formerly part of EFnet, now split.
  221.  
  222.         - EFnet: Eris Free Network. The largest IRC network
  223.  
  224.         - DAL-Net: A different IRC network with some specialized
  225.           functons that do not appear in typical IRC networks.
  226.  
  227.         - Undernet: An alternative IRC network
  228.  
  229.    * Command: A message to an IRC server or to a local or remote
  230.      client.  Commands generally begin with a /.  See Commands.
  231.  
  232.    * CTCP: Client To Client Protocol, A standard for sending commands
  233.      from one client to another, usually for the purpose of getting
  234.      information from the remote client. See CTCP.
  235.  
  236.    * DCC: Direct Client Connection - a standard for creating a direct
  237.      link between two clients, for the purpose of sending or receiving
  238.      files, or to carry a more secure conversation. See DCC.
  239.  
  240.    * IdentD: IdentD is software that can be run on the client,
  241.      allowing an IRC server to corroberate the identity of a client.
  242.      AmIRC has an IdentD built in, and will automatically disable it if
  243.      an external IdentD is running.
  244.  
  245.    * IRC: Internet Relay Chat - Any Network of Computers that run
  246.      IRC servers for the purpose of allowing users to connect to it
  247.      using client software made for IRC.
  248.  
  249.    * Kick: The occurance of a user being removed from a joined
  250.      channel by a channel operator.
  251.  
  252.    * Lag: Term to specify that the connection is delayed to some
  253.      extend.
  254.  
  255.    * MOTD: Message Of The Day, A message that may or may not be
  256.      updated daily, that is meant to be read when connecting to an IRC
  257.      server.
  258.  
  259.    * Netsplit: An event that occurs when a server goes down that
  260.      other servers depend on for network packets. Any servers that are
  261.      dependant on the crashed server will split from the net, that is,
  262.      they will still be up and running, with active clients, but any
  263.      clients on the other side of the crashed unit will appear to have
  264.      all logged off at once.
  265.  
  266.    * Nick: Short for Nickname, this is an alias that you may pick for
  267.      yourself.
  268.  
  269.    * Op: See Channel Operator.
  270.  
  271.    * Server: A computer that is Running IRC server software, allowing
  272.      it to be connected to by IRC clients or other servers.
  273.  
  274.    * Server Operator: A person in control of an IRC server.
  275.  
  276.    * TLA (Three Letter Abreviations): Commonly used acronyms, not
  277.      entirely restricted to 3 letters:
  278.  
  279.         - AFAIK: As Far As I Know
  280.  
  281.         - AFK: Away From Keyboard
  282.  
  283.         - ASAP: As Soon As Possible
  284.  
  285.         - ATM: At The Moment
  286.  
  287.         - BRB: (I'll) Be Right Back
  288.  
  289.         - BBL: (I'll) Be Back Later
  290.  
  291.         - BBIAB: (I'll) Be Back In A Bit
  292.  
  293.         - BTW: By The Way
  294.  
  295.         - CU: Or Cya, See You
  296.  
  297.         - CUL: Or CUL8R, See You Later, Catch You Later
  298.  
  299.         - DL: Or D/L, Download
  300.  
  301.         - FAQ: Frequently Asked Questions
  302.  
  303.         - FWIW: For What It's Worth
  304.  
  305.         - FYI: For Your Information
  306.  
  307.         - IC: I See
  308.  
  309.         - IIRC: If I Remember Correctly
  310.  
  311.         - IMHO: In My Humble|Honest Opinion
  312.  
  313.         - L8R: Later
  314.  
  315.         - LOL: Laughs Out Loud
  316.  
  317.         - LTNS: Long Time No See
  318.  
  319.         - MOTD: Message Of The Day
  320.  
  321.         - NE1: Anyone
  322.  
  323.         - NP: No Problem
  324.  
  325.         - OTL: Out To Lunch
  326.  
  327.         - PLS: Or PLZ, Please
  328.  
  329.         - PPL: People
  330.  
  331.         - POV: Point Of View
  332.  
  333.         - RE: Welcome back, short for Regards
  334.  
  335.         - ROTFL: Rolls On The Floor Laughing
  336.  
  337.         - RSN: Real Soon Now
  338.  
  339.         - RTFM: Read The F***ing Manual
  340.  
  341.         - TIA: Thanks In Advance
  342.  
  343.         - TNX: Or Thnx, Thanks
  344.  
  345.         - TTYL: Talk To You Later
  346.  
  347.         - TTFN: Ta Ta For Now
  348.  
  349.         - UL: Or U/L, Upload
  350.  
  351.         - WB: Welcome Back
  352.  
  353.         - WTF: What(Why) The F***
  354.  
  355.    * Topic: A heading for a channel that may or may not have
  356.      anything to do with the conversation at hand.
  357.  
  358.    * User: A person using an IRC Client to connect to a server to
  359.      chat.
  360.  
  361.    * User Mode: Settings that affect a users properties.
  362.  
  363.         - Invisible: If this mode is set, a user will be invisible
  364.           in the global user list. The user will still be visible in
  365.           the user list of any joined channel, however.
  366.  
  367.         - Wallops: When set, this mode will allow receiving of
  368.           messages from the server operator to all operators.
  369.  
  370.    * Userhost: This is the string that defines a user.  It consists
  371.      of the user's chosen nick, login name and domain name.  For
  372.      example:
  373.      Wupper!jwupper@monorail.denet234.de
  374.      |      |       |        |      |_ Domain
  375.      |      |       |        |________ Network
  376.      |      |       |_________________ Machine
  377.      |      |_________________________ Login
  378.      |________________________________ Nick
  379.    * Voice: Status a normal (not an operator) user must have to type
  380.      into a moderated channel.
  381.  
  382. Features
  383. ********
  384.  
  385. Features of AmIRC
  386. =================
  387.  
  388.    * Runs with Genesis, AmiTCP, Miami and AS225 without additional
  389.      support libraries.
  390.  
  391.    * Built-in high speed DCC drivers for SEND and MOVE.  Highly
  392.      optimized with asynchronous file I/O and threaded network
  393.      handling. Supports Drag&Drop sending of files.
  394.  
  395.    * Transparent implementation of DCC CHAT. All /MSGs are
  396.      automatically routed via DCC CHAT if applicable, to save runtime
  397.      and reduce IRC load. Option to automatically accept DCC CHAT
  398.      connections.
  399.  
  400.    * Ultra fast text output and scrolling. Supports Cut&Paste for the
  401.      list text. Supports proportional fonts.
  402.  
  403.    * Full support of the 'Undernet' IRC extensions, both reply codes and
  404.      additional IRC commands.
  405.  
  406.    * Intuitive channel display with userlist and channel mode overview.
  407.      Channel modes can easily be changed via gadgets. Configurable user
  408.      action list to perform whatever action you like on users in channel
  409.      by the press of a mousebutton.
  410.  
  411.    * Supports QUERY windows for private chat.
  412.  
  413.    * Supports 'smart' banning.
  414.  
  415.    * Versatile AREXX port including server message parsing ("event
  416.      trapping") and commandline/script interaction.
  417.  
  418.    * Easy command line aliasing.
  419.  
  420.    * Builtin IdentD (automatically disabled if another IdentD is already
  421.      installed).
  422.  
  423.    * Supports nick notification, highlighting, ignoring, and kickban.
  424.  
  425.    * Versatile event handling allows you to bind sound effects,
  426.      auto-deiconify or rexx scripts to certain events.
  427.  
  428.    * Server phonebook.
  429.  
  430.    * Last nick history.  Stores the nicknames of the last nicks you've
  431.      send MSGs to, received MSGs from or addressed publically with
  432.      'nick:'.  Reference can be used in all commands which require nick
  433.      names, e.g.  /MSG, /OP, /DEOP. Automatic nick expansion on public
  434.      messages with ':'.
  435.  
  436.    * TAB messaging to automatically cycle the list of last used
  437.      nicknames with a /MSG prefix.
  438.  
  439.    * Auto rejoin channel on KICK and auto reconnect server facility.
  440.  
  441.    * Auto away after idle timeout. Auto unaway after sending public
  442.      and/or private msgs.
  443.  
  444.    * Auto update download.  Check for and download new releases with a
  445.      simple click.
  446.  
  447.    * URL grabber for interfacing with a web browser..
  448.  
  449.    * Support for DALnet extensions.
  450.  
  451. Requirements
  452. ************
  453.  
  454. What is needed to use AmIRC?
  455. ============================
  456.  
  457. Hardware
  458. --------
  459.  
  460. AmIRC was written for the Amiga family of computers, and has been
  461. tested on Amiga 500, 1000, 1200, 2000, 3000, & 4000 computers in various
  462. configurations.
  463.  
  464. Software
  465. --------
  466.  
  467. AmIRC requires MUI V3.6 or later in order to run.
  468.  
  469. AmIRC requires KickStart & WorkBench 2.x or later, with setpatch 40.16
  470. installed.
  471.  
  472. AmIRC020 requires a 68020 or higher CPU and OS3.0 or newer. This
  473. version is optimized for such machines.
  474.  
  475. If you plan to run a TCP/IP stack and AmIRC among other Internet
  476. applications you should have at least 2 megabytes of RAM.
  477.  
  478. Finally, you need to have a tcp/ip protocol stack running, such as
  479. Miami, AmiTCP/IP or Amiga Technology's as225r2 tcp/ip protocol stack.
  480.  
  481. Installation
  482. ************
  483.  
  484. How to install AmIRC
  485. ====================
  486.  
  487. AmIRC has its own installer script and requires that you have the Amiga
  488. installer utility (version 43.3 or later). To install, just click on
  489. the install icon, and answer the questions in the installer's
  490. requesters.
  491.  
  492. If you cannot or prefer not to use the installer utility, a manual
  493. install is very simple, just move the contents of the archive to a
  494. directory of your choice and it's ready to use. If you have met the
  495. Requirements for the optimized version of AmIRC, delete the AmIRC file
  496. and rename "AmIRC020" as "AmIRC".  You might want to copy the "MUI"
  497. directory of the AmIRC distribution to MUI:Libs/MUI/ to avoid version
  498. confusion.
  499.  
  500. Connecting
  501. **********
  502.  
  503. Let's have a go
  504. ===============
  505.  
  506. Once you have Installation AmIRC, you can start the program from WB by
  507. clicking on its icon. After a few moments you will see the server
  508. selection window.  The first thing you need to do is enter a nickname
  509. in the first 'Nicknames' gadget at the top of the window. This is how
  510. you will be known on IRC. It may be a good idea to enter some
  511. alternative nicks in the next three boxes. This way, if your nick is
  512. used by another person, AmIRC will retry with the next nick.
  513.  
  514. Next, enter your real name (plus your email address or www home page
  515. URL if you want) in the 'Real name' gadget. It is best if you are
  516. truthful.
  517.  
  518. Then, enter a username that will show as
  519. ½username╗@machine.network.org.  ½username╗ should be the same as the
  520. login ID for your service provider.
  521.  
  522. Note: If there is already an IdentD service running on your machine
  523. (usually by your TCP/IP stack) the username field will be ghosted and
  524. the usernam specified by the stack will be used.
  525.  
  526. Now you are ready to connect to an IRC network. The servers in the
  527. serverlisting are organized in server groups which usually represent
  528. the different networks. You can open and close the server groups, by
  529. doubleclicking on the group, to show or hide the servers in that
  530. specific group. AmIRC comes with a basic serverlist with one server for
  531. all popular networks.  Select the network you want to connect to and
  532. doubleclick on the server or use the 'New Server' button and enter the
  533. address and port number of your favorite server and then click on
  534. 'Connect'.  Optionally, you can add one or a few channels to autojoin,
  535. just separate them with a comma.  If you want to make an entire new
  536. server group use the 'New Group' button. You can move servers around
  537. the groups using drag&drop.  If you are already connected, and wish to
  538. connect to an additional server, select the server and use 'Connect
  539. Thread' to open a second instance of AmIRC.  Use the 'Copy' to make a
  540. duplicate of the currently selected server or group.  The 'Delete
  541. Server' button will remove a server that you no longer wish to use.
  542.  
  543. Operation
  544. *********
  545.  
  546. How Does AmIRC Work?
  547. ====================
  548.  
  549. The main AmIRC user interface is laid out in a logical, intuitive
  550. manner, making it easy to use. Here's an overview of the main interface:
  551.  
  552.    * The main feature of the interface is the Text Listview, where
  553.      all incoming text is displayed.
  554.  
  555.    * Directly below this is the Textinput Gadget, labeled with the
  556.      nickname that you have chosen. Any text entered here will be sent
  557.      out to the IRC server.
  558.  
  559.    * Directly next to the textinput gadget is the Logging Button
  560.      marked 'L'.  Clicking on it activates the logging of that window
  561.      to a file.
  562.  
  563.    * To the right of the listview is a Scroll Gadget, which enables
  564.      you to scroll backward through the text in the listview.
  565.  
  566.    * At the top left of the listview is a the Channelname Gadget that
  567.      shows the name of the channel that you have joined.
  568.  
  569.    * To the right of the channelname, is the Topic Input/Display
  570.      Gadget, where the topic of a joined channel is displayed.  If you
  571.      have Channel Operator (Ops) status, you may change the topic of
  572.      the channel by entering the topic in this gadget, and hitting the
  573.      'Enter' key.
  574.  
  575.    * To the right of the topic input gadget are theChannel Mode
  576.      Buttons, which display the current modes for the joined channel.
  577.      Users with Channel Operator (Ops) status may also use these
  578.      buttons to change the current channel modes.
  579.  
  580.         - T - Topic Protection: Toggles Topic Protecton on/off. If
  581.           on, the topic can be changed by Channel Operators (Ops) only.
  582.  
  583.         - N - No Messaging: Toggles Messaging on/off. If active, a
  584.           user can only write to the channel if they have joined it.
  585.  
  586.         - S - Secret: Toggles Secret mode on/off. If active, the
  587.           channel is invisible until it is joined.
  588.  
  589.         - I - Invite Only: Toggles Invite Only mode on/off. If
  590.           active, users can only join after they have been invited.
  591.  
  592.         - P - Private: Toggles Private mode on/off. If active, the
  593.           channel will be invisible in the global channel list.
  594.  
  595.         - M - Moderated: Toggles Moderated mode on/off. If active,
  596.           only channel operators (Ops) and users with 'voice' can type
  597.           to the channel.
  598.  
  599.         - L - Limit: Sets a limited number of users allowed on the
  600.           channel
  601.  
  602.         - K - Keyword: Toggles Keyword mode on/off. If active, Users
  603.           can only join the channel if they give the correct keyword.
  604.  
  605.         - B - Ban: Sets/Displays the current Bans active on the
  606.           channel
  607.  
  608.    * Below the channel mode buttons is the User Listview, which shows
  609.      a current list of users on the joined channel. Double clicking on
  610.      a users name will perform a /WHOIS on that user. Clicking once on
  611.      a users name will set that user as the default to perform other
  612.      operations on, such as an operation from the configurable user
  613.      buttons. Pressing the right mousebutton when on a name shows a
  614.      menu where you can select the same functions as the User Buttons
  615.      below.
  616.  
  617.    * Directly below the User Listview are theUser Buttons. These
  618.      buttons are configurable from the GUI window, accessable by
  619.      selecting 'Setup...' from the AmIRC Settings menu.
  620.  
  621.    * You can Drag-Hilight text in the listview in order to paste it
  622.      elsewhere.  you will need some type of snap utility such as
  623.      Newedit or Powersnap in order to past the text into another
  624.      application. The text is stored in the clipboard. To paste the
  625.      text inside AmIRC you can use <right-amiga> V.
  626.  
  627.      The TAB key will cycle through the names of people that have
  628.      previously /MSG'ed you, and insert it into the textinput gadget.
  629.      Simply enter your message after the "/MSG <user> " in order to
  630.      /MSG them back.
  631.  
  632.      Entering ':' first in the textinput gadget will automatically
  633.      publicly address the last person you typed to using the ':' after
  634.      their nick.
  635.  
  636. Menus
  637. *****
  638.  
  639. What's on the menu?
  640. ===================
  641.  
  642. Menus
  643. =====
  644.  
  645. AmIRC Menu
  646. ----------
  647.  
  648. Select Server...
  649.      Opens the server window from which you can select various options
  650.      for connecting to an IRC server. See Connecting.
  651.  
  652. Logging Enabled?
  653.      Toggles logging on/off.
  654.  
  655. Iconify
  656.      Hides the AmIRC window either in an icon on the Workbench screen
  657.      or in the WB Tools menu (selectable in MUI Prefs).
  658.  
  659. Help...
  660.      Opens Amirc.guide for reference while using AmIRC.
  661.  
  662. About AmIRC...
  663.      Opens a window with information about AmIRC and its Developer.
  664.      Here you may connect to the AmIRC home page if your browser is
  665.      running.
  666.  
  667. About MUI...
  668.      This will open a small window that displays information about the
  669.      current version of MUI that is installed on your system, also,
  670.      this window provides the option to register or update your MUI
  671.      software.
  672.  
  673. Quit
  674.      Will close the current instance of AmIRC, leaving other instances
  675.      open.
  676.  
  677. Menus
  678. =====
  679.  
  680. Windows Menu
  681. ------------
  682.  
  683. Channel Windows
  684.      If more than one AmIRC window is opened, you may select one here
  685.      to pop it to front.
  686.  
  687. Dialog Windows
  688.      If any dialog windows are open, you may select one here and bring
  689.      it to front.
  690.  
  691. Windows List...
  692.      Shows the tray window where all windows are represented by a
  693.      button. Hidden windows can be opened by doubleclicking that
  694.      window's button.
  695.  
  696. Channel List Window...
  697.      This will produce a window where you may list channels by min.
  698.      users, pattern matching, or both. Once listed, you may list users
  699.      on a channel or join it by double-clicking the channel name or
  700.      selecting 'join channel' gadget.  Please note that this function
  701.      can cause a high load of traffic and may take a while on slow
  702.      (14.4 or less) connections.
  703.  
  704. Notify Window...
  705.      In the Notify window you may enter nicks of users that you wish to
  706.      be notified of their entering/leaving IRC. The 'check period' is
  707.      how often AmIRC will check for the specified users. Add a nick to
  708.      the list by clicking in the input text gadget, and typing in the
  709.      nick. Delete a nick by clicking on it's entry and then click on
  710.      'Delete nick' gadget.
  711.  
  712. DCC-Send Window...
  713.      Brings up the DCC-Send window where you can specify a user and a
  714.      file to send to them. This window will also be opened
  715.      automatically when using the 'DCC send' userbutton on the
  716.      interface. 'Send Path' is the path (and filename) that will be sent
  717.      to the user. Enter the name of the user in the textinput gadget at
  718.      the bottom of the window. The cycle gadget next to the 'Nick'
  719.      gadget selects either 'DCC Send' or 'DCC Move' protocols. See DCC
  720.      section for details about these protocols.  The 'Reoffer' button
  721.      allows you to reoffer a (failed) file to the user. The 'Remove Job'
  722.      button will remove a complete transfer or if not complete, one
  723.      click will abort the send and the second click will remove it.
  724.      Finally, the 'Cleanup' button removes all finished or aborted
  725.      transfers from the window.
  726.  
  727. DCC-Receive Window...
  728.      The DCC-Receive window is very similar to the DCC-Send window.
  729.      This window will appear automatically on receiving a DCC request.
  730.      The files will be downloaded to the path entered in the 'Receive
  731.      Path' field. After a valid path is entered, click on an entry to
  732.      receive, then click the 'Get' gadget at the bottom. You can also
  733.      start the transfer by doubleclicking on the entry or enabling
  734.      'Auto accept DCC send requests' in the User Modes menu.  If you
  735.      are trying to receive after a failed send, you may use the
  736.      'Resume' button instead of 'Get'. This will attempt to start
  737.      transfer where it left off. If you wish to rename the incoming
  738.      file for whatever reason, you may use the 'Rename' button.  The
  739.      'Replace' button will cause the received file to replace any
  740.      present versions.  'Remove Job' will abort an incoming file and
  741.      remove a completed or aborted file.  'Cleanup' removes all
  742.      finished or aborted transfers. See DCC.
  743.  
  744. DCC-Chat Window...
  745.      In the DCC-Chat window you can confirm a DCC chat connection from
  746.      another user.  Simply select the client sending the request and
  747.      click on 'Open' to make the connection.  You can close the
  748.      connections using 'Close'. 'Cleanup' removes all closed DCC chat
  749.      connections. See DCC.
  750.  
  751. Raw Log Window...
  752.      The Raw Log window ca be used to view the raw IRC messages as they
  753.      appear before AmIRC formats them for easy reading in the AmIRC
  754.      listview.  Here you may also clear the log, and select when the
  755.      log is active: 'Never', 'Only if window open', or 'Always'.  The
  756.      log Listview shows the USERHOST, Type of message, Channel Name,
  757.      and message, in that order.
  758.  
  759. URL Grabber Window...
  760.      Any WWW WWW URL AmIRC recognizes it will place in the URL Grabber
  761.      window. From here you can select them and either send them to your
  762.      browser or the clipboard. You can also clear the list.
  763.  
  764. Private Msgs Window...
  765.      The Private Messages window holds a history of private messages
  766.      sent to you, which you can later reference or review. You can
  767.      ofcourse clear the list.
  768.  
  769. Info messages Window
  770.      The Info Messages window displays server messages, wallops
  771.      messages, and CTCP requests.  Any 'Shanghai' gadgets that are
  772.      activated will prevent that type of message from showing in the
  773.      main channel window, even when the info window is closed.  The
  774.      lower part of the window shows AmIRC's Lag-O-Meter. The VU style
  775.      meter is a graphical representation of the current lag to the
  776.      server. Next to the meter is the name of the server. Also shown
  777.      are the current lag, last two probes and the average of the last
  778.      two lags.
  779.  
  780. Flush Buffer
  781.      This item will clear the history of the main AmIRC listview.
  782.  
  783. Save Buffer...
  784.      This item allows you to select a filename to save the history
  785.      buffer to disk.
  786.  
  787. Menus
  788. =====
  789.  
  790. User Modes Menu
  791. ---------------
  792.  
  793. Invisible?
  794.      Toggles wether you're invisible in the global userlist or not. See
  795.      IRC Terms.
  796.  
  797. Receive Wallops?
  798.      Toggles wether you will receive messages to all operators or not.
  799.      See IRC Terms.
  800.  
  801. Receive Server Notices?
  802.      Toggles wether you receive server notices or not.
  803.  
  804. Marked AWAY?
  805.      Marks you are AWAY.
  806.  
  807. Auto rejoin on KICK?
  808.      If set, will automatically attempt to reconnect you to a channel
  809.      you have been kicked from. Note that if a ban was set with the
  810.      kick, you will not be able to rejoin.
  811.  
  812. Auto reconnect to server?
  813.      If set, this will automatically attempt to reconnect you to the
  814.      server if you are disconnected for any reason.
  815.  
  816. Auto open Dialog Windows?
  817.      If set, will automatically open chat window upon receipt of a /MSG
  818.      or DCC chat request.
  819.  
  820. Auto accept DCC chat requests?
  821.      If set, this will automatically accept DCC chat requests.  It will
  822.      not open a chat window for you, however. Do this by opening the
  823.      DCC chat window in the Windows menu.
  824.  
  825. Auto accept DCC send requests?
  826.      If set, this will automatically accept DCC send requests, so
  827.      downloading will start immediately.
  828.  
  829. Do BEEPS?
  830.      If set, AmIRC will send audio beeps (or samples, if configured in
  831.      the Events page of the settings requester) for certain events.
  832.  
  833. Play CTCP SOUND requests?
  834.      If checked, AmIRC will acknowledge and play /CTCP sound requests,
  835.      if this is configured properly.
  836.  
  837. Menus
  838. =====
  839.  
  840. Settings Menu
  841. -------------
  842.  
  843. Setup...
  844.      Calls the AmIRC Setup, allowing you to change the many settings of
  845.      AmIRC to suit your needs.
  846.  
  847. Lists...
  848.      Calls up the Lists, allowing you to configure AmIRC's Alias,
  849.      Ignore, and Hilite lists.
  850.  
  851. Function Keys...
  852.      Calls the Function Keys Settings Window, allowing you to configure
  853.      the function key macros.
  854.  
  855. MIMEPrefs...
  856.      Calls the MIMEPrefs program if present in the AmIRC directory or
  857.      Prefs:. It allows you to set global MIME settings for view and
  858.      saving files.
  859.  
  860. Dialog Window Buttons?
  861.      If set, the AmIRC dialog window will contain 4 gadgets in the
  862.      upper right corner.  These are labeled: 'Whois', 'Ping', 'DCC
  863.      Chat', & 'DCC Send'.  These gadgets will perform their respective
  864.      functions on the user that the dialog window is opened to.
  865.  
  866. Use MIMEPrefs for viewing?
  867.      If set, AmIRC uses the global MIME settings set with the MIMEPrefs
  868.      program to determine what program to view the received file with.
  869.  
  870. Use MIMEPrefs for saving?
  871.      If set, AmIRC uses the global MIME setting set with the MIMEPrefs
  872.      program to determine whether and where to save the received file.
  873.  
  874. Single Channel Window?
  875.      If set, AmIRC will only open one channel window at a time.
  876.      Messages in other channels will still be shown, however, with a
  877.      reference to the corresponding channel.
  878.  
  879. Load Settings...
  880.      Opens a requester allowing you to recall previously saved
  881.      non-default AmIRC Configurations.
  882.  
  883. Load settings from default
  884.      Reloads the last saved default configuration
  885.  
  886. Save Settings
  887.      Saves the current configuration under the last name set in the
  888.      'Save settings as...' menu item.  If the settings have not
  889.      previously been named, they are saved as default.
  890.  
  891. Save settings as...
  892.      Opens a requester allowing you to choose a filename to save the
  893.      current AmIRC configuration as other than default.
  894.  
  895. Save as default
  896.      Saves the current AmIRC configuration as the default startup
  897.      configuration.
  898.  
  899. Create icons?
  900.      If Checked, will create icons for saved configuration files,
  901.      allowing them to be selected from the Workbench.
  902.  
  903. Save Settings On Exit
  904.      If checked, this item will cause AmIRC to save the current
  905.      settings as default upon exiting the program.
  906.  
  907. MUI Settings...
  908.      Opens the MUI Prefs program for altering the MUI Configurable AmIRC
  909.      configuration.
  910.  
  911. Menus
  912. =====
  913.  
  914. Plugins Menu
  915. ------------
  916.  
  917. The Plugins menu shows a list of all installed AmIRC plugins. The
  918. plugins are located in the Plugins directory in the AmIRC directory. It
  919. also allows you to access any Plugin preference that may be available.
  920.  
  921. Menus
  922. =====
  923.  
  924. Rexx Menu
  925. ---------
  926.  
  927. This menu will Display any ARexx scripts that reside in AmIRC/Rexx/
  928. directory. AmIRC ARexx scripts should be named with the .amirx
  929. extension.  From this menu you may execute any existing AmIRC ARexx
  930. script. See the full ARexx for an indepth look on ARexx.
  931.  
  932. Using the commands in AmIRC.
  933. ****************************
  934.  
  935. Overview
  936. ========
  937.  
  938. AmIRC has many builtin commands. Some of these commands are processed
  939. locally, whereas others are sent to the IRC server.
  940.  
  941. Commands generally start with a '/' to differentiate them from normal
  942. text. If you want to use the / character at the start of normal text,
  943. use '//' instead.
  944.  
  945. Many commands require a channel name as a parameter. AmIRC will
  946. automatically fill in the channel name of the current window if you
  947. don't specify a channel name on your own.
  948.  
  949. For commands which require a nick name (e.g. /MSG or /OP, there
  950. are three special shortcut arguments:
  951.  
  952. .
  953.      The period is replaced with the nickname of the last person you
  954.      have send a private message to.
  955.  
  956. ,
  957.      The comma is replaced with the nickname of the last person who
  958.      send a message to you. Be careful with this, since you might
  959.      easily address the wrong person if someone sends you a message
  960.      while you are still typing this command!
  961.  
  962. :
  963.      The colon is replaced with the nickname of the last person which
  964.      you haved a addressed with a 'Nick:' prefix inside a channel.
  965.  
  966. You may easily carry a dialog with a particular user by first clicking
  967. on their username in the user list, then anytime you hit the TAB key,
  968. the input string will be set up with '/MSG <user> ', after which you
  969. may type in the message and hit return.  This will work after
  970. initiating a DCC request as well. Please note that if you have
  971. configured the user list as a separate window, you must reactivate the
  972. message window after clicking on a username.
  973.  
  974. Reference to all AmIRC commands
  975. ===============================
  976.  
  977. Commands
  978. ========
  979.  
  980. ?
  981. -
  982.  
  983. Usage: /? [Command]
  984.  
  985. With this command you can get a list of all available commands. When a
  986. command is added behind it, you get the correct command syntax.
  987.  
  988. Alternative: HELP
  989.  
  990. EXAMPLES:
  991.  
  992. /?
  993.      Will show a list of all available commands
  994.  
  995. /? Ping
  996.      Will show the correct command syntax for the PING command: Usage:
  997.      /PING [nick]
  998.  
  999. Commands
  1000. ========
  1001.  
  1002. ADMIN
  1003. -----
  1004.  
  1005. Usage: /ADMIN [Server]
  1006.  
  1007. The admin message is used to find the name of the administrator of the
  1008. given server, or current server if [Server] parameter is omitted.
  1009.  
  1010. EXAMPLES:
  1011.  
  1012. /ADMIN irctest.vapor.com
  1013.      Shows the information for the server irctest.vapor.com:
  1014.               ½Admin╗ Administrative info about irctest.vapor.com
  1015.           ½Admin╗ Vapor's experimental ARCNet Server
  1016.           ½Admin╗ Oliver Wagner <owagner@vapor.com>
  1017.           ½Admin╗ Slow Mess Clients Welcome(tm)
  1018.  
  1019. Commands
  1020. ========
  1021.  
  1022. ALIAS
  1023. -----
  1024.  
  1025. Usage: /ALIAS [Alias [Replacement, %p for alias parameters]
  1026.  
  1027. With ALIAS you can make an alias for frequently used terms. You can
  1028. also add parameters needed for certain commands using %p.
  1029.  
  1030. You can also change Aliases using the Lists.  EXAMPLES:
  1031.  
  1032. /ALIAS Goto Join %p
  1033.      You can now use: /GOTO #Test instead of /JOIN #Test
  1034.  
  1035. Commands
  1036. ========
  1037.  
  1038. AWAY
  1039. ----
  1040.  
  1041. Usage: /AWAY [message]
  1042.  
  1043. When used with the optional [message] argument, it will mark you as
  1044. being away and send the message to any client sending a MSG to you.
  1045. Otherwise, it will remove a previously set away message.
  1046.  
  1047. Related: BACK
  1048.  
  1049. EXAMPLES:
  1050.  
  1051. /AWAY eating dinner
  1052.      Will send the message '<nick> is away: eating dinner', where
  1053.      nick is the nickname of the user that is away.
  1054.  
  1055. /AWAY
  1056.      Will remove a previously set Away Message.
  1057.  
  1058. Commands
  1059. ========
  1060.  
  1061. BACK
  1062. ----
  1063.  
  1064. Usage: /BACK (no arguments)
  1065.  
  1066. Where AWAY toggles between setting and resetting the Away state.  This
  1067. command always resets the Away state and thus no longer marks you as
  1068. away.
  1069.  
  1070. Related: AWAY
  1071.  
  1072. EXAMPLES:
  1073.  
  1074. /BACK
  1075.      Will reset the away state and no longer marks you as away.
  1076.  
  1077. Commands
  1078. ========
  1079.  
  1080. BAN
  1081. ---
  1082.  
  1083. Usage: /BAN [channel] userhost[,userhost...]
  1084.  
  1085. This command will ban everyone with the specified userhost(s) from
  1086. entering the channel. With the optional channel argument you can setup
  1087. a ban on a different channel than the one in which window the command
  1088. is executed.
  1089.  
  1090. Related: BANDEL BANLIST KICK KICKBAN QKICK QKICKBAN
  1091.  
  1092. EXAMPLES:
  1093.  
  1094. /BAN bill@*.microsoft.com
  1095.      Will prevent a user called bill in the microsoft.com domain
  1096.      from entering the channel.
  1097.  
  1098. /BAN Amiga bill@*.microsoft.com
  1099.      Will ban user bill on microsoft.com from entering #Amiga.
  1100.  
  1101. Commands
  1102. ========
  1103.  
  1104. BANDEL
  1105. ------
  1106.  
  1107. Usage: /BANDEL [channel] userhost[,userhost...]
  1108.  
  1109. Will remove a ban on the specified userhost(s) on the (optional)
  1110. channel.
  1111.  
  1112. Related: BAN BANLIST KICK KICKBAN QKICK QKICKBAN
  1113.  
  1114. EXAMPLES:
  1115.  
  1116. /BANDEL *!*@*microsoft.com
  1117.      Will remove the ban for the microsoft.com domain.
  1118.  
  1119. Commands
  1120. ========
  1121.  
  1122. BANLIST
  1123. -------
  1124.  
  1125. Usage: /BANLIST [channel] userhost[,userhost...]
  1126.  
  1127. Shows a list of bans currently active on the (specified) channel.
  1128.  
  1129. Related: BAN BANDEL KICK KICKBAN QKICK QKICKBAN
  1130.  
  1131. EXAMPLES:
  1132.  
  1133. /BANLIST
  1134.      Shows a list of all bans on the currently active channel.
  1135.  
  1136. Commands
  1137. ========
  1138.  
  1139. CHANNEL
  1140. -------
  1141.  
  1142. Usage: /CHANNEL channel[,channel[,...]] [key[,key,...]]
  1143.  
  1144. Join a channel on the IRC. If the channel doesn't exists, it is
  1145. automatically created.
  1146.  
  1147. There are two kinds of channels: Channel names starting with an
  1148. # are global channels and available on all IRC servers which
  1149. are connected to the net you are currently on. Channels which begin with
  1150. & are local to the chat server you are connected to.
  1151.  
  1152. If a channel requires a special keyword to join, you can submit this
  1153. after the channel name.
  1154.  
  1155. AmIRC will look for a channel window which isn't currently bound to a
  1156. channel. If it doesn't find one, a new window will be created and bound
  1157. to this channel.
  1158.  
  1159. Alternative: JOIN
  1160.  
  1161. Related: LEAVE PART QUIT
  1162.  
  1163. EXAMPLES:
  1164.  
  1165. /CHANNEL #Amiga
  1166.      Join the channel #Amiga
  1167.  
  1168. /CHANNEL #Amiga,#AmIRC
  1169.      Join the channels #Amiga and #AmIRC
  1170.  
  1171. /CHANNEL #Secret Booh
  1172.      Join the channel #Secret that protected with keyword Booh.
  1173.  
  1174. Commands
  1175. ========
  1176.  
  1177. CONNECT
  1178. -------
  1179.  
  1180. Usage: /CONNECT server [port [remote server]]
  1181.  
  1182. The CONNECT command can be used to force a server to try to establish a
  1183. new connection to another server immediately. CONNECT is a privileged
  1184. command and is available only to IRC Operators. If a [remote server] is
  1185. given then the CONNECT attempt is made by that remote server to the
  1186. given server and port.
  1187.  
  1188. EXAMPLES:
  1189.  
  1190. /CONNECT test1.irc.com
  1191.      Will connect test1.irc.com to the currently connected server
  1192.  
  1193. Commands
  1194. ========
  1195.  
  1196. CTCP
  1197. ----
  1198.  
  1199. Usage: /CTCP nick request
  1200.  
  1201. CTCP or Client To Client Protocol is a standard for sending commands
  1202. to other clients on IRC. Basically, CTCP messages are simply private
  1203. messages that include a code to alert the receiving client (not user)
  1204. to respond to the command.
  1205.  
  1206. CTCP commands are typicaly used to get informaton from the receiving
  1207. client, such as '/CTCP time', or '/CTCP version'. Even DCC sends a
  1208. request via CTCP to the receiving client, asking to initiate a direct
  1209. connection.
  1210.  
  1211. Related: ME DCC SOUND TIME QUERY VERSION
  1212.  
  1213. EXAMPLES:
  1214.  
  1215. /CTCP Franky Version
  1216.      This will return the version of Franky's client:
  1217.               ½Reply╗ Franky VERSION AmIRC/AmigaOS 1.118 by Oliver Wagner <owagner@vapor.com> :
  1218.                   http://www.vapor.com/amirc/ : [#00000000] : This space for rent.
  1219.                   Mail <ads@vapor.com> for more info.
  1220.  
  1221. /CTCP Bert Time
  1222.      This will show the time set on Bert's machine:
  1223.               ½Reply╗ Bert TIME Tue Jan 13 10:54:23 1998
  1224.  
  1225. Commands
  1226. ========
  1227.  
  1228. DCC
  1229. ---
  1230.  
  1231. Usage: /DCC [SEND|MOVE|CHAT|SCHAT|GET|RESUME|LIST] [nick]
  1232. [parameters]    or: /DCC CLOSE [SEND|GET|CHAT|SCHAT] nick
  1233. [parameters]
  1234.  
  1235. DCC or Direct Client Connection is a protocol that IRC clients can
  1236. use to communicate directly with each other, bypassing the IRC server.
  1237. The reason for this is to form a faster, more stable and direct
  1238. connection through which users can transfer files, or send private
  1239. messages.
  1240.  
  1241. Note that AmIRC has its own set of Highly Optimized DCC protocols
  1242. built-in, and does not require external DCC utilities.
  1243.  
  1244. The most common use of DCC is for transfering files between two clients.
  1245. The initiating client will send a message through the IRC server,
  1246. telling the receiver that a connection is requested. At this time, the
  1247. receiver will either accept or reject the offer for the connection. If
  1248. the receiver accepts the connection, the initiating client will proceed
  1249. to send the information directly to the receiver. If the connecton is
  1250. refused, the initiating client will simply timeout the attempt to
  1251. connect.
  1252.  
  1253. Another use of the DCC standard is DCC chat, which, like DCC Send, will
  1254. send a CTCP request to the receiving client to set up a direct link. In
  1255. this case, however, the purpose of the link is for users to send
  1256. messages to each other. Because the mesages are sent through the direct
  1257. link, and do not pass through the IRC server, this method of sending
  1258. messages is much more private than using the IRC's private message
  1259. (MSG) command.  With AmiRC, it must be noted that a DCC Chat request
  1260. will not open a dialog window for you, instead, when DCC chat is
  1261. initiated and accepted, all privmsg's (MSG) to the receiving user will
  1262. be sent through the DCC link. If you wish to have a dialog box for
  1263. chatting, the best way to do this is to highlight the users's name in
  1264. the userlist by clicking on it and then click on the 'Query' button
  1265. below the listview. This will open a window that has several options
  1266. within it. From here, you can PING or WHOIS the other user, or you may
  1267. inititate a 'DCC Send' or 'DCC Chat'. Starting a 'DCC Chat' from
  1268. this window will allow you to carry on a dialog with the remote user
  1269. through the window.
  1270.  
  1271. EXAMPLES:
  1272.  
  1273. /DCC send Franky AmIRC20.lzx
  1274.      Will send a request to Franky to transfer a file called
  1275.      AmIRC20.lzx.  When Franky (auto-)accepts transfer will begin.
  1276.  
  1277. /DCC move Franky AmIRC20.lzx
  1278.      Will basically do the same as 'DCC Send' but it is capable of
  1279.      resuming an aborted or failed transfer. It looks in the receiving
  1280.      directory and if a file with the same name if found it will send a
  1281.      'DCC Resume' instead of 'DCC Send'.
  1282.  
  1283. Commands
  1284. ========
  1285.  
  1286. DESCRIBE
  1287. --------
  1288.  
  1289. Usage: /DESCRIBE nick describe-text
  1290.  
  1291. DESCRIBE is used to 'describe' something to another user.
  1292.  
  1293. Related: ME MSG
  1294.  
  1295. EXAMPLES:
  1296.  
  1297. /DESCRIBE John It is nice weather here
  1298.      Send the following text to user John:
  1299.               ½Describe╗ <nick> It is nice weather here
  1300.      Where <nick> is your nickname.
  1301.  
  1302. Commands
  1303. ========
  1304.  
  1305. DEOP
  1306. ----
  1307.  
  1308. Usage: /DEOP [channel] nick[,nick...]
  1309.  
  1310. Will remove the Channel Operator status of one or several users. Note
  1311. that the user issueing the command needs to be Channel Operator himself.
  1312.  
  1313. Related: OP
  1314.  
  1315. EXAMPLES:
  1316.  
  1317. /DEOP Billy
  1318.      Removes Channel Operator status from a user called Billy.
  1319.  
  1320. /DEOP #Amiga Billy,John
  1321.      Removes Channel Operator status from users Billy and John on
  1322.      the channel #Amiga.
  1323.  
  1324. Commands
  1325. ========
  1326.  
  1327. GLINE
  1328. -----
  1329.  
  1330. Usage: /GLINE [gline]
  1331.  
  1332. GLINE returns a list of all (partial) domains that are banned from the
  1333. network.  The optional parameter is used as a mask.
  1334.  
  1335. EXAMPLES:
  1336.  
  1337. /GLINE
  1338.      Returns all domains banned from the network.
  1339.  
  1340. Commands
  1341. ========
  1342.  
  1343. HELP
  1344. ----
  1345.  
  1346. Usage: /HELP [Command]
  1347.  
  1348. With this command you can get a list of all available commands. When
  1349. the optional command parameter you get specific help about that command.
  1350.  
  1351. Alternative: ?
  1352.  
  1353. EXAMPLES:
  1354.  
  1355. /HELP
  1356.      Will show a list of all available commands
  1357.  
  1358. /HELP Ping
  1359.      Will show additional help about the PING command.
  1360.  
  1361. Commands
  1362. ========
  1363.  
  1364. HIGHLITE
  1365. --------
  1366.  
  1367. Usage: /HIGHLITE [item]
  1368.  
  1369. HIGHLITE can be used to light up certain texts. They will be shown in a
  1370. color that's defined in the GUI.
  1371.  
  1372. You can also change Highlighting using the Lists.
  1373.  
  1374. Alternative: HILITE
  1375.  
  1376. Related: UNHIGHLITE UNHILITE
  1377.  
  1378. EXAMPLES:
  1379.  
  1380. /HIGHLITE MyName
  1381.      Whenever AmIRC encounters MyName it will be shown in the
  1382.      Hilighted color.
  1383.  
  1384. Commands
  1385. ========
  1386.  
  1387. HILITE
  1388. ------
  1389.  
  1390. Usage: /HILITE [item]
  1391.  
  1392. HIGHLITE can be used to light up certain texts. They will be shown in a
  1393. color that's defined in the GUI.
  1394.  
  1395. You can also change Highlighting using the Lists.  Alternative: HIGHLITE
  1396.  
  1397. Related: UNHIGHLITE UNHILITE
  1398.  
  1399. EXAMPLES:
  1400.  
  1401. /HILITE MyName
  1402.      Whenever AmIRC encounters MyName it will be shown in the
  1403.      Hilighted color.
  1404.  
  1405. Commands
  1406. ========
  1407.  
  1408. IRCNAME
  1409. -------
  1410.  
  1411. Usage: /IRCNAME [new name]
  1412.  
  1413. IRCNAME is used to to give yourself a nickname or change your current
  1414. one. If the chosen nick is already in use, you wil be notified of this
  1415. and prompted for a new nick.
  1416.  
  1417. Alternative: NICK
  1418.  
  1419. EXAMPLES:
  1420.  
  1421. /IRCNAME Phalanx
  1422.      Sets your nickname to 'Phalanx'
  1423.  
  1424. Commands
  1425. ========
  1426.  
  1427. IGNORE
  1428. ------
  1429.  
  1430. Usage: /IGNORE [userhost|nick [[+|-]TEXT [+|-]PRIV [+|- -]CTCP
  1431. [+|-]ALL]]
  1432.  
  1433. IGNORE can be used to ignore messages coming from an annoying user. You
  1434. can set different levels of ignoring:
  1435.  
  1436.      text - This will block only text.
  1437.      priv - This will block all private messages.
  1438.      ctcp - You won't reveive any CTCP request.
  1439.      all  - All traffic will be blocked.
  1440.  
  1441. Related: SILENCE UNIGNORE
  1442.  
  1443. EXAMPLES:
  1444.  
  1445. /IGNORE bill@user1.microsoft.com +priv
  1446.      This will ignore all PrivMsgs (MSG) sent by the offending user.
  1447.  
  1448. /IGNORE Bill -ctcp
  1449.      Removes CTCP ignores of Bill
  1450.  
  1451. Commands
  1452. ========
  1453.  
  1454. INVITE
  1455. ------
  1456.  
  1457. Usage: /INVITE [channel] nick
  1458.  
  1459. Invites a user to the channel given in the argument, regardless of
  1460. wether the channel exists. If the named channel is MODE, the user
  1461. performing the command must be a channel operator for that channel. When
  1462. receiving an invitation you will be presented with a requester.
  1463.  
  1464. EXAMPLES:
  1465.  
  1466. /INVITE freddie #AmIRC
  1467.      Invites 'freddie' to join #AmIRC.
  1468.  
  1469. Commands
  1470. ========
  1471.  
  1472. INFO
  1473. ----
  1474.  
  1475. Usage: /INFO [server]
  1476.  
  1477. The INFO command is required to return information which describes the
  1478. server: its version, when it was compiled, the patchlevel, when it was
  1479. started, and any other miscellaneous information which may be
  1480. considered to be relevant. If no parameter is submitted the currently
  1481. connected server will be shown.
  1482.  
  1483. EXAMPLES:
  1484.  
  1485. /INFO
  1486.      Will return information about the server the user is currently
  1487.      connected to.
  1488.  
  1489. Commands
  1490. ========
  1491.  
  1492. ISON
  1493. ----
  1494.  
  1495. Usage: /ISON nick [nick [nick [...]]]
  1496.  
  1497. Quickly returns the user's nick if it is found, does nothing if it is
  1498. not.
  1499.  
  1500. Related: WHOIS WHOWAS WHO
  1501.  
  1502. EXAMPLES:
  1503.  
  1504. /ISON Kenneth
  1505.      Returns: '<ISON>Kenneth', if nick 'Kenneth' is found on the
  1506.      server.
  1507.  
  1508. Commands
  1509. ========
  1510.  
  1511. JOIN
  1512. ----
  1513.  
  1514. Usage: /JOIN channel[,channel[,...]] [key[,key[,...]]]
  1515.  
  1516. Join a channel on the IRC. If the channel doesn't exists, it is
  1517. automatically created.
  1518.  
  1519. There are two kinds of channels: Channel names starting with an
  1520. # are global channels and available on all IRC servers which
  1521. are connected to the net you are currently on. Channels which begin with
  1522. & are local to the chat server you are connected to.
  1523.  
  1524. If a channel requires a special keyword to join, you can submit this
  1525. after the channel name.
  1526.  
  1527. AmIRC will look for a channel window which isn't currently bound to a
  1528. channel. If it doesn't find one, a new window will be created and bound
  1529. to this channel.
  1530.  
  1531. Alternative: CHANNEL
  1532.  
  1533. Related: LEAVE PART QUIT
  1534.  
  1535. EXAMPLES:
  1536.  
  1537. /JOIN #Amiga
  1538.      Join channel #Amiga
  1539.  
  1540. /JOIN #Amiga,#AmIRC
  1541.      Join channels #Amiga and #AmIRC
  1542.  
  1543. /JOIN #Secret Booh
  1544.      Join channel #Secret with keyword Booh.
  1545.  
  1546. Commands
  1547. ========
  1548.  
  1549. KICK
  1550. ----
  1551.  
  1552. Usage: /KICK [channel] nick [reason]
  1553.  
  1554. Forcibly removes a user from the named channel. The user sending the
  1555. /KICK command must be a Channel Operator of the channel. If the optional
  1556. [reason] is given, it will be shown as the reason for the kick.
  1557.  
  1558. Related: BAN BANDEL BANLIST KICKBAN QKICK QKICKBAN
  1559.  
  1560. EXAMPLES:
  1561.  
  1562. /KICK #AmIRC Freddie Take it outside!
  1563.      Forces 'Freddie' from channel #AmIRC with the reason 'Take it
  1564.      outside!'.
  1565.  
  1566. Commands
  1567. ========
  1568.  
  1569. KICKBAN
  1570. -------
  1571.  
  1572. Usage: /KICKBAN [channel] nick [reason]
  1573.  
  1574. Forcibly removes a user from the named channel and prevents him from
  1575. re-entering with a ban. The user sending the /KICKBAN command must be a
  1576. channel operator of the channel. If the optional [reason] is given, it
  1577. will be shown as the reason for the kick & ban.
  1578.  
  1579. Related: BAN BANDEL BANLIST KICK QKICK QKICKBAN
  1580.  
  1581. EXAMPLES:
  1582.  
  1583. /KICKBAN #AmIRC Freddie You dirty pirate!
  1584.      Forces 'Freddie' from channel #AmIRC with the reason 'You dirty
  1585.      pirate!' and cannot re-enter because he's banned.
  1586.  
  1587. Commands
  1588. ========
  1589.  
  1590. KILL
  1591. ----
  1592.  
  1593. Usage: Usage: /KILL nick comment
  1594.  
  1595. This command allows IRC Operators to disconnect abusive users from the
  1596. network.
  1597.  
  1598. EXAMPLES:
  1599.  
  1600. /KILL Pierat You're not wanted here!
  1601.      Disconnects user Pierat with the reason 'You're not wanted
  1602.      here!'
  1603.  
  1604. Commands
  1605. ========
  1606.  
  1607. LASTLOG
  1608. -------
  1609.  
  1610. Usage /LASTLOG [undefined]
  1611.  
  1612. Searches back through AmIRC's buffer and displays all occurances of the
  1613. specified text.
  1614.  
  1615. EXAMPLES:
  1616.  
  1617. /LASTLOG amirc
  1618.      Searches and displays all lines from the buffer containing the
  1619.      text 'amirc'.
  1620.  
  1621. Commands
  1622. ========
  1623.  
  1624. LEAVE
  1625. -----
  1626.  
  1627. Usage: /LEAVE [Channel[,Channel[,...]]
  1628.  
  1629. Leaves a channel. If you don't give a channel name as a parameter, the
  1630. channel currently bound to the window in which in the command is
  1631. entered will be left.
  1632.  
  1633. Alternative: PART
  1634.  
  1635. Related: CHANNEL JOIN
  1636.  
  1637. EXAMPLES:
  1638.  
  1639. /LEAVE
  1640.      Leave the channel currently bound to this window.
  1641.  
  1642. /LEAVE #AmigaGER
  1643.      Leave channel #AmigaGER.
  1644.  
  1645. Commands
  1646. ========
  1647.  
  1648. LINKS
  1649. -----
  1650.  
  1651. Usage: /LINKS [pattern]
  1652.  
  1653. LINKS shows which server of the IRC network is connected to which other
  1654. server. The optional [pattern] can be used to limit the shown server
  1655. with a mask.
  1656.  
  1657. Related: MAP
  1658.  
  1659. EXAMPLES:
  1660.  
  1661. /LINKS *.*com
  1662.      Shows all links with servers ending with .com
  1663.  
  1664. Commands
  1665. ========
  1666.  
  1667. LIST
  1668. ----
  1669.  
  1670. Usage: /LIST [pattern] [MIN minusers]
  1671.  
  1672. Shows the Windows in which the accessable channels are listed. The
  1673. optional [pattern] is used as a mask and the MIN minusers parameter
  1674. prevents channels with less users to be displayed.
  1675.  
  1676. EXAMPLES:
  1677.  
  1678. /LIST
  1679.      Returns a list of all public channels on available. Note that
  1680.      'secret' channels are only shown when the user has actually joined
  1681.      them.
  1682.  
  1683. /LIST br* 6
  1684.      Returns all channels starting with br and minimal 6 users
  1685.      present.
  1686.  
  1687. Commands
  1688. ========
  1689.  
  1690. LOG
  1691. ---
  1692.  
  1693. Usage: /LOG [filename|ON|OFF]
  1694.  
  1695. LOG allows you to start/stop logging, as well as setting the log
  1696. filename and displaying status of logging.
  1697.  
  1698. EXAMPLES:
  1699.  
  1700. /LOG
  1701.      Displays current status of logging
  1702.  
  1703. /LOG ON
  1704.      Begins logging to the logfile
  1705.  
  1706. /LOG <filename>
  1707.      Sets the path and name of the logfile.
  1708.  
  1709. Commands
  1710. ========
  1711.  
  1712. LUSERS
  1713. ------
  1714.  
  1715. Usage: /LUSERS (no arguments)
  1716.  
  1717. Returns information on the current network. Specifically on the number
  1718. of users present.
  1719.  
  1720. EXAMPLES:
  1721.  
  1722. /LUSERS
  1723.      This will return information on the users on the current network.
  1724.  
  1725. Commands
  1726. ========
  1727.  
  1728. M
  1729. -
  1730.  
  1731. Usage: /M nick_or_channel[,nick,...] text
  1732.  
  1733. Sends a Private Message to one or more users. Note that this is
  1734. different from a DCC, in that /M (PRIVMSG) is sent through the IRC
  1735. server to the recipient. Note that the TAB key will cycle back and
  1736. forth through the users who have /MSG'ed you. This will appear in the
  1737. input string gadget, and you may simply add your message after it.
  1738.  
  1739. Alternative: MSG RMSG
  1740.  
  1741. EXAMPLES:
  1742.  
  1743. /M Kenneth Heya Dude! How's Florida?
  1744.      Send the message: "Heya Dude! How's Florida?" to user
  1745.      Kenneth.
  1746.  
  1747. /M Kenneth,Aerosoul I am in Pittsburgh
  1748.      Sends the message "I am in Pittsburgh" to Kenneth and
  1749.      Aerosoul.
  1750.  
  1751. Commands
  1752. ========
  1753.  
  1754. MAP
  1755. ---
  1756.  
  1757. Usage: /MAP [server]
  1758.  
  1759. MAP returns a map of all servers the network consists of. The optional
  1760. parameter is used as a mask
  1761.  
  1762. Related: LINKS
  1763.  
  1764. EXAMPLES:
  1765.  
  1766. /MAP
  1767.      Shows a map of all servers
  1768.  
  1769. /MAP *.*.com
  1770.      Shows a map of all servers ending with com.
  1771.  
  1772. Commands
  1773. ========
  1774.  
  1775. ME
  1776. --
  1777.  
  1778. Usage: /ME Action
  1779.  
  1780. ME sends a CTCP to the channel.
  1781.  
  1782. Related: DESCRIBE
  1783.  
  1784. EXAMPLES:
  1785.  
  1786. /ME is currently happy.
  1787.      Sends the following text to the channel:
  1788.      '<Action><nick> is currently happy'.
  1789.      Where <nick> is the currently selected nickname.
  1790.  
  1791. Commands
  1792. ========
  1793.  
  1794. MODE
  1795. ----
  1796.  
  1797. Usage: /MODE [channel] [+-modes [modeparms]]
  1798.  
  1799. MODE is used to change the modes of a channel or a user. Only Channel
  1800. Opertators can change Channel Modes. Here's a list of all available
  1801. modes:
  1802.  
  1803.  
  1804.      o - Remove Channel Operator status. Note that you cannot set ChanOp status using +o.
  1805.      p - Private channel; Not visible in the Channel List.
  1806.      s - Secret channel; Not visible until you enter.
  1807.      i - Invite-only channel; Only accessible on invitation.
  1808.      t - Topic protection; Settable by Channel Operators only.
  1809.      n - No Messages; No messages from clients outside channel.
  1810.      m - Moderated channel; Only ChanOps and people with VOICE can send public messages.
  1811.      l - Limit: Set maximum number of users allowed on channel.
  1812.      b - Ban: Set a ban to keep users out.
  1813.      v - Voice: Give/take the ability to speak on a Moderated channel.
  1814.      k - Keyword: Set a channel keyword (password).
  1815.  
  1816. Related: BAN BANDEL INVITE OP DEOP TOPIC VOICE UMODE UNVOICE
  1817.  
  1818. EXAMPLES:
  1819.  
  1820. /MODE #AmIRC +tm
  1821.      Sets topic protection and makes channel #AmIRC moderated.
  1822.  
  1823. /MODE #AmIRC -o Sarek
  1824.      Removes channel operator status from user 'Sarek' on channel
  1825.      #AmIRC.
  1826.  
  1827. /MODE #AmIRC +l 50
  1828.      Sets limit of 50 users on #AmIRC.
  1829.  
  1830. /MODE #AmIRC -l
  1831.      Removes the limit form #AmIRC.
  1832.  
  1833. Commands
  1834. ========
  1835.  
  1836. MOTD
  1837. ----
  1838.  
  1839. Usage: /MOTD (no arguments)
  1840.  
  1841. This returns the Message Of The Day of the server currently connected
  1842. to.
  1843.  
  1844. EXAMPLES:
  1845.  
  1846. /MOTD
  1847.      Shows the current Message Of The Day of the server.
  1848.  
  1849. Commands
  1850. ========
  1851.  
  1852. MSG (PRIVMSG)
  1853. -------------
  1854.  
  1855. Usage: /MSG nick_or_channel[,nick,...] text
  1856.  
  1857. Sends a Private Message to one or more users. Note that this is
  1858. different from a DCC, in that a /MSG (PRIVMSG) is sent thru the IRC
  1859. server to the recipient. Note that the TAB key will cycle back and
  1860. forth through the users who have /MSG'ed you. This will appear in the
  1861. input string gadget, and you may simply add your message after it.
  1862.  
  1863. Alternatives: M RMSG EXAMPLES:
  1864.  
  1865. /MSG Kenneth Heya Dude! How's Florida?
  1866.      Send the message: "Heya Dude! How's Florida?" to user 'Kenneth'.
  1867.  
  1868. /MSG Kenneth,Aerosoul I am in Pittsburgh
  1869.      Sends the message "I am in Pittsburgh" to Kenneth and Aerosoul.
  1870.  
  1871. Commands
  1872. ========
  1873.  
  1874. Names
  1875. -----
  1876.  
  1877. Usage /NAMES channel[,channel[,...]]
  1878.  
  1879. Gives a list of nicknames on any channel visible to the user(not secret
  1880. or private, or one actually joined by the user performing the command).
  1881.  
  1882. EXAMPLES:
  1883.  
  1884. /NAMES #AmIRC,#amigaGER
  1885.      Will list all users on channels #AmIRC and #amigaGER, provided the
  1886.      channels are visible to the user.
  1887.  
  1888. /NAMES
  1889.      Will return a list of all visible channels and users (Strongly
  1890.      Discouraged!)
  1891.  
  1892. Commands
  1893. ========
  1894.  
  1895. NICK
  1896. ----
  1897.  
  1898. Usage: /NICK NewNick
  1899.  
  1900. NICK is used to to give yourself a nickname or change your current one.
  1901. If the chosen nick is already in use, you wil be notified of this and
  1902. prompted for a new nick.
  1903.  
  1904. Alternative: IRCNAME
  1905.  
  1906. EXAMPLES:
  1907.  
  1908. /NICK Phalanx
  1909.      Sets your nickname to 'Phalanx'
  1910.  
  1911. Commands
  1912. ========
  1913.  
  1914. NOTE
  1915. ----
  1916.  
  1917. Usage: /NOTE [undefined]
  1918.  
  1919. This command is still a leftover from the past and is not supported
  1920. anymore by any current servers.
  1921.  
  1922. Commands
  1923. ========
  1924.  
  1925. NOTICE
  1926. ------
  1927.  
  1928. Usage: /NOTICE nick_or_channel[,nick,...] text
  1929.  
  1930. /NOTICE is usually used by Bots or clients being controlled by scripts.
  1931. /NOTICE messages must never be responded to by an automatic reply.
  1932.  
  1933. See MSG for syntax examples.
  1934.  
  1935. Commands
  1936. ========
  1937.  
  1938. NOTIFY
  1939. ------
  1940.  
  1941. Usage: /NOTIFY [nick]
  1942.  
  1943. With NOTIFY you can specify the nick of a user you want to be notified
  1944. of when he joins IRC. You can set the notification event in the Events
  1945. of the Settings. When no nick is submitted you will be presented with
  1946. the Windows.
  1947.  
  1948. EXAMPLES:
  1949.  
  1950. /NOTIFY Bert
  1951.      You will be notified when user Bert is joining the IRC network.
  1952.  
  1953. Commands
  1954. ========
  1955.  
  1956. OP
  1957. --
  1958.  
  1959. Usage: /OP [channel] nick[,nick...]
  1960.  
  1961. With this command you can set the Channel Operator status of a user or
  1962. several users at once.
  1963.  
  1964. EXAMPLES:
  1965.  
  1966. /OP Bert,Franky
  1967.      Sets the Channel Operator status for users Bert and
  1968.      Franky
  1969.  
  1970. Commands
  1971. ========
  1972.  
  1973. OPER
  1974. ----
  1975.  
  1976. Usage: /OPER user password
  1977.  
  1978. Allows users to set their IRC Operator status. You will need to know the
  1979. password to become IRC Operator. Using /OPER without it's parameters
  1980. will present you with a requester where you can enter your username and
  1981. password.
  1982.  
  1983. EXAMPLES:
  1984.  
  1985. /OPER Bill Bucks
  1986.      Sets user Bill IRC Operator status using password Bucks.
  1987.  
  1988. Commands
  1989. ========
  1990.  
  1991. PART
  1992. ----
  1993.  
  1994. Usage: /PART [Channel[,Channel...]]
  1995.  
  1996. Leaves a channel. If you don't give a channel name as a parameter, the
  1997. channel currently bound to the window in which in the command is
  1998. entered will be left.
  1999.  
  2000. Alternative: LEAVE
  2001.  
  2002. Related: CHANNEL JOIN
  2003.  
  2004. EXAMPLES:
  2005.  
  2006. /PART
  2007.      Leave the channel currently bound to this window.
  2008.  
  2009. /PART #AmigaGER
  2010.      Leave channel #AmigaGER.
  2011.  
  2012. Commands
  2013. ========
  2014.  
  2015. PING
  2016. ----
  2017.  
  2018. Usage: /PING [nick]
  2019.  
  2020. Sends a CTCP to the user with the submitted nick and return the time it
  2021. took to receive it back. If no nick is given the PING will be sent to
  2022. the server.
  2023.  
  2024. Related: CTCP
  2025.  
  2026. EXAMPLES:
  2027.  
  2028. /PING Bill
  2029.      Will send a PING to Bill and return:
  2030.               ½Pong╗  PING Response received from Bill: 2.4s
  2031.  
  2032. Commands
  2033. ========
  2034.  
  2035. QKICK
  2036. -----
  2037.  
  2038. Usage: /QKICK [channel] nick[,nick...] [reason]
  2039.  
  2040. This command is use to kick or ban a person and presents you with a
  2041. window in which you can select the hostmask use for the ban. Pressing
  2042. either the Kick or Kick&Ban button will kick(ban) the user. Here's
  2043. the hostmasks offered:
  2044.  
  2045.      nick!*user@host.do.main : Bans a specific user with a specific nick.
  2046.      *!*@*.do.main : Ban all users of do.main.
  2047.      *!*user@host.do.main : Ban a user with a specific host.
  2048.      *!*@ip1.ip2.ip3.* : Numerical hostmask, banning all users in a domain.
  2049.  
  2050. Alternative: QKICKBAN
  2051.  
  2052. Related: BAN BANDEL BANLIST KICK KICKBAN
  2053.  
  2054. EXAMPLES:
  2055.  
  2056. /QKICK
  2057.      You will be presented with a Kick/Ban window
  2058.  
  2059. Commands
  2060. ========
  2061.  
  2062. QKICKBAN
  2063. --------
  2064.  
  2065. Usage: /QKICKBAN [channel] nick[,nick...] [reason]
  2066.  
  2067. This command is use to kick or ban a person and presents you with a
  2068. window in which you can select the hostmask use for the ban. Pressing
  2069. either the Kick or Kick&Ban button will kick(ban) the user. Here's
  2070. the hostmasks offered:
  2071.  
  2072.      nick!*user@host.do.main : Bans a specific user with a specific nick.
  2073.      *!*@*.do.main : Ban all users of do.main.
  2074.      *!*user@host.do.main : Ban a user with a specific host.
  2075.      *!*@ip1.ip2.ip3.* : Numerical hostmask, banning all users in a domain.
  2076.  
  2077. Alternative: QKICK
  2078.  
  2079. Related: BAN BANDEL BANLIST KICK KICKBAN
  2080.  
  2081. EXAMPLES:
  2082.  
  2083. /QKICKBAN
  2084.      You will be presented with a Kick/Ban window
  2085.  
  2086. Commands
  2087. ========
  2088.  
  2089. QUERY
  2090. -----
  2091.  
  2092. Usage: /QUERY nick
  2093.  
  2094. With this command you can open a Query window. From here, you can PING
  2095. or WHOIS the other user, or you may inititate a 'DCC Send' or 'DCC
  2096. Chat'. Starting a 'DCC Chat' from this window will allow you to
  2097. carry on a dialog with the remote user through the window.
  2098.  
  2099. EXAMPLES:
  2100.  
  2101. /QUERY Hero
  2102.      Will open a Query window with user Hero.
  2103.  
  2104. Commands
  2105. ========
  2106.  
  2107. QUIT
  2108. ----
  2109.  
  2110. Usage: /QUIT [Quit message]
  2111.  
  2112. Used to end an IRC session. The optional [Quit message] is the text that
  2113. will be displayed upon quitting.
  2114.  
  2115. Related: SERVER
  2116.  
  2117. EXAMPLES:
  2118.  
  2119. /QUIT Gone to have lunch
  2120.      Will quit AmIRC and send the text 'Gone to have lunch' to all
  2121.      joined channels.
  2122.  
  2123. Commands
  2124. ========
  2125.  
  2126. QUOTE
  2127. -----
  2128.  
  2129. Usage: /QUOTE Raw_data_to_send_to_IRC_server
  2130.  
  2131. Sends text directly to the IRC server without any further processing.
  2132. Warning: Don't even think about using this command without interior
  2133. knowledge of the IRC protocol, or you might run into severe trouble.
  2134. See `RFC 1459' for a description of the IRC protocol.
  2135.  
  2136. Alternative: RAW
  2137.  
  2138. EXAMPLES:
  2139.  
  2140. /QUOTE JOIN #IRC-Heros
  2141.      Send the string JOIN #IRC-Heros directly to the IRC server.
  2142.  
  2143. Commands
  2144. ========
  2145.  
  2146. RAW
  2147. ---
  2148.  
  2149. Usage: /RAW Raw_data_to_send_to_IRC_server
  2150.  
  2151. Sends text directly to the IRC server without any further processing.
  2152. Warning: Don't even think about using this command without interior
  2153. knowledge of the IRC protocol, or you might run into severe trouble.
  2154. See `RFC 1459' for a description of the IRC protocol.
  2155.  
  2156. Alternative: QUOTE
  2157.  
  2158. EXAMPLES:
  2159.  
  2160. /RAW JOIN #IRC-Heros
  2161.      Send the string JOIN #IRC-Heros directly to the IRC server.
  2162.  
  2163. Commands
  2164. ========
  2165.  
  2166. REHASH
  2167. ------
  2168.  
  2169. Usage: /REHASH (no arguments)
  2170.  
  2171. The rehash message can be used by the operator to force the server to
  2172. re-read and process its configuration file. It's can only be used by
  2173. IRC Operators.
  2174.  
  2175. EXAMPLES:
  2176.  
  2177. /REHASH
  2178.      Will cause the IRC server to reread it's configuration file.
  2179.  
  2180. Commands
  2181. ========
  2182.  
  2183. RESTART
  2184. -------
  2185.  
  2186. Usage: /RESTART (no arguments)
  2187.  
  2188. This command is used to reset the IRC server. Note that this command
  2189. can only be used by IRC Operators.
  2190.  
  2191. EXAMPLES:
  2192.  
  2193. /RESTART
  2194.      Will reset the IRC server
  2195.  
  2196. Commands
  2197. ========
  2198.  
  2199. RMSG
  2200. ----
  2201.  
  2202. Usage: /RMSG nick_or_channel[,nick,...] text
  2203.  
  2204. Sends a Private Message to one or more users. Note that this is
  2205. different from a DCC, in that /M (PRIVMSG) is sent through the IRC
  2206. server to the recipient. Note that the TAB key will cycle back and
  2207. forth through the users who have /MSG'ed you. This will appear in the
  2208. input string gadget, and you may simply add your message after it.
  2209.  
  2210. Alternative: M MSG
  2211.  
  2212. EXAMPLES:
  2213.  
  2214. /RMSG Kenneth Heya Dude! How's Florida?
  2215.      Send the message: "Heya Dude! How's Florida?" to user 'Kenneth'.
  2216.  
  2217. /RMSG Kenneth,Aerosoul I am in Pittsburgh
  2218.      Sends the message "I am in Pittsburgh" to Kenneth and Aerosoul.
  2219.  
  2220. Commands
  2221. ========
  2222.  
  2223. RX
  2224. --
  2225.  
  2226. Usage: /RX rxcommand [parms]
  2227.  
  2228. This command is used to start any of the Arexx commands that are in
  2229. AmIRC's Rexx directory. A complete Rexx guide is also available.
  2230.  
  2231. Related: RXRETURN
  2232.  
  2233. EXAMPLES:
  2234.  
  2235. /RX leave
  2236.      Will start the Arexx command 'Leave.amirx' if present.
  2237.  
  2238. Commands
  2239. ========
  2240.  
  2241. RXRETURN
  2242. --------
  2243.  
  2244. Usage: /RXRETURN Command [Rest]
  2245.  
  2246. /RXRETURN is only useful to ARexx script authors. It will cause any
  2247. pending GETREXXLINE commands to immediately return with the arguments
  2248. given to it."
  2249.  
  2250. Related: RX
  2251.  
  2252. Commands
  2253. ========
  2254.  
  2255. SERVER
  2256. ------
  2257.  
  2258. Usage: /SERVER [server [port [password]]]
  2259.  
  2260. You can use this command to connect to a different server or to get
  2261. information about the currently connected server.
  2262.  
  2263. Related: QUIT
  2264.  
  2265. EXAMPLES:
  2266.  
  2267. /SERVER irc.server.com
  2268.      Connects you to the server irc.server.com
  2269.  
  2270. /SERVER
  2271.      Shows current connection information
  2272.  
  2273. Commands
  2274. ========
  2275.  
  2276. SILENCE
  2277. -------
  2278.  
  2279. Usage: /SILENCE [[+|-]nick|userhost]
  2280.  
  2281. SILENCE can be used to block all CTCP traffic from a certain user or
  2282. userhost.  Meaning for instance that no MSG or DCC will be received
  2283. from that user.
  2284.  
  2285. Related: IGNORE UNIGNORE
  2286.  
  2287. EXAMPLES:
  2288.  
  2289. /SILENCE
  2290.      Shows a list of all currently silenced users.
  2291.  
  2292. /SILENCE +Bill
  2293.      Will silence user Bill
  2294.  
  2295. /SILENCE -Friend
  2296.      Will remove Friend from the Silence list.
  2297.  
  2298. Commands
  2299. ========
  2300.  
  2301. SOUND
  2302. -----
  2303.  
  2304. Usage: /SOUND soundfile[.wav] action_text
  2305.  
  2306. This command can be used to have all clients on a channel play a
  2307. certain sound.  Please note that the sound file must be present on the
  2308. user's system to be able to play it, so don't use this randomly as
  2309. nobody will hear a thing when the submitted filename is not found.
  2310.  
  2311. EXAMPLES:
  2312.  
  2313. /SOUND Burp
  2314.      Will play the soundfile Burp.wav on all user's system, if found!
  2315.  
  2316. /SOUND Burp Excuse me!
  2317.      Will play the soundfile and send the text 'Excuse me!' with it.
  2318.  
  2319. Commands
  2320. ========
  2321.  
  2322. SQUIT
  2323. -----
  2324.  
  2325. Usage: /SQUIT server
  2326.  
  2327. This command is used to disconnect a server from the network. Note that
  2328. only IRC Operators have access to this command.
  2329.  
  2330. EXAMPLES:
  2331.  
  2332. /SQUIT irc.server.com
  2333.      Will quit server irc.server.com
  2334.  
  2335. Commands
  2336. ========
  2337.  
  2338. STATS
  2339. -----
  2340.  
  2341. Usage: /STATS [server] [query]
  2342.  
  2343. The STATS command is used to query statistics of certain server. If the
  2344. [server] parameter is omitted, only the end of stats reply is sent
  2345. back. The implementation of this command is highly dependent on the
  2346. server which replies, although the server must be able to supply
  2347. information as described by the queries below (or similar).
  2348.  
  2349. The currently supported queries are:
  2350.  
  2351.      c - Returns a list of servers which the server may connect to or allow connections
  2352.      from.
  2353.      h - Returns a list of servers which are either forced to be treated as leaves or
  2354.      allowed to act as hubs.
  2355.      i - Returns a list of hosts which the server allows a client to connect from.
  2356.      k - Returns a list of banned username/hostname combinations for that server.
  2357.      l - Returns a list of the server's connections, showing how long each connection
  2358.      has been established and the traffic over that connection in bytes and messages
  2359.      for each direction.
  2360.      m - Returns a list of commands supported by the server and the usage count for
  2361.      each if the usage count is non zero.
  2362.      o - Returns a list of hosts from which normal clients may become operators.
  2363.      y - Show Y (Class) lines from server's configuration file.
  2364.      u - Returns a string showing how long the server has been up.
  2365.  
  2366. EXAMPLES:
  2367.  
  2368. /STATS irc.server.com u
  2369.      Shows how long server irc.server.com has been up
  2370.  
  2371. Commands
  2372. ========
  2373.  
  2374. SUMMON
  2375. ------
  2376.  
  2377. Usage: /SUMMON user
  2378.  
  2379. The SUMMON command can be used to give users who are on a host running
  2380. an IRC server a message asking them to please join IRC. This message is
  2381. only sent if the target server (a) has SUMMON enabled, (b) the user is
  2382. logged in and (c) the server process can write to the user's tty (or
  2383. similar).
  2384.  
  2385. EXAMPLES:
  2386.  
  2387. /SUMMON John
  2388.      Will ask user John to join IRC.
  2389.  
  2390. Commands
  2391. ========
  2392.  
  2393. TIME
  2394. ----
  2395.  
  2396. Usage: /TIME [server]
  2397.  
  2398. Returns the local time from the server. If the optional [server]
  2399. argument is given, then that servers local time will be returned.
  2400.  
  2401. EXAMPLES:
  2402.  
  2403. /TIME irc.pitt.edu
  2404.      Returns the local time from server irc.pitt.edu.
  2405.  
  2406. Commands
  2407. ========
  2408.  
  2409. TOPIC
  2410. -----
  2411.  
  2412. Usage: /TOPIC [channel] [New Topic]
  2413.  
  2414. The topic command alone will display the channels topic. If the optional
  2415. [New Topic] argument is given, the topic will be changed to the
  2416. argument given, provided that the topic is not protected, or the user
  2417. issuing the command is an operator on the channel.
  2418.  
  2419. Related: MODE
  2420.  
  2421. EXAMPLES:
  2422.  
  2423. /TOPIC #AmIRC
  2424.      Will display the current topic on #AmIRC.
  2425.  
  2426. /TOPIC #AmIRC Amigas Rule!
  2427.      Will replace the current topic of #AmIRC with the topic 'Amigas
  2428.      Rule'
  2429.  
  2430. Commands
  2431. ========
  2432.  
  2433. TRACE
  2434. -----
  2435.  
  2436. Usage: /TRACE [server|nick]
  2437.  
  2438. TRACE is used to find the route to specific server. If the parameter is
  2439. omitted, it will return which servers the current server has a direct
  2440. connection to. If the destination given is a nickname, only a reply for
  2441. that nickname is given. If the destination is an actual server, then
  2442. the destination server is required to report all servers and users which
  2443. are connected to it, although only operators are permitted to see users
  2444. present.
  2445.  
  2446. EXAMPLES:
  2447.  
  2448. /TRACE Bill
  2449.      Traces connection to user Bill.
  2450.  
  2451. Commands
  2452. ========
  2453.  
  2454. UMODE
  2455. -----
  2456.  
  2457. Usage: /UMODE [usermodes]
  2458.  
  2459. UMODE is used to set your own usermodes. The available options are:
  2460.  
  2461.      o - Chan Op: Sets/Takes Channel Operator status
  2462.      i - Invisible: Sets Visible/Invisible (in global userlist).
  2463.      w - Wallops: Allows receiving of texts sent to all Operators.
  2464.      s - Server Notices: Allows receiving of Server Notices.
  2465. Related: MODE
  2466.  
  2467. EXAMPLES:
  2468.  
  2469. /UMODE i
  2470.      Makes you invisible to the global userlist.
  2471.  
  2472. Commands
  2473. ========
  2474.  
  2475. UNHIGHLITE
  2476. ----------
  2477.  
  2478. Usage: /UNHIGHLITE [item]
  2479.  
  2480. HIGHLITE can be used to light up certain texts. They will be shown in a
  2481. color that's defined in the GUI.
  2482.  
  2483. You can also change Highlighting using the Lists.
  2484.  
  2485. Alternative: UNHILITE
  2486.  
  2487. Related: HIGHLITE HILITE
  2488.  
  2489. EXAMPLES:
  2490.  
  2491. /UNHIGHLITE MyName
  2492.      Will remove MyName from the Highlight List.
  2493.  
  2494. Commands
  2495. ========
  2496.  
  2497. UNHILITE
  2498. --------
  2499.  
  2500. HIGHLITE can be used to light up certain texts. They will be shown in a
  2501. color that's defined in the GUI.
  2502.  
  2503. You can also change Highlighting using the Lists.
  2504.  
  2505. Alternative: UNHILITE
  2506.  
  2507. Related: HIGHLITE HILITE
  2508.  
  2509. Usage: /UNHILITE [item]
  2510.  
  2511. EXAMPLES:
  2512.  
  2513. /UNHILITE MyName
  2514.      Will remove MyName from the Highlight List.
  2515.  
  2516. Commands
  2517. ========
  2518.  
  2519. UNIGNORE
  2520. --------
  2521.  
  2522. Usage: /UNIGNORE [userhost|nick]
  2523.  
  2524. Removes the Ignore state of a user. Will show current ignores when no
  2525. argument is submitted.
  2526.  
  2527. Related: IGNORE SILENCE
  2528.  
  2529. EXAMPLES:
  2530.  
  2531. /UNIGNORE
  2532.      Shows a list of all currently ignored users
  2533.  
  2534. /UNIGNORE Franky
  2535.      Will remove all ignores on Franky
  2536.  
  2537. Commands
  2538. ========
  2539.  
  2540. UNVOICE
  2541. -------
  2542.  
  2543. Usage: /UNVOICE [channel] nick[,nick...]
  2544.  
  2545. Will remove a user's Voice status. You can specify a certain channel
  2546. and submit multiple users.
  2547.  
  2548. Related: VOICE
  2549.  
  2550. EXAMPLES:
  2551.  
  2552. /UNVOICE Boy
  2553.      Will remove the Voice status of Boy
  2554.  
  2555. Commands
  2556. ========
  2557.  
  2558. UNPING
  2559. ------
  2560.  
  2561. Usage: /UPING host
  2562.  
  2563. UPING is used by IRCops to ping a certain host. Mainly used for
  2564. debugging the network and see if connections are alive.
  2565.  
  2566. EXAMPLES:
  2567.  
  2568. /UPING irc.network.com
  2569.      Send a Ping packet to irc.network.com.
  2570.  
  2571. Commands
  2572. ========
  2573.  
  2574. USERS
  2575. -----
  2576.  
  2577. Usage: /USERS [host]
  2578.  
  2579. The USERS command returns a list of users logged into the server in a
  2580. similar format to who, rusers and finger. This command is frequently
  2581. disabled for security related reasons.
  2582.  
  2583. EXAMPLES:
  2584.  
  2585. /USERS *.microsoft.com
  2586.      Will show all user connected to *.microsoft.com.
  2587.  
  2588. Commands
  2589. ========
  2590.  
  2591. USERHOST
  2592. --------
  2593.  
  2594. Usage: /USERHOST nick[,nick[,...]]
  2595.  
  2596. Returns the login@domain for the specified nickname(s). Up to five
  2597. nicknames may be specified, each separated by a <space>.
  2598.  
  2599. EXAMPLES:
  2600.  
  2601. /USERHOST DuRaN
  2602.      Returns: DuRaN is DuRaN@calci.amiganet.pgh.net
  2603.  
  2604. Commands
  2605. ========
  2606.  
  2607. VERSION
  2608. -------
  2609.  
  2610. Usage /VERSION [nick|server]
  2611.  
  2612. Returns the version of the server's software. If the optional [server]
  2613. argument is given, returns the version of the specified server's
  2614. software. When a user's nick is given instead it will return the user's
  2615. client software version and info.
  2616.  
  2617. EXAMPLES:
  2618.  
  2619. /VERSION *.edu
  2620.      Returns server version information for all servers matching
  2621.      '*.edu'.
  2622.  
  2623. /VERSION Franky
  2624.      Will return information and version of Franky's client software.
  2625.  
  2626. Commands
  2627. ========
  2628.  
  2629. VOICE
  2630. -----
  2631.  
  2632. Usage /VOICE [channel] nick[,nick...]
  2633.  
  2634. You can give a user a Voice with this command. A voice is needed on a
  2635. Moderated channel to be able to speak. (See MODE for details).
  2636.  
  2637. Related: UNVOICE
  2638.  
  2639. EXAMPLES:
  2640.  
  2641. /VOICE Sinatra
  2642.      Gives a Voice to user Sinatra.
  2643.  
  2644. Commands
  2645. ========
  2646.  
  2647. WALLOPS
  2648. -------
  2649.  
  2650. Usage /WALLOPS text_to_broadcast
  2651.  
  2652. Sends a text to all Operators who have 'Receiving WALLOPS' enabled.
  2653. This command is mainly used by servers.
  2654.  
  2655. EXAMPLES:
  2656.  
  2657. /WALLOPS Greeting to you all!
  2658.      Sends the text 'Greeting to you all!' to all Operators.
  2659.  
  2660. Commands
  2661. ========
  2662.  
  2663. WHO
  2664. ---
  2665.  
  2666. Usage: /WHO channel|pattern
  2667.  
  2668. Returns a generated list of all users matching the criteria passed to
  2669. the command, i/e. everyone at a particular channel, or matching a
  2670. particular pattern.
  2671.  
  2672. EXAMPLES:
  2673.  
  2674. /WHO *.cmu.edu
  2675.      Will list all users at the cmu.edu domain.
  2676.  
  2677. /WHO #Amiga
  2678.      Shows all users on #Amiga.
  2679.  
  2680. Commands
  2681. ========
  2682.  
  2683. WHOIS
  2684. -----
  2685.  
  2686. Usage: /WHOIS nick[,nick[,...]]
  2687.  
  2688. Returns information about the specified user or users, that you are
  2689. allowed to see.
  2690.  
  2691. EXAMPLES:
  2692.  
  2693. /WHOIS Phalanx
  2694.      Returns available information about user 'Phalanx'.
  2695.  
  2696. Commands
  2697. ========
  2698.  
  2699. WHOWAS
  2700. ------
  2701.  
  2702. Usage /WHOWAS nick[,nick[,...]]
  2703.  
  2704. Returns information on a nick that no longer exists, due to the user
  2705. leaving the server or changing their nick.
  2706.  
  2707. EXAMPLES:
  2708.  
  2709. /WHOWAS Aerosoul
  2710.      Checks for and returns available information on the nick
  2711.      'Aerosoul'.
  2712.  
  2713. Customizing your environment
  2714. ****************************
  2715.  
  2716. Overview
  2717. ========
  2718.  
  2719. Now that you have AmIRC running, you may want to get it to operate the
  2720. way you want it to, and to look pleasing as well. This is achieved
  2721. through both the MUI preferences and AmIRC's Menu options.
  2722.  
  2723. MUI Settings
  2724. ************
  2725.  
  2726. Changing MUI Settings
  2727. =====================
  2728.  
  2729. Most of the configuration dealing with how AmIRC's GUI appears can be
  2730. customized with MUI. Check the MUI Settings... entry under the
  2731. Settings menu. This will pop up MUI's interface, allowing you to
  2732. setup AmIRC's MUI Prefs, without disturbing any of your other MUI
  2733. configurations. Read the documentation for MUI to learn more about the
  2734. operation of MUI Preferences.
  2735.  
  2736. AmIRC Configuration
  2737. *******************
  2738.  
  2739. Customizing your environment
  2740. ============================
  2741.  
  2742. Most of the setup functions appear in the Setup entry under the
  2743. Settings & Lists menus. Here you will get a window that will
  2744. allow you to access several pages that deal with configuring AmIRC.
  2745.  
  2746. AmIRC Configuration
  2747. *******************
  2748.  
  2749. Messages Page
  2750. =============
  2751.  
  2752. Misc Messages
  2753. -------------
  2754.  
  2755. CTCP Userinfo
  2756.      The text in this string is what will be returned to a user who
  2757.      sends CTCP to your client.
  2758.  
  2759. KICK Reason
  2760.      If you are a channel operator and KICK another user from the
  2761.      Channel, this text will appear as the reason for the /KICK.
  2762.  
  2763. Quit Messages
  2764. -------------
  2765.  
  2766. Exit
  2767.      This will appear to users in the channel when you exit AmIRC.
  2768.  
  2769. New Server
  2770.      This text will appear to users in the channel when you select
  2771.      Select Server in the AmIRC menu, and pick a new server to
  2772.      connect to.
  2773.  
  2774. System Reset
  2775.      This is the text to appear if you reboot your amiga (Crtl-
  2776.      Amiga-Amiga) while connected to a server.
  2777.  
  2778. AWAY Messages
  2779. -------------
  2780.  
  2781. Default
  2782.      This is the text that will appear when you are set AWAY by
  2783.      selecting the Marked Away? item in the User Modes menu or
  2784.      using the AWAY command
  2785.  
  2786. AutoAWAY
  2787.      Text that appears when you are automatically set away due to
  2788.      inactivity.
  2789.  
  2790. Timeout
  2791.      This sets how much time will pass before AmIRC assumes you are
  2792.      away from the computer and marks you as AWAY. If set to 0 (Zero),
  2793.      timeout will be disabled.
  2794.  
  2795. UnAWAY
  2796.      This cycle gadget allows you to choose the conditions of which
  2797.      AmIRC will automatically set you to Not AWAY.
  2798.  
  2799. AmIRC Configuration
  2800. *******************
  2801.  
  2802. Actions Page
  2803. ============
  2804.  
  2805. The 96 text gadgets in the Label: column here correspond to the
  2806. buttons under the user list on AmIRC's main window. You may set these
  2807. gadgets to be anything, sort of like macros. AmIRC, however, does
  2808. include configurable function keys to act as macros, so these buttons
  2809. are preset for CTCP, DCC, and MODE operations.
  2810.  
  2811. Below the text gadgets is a quick reference of the placeholders that
  2812. can be used in the desired operation. These actions can also be
  2813. accessed by clicking the right mouse button after selecting a users
  2814. nick from the userlist.
  2815.  
  2816. The bottom slider gadget determines how many button pages there will be
  2817. to avoid the buttons taking up to much space on the screen.
  2818.  
  2819. AmIRC Configuration
  2820. *******************
  2821.  
  2822. Events Page
  2823. ===========
  2824.  
  2825. Here you may define certain actions to take place upon incoming events.
  2826. These actions can be as simple as a warning beep from your amiga, or a
  2827. complex and powerful Rexx command. The following text first explains
  2828. the functions of the columns of this page, and then goes on to explain
  2829. what each event is.
  2830.  
  2831. Columns
  2832. -------
  2833.  
  2834. Event
  2835.      The particular event for the action to take place on.
  2836.  
  2837. Deiconify
  2838.      If AmIRC is iconified, this will uniconify and bring to front the
  2839.      AmIRC window on the occurence of the event.
  2840.  
  2841. Beep
  2842.      This will perform a system beep on the occurence of the event
  2843.  
  2844. Sound
  2845.      If a sound sample is preferred for the event, you may use the
  2846.      requester gadget to pick a sound to play instead of the system
  2847.      beep. Please Note, AmIRC uses the DataTypes of OS 3.x for sounds,
  2848.      and you will not be able to use this feature under OS 2.x.
  2849.  
  2850. Vol
  2851.      This sets the volume for the sound sample. The valid range for the
  2852.      volume is 0 - 64.  This is a slider gadget. The small gadget just
  2853.      to the left of this silder gadget can be used to test the selected
  2854.      soundfile.
  2855.  
  2856. Rexx Command
  2857.      Here you may configure a Rexx script to be run on the occurence of
  2858.      the event.
  2859.  
  2860. Events
  2861. ------
  2862.  
  2863. Any Message
  2864.      This event occurs on any incoming public message.
  2865.  
  2866. Private Msg
  2867.      This event occurs when you receive an incoming private MSG or DCC
  2868.      message.
  2869.  
  2870. Notice
  2871.      This event occurs when an operator sends out a NOTICE.
  2872.  
  2873. CTCP request
  2874.      This event occures when your client receives any CTCP request. (For
  2875.      example /CTCP Time, or /CTCP Version)
  2876.  
  2877. DCC request
  2878.      This event occurs on receiving a DCC file transfer request or chat
  2879.      request.
  2880.  
  2881. Join
  2882.      This event occurs when anyone JOIN the channel you are currently
  2883.      on.
  2884.  
  2885. Kick
  2886.      This event occurs when anyone is KICK from the channel you are
  2887.      currently on.
  2888.  
  2889. Mode change
  2890.      This event occurs when the channel mode is changed for the channel
  2891.      you are currently on. E.g. If someone is OPed or /DeOPed, or if the
  2892.      channel is made private, etc.
  2893.  
  2894. ISON Notify
  2895.      This event occurs when AmIRC 'sees' a user that is configured in
  2896.      your Notify list.
  2897.  
  2898. Connection
  2899.      This event occurs when AmIRC makes a connection to an IRC server.
  2900.  
  2901. Invite
  2902.      This event occurs when another user INVITE you to join a channel
  2903.      that is currently set to MODE Invite Only.
  2904.  
  2905. Highlite
  2906.      This even occurs upon receiving text that is configured in the
  2907.      Hilite section of the Lists setup.
  2908.  
  2909. AmIRC Configuration
  2910. *******************
  2911.  
  2912. GUI Page
  2913. ========
  2914.  
  2915. The GUI configuraton page allows you to control some specific aspects
  2916. of AmIRC that aren't covered in the MUI configuration.
  2917.  
  2918. Userlist:
  2919. ---------
  2920.  
  2921. The Userlist cycle gadget allows you to control if the User List is
  2922. visible or not visible, and if it is visible, if it is a separate
  2923. window, or a part of the AmIRC window.
  2924.  
  2925. The Order cycle gadget determinew how the userlist will be shown.
  2926. Either Alpabetical Order, New at bottom or New at top.
  2927.  
  2928. The Buttons? Gadget will toggle the gadgets in the User Action List,
  2929. located below the user list, either on or off. If the user list is
  2930. configured as a separate window, the buttons will also appear in that
  2931. window.
  2932.  
  2933. The Userlist win open? gadget will control if the userlist is open or
  2934. closed if configured as a separate window.
  2935.  
  2936. Misc
  2937. ----
  2938.  
  2939. Here you may select a different pubscreen for the QUERY window to appear
  2940. on. If no pubscreen is specified, the Query Window will open on the
  2941. AmIRC default screen.
  2942.  
  2943. Text Colors
  2944. -----------
  2945.  
  2946. In this section, you may configure the colors that certain text will
  2947. appear in AmIRC. These colors are based on the MUI pen colors that you
  2948. have configured in MUI. Just click and hold on the cycle gadget to see
  2949. a list of the MUI Pen colors available.
  2950.  
  2951. Normal Text
  2952.      Text that is a normal message from a user.
  2953.  
  2954. Private Messages
  2955.      Text that is a private message from another user to you.
  2956.  
  2957. Mode Changes
  2958.      Text that shows a mode change for the channel.
  2959.  
  2960. Highlighted Text
  2961.      Text that is configured in the Lists list for AmIRC.
  2962.  
  2963. Server Messages
  2964.      Text that comes from the server, e.g. when a user joins or exits
  2965.      the channel.
  2966.  
  2967. CTCP/DCC Messages
  2968.      Text that informs you of an incoming CTCP or DCC request.
  2969.  
  2970. AmIRC Configuration
  2971. *******************
  2972.  
  2973. Windows Page
  2974. ============
  2975.  
  2976. Open which windows on startup
  2977. -----------------------------
  2978.  
  2979. In this section you can determine which windows will be opened when
  2980. AmIRC is started. When the gadget behind an item is checked that window
  2981. will be opened.
  2982.  
  2983. Window List?
  2984.      The Window List or Tray Window holds a button for each opened
  2985.      window.
  2986.  
  2987. URL grabber?
  2988.      The URL Grabber window, keeps track of all URL's (or WWW
  2989.      addresses) mentioned on any of the joined channels.
  2990.  
  2991. RAW log?
  2992.      The RAW Log window contains the raw IRC messages.
  2993.  
  2994. DCC send list?
  2995.      The DCC send window can be used to monitor all outgoing DCC
  2996.      traffic.
  2997.  
  2998. Notify list?
  2999.      The Notify window holds all nicks you want to be notified of when
  3000.      they join IRC.
  3001.  
  3002. Info window?
  3003.      The Info window shows all redirected messages and a graphical
  3004.      representation of current lag to the server.
  3005.  
  3006. Privmsg log?
  3007.      The Privmsg displays all messages sent to you with MSG.
  3008.  
  3009. DCC recv list?
  3010.      The DCC recv window can be used to monitor all incoming DCC
  3011.      traffic.
  3012.  
  3013. Other automatic windows
  3014. -----------------------
  3015.  
  3016. 'Invite' window?
  3017.      The 'Invite' window is shown when you are INVITE to a channel.
  3018.  
  3019. Windows Limits
  3020. --------------
  3021.  
  3022. Scrollback Buffer Size:
  3023.      Here the size of the Scrollback buffer can be set (in lines).
  3024.  
  3025. Maximun Number of QUERY windows:
  3026.      Here you can set how many QUERY windows there will be open
  3027.      maximally at a time.
  3028.  
  3029. AmIRC Configuration
  3030. *******************
  3031.  
  3032. Logging Page
  3033. ============
  3034.  
  3035. Logging
  3036. -------
  3037.  
  3038. In this section the default logfile name and logdirectory can be set.
  3039. You can also specify if you want to log all Channel windows and Dialog
  3040. windows.
  3041.  
  3042. Logfile:
  3043.      This is the file that is used when 'Enable Logging?' item is
  3044.      enabled in the Menus.
  3045.  
  3046. Logfile directory:
  3047.      This is the directory where all individual logfiles are stored
  3048.      when a Channel or Dialog window is logged.
  3049.  
  3050. Log all Channels?
  3051.      When this item is checked all Channels will be logged.
  3052.  
  3053. Log all Dialog windows?
  3054.      When this item is checked all Dialog windows will be logged.
  3055.  
  3056. AmIRC Configuration
  3057. *******************
  3058.  
  3059. Misc Page
  3060. =========
  3061.  
  3062. CTCP COUND handling
  3063. -------------------
  3064.  
  3065. Here you may set the directory where AmIRC looks for files requested by
  3066. incoming CTCP requests. Also, the volume of the sound to be played back
  3067. can be set.  If the 'Use external player?' is checked, AmIRC will
  3068. attempt to use the player specified in the Player command line to
  3069. play sounds.  This player applies to CTCP Sound requests as well as
  3070. sounds configured in the Setup/Events page.
  3071.  
  3072. "Lists..." Menu Item
  3073. ********************
  3074.  
  3075. Lists Configuration
  3076. ===================
  3077.  
  3078. Alias Page
  3079. ----------
  3080.  
  3081. Here you can create aliases, or shortcuts for complex IRC commands.
  3082. Some examples have been created for you, and a reference template
  3083. appears at the bottom of this page. %p is the place holder for any
  3084. arguments you may wish to add when using an ALIAS.
  3085.  
  3086. Ignore Page
  3087. -----------
  3088.  
  3089. Here you can set which users if any you want to IGNORE, and what kind
  3090. of messages from them to ignore.  To add an ignore to the list, click
  3091. the Add Ignore gadget, then type the user's name in the text input
  3092. gadget labeled Ignore. Next click on the type of messages you want to
  3093. ignore.  Checking the Text box will prevent you from seeing any
  3094. public messages from the user. Setting the PrivMsgs box will prevent
  3095. you from seeing MSGs from that user to you. Likewise, clicking the
  3096. CTCPs box will prevent you from seeing any CTCP requests from the
  3097. Ignored user. To delete an ignore, click on the entry you wish to
  3098. delete, and then click on the Delete Ignore gadget.
  3099.  
  3100. Hilite Page
  3101. -----------
  3102.  
  3103. Here you may set certain text to be highlighted in order to get your
  3104. attention if that text appears. You may set text to match the Nick,
  3105. Userhost, or any keyword enclosed in double quotes. To add a new
  3106. pattern, click on the Button labeled Add new Hilite pattern, and type
  3107. your pattern into the input gadget. To delete an existing pattern,
  3108. Click on the entry you wish to delete and then click on the button
  3109. labeled Delete Hilite pattern. The Hilite patterns will ignore a
  3110. pattern it recognizes if it was input by you, but will activate on the
  3111. pattern from other users.
  3112.  
  3113. Pattern Definitions:
  3114. --------------------
  3115.  
  3116. Nick
  3117.      This will watch the AmIRC listview for the nick that you specify,
  3118.      and highlight the text for that users message.  The 'Nick' entry
  3119.      does not require double quotes.
  3120.  
  3121. Userhost
  3122.      This will watch for messages that originate from a particular
  3123.      Userhost, and highlight the text for that message. Userhost
  3124.      entries may contain wildcards.  Examples:
  3125.  
  3126.     fred!fdoe@doe1.powernet.edu
  3127.           This will highlight only messages from fred at that
  3128.           particular address.
  3129.  
  3130.     fred!*@*
  3131.           This will highlight messages from anyone named fred,
  3132.           regardless of address or login name.
  3133.  
  3134.     Fred!*@*.powernet.edu
  3135.           This will highlight messages from anyone named fred on any
  3136.           machine on powernet.edu
  3137.  
  3138.     *!*@doe1.powernet.edu
  3139.           This will highlight any messages from anyone on the doe1
  3140.           machine at powernet.edu
  3141.  
  3142.     *!*@*
  3143.           This will highlight any messages from any user.
  3144.  
  3145. "Keyword"
  3146.      This will highlight any message that contains the text enclosed in
  3147.      double quotes.
  3148.  
  3149. Function Key Definitions
  3150. ************************
  3151.  
  3152. Function Keys
  3153. =============
  3154.  
  3155. Here you may define the Amiga's ten function keys to insert text into
  3156. the input string gadget of AmIRC. By using the keys normally, or with
  3157. the shift or ctrl modifiers, you may define up to 30 text input
  3158. macros that can be used at the press of a key. This is similar to the
  3159. functon key macros found on many popular terminal emulation programs.
  3160.  
  3161. A /n at the end of a function key definition will send a <CR> after
  3162. the text. The function key definitions also allow placeholders, similar
  3163. to the Operation.
  3164.  
  3165. AmIRC's ARexx Port
  3166. ******************
  3167.  
  3168. Overview
  3169. ========
  3170.  
  3171. AmIRC supports a versatile ARexx Port.
  3172.  
  3173.  
  3174.  
  3175. ARGUMENTS:
  3176.  
  3177. None
  3178.  
  3179. DESCRIPTION:
  3180.  
  3181. This script is executed when AmIRC is launched.  It may be used to
  3182. initialise scripts.
  3183.  
  3184. Connected.amirx
  3185. ===============
  3186.  
  3187. ARGUMENTS:
  3188.  
  3189. None
  3190.  
  3191. DESCRIPTION:
  3192.  
  3193. This script is executed once a connection has been established to a
  3194. server.
  3195.  
  3196. Shutdown.amirx
  3197. ==============
  3198.  
  3199. ARGUMENTS:
  3200.  
  3201. None
  3202.  
  3203. DESCRIPTION:
  3204.  
  3205. This script is executed on shutdown of an AmIRC client.  It may be used
  3206. to flush memory.
  3207.  
  3208. Note: It is imperative to change host address in the beginning of the
  3209. script       becuase the AmIRC arexx port will drop shortly after
  3210. shutdown.amirx       is executed.  EXAMPLE :
  3211.  
  3212.      /* Shutdown.amirx */
  3213.      address REXX
  3214.  
  3215. Custom_CTCP.amirx
  3216. =================
  3217.  
  3218. ARGUMENTS:
  3219.  
  3220. command fromnick destination arguments
  3221.  
  3222. where "destination" is either the destination channel or   your own
  3223. nickname.
  3224.  
  3225. DESCRIPTION:
  3226.  
  3227. This script will be executed for every CTCP command received that is
  3228. not implemented internally into AmIRC.  When this script exists,the
  3229. "Unknown CTCP command ..." line will not be displayed, so include code
  3230. to emulate it.
  3231.  
  3232. EXAMPLE :
  3233.  
  3234. This example shows how to implement a simple page command that plays a
  3235. sound and deiconifies the client.
  3236.  
  3237.      /* Custom_CTCP.amirx */
  3238.      options results
  3239.      parse arg command fromnick destination arguments
  3240.      
  3241.      /* Display unknown CTCP commands */
  3242.      if command ~= 'PAGE' then do
  3243.          'ECHO P=½CTCP╗ C=5 Unknown "'command'" request from' fromnick'.'
  3244.          exit
  3245.      end
  3246.      /* Ignore if request was sent to a channel */
  3247.      if left(1,destination) ~= '#' then do
  3248.          /* echo a line,deiconify client and play a sample */
  3249.          'ECHO P=½CTCP╗ C=5' fromnick 'has paged you.'
  3250.          'SHOW'
  3251.          'PLAYSOUND Page.WAV'
  3252.      end
  3253.  
  3254. DCCDone.amirx
  3255. =============
  3256.  
  3257. ARGUMENTS:
  3258.  
  3259. com successcode nick filename
  3260.  
  3261. where :   successcode is 1 for a successfull DCC 0 for failed.    com
  3262. is SEND for Outgoing DCC's or RECEIVE for Incoming DCC's.
  3263.  
  3264. DESCRIPTION:
  3265.  
  3266. This script is executed when a DCC is completed/aborted/failed.  It may
  3267. be used to perform autgomated actions on received files.
  3268.  
  3269. EXAMPLE:
  3270.  
  3271. This script will extract lha/lzx archives to RAM: and play wav's and
  3272. snd's.
  3273.  
  3274.      /* DCCDone.amirx */
  3275.      options results
  3276.      parse arg com successcode nick filename
  3277.      
  3278.      /*Transfer failed/DCC is incoming - abort*/
  3279.      if successcode=0 | com='SEND' then exit
  3280.      
  3281.      /* Obtain 3 - letter extension */
  3282.      ext = upper(right(strip(filename,'B',' "'),4))
  3283.      
  3284.      /*
  3285.      ** #?.wav or #?.snd  will be played in AmIRC
  3286.      ** #?.lha will be extracted to RAM:
  3287.      ** #?.lzx will be extracted to RAM:
  3288.      */
  3289.      Select
  3290.          when ext = '.WAV' | ext = '.SND' then 'PLAYSOUND' filename
  3291.          when ext = '.LHA' then address command 'lha x' filename 'RAM:'
  3292.          when ext = '.lzx' then address command 'lzx x' filename 'RAM:'
  3293.      otherwise
  3294.      end
  3295.  
  3296. HandleFlood.amirx
  3297. =================
  3298.  
  3299. ARGUMENTS:
  3300.  
  3301. :nick!user@host type target :text
  3302.  
  3303. DESCRIPTION:
  3304.  
  3305. If this script exists,it will be called once AmIRC identifies a CTCP
  3306. flood.  It is passed the last flood-line as arguments.  If the script
  3307. does not exist, the internal AmIRC function will be used.
  3308.  
  3309. EXAMPLE :
  3310.  
  3311.      This example will effectively emulate the internal AmIRC flood
  3312.      protection.  One may improve on it.
  3313.      
  3314.      /* Handleflood.amirx */
  3315.      options results
  3316.      parse arg last
  3317.      "parseline" last
  3318.      
  3319.      parse value last.prefix WITH nick'!'user''host
  3320.      
  3321.      'SAY /IGNORE *!*'host 'CTCP'
  3322.      "ECHO P=FloodProt Flood from" nick "defused."
  3323.  
  3324. SAY
  3325. ===
  3326.  
  3327. Usage:
  3328.      SAY TEXT/F
  3329.  
  3330. DESCRIPTION:
  3331.  
  3332. Treats TEXT just like it has been entered in the string gadget of the
  3333. current window.
  3334.  
  3335. EXAMPLES:
  3336.  
  3337.      'say /JOIN #Amigager'
  3338.  
  3339. RELATED TOPICS: See RX_ECHO.
  3340.  
  3341. ISCONNECTED
  3342. ===========
  3343.  
  3344. Usage:
  3345.      ISCONNECTED
  3346.  
  3347. DESCRIPTION:
  3348.  
  3349. Checks whether a connection is currently established. Returns RC 0 if
  3350. the link is up, RC 5 otherwise.
  3351.  
  3352. EXAMPLES:
  3353.  
  3354.      "ISCONNECTED";"ECHO" rc
  3355.  
  3356. RELATED TOPICS:
  3357.  
  3358. GETMYNICK
  3359. =========
  3360.  
  3361. Usage:
  3362.      GETMYNICK
  3363.  
  3364. DESCRIPTION:
  3365.  
  3366. Returns your current nickname.
  3367.  
  3368. EXAMPLES:
  3369.  
  3370.      "GETMYNICK";"ECHO" result
  3371.  
  3372. RELATED TOPICS: See RX_GETSERVERNAME.
  3373.  
  3374. GETSERVERNAME
  3375. =============
  3376.  
  3377. Usage:
  3378.      GETSERVERNAME
  3379.  
  3380. DESCRIPTION:
  3381.  
  3382. Returns the name of the IRC server you are currently connected to.
  3383.  
  3384. EXAMPLES:
  3385.  
  3386.      "GETSERVERNAME";"ECHO" result
  3387.  
  3388. RELATED TOPICS: See RX_GETMYNICK.
  3389.  
  3390. USERHOST
  3391. ========
  3392.  
  3393. Usage:
  3394.      USERHOST NICK/A
  3395.  
  3396. DESCRIPTION:
  3397.  
  3398. Returns the userhost specification belonging to NICK.  AMIRC keeps an
  3399. internal list of the userhosts of every nick that occured yet. You can
  3400. query this database with this command.  Note however that it is
  3401. possible that the userhost isn't in the database yet; this command will
  3402. not query the server then, but simply return an error.
  3403.  
  3404. EXAMPLES:
  3405.  
  3406.      "USERHOST Olli";"ECHO" result
  3407.  
  3408. RELATED TOPICS: See RX_GETMYNICK.
  3409.  
  3410. ECHO
  3411. ====
  3412.  
  3413. Usage:
  3414.      ECHO P=PREFIX/K,C=COL/K/N,TEXT/F/A
  3415.  
  3416. DESCRIPTION:
  3417.  
  3418. Sends text to the listview.  With P=Text you can set the prefix which
  3419. will be put in the Prefix part of the echo.  With C=Colour you can set
  3420. any of the colours set in the AmIRC configuration.The colours you can
  3421. use are :
  3422. C=0 : Normal Text
  3423. C=1 : Highlighted Text
  3424. C=2 : Private Messages
  3425. C=3 : Server Messages
  3426. C=4 : Mode Changes
  3427. C=5 : CTCP/DCC Messages
  3428. BUGS:
  3429.  
  3430. AmigaDOS Readargs() has a small bug.
  3431.  
  3432. If you do "ECHO P" or "ECHO P=Prefix P is a letter" or "ECHO C" or
  3433. "ECHO C=1 C is a letter"
  3434.  
  3435. AmIRC will not display anything.  To cure this enter the template in
  3436. full like: "ECHO TEXT=P..."
  3437.  
  3438. EXAMPLES:
  3439.  
  3440.      "ECHO P=Kewlja C=3 This is echo test"
  3441.  
  3442. RAW
  3443. ===
  3444.  
  3445. Usage:
  3446.      RAW TEXT/F
  3447.  
  3448. DESCRIPTION:
  3449.  
  3450. Sends text to the server in raw format.
  3451.  
  3452. EXAMPLES:
  3453.  
  3454.      "RAW PRIVMSG phalanx :heya! whats happening?"
  3455.  
  3456. GETWINNUM
  3457. =========
  3458.  
  3459. Usage:
  3460.      GETWINNUM CHANNEL/A
  3461.  
  3462. DESCRIPTION:
  3463.  
  3464. Returns the window number for the specified channel.
  3465.  
  3466. EXAMPLES:
  3467.  
  3468.      options results;"getwinnum CHANNEL=#amiga";"ECHO" result
  3469.  
  3470. GETCHANNEL
  3471. ==========
  3472.  
  3473. Usage:
  3474.      GETCHANNEL WINNUM/N
  3475.  
  3476. DESCRIPTION:
  3477.  
  3478. Returns the name of the channel currently active in the format:
  3479. "#channel."
  3480.  
  3481. If the WINNUM argument is given , the channel for that window is
  3482. returned.
  3483.  
  3484. EXAMPLES:
  3485.  
  3486.      options results;"getchannel";"ECHO" result
  3487.  
  3488.      options results;"getchannel WINNUM=1";"ECHO" result
  3489.  
  3490. RELATED TOPICS: See RX_CHANNELS, RX_GETWINNUM.
  3491.  
  3492. CHANNELS
  3493. ========
  3494.  
  3495. Usage:
  3496.      CHANNELS
  3497.  
  3498. DESCRIPTION:
  3499.  
  3500. Returns a list of channels currently joined in the format: "#channel1
  3501. #channel2 etc."
  3502.  
  3503. EXAMPLES:
  3504.  
  3505.      options results;"channels";"ECHO" result
  3506.  
  3507. GETDCC
  3508. ======
  3509.  
  3510. Usage:
  3511.      GETDCC
  3512.  
  3513. DESCRIPTION:
  3514.  
  3515. Returns status of DCC Send,Receive and chat to stem variables.
  3516. Remember that the values set are the current ones.If your script will
  3517. delay for a minute or so the values for cps or state will possible
  3518. change.To refresh them,call GETDCC again.
  3519.  
  3520. The status is returned to three stems:
  3521.  
  3522.      dcc.send.#    : DCC Send
  3523.      dcc.send.0 holds number of entries.
  3524.      dcc.send.# is composed of :
  3525.      
  3526.      nick moveflag hostname state length cps filename
  3527.      
  3528.      * moveflag reflects if this DCC is MOVE or SEND
  3529.      state can be :
  3530.      
  3531.      0 : Waiting
  3532.      1 : Aborted
  3533.      2 : Sending
  3534.      3 : Complete
  3535.      4 : Failed
  3536.      5 : No Socket
  3537.      6 : No File
  3538.      7 : ReadError
  3539.      8 : Calculating Checksum
  3540.      So to see if a dcc is active, check if state=2|state=8
  3541.      
  3542.      dcc.receive.#    : DCC Receive
  3543.      dcc.receive.0 holds number of entries.
  3544.      dcc.receive.# is composed of :
  3545.      
  3546.      nick moveflag hostname state length cps filename
  3547.      
  3548.      * moveflag reflects if this DCC is MOVE or SEND
  3549.      
  3550.      state can be :
  3551.      
  3552.      0 : Waiting
  3553.      1 : Connecting
  3554.      2 : Receiving
  3555.      3 : Complete
  3556.      4 : Failed
  3557.      5 : Unable to connect
  3558.      6 : Aborted
  3559.      7 : No Socket
  3560.      8 : Unknown Host
  3561.      9 : No File
  3562.      10: Disk Write Error
  3563.      
  3564.      So to see if a dcc is active, check if state=1|state=2
  3565.      
  3566.      EXAMPLE :
  3567.      
  3568.      The following loop goes through the list of dcc receives(if there
  3569.      are ones active) and parses each entry.
  3570.      
  3571.      "GETDCC"
  3572.      if dcc.receive.0>0 THEN DO i=1 TO dcc.receive.0
  3573.          parse value dcc.receive.i WITH nick moveflag hostname state length cps filename .
  3574.          /*process*/
  3575.      end
  3576.      
  3577.      dcc.chat.#    : DCC Chat
  3578.      dcc.chat.0 holds number of entries.
  3579.      dcc.chat.# is composed of :
  3580.      
  3581.      nick state hostname
  3582.      
  3583.      state can be :
  3584.      
  3585.      0 : Waiting
  3586.      1 : Connecting
  3587.      2 : Connected
  3588.      3 : Waiting for
  3589.      4 : Closed
  3590.      5 : Unable to connect
  3591.      6 : No Socket
  3592.      7 : Aborted
  3593.      
  3594.      So to see if a dcc is active, check if state=1
  3595.      
  3596.      EXAMPLE :
  3597.      
  3598.      The following loop goes through the list of dcc chats(if there
  3599.      are ones active) and parses each entry.
  3600.      
  3601.      "GETDCC"
  3602.      if dcc.chat.0>0 THEN DO i=1 TO dcc.chat.0
  3603.          parse value dcc.receive.i WITH nick state hostname .
  3604.          /*process*/
  3605.      end
  3606.  
  3607. GETSELECTEDUSER
  3608. ===============
  3609.  
  3610. Usage:
  3611.      GETSELECTEDUSER WINNUM/N,CHANNEL/K
  3612.  
  3613. DESCRIPTION:
  3614.  
  3615. Returns the Nick the user highlighted in the userlist window.
  3616.  
  3617. If the WINNUM argument is specified,the selected user in that window
  3618. will be returned.  If the CHANNEL argument is specified,the selected
  3619. user in that channel will be returned.
  3620.  
  3621. EXAMPLES:
  3622.  
  3623.      options results;"getselecteduser";"ECHO" result
  3624.  
  3625.      options results;"getselecteduser WINNUM=1";"ECHO" result
  3626.  
  3627.      options results;"getselecteduser CHANNEL=#amiga";"ECHO" result
  3628.  
  3629. RELATED TOPICS: See RX_GETUSER, RX_GETUSERS, RX_GETWINNUM.
  3630.  
  3631. GETUSER
  3632. =======
  3633.  
  3634. Usage
  3635.      GETUSER USER/N/A,WINNUM/N,CHANNEL/K
  3636.  
  3637. DESCRIPTION:
  3638.  
  3639. Returns the nick of the user number given on the active channel
  3640. userlist.
  3641.  
  3642. If the WINNUM argument is specified,the nick in that window will be
  3643. returned.  If the CHANNEL argument is specified,the nick in that channel
  3644. will be returned.
  3645.  
  3646. Keep in mind,the userlist starts from 0!
  3647.  
  3648. EXAMPLES:
  3649.  
  3650.      options results; "getuser 0"; "ECHO" result
  3651.  
  3652.      options results; "getuser 0 WINNUM=1"; "ECHO" result
  3653.  
  3654.      options results; "getuser 0 CHANNEL=#amiga"; "ECHO" result
  3655.  
  3656. RELATED TOPICS: See RX_GETSELECTEDUSER, RX_GETUSERS, RX_GETWINNUM.
  3657.  
  3658. GETUSERS
  3659. ========
  3660.  
  3661. Usage
  3662.      GETUSERS WINNUM/N,CHANNEL/K
  3663.  
  3664. DESCRIPTION:
  3665.  
  3666. Returns a string containing the list of users on the active channel.
  3667.  
  3668. The user list is time-sorted and every user is appended the "@" char
  3669. for Ops and "+" char for voice.This is effectively a copy from /names
  3670. output.  This will look like : @Nick1 Nick2 +Nick3 Nick4 Nick1 is
  3671. opped,and joined the channel first(is first in the list).  Nick3 is
  3672. voiced.  Nick4 joined the channel last.
  3673.  
  3674. If the WINNUM argument is specified,the users in that window will be
  3675. returned.  If the CHANNEL argument is specified,the users in that
  3676. channel will be returned.
  3677.  
  3678. EXAMPLES:
  3679.  
  3680.      options results; "getusers"; "ECHO" result
  3681.  
  3682.      options results; "getusers WINNUM=1"; "ECHO" result
  3683.  
  3684.      options results; "getusers WINNUM=#amiga"; "ECHO" result
  3685.  
  3686. RELATED TOPICS: See RX_GETUSER, RX_GETSELECTEDUSER.
  3687.  
  3688. GETUSERSTATE
  3689. ============
  3690.  
  3691. Usage
  3692.      GETUSERSTATE USER/N/A,WINNUM/N,CHANNEL/K
  3693.  
  3694. DESCRIPTION:
  3695.  
  3696. Returns the status of user "num" on the active channel.
  3697.      RC=0 User is online, but has no special status.
  3698.  
  3699.      RC=1 User is Channel Operator.
  3700.  
  3701.      RC=2 User is online and has been "Voiced".
  3702.  
  3703.      RC=5 User # not in the userlist.
  3704.  
  3705. If the WINNUM argument is specified,the status for the user in that
  3706. window will be returned.  If the CHANNEL argument is specified,the
  3707. status for the user in that channel will be returned.
  3708.  
  3709. EXAMPLES:
  3710.  
  3711.      options results; "getuserstate 0"; "ECHO" rc
  3712.  
  3713.      options results; "getuserstate 0 WINNUM=1"; "ECHO" rc
  3714.  
  3715.      options results; "getuserstate 1 CHANNEL=#amiga"; "ECHO" rc
  3716.  
  3717. GETLINE
  3718. =======
  3719.  
  3720. Usage
  3721.      GETLINE
  3722.  
  3723. DESCRIPTION:
  3724.  
  3725. Waits for a line from the server and returns the following stem
  3726. variables;.
  3727.      LINE        = The entire, unparsed, line recieved.
  3728.  
  3729.      LINE.PREFIX = The Nick and user@host.
  3730.  
  3731.      LINE.COMMAND= The MSG Type.
  3732.  
  3733.      LINE.DEST   = The channel the message was written to.
  3734.  
  3735.      LINE.REST   = The message text.
  3736. EXAMPLES:
  3737.  
  3738.      options results
  3739.      
  3740.      "getline"
  3741.      
  3742.      text=line prefix=line.prefix comm=line.command dest=line.dest
  3743.      rest=line.rest
  3744.      
  3745.      "ECHO" text prefix comm dest rest
  3746.  
  3747. RELATED TOPICS: See RX_PARSELINE, RX_GETLASTLINE.
  3748.  
  3749. GETLINECOUNT
  3750. ============
  3751.  
  3752. Usage
  3753.      GETLINECOUNT
  3754.  
  3755. DESCRIPTION:
  3756.  
  3757. Returns the number of lines in the channel buffer for the active window
  3758. channel.
  3759.  
  3760. EXAMPLES:
  3761.  
  3762.      options results; "getlinecount"; "ECHO" result
  3763.  
  3764. RELATED TOPICS: See RX_GETLINE.
  3765.  
  3766. GETLASTLINE
  3767. ===========
  3768.  
  3769. Usage
  3770.      GETLASTLINE
  3771.  
  3772. DESCRIPTION:
  3773.  
  3774. Returns the last private message received in the format;.
  3775. :nick!~user@host Messagetype Nick :message text.
  3776.  
  3777. EXAMPLES:
  3778.  
  3779.      options results; "getlastline"; "ECHO" result
  3780.  
  3781. RELATED TOPICS: See RX_PARSELINE, RX_GETLINE.
  3782.  
  3783. GETAWAYSTATE
  3784. ============
  3785.  
  3786. Usage
  3787.      GETAWAYSTATE
  3788.  
  3789. DESCRIPTION:
  3790.  
  3791. Returns your away status.
  3792.      rc=0 Not away.
  3793.  
  3794.      rc=5 Away.
  3795. EXAMPLES:
  3796.  
  3797.      options results; "getawaystate"; "ECHO" rc
  3798.  
  3799. GETVERSION
  3800. ==========
  3801.  
  3802. Usage
  3803.      GETUSERS
  3804.  
  3805. DESCRIPTION:
  3806.  
  3807. Returns the Version number of AmIRC.
  3808.  
  3809. EXAMPLES:
  3810.  
  3811.      options results; "getversion"; "ECHO" result
  3812.  
  3813. GETCTCPSOUNDDIR
  3814. ===============
  3815.  
  3816. Usage
  3817.      GETCTCPSOUNDDIR
  3818.  
  3819. DESCRIPTION:
  3820.  
  3821. Returns the path to the sounds played with ctcp sound.
  3822.  
  3823. EXAMPLES:
  3824.  
  3825.      options results; "GETCTCPSOUNDDIR" ; "ECHO" result
  3826.  
  3827. GETDCCRECEIVEDIR
  3828. ================
  3829.  
  3830. Usage
  3831.      GETDCCRECEIVEDIR
  3832.  
  3833. DESCRIPTION:
  3834.  
  3835. Returns the path of the dcc receive directory.
  3836.  
  3837. EXAMPLES:
  3838.  
  3839.      options results; "GETDCCRECEIVEDIR" ; "ECHO" result
  3840.  
  3841. MATCHUSERHOST
  3842. =============
  3843.  
  3844. Usage
  3845.      MATCHUSERHOST USERHOST/A,PATTERN/A
  3846.  
  3847. DESCRIPTION:
  3848.  
  3849. Matches userhost with pattern and sets rc to 0 if there is no match and
  3850. rc to 1 if there is a match.  USERHOST must be a real host like
  3851. nick!user@hostname and not a pattern.  PATTERN may hold special
  3852. charecters like "*" and "?" such as ni*!use?@ho?tna*.
  3853.  
  3854. EXAMPLES:
  3855.  
  3856.      options results
  3857.      "MATCHUSERHOST Joe!Joeshmoe@ppp100.net.il *!*@*.net.il"
  3858.      "ECHO" rc
  3859.  
  3860. PLAYSOUND
  3861. =========
  3862.  
  3863. Usage
  3864.      PLAYSOUND FILENAME,EVENT/K/N
  3865.  
  3866. DESCRIPTION:
  3867.  
  3868. This command will play a sound via AmIRC.  It may play a sound-file if
  3869. you give it a filename.  You dont have to give a complete file name,you
  3870. can give one that is in the sounds directory.  You may also play the
  3871. sound set for one of the events by specifying the EVENT argument.
  3872.  
  3873. EXAMPLES:
  3874.  
  3875.      "PLAYSOUND Hello.WAV"
  3876.  
  3877.      "PLAYSOUND EVENT=1"
  3878.  
  3879. PARSELINE
  3880. =========
  3881.  
  3882. Usage
  3883.      PARSELINE LINE/F/A
  3884.  
  3885. DESCRIPTION:
  3886.  
  3887. Parses the line specified and returns the following stem variables;
  3888.      LINE        = The entire, unparsed, line recieved.
  3889.  
  3890.      LINE.PREFIX = The Nick and user@host
  3891.  
  3892.      LINE.COMMAND= The MSG Type
  3893.  
  3894.      LINE.DEST   = The channel the message was written to.
  3895.  
  3896.      LINE.REST   = The message text.
  3897. EXAMPLES:
  3898.  
  3899.      options results
  3900.      
  3901.      "getlastline"
  3902.      last=result
  3903.      "parseline" last
  3904.      
  3905.      text=line
  3906.      prefix=line.prefix
  3907.      comm=line.command
  3908.      dest=line.dest
  3909.      rest=line.rest
  3910.      
  3911.      "ECHO" text prefix comm dest rest
  3912.  
  3913. RELATED TOPICS: See RX_GETLINE, RX_GETLASTLINE.
  3914.  
  3915. How to Get Help & Updates
  3916. *************************
  3917.  
  3918. Support
  3919. =======
  3920.  
  3921.     AmIRC Support Mailing List
  3922.  
  3923.      To keep up to date on AmIRC improvements or to get answers to AmIRC
  3924.      problems, join the AmIRC support mailing list by sending email to:
  3925.      
  3926.      <AmIRC-Request@vapor.com>
  3927.      
  3928.      with the text ADD in the body.
  3929.      
  3930.      AmIRC FTP Support Site
  3931.      
  3932.      For AmIRC Updates & Patches, ftp to:
  3933.      
  3934.      ftp.vapor.com, /pub/amirc/
  3935.      
  3936.      AmIRC Support on the World Wide Web
  3937.      
  3938.      Or, Alternatively, visit the Vapor WWW Site at:
  3939.      
  3940.      http://www.vapor.com/
  3941.  
  3942. Index
  3943. *****
  3944.  
  3945.  
  3946.  
  3947.  ? command                              ?
  3948.  Actions Options                        Actions
  3949.  ADMIN command                          ADMIN
  3950.  Administrator, Showing                 ADMIN
  3951.  ALIAS command                          ALIAS
  3952.  Aliases, setting up                    Lists
  3953.  AmIRC Menu                             AmIRC
  3954.  AmIRC Support                          AmIRC Support
  3955.  ARexx Menu                             Rexx
  3956.  ARexx Reference                        ARexx
  3957.  Arexx, Using                           RX
  3958.  AWAY command                           AWAY
  3959.  AWAY, Resetting                        BACK
  3960.  AWAY, Setting                          AWAY
  3961.  BACK command                           BACK
  3962.  BAN command                            BAN
  3963.  Ban, Listing                           BANLIST
  3964.  Ban, Removing                          BANDEL
  3965.  BANDEL command                         BANDEL
  3966.  BANLIST command                        BANLIST
  3967.  Buffer, Searching                      LASTLOG
  3968.  CHANNEL command                        CHANNEL
  3969.  Channel Op, Removing                   DEOP
  3970.  Channel, Joining/Creating              JOIN
  3971.  Channel, Joining/Creating              CHANNEL
  3972.  Channel, Leaving                       LEAVE
  3973.  Channel, Leaving                       PART
  3974.  Channels, Listing                      LIST
  3975.  ChanOp, Setting                        OP
  3976.  Chat Window, Logging                   LOG
  3977.  Command, Renaming                      ALIAS
  3978.  Commands                               Commands
  3979.  Configuration Options                  AmIRC Setup
  3980.  Configuration with MUI                 MUI Preferences
  3981.  Configuring AmIRC                      Configuration
  3982.  CONNECT command                        CONNECT
  3983.  Connecting to an IRC server            Connecting
  3984.  Contents, Table of                     Top
  3985.  Copyright Information                  Copyright
  3986.  CTCP Action, Sending                   ME
  3987.  CTCP command                           CTCP
  3988.  CTCP command, Sending                  CTCP
  3989.  CTCP Ping, Sending                     PING
  3990.  CTCP Sound Settings                    Misc
  3991.  DCC command                            DCC
  3992.  DCC command, Sending                   DCC
  3993.  DEOP command                           DEOP
  3994.  DESCRIBE command                       DESCRIBE
  3995.  Events Options                         Events
  3996.  Features of AmIRC                      Features
  3997.  Function Keys, Setting up              Function Keys
  3998.  GLINE command                          GLINE
  3999.  Global KLine, Showing                  GLINE
  4000.  GUI Options                            GUI
  4001.  HELP command                           HELP
  4002.  Help, Getting                          HELP
  4003.  Help, Getting                          ?
  4004.  HIGHLITE command                       HIGHLITE
  4005.  Hilighting certain text                Lists
  4006.  HILITE command                         HILITE
  4007.  IGNORE command                         IGNORE
  4008.  Igoring Users                          Lists
  4009.  INFO command                           INFO
  4010.  Installing AmIRC                       Installation
  4011.  INVITE command                         INVITE
  4012.  IRC                                    IRC
  4013.  IRC Names, Showing                     NAMES
  4014.  IRC Terminology                        IRC Terms
  4015.  IRC, Quitting                          QUIT
  4016.  IRCNAME command                        IRCNAME
  4017.  IRCop, Setting                         OPER
  4018.  ISON command                           ISON
  4019.  JOIN command                           JOIN
  4020.  KICK command                           QKICK
  4021.  KICK command                           KICK
  4022.  KICKBAN command                        QKICKBAN
  4023.  KICKBAN command                        KICKBAN
  4024.  KILL command                           KILL
  4025.  LASTLOG command                        LASTLOG
  4026.  LEAVE command                          LEAVE
  4027.  LINKS command                          LINKS
  4028.  LIST command                           LIST
  4029.  Lists Menu                             Lists
  4030.  LOG command                            LOG
  4031.  Logging Settings                       Logging
  4032.  LUSERS command                         LUSERS
  4033.  M command                              M
  4034.  MAP command                            MAP
  4035.  ME command                             ME
  4036.  Menus                                  Menus
  4037.  Messages options                       Messages
  4038.  MODE command                           MODE
  4039.  Modes, Changing                        MODE
  4040.  MOTD command                           MOTD
  4041.  MOTD, Showing                          MOTD
  4042.  MSG command                            MSG
  4043.  MUI Configuration                      MUI Preferences
  4044.  NAMES command                          NAMES
  4045.  Net Etiquette                          IRC
  4046.  NICK command                           NICK
  4047.  Nickname, Changing                     NICK
  4048.  Nickname, Changing                     IRCNAME
  4049.  Nickname, Setting                      NICK
  4050.  NOTE command                           NOTE
  4051.  NOTICE command                         NOTICE
  4052.  Notice, Sending                        NOTICE
  4053.  NOTIFY command                         NOTIFY
  4054.  OP command                             OP
  4055.  OPER command                           OPER
  4056.  Operating AmIRC                        Operation
  4057.  Operators, Sending text to             WALLOPS
  4058.  PART command                           PART
  4059.  Pattern matching of users              WHO
  4060.  PING command                           PING
  4061.  Plugins Menu                           Plugins
  4062.  PrivMsg, Sending                       MSG
  4063.  PrivMsg, Sending                       RMSG
  4064.  PrivMsg, Sending                       M
  4065.  QUERY command                          QUERY
  4066.  Query window, Opening                  QUERY
  4067.  QUIT command                           QUIT
  4068.  QUOTE command                          QUOTE
  4069.  RAW command                            RAW
  4070.  Raw text, Sending                      QUOTE
  4071.  Raw text, Sending                      RAW
  4072.  Registration                           Registration
  4073.  REHASH command                         REHASH
  4074.  Requirements for running AmIRC         Requirements
  4075.  RESTART command                        RESTART
  4076.  RMSG command                           RMSG
  4077.  RX command                             RX
  4078.  RXRETURN command                       RXRETURN
  4079.  SERVER command                         SERVER
  4080.  Server Info, Getting                   INFO
  4081.  Server Links, Showing                  LINKS
  4082.  Server Map, Showing                    MAP
  4083.  Server, (Re)connecting                 CONNECT
  4084.  Server, Connecting                     SERVER
  4085.  Server, Quitting                       SQUIT
  4086.  Server, Resetting                      REHASH
  4087.  Server, Restarting                     RESTART
  4088.  Server, Tracing                        TRACE
  4089.  Settings Menu                          Settings
  4090.  Settings menu: Actions                 Actions
  4091.  Settings Menu: Events                  Events
  4092.  Settings Menu: GUI                     GUI
  4093.  Settings Menu: Messages                Messages
  4094.  SILENCE command                        SILENCE
  4095.  SOUND command                          SOUND
  4096.  Sounds, Sending                        SOUND
  4097.  SQUIT command                          SQUIT
  4098.  STATS command                          STATS
  4099.  Stats, Showing                         STATS
  4100.  SUMMON command                         SUMMON
  4101.  Support for AmIRC users                AmIRC Support
  4102.  Text, Highlighting                     HILITE
  4103.  Text, Highlighting                     HIGHLITE
  4104.  Text, Unhighlighting                   UNHIGHLITE
  4105.  Text, Unhighlighting                   UNHILITE
  4106.  TIME command                           TIME
  4107.  Time, Getting server's                 TIME
  4108.  TOPIC command                          TOPIC
  4109.  Topic, Changing                        TOPIC
  4110.  TRACE command                          TRACE
  4111.  UMODE command                          UMODE
  4112.  UNHIGHLITE command                     UNHIGHLITE
  4113.  UNHILITE command                       UNHILITE
  4114.  UNIGNORE command                       UNIGNORE
  4115.  UNVOICE command                        UNVOICE
  4116.  UPING command                          UPING
  4117.  User IsOn, Checking if                 ISON
  4118.  User Modes Menu                        User Modes
  4119.  User's, Finding more info on           WHOIS
  4120.  User, Banning                          BAN
  4121.  User, Describing to                    DESCRIBE
  4122.  User, Disconnecting                    KILL
  4123.  User, Giving Voice                     VOICE
  4124.  User, Ignoring                         IGNORE
  4125.  User, Inviting                         INVITE
  4126.  User, Kicking                          KICK
  4127.  User, Kicking                          QKICK
  4128.  User, Kicking/Banning                  KICKBAN
  4129.  User, Kicking/Banning                  QKICKBAN
  4130.  User, Notifying                        NOTIFY
  4131.  User, Removing Ignore                  UNIGNORE
  4132.  User, Removing Voice                   UNVOICE
  4133.  User, Silencing                        SILENCE
  4134.  User, Summon                           SUMMON
  4135.  User, Tracing                          TRACE
  4136.  USERHOST command                       USERHOST
  4137.  Userhost, Finding                      USERHOST
  4138.  USERS command                          USERS
  4139.  Users Info, Showing                    LUSERS
  4140.  Users, Listing                         USERS
  4141.  VERSION command                        VERSION
  4142.  Version, Server's software             VERSION
  4143.  Version, User's client                 VERSION
  4144.  VOICE command                          VOICE
  4145.  WALLOPS command                        WALLOPS
  4146.  What is IRC                            IRC
  4147.  What's new in AmIRC v2.1?              What's new?
  4148.  WHO command                            WHO
  4149.  Who Was User                           WHOWAS
  4150.  WHOIS command                          WHOIS
  4151.  WHOWAS command                         WHOWAS
  4152.  Windows Menu                           Windows
  4153.  Windows Settings                       Window
  4154.  
  4155.