home *** CD-ROM | disk | FTP | other *** search
/ ftp.swcp.com / ftp.swcp.com.zip / ftp.swcp.com / mac / mozilla-mac-0.9.sea.hqx / mozilla-mac-0.9 / Chrome / chatzilla.jar / content / chatzilla / commands.js < prev    next >
Text File  |  2001-05-05  |  11KB  |  286 lines
  1. /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  2.  *
  3.  * The contents of this file are subject to the Mozilla Public
  4.  * License Version 1.1 (the "License"); you may not use this file
  5.  * except in compliance with the License. You may obtain a copy of
  6.  * the License at http://www.mozilla.org/MPL/
  7.  *
  8.  * Software distributed under the License is distributed on an "AS
  9.  * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
  10.  * implied. See the License for the specific language governing
  11.  * rights and limitations under the License.
  12.  *
  13.  * The Original Code is JSIRC Test Client #3
  14.  *
  15.  * The Initial Developer of the Original Code is New Dimensions Consulting,
  16.  * Inc. Portions created by New Dimensions Consulting, Inc. are
  17.  * Copyright (C) 1999 New Dimenstions Consulting, Inc. All
  18.  * Rights Reserved.
  19.  *
  20.  * Contributor(s): 
  21.  *
  22.  *
  23.  * Contributor(s):
  24.  *  Robert Ginda, rginda@ndcico.com, original author
  25.  */
  26.  
  27. function addCommands(commandObject)
  28. {
  29.  
  30.     function add (name, func, usage, help)
  31.     {
  32.         commandObject.add (name, func, usage, help);
  33.     }
  34.     
  35.     add ("attach", "onInputAttach",
  36.          "[<network-name>] [<password>]",
  37.          "Attaches to the network specified by <network-name>, " +
  38.          "or the current network, if no network is specified.  " +
  39.          "Provides the password <password> if specified.  If you are already " +
  40.          "attached, the view for <network-name> is made current.  If that " +
  41.          "view has been deleted, it is recreated.");
  42.  
  43.     add ("away", "onInputAway",
  44.          "[<reason>]",
  45.          "If <reason> is spcecified, sets you away with that message. " +
  46.          "Used without <reason>, you are marked back as no longer being away.");
  47.     
  48.     add ("cancel", "onInputCancel", "",
  49.          "Cancels a /attach or /server command.  Use /cancel when ChatZilla " +
  50.          "is repeatdly trying to attach to a network that is not responding, " +
  51.          "to tell ChatZilla to give up before the normal number of retries.");
  52.  
  53.     add ("clear", "onInputClear", "",
  54.          "Clear the current view, discarding *all* content.");
  55.  
  56.     add ("client", "onInputClient", "",
  57.          "Make the ``*client*'' view current.  If the ``*client*'' view has " +
  58.          "been deleted, it will be recreated.");
  59.     
  60.     add ("commands", "onInputCommands", "[<pattern>]",
  61.          "Lists all command names matching <pattern>, or all command names " +
  62.          "if pattern is not specified.");
  63.       
  64.     add ("ctcp", "onInputCTCP",
  65.          "<target> <code> [<params>]",
  66.          "Sends the CTCP code <code> to the target (user or channel) " +
  67.          "<target>.  If <params> are specified they are sent along as well.");
  68.     
  69.     add ("delete", "onInputDelete", "",
  70.          "Clear the current view, discarding *all* content, and drop it's " +
  71.          "icon from the toolbar.");
  72.  
  73.     add ("deop", "onInputDeop",
  74.          "<nick>",
  75.          "Removes operator status from <nick> on current channel. " +
  76.          "Requires operator status.");
  77.     
  78.     add ("desc", "onInputDesc",
  79.          "<description>",
  80.          "Changes the 'ircname' line returned when someone performs a /whois " +
  81.          "on you.  You must specify this *before* connecting to the network.");
  82.  
  83.     add ("devoice", "onInputDevoice",
  84.          "<nick>",
  85.          "Removes voice status from <nick> on current channel. " +
  86.          "Requires operator status.");    
  87.     
  88.     add ("disconnect", "onInputQuit", "[<reason>]",
  89.          "Disconnects from the server represented by the active view when " +
  90.          "the command is executed providing the reason <reason> " +
  91.          "or the default reason if <reason> is not specified.");
  92.  
  93.     add ("echo", "onInputEcho",
  94.          "<text>",
  95.          "Displays <text> in the current view, but does not send it to " +
  96.          "the server.");
  97.  
  98.     add ("eval", "onInputEval",
  99.          "<script>",
  100.          "Evaluates <script> as JavaScript code.  Not for the faint of heart.");
  101.  
  102.     add ("exit", "onInputExit", "[<reason>]",
  103.          "Disconnects from all active servers and networks,  providing the " +
  104.          "reason <reason>, or the default reason if <reason> is not " +
  105.          "specified.  Exits ChatZilla after disconnecting.");
  106.  
  107.     /* FIXME: JG: not implemented yet */
  108.     /*
  109.       add ("filter", "onInputFilter",
  110.       "<regex>",
  111.       "Shows only messages matching <regex> on current channel. When used " $
  112.       "with no parameter, the contents are restored.");
  113.     */  
  114.     
  115.     add ("help", "onInputHelp",
  116.          "[<command-name>]",
  117.          "Displays help on all commands matching <command-name>, if " +
  118.          "<command-name> is not given, displays help on all commands");
  119.  
  120.     add ("hide", "onInputHide", "",
  121.          "Drop the current view's icon from the toolbar, but save it's " +
  122.          "contents.  The icon will reappear the next time there is activity " +
  123.          "on the view.");
  124.  
  125.     add ("infobar", "onInputInfobar", "",
  126.          "Toggles the visibility of the username list.");
  127.  
  128.     add ("invite", "onInputInvite",
  129.          "<nick> [<channel>]",
  130.          "Invites <nick> to <channel> or current channel if not " +
  131.          "supplied. Requires operator status if +i is set.");
  132.     
  133.     add ("join", "onInputJoin",
  134.          "[#|&|+]<channel-name> [<key>]",
  135.          "Joins a the global (name starts with #), local (name starts " +
  136.          "with &), or modeless (name starts with a +) channel named " +
  137.          "<channel-name>.  If no prefix is given, # is " +
  138.          "assumed.  Provides the key <key> if specified.");
  139.  
  140.     add ("kick", "onInputKick",
  141.          "[<channel>] <nick>",
  142.          "Kicks <nick> from <channel> or current channel if not " +
  143.          "supplied. Requires operator status.");    
  144.  
  145.     add ("leave", "onInputLeave",
  146.          "",
  147.          "Leaves the current channel, use /delete or /hide to force the " +
  148.          "view to go away.");
  149.  
  150.     add ("list", "onInputSimpleCommand",
  151.          "[channel]",
  152.          "Lists channel name, user count, and topic information for the " +
  153.          "network/server you are attached to.  If you omit the optional " +
  154.          "channel argument, all channels will be listed.  On large networks, " +
  155.          "the server may disconnect you for asking for a complete list.");
  156.  
  157.     add ("me", "onInputMe",
  158.          "<action>",
  159.          "Performs an 'action' on the current channel.");
  160.     
  161.     add ("msg", "onInputMsg",
  162.          "<user> <msg>",
  163.          "Sends a private message <msg> to the user <user>.");
  164.     
  165.     add ("name", "onInputName",
  166.          "<username>",
  167.          "Changes the username displayed before your hostmask if the server " +
  168.          "you're connecting to allows it.  Some servers will only trust the " +
  169.          "username reply from the ident service.  You must specify this " +
  170.          "*before* connecting to the network.");
  171.  
  172.     add ("names", "onInputNames", "[<channel>]",
  173.          "Lists the users in a channel.");
  174.  
  175.     add ("network", "onInputNetwork",
  176.          "<network-name>",
  177.          "Sets the current network to <network-name>");
  178.  
  179.     add ("networks", "onInputNetworks",
  180.          "",
  181.          "Lists all available networks as clickable links.");
  182.  
  183.     add ("nick", "onInputNick",
  184.          "<nickname>",
  185.          "Changes your current nickname.");
  186.  
  187.     add ("notify", "onInputNotify",
  188.          "[<nickname> [...]]",
  189.          "With no parameters, /notify shows you the online/offline status " +
  190.          "of all the users on your notify list.  If one or more <nickname> " +
  191.          "parameters are supplied, the nickname(s) will be added to your " +
  192.          "notify list if they are not yet on it, or removed from it if they "+
  193.          "are.");
  194.  
  195.     add ("op", "onInputOp",
  196.          "<nick>",
  197.           "Gives operator status to <nick> on current channel. Requires " +
  198.          "operator status.");
  199.     
  200.     add ("part", "onInputLeave",
  201.          "",
  202.          "See /leave");
  203.  
  204.     add ("query", "onInputQuery", ",<user> [<msg>]",
  205.          "Opens a one-on-one chat with <usr>.  If <msg> is supplied, it is " +
  206.          "sent as the initial private message to <user>.");
  207.  
  208.     add ("quit", null, "[<reason>]",
  209.          "This command has been replaced by /disconnect.");
  210.  
  211.     add ("quote", "onInputQuote",
  212.          "<irc-command>",
  213.          "Sends a raw command to the IRC server, not a good idea if you " +
  214.          "don't know what you're doing. see IRC 1459 " +
  215.          "( http://www.irchelp.org/irchelp/rfc1459.html ) for complete " +
  216.          "details.");
  217.  
  218.     add ("server", "onInputServer",
  219.          "<server-hostname> [<port>] [<password>]",
  220.          "Connects to server <server-hostname> on <port>, or 6667 if " +
  221.          "<port> is not specified.  Provides the password <password> if " +
  222.          "specified. If you are already connected, " +
  223.          "the view for <server-hostname> is made current.  If that view " +
  224.          "has been deleted, it is recreated.");
  225.  
  226.     add ("stalk", "onInputStalk",
  227.          "<text>",
  228.          "Add text to list of words for which you would like to see alerts." +
  229.          "Whenever a person with a nickname macthing <text> speaks, or " +
  230.          "someone says a phrase containing <text>, your " +
  231.          "ChatZilla window will become active (on some operating systems) " +
  232.          "and it's taskbar icon will flash (on some operating systems.)");
  233.  
  234.     add ("status", "onInputStatus", "",
  235.          "Shows status information for the current view.");
  236.     
  237.     add ("statusbar", "onInputStatusbar", "",
  238.          "Toggles the visibility of the status bar.");
  239.  
  240.     add ("testdisplay", "onInputTestDisplay",
  241.          "",
  242.          "Displays a sample text.  Used to preview styles");
  243.  
  244.     add ("topic", "onInputTopic",
  245.          "[<new-topic>]",
  246.          "If <new-topic> is specified and you are a chanop, or the channel " +
  247.          "is not in 'private topic' mode (+t), the topic will be changed to " +
  248.          "<new-topic>.  If <new-topic> is *not* specified, the current topic " +
  249.          "will be displayed");
  250.  
  251.     add ("toolbar", "onInputToolbar", "",
  252.          "Toggles the visibility of the channel toolbar.");
  253.  
  254.     add ("unstalk", "onInputUnstalk",
  255.          "<text>",
  256.          "Remove word from list of terms for which you would like to see " +
  257.          "alerts.");
  258.  
  259.     add ("voice", "onInputVoice",
  260.          "<nick>",
  261.          "Gives voice status to <nick> on current channel. " +
  262.          "Requires operator status.");   
  263.  
  264.     add ("who", "onInputSimpleCommand",
  265.          "<pattern>",
  266.          "List users who have name, host, or description information matching" +
  267.          " <pattern>.");
  268.     
  269.     add ("whois", "onInputWhoIs",
  270.          "<nick>",
  271.          "Displays information about the user <nick>, including 'real name', " +
  272.          "server connected to, idle time, and signon time.  Note that some " +
  273.          "servers will lie about the idle time.");
  274.  
  275.  
  276.     
  277. /*
  278.     add ("zoom", "onInputZoom",
  279.          "<nick>",
  280.          "Shows only messages <nick> has sent to the channel, filtering out " +
  281.          "all others, (including yours.)");
  282. */
  283.     
  284. }
  285.  
  286.