Initial import of the ircii-pana-1.1-final source tree.

git-svn-id: svn://svn.code.sf.net/p/bitchx/code/tags/ircii-pana-1.1-final@1 13b04d17-f746-0410-82c6-800466cd88b0

bitchx-docs/3_Operators/3_Operators

@@ -0,0 +1,6 @@
+Section 3: IRC Operator Commands                                            
+
+This section includes commands only available to irc operators.  While it
+is probably worth a look, it will be of little practical use to anyone who
+isn't an irc operator.
+

bitchx-docs/3_Operators/connect

@@ -0,0 +1,27 @@
+Synopsis:
+   connect <new server> [[<port>] <existing server>]
+
+Description:
+   This command is used to connect servers to the irc network.  It must be
+   given at least one argument, the name of a remote server to connect to
+   the network.  If only one server is given, it is connected to the
+   client's server on the default port.  Alternately, a specific server
+   and port may be specified.
+
+   Wildcards are permitted in the server names, if they are unambiguous.
+
+Examples:
+   To connect irc.foo.com to your current server:
+      /connect irc.foo.com
+
+   To connect irc.foo.com with irc.bar.com on port 31337 of irc.bar.com:
+      /connect irc.foo.com 31337 irc.bar.com
+
+See Also:
+   die(3); squit(3)
+
+Restrictions:
+   This command is limited to irc operators, for reasons that should be
+   obvious.  Further, both servers must have appropriate C: and N: lines
+   in their configuration to allow the connection.
+

bitchx-docs/3_Operators/deoper

@@ -0,0 +1,13 @@
+Synopsis:
+   deoper
+
+Description:
+   This command is used by an irc operator to remove his or her operator
+   status.  That's it.
+
+Aliases:
+   DEOPER has the same effect as setting user mode -o with MODE.
+
+See Also:
+   mode(1); oper(3)
+

bitchx-docs/3_Operators/die

@@ -0,0 +1,13 @@
+Synopsis:
+   die
+
+Description:
+   DIE causes the operator's server to do just that; die.  The process
+   terminates normally.
+
+Restrictions:
+   This command is limited to irc operators.  Additionally, it may not be
+   available even to them, depending on how the server was compiled.  The
+   server must #define either OPER_DIE or LOCAL_DIE (or both) for someone
+   to be able to use it at all.
+

bitchx-docs/3_Operators/dline

@@ -0,0 +1,12 @@
+Synopsis:
+   dline <user@host>,<user@host> :<comment>
+
+Description:
+   DLINE is used to block a client from the irc server.  It works
+   similarly to a KLINE, except that a reason must be given (even if it
+   is meaningless or flat-out wrong). Multiple user@host may be specified
+   using comma's. The ":" specify's the comment. 
+
+Restrictions:
+   This command is limited to irc operators.  
+

bitchx-docs/3_Operators/hash

@@ -0,0 +1,14 @@
+Synopsis:
+   hash
+
+Description:
+   This command is primarily for debugging the irc server.  It is used to
+   profile the server's internal use of its hashed records.  It does not
+   actually do anything useful on the network, and is of little use to
+   anyone other than server programmers.
+
+Restrictions:
+   The protocol HASH command is only available (or at least only produces
+   useful output) when the irc server is compiled in debug mode.  Its use
+   is limited to irc operators.
+

bitchx-docs/3_Operators/helpop

@@ -0,0 +1,8 @@
+Synopsis:
+   helpop
+
+Description:
+   Unknown.
+
+Restrictions:
+

bitchx-docs/3_Operators/helpserv

@@ -0,0 +1,8 @@
+Synopsis:
+   helpserv
+
+Description:
+   Unknown.
+
+Restrictions:
+

bitchx-docs/3_Operators/kill

@@ -0,0 +1,19 @@
+Synopsis:
+   kill <nick> <comment>
+
+Description:
+   KILL is used to forcibly remote a client from the irc network.  It works
+   similarly to KICK, except that a reason must be given (even if it is
+   meaningless or flat-out wrong).
+
+   In general, KILL is useful only as a warning tool for abusive users.
+   Modern irc clients (this one included) have automated means for
+   reconnecting to a server after a disconnection (whether due to a KILL or
+   something else), so KILL is by no means a permanent solution.  It is not
+   intended as a means for personal vendettas; this practice is generally
+   frowned upon.
+
+Restrictions:
+   This command is limited to irc operators.  Further, local operators may
+   only KILL clients on their local server.
+

bitchx-docs/3_Operators/kline

@@ -0,0 +1,13 @@
+Synopsis:
+   kline [<seconds>] <user@host>,<user@host> :<comment>
+
+Description:
+   KLINE is used to ban a client from the irc server.  It works
+   similarly to a KILL, except that a reason must be given (even if it
+   is meaningless or flat-out wrong). Multiple user@host may be specified
+   using comma's. The ":" specify's the comment. If a "seconds" arguement
+   is given, then this becomes a timed KLINE.
+
+Restrictions:
+   This command is limited to irc operators.  
+

bitchx-docs/3_Operators/locop

@@ -0,0 +1,19 @@
+Synopsis:
+   locop <message>
+
+Description:
+   This command sends the given message to everyone on the server who has
+   user mode +w turned on.  If you are not an operator, you will probably
+   receive an error message when using this command.
+
+See Also:
+   mode(1); msg(1); notice(1); on(5) wallop
+
+Restrictions:
+   This command is limited to irc operators.
+
+Other Notes:
+   The existence of this command is not guaranteed.  It is easily abused by
+   over-zealous operators, and some networks have it disabled completely.
+   It is yet another example of a good idea gone to waste due to abuse.
+

bitchx-docs/3_Operators/oper

@@ -0,0 +1,23 @@
+Synopsis:
+   oper [<nick> [<password>]]
+
+Description:
+   The OPER command is used to gain irc operator status on the current
+   server, with the stipulation that the specified (or current) nickname
+   and password match an O: line entry in the server's configuration.
+   If a password is not specified, the client will prompt for one.
+
+See Also:
+   deop(3); mode(1)
+
+Restrictions:
+   Unlike DEOP, the MODE command cannot be used to gain operator status.
+
+Other Notes:
+   Specifying the password on the input line is not recommended, for many
+   reasons, the most obvious being that anyone with a line of sight to your
+   monitor can see what your password is.  When the client prompts for a
+   password, it does not display it as it is typed.  Further, the client's
+   command history may be written to a file, which would compromise the
+   password if the history file is world-readable.
+

bitchx-docs/3_Operators/rehash

@@ -0,0 +1,14 @@
+Synopsis:
+   rehash
+
+Description:
+   This command is used to force the current server to reload it's ircd.conf
+   configuration file.  This is useful for effecting configuration changes
+   without starting a new server.
+
+See Also:
+   restart(3)
+
+Restrictions:
+   This command is limited to irc operators on the server to be REHASHed.
+

bitchx-docs/3_Operators/restart

@@ -0,0 +1,14 @@
+Synopsis:
+   restart
+
+Description:
+   This command is used to completely restart the server.  A side effect of
+   this is that the configuration file will be read again.  However, it is
+   generally more useful for clearing out internal buffers and other wasted
+   memory.
+
+See Also:
+   rehash(3)
+
+Restrictions:
+   This command is limited to irc operators on the server to be RESTARTed.

bitchx-docs/3_Operators/rping

@@ -0,0 +1,15 @@
+Synopsis:
+   rping <server>
+
+Description:
+   This command works like the PING command (CTCP PING), except it is used
+   on a server instead of a client.  As with PING, it is used to test the
+   relative distance another server is from you across the irc network.
+
+See Also:
+   ping(1); uping(3)
+
+Restrictions:
+   This command is limited to irc operators.  Additionally, it is limited
+   to the Undernet, and servers using recent ircu server code.
+

bitchx-docs/3_Operators/sping

@@ -0,0 +1,16 @@
+Synopsis:
+   sping <server>|<.>|<-clear>
+
+Description:
+   This form of ping is similar to the Unix ping command.  It tests the
+   relative distance a server is from you on the Internet, which is useful
+   for detecting the source of irc lag or netsplits. Without an arguement,
+   sping will display the server pings it is currently waiting for. A
+   server name of "." will use your current server. The arguement -CLEAR
+   will clear the waiting server ping queue. This command is not restricted
+   to irc operators and should work on ALL irc networks.
+
+See Also:
+   ping(1); rping(3) uping(3)
+
+

bitchx-docs/3_Operators/squit

@@ -0,0 +1,31 @@
+Synopsis:
+   squit <server|mask> <comment>
+
+Description:
+   This command is used to send a server quit command to another server.
+   Due to the way some servers present themselves on the network, a
+   wildcard mask may be specified for the server to SQUIT.  This is
+   generally used in conjunction with CONNECT, for rerouting the network.
+
+   This command should never ever be used for personal vendettas!
+
+Examples:
+   To squit irc.foo.com:
+      /squit irc.foo.com rerouting
+
+   To squit all of Australia, which is hidden behind a server mask:
+      /squit *.au why is iceland routing aus?
+
+See Also:
+   connect(3)
+
+Restrictions:
+   This command is limited to irc operators, for reasons that should be
+   obvious.
+
+Other Notes:
+   Care must be taken when SQUITing a server mask.  The local server will
+   send the SQUIT to the first server it finds that matches the mask, and
+   it may not be the intended server if the mask is too general.  It is
+   best to avoid masks when possible.
+

bitchx-docs/3_Operators/swallop

@@ -0,0 +1,19 @@
+Synopsis:
+   swallop <message>
+
+Description:
+   This command sends the given message to everyone on the server who has
+   user mode +w turned on.  If you are not an operator, you will probably
+   receive an error message when using this command.
+
+See Also:
+   mode(1); msg(1); notice(1); on(5) wallop
+
+Restrictions:
+   This command is limited to irc operators.
+
+Other Notes:
+   The existence of this command is not guaranteed.  It is easily abused by
+   over-zealous operators, and some networks have it disabled completely.
+   It is yet another example of a good idea gone to waste due to abuse.
+

bitchx-docs/3_Operators/tkline

@@ -0,0 +1,12 @@
+Synopsis:
+   tkline <seconds> <user@host>[,<user@host>] :<comment>
+
+Description:
+   TKLINE is used to forcibly remote a client from the server. After
+   "seconds" has passed the server will remove the temporary kline. 
+   Multiple user@host's may be specified using a , delimited list. A colon
+   is the start of the comment.
+
+Restrictions:
+   This command is limited to irc operators.  
+

bitchx-docs/3_Operators/unkline

@@ -0,0 +1,9 @@
+Synopsis:
+   unkline <user@host>
+
+Description:
+   UNKLINE is used to remove a ban on a client from the irc server.
+
+Restrictions:
+   This command is limited to irc operators.  
+

bitchx-docs/3_Operators/uping

@@ -0,0 +1,15 @@
+Synopsis:
+   uping <server>
+
+Description:
+   This form of ping is similar to the Unix ping command.  It tests the
+   relative distance a server is from you on the Internet, which is useful
+   for detecting the source of irc lag or netsplits.
+
+See Also:
+   ping(1); rping(3)
+
+Restrictions:
+   This command is limited to irc operators.  Additionally, it is limited
+   to the Undernet, and servers using recent ircu server code.
+

bitchx-docs/3_Operators/wallops

@@ -0,0 +1,19 @@
+Synopsis:
+   wallops <message>
+
+Description:
+   This command sends the given message to everyone on the network who has
+   user mode +w turned on.  If you are not an operator, you will probably
+   receive an error message when using this command.
+
+See Also:
+   mode(1); msg(1); notice(1); on(5) wallop
+
+Restrictions:
+   This command is limited to irc operators.
+
+Other Notes:
+   The existence of this command is not guaranteed.  It is easily abused by
+   over-zealous operators, and some networks have it disabled completely.
+   It is yet another example of a good idea gone to waste due to abuse.
+