Accept topic changes from servers that do not send topic-set timestamps (fixes SF...
[ircu2.10.12-pk.git] / doc / ircd.8
index be36b88fc323e56497f01e0fb1d9fd0ce5968dc0..681fbc36e3da2e3dcdc615d6a38f49b2691d89fe 100644 (file)
@@ -1,22 +1,23 @@
 .\" @(#)ircd.8 2.0 (beta version) 29 Mar 1989 
-.TH IRCD 8 "29 March 1989"
+.TH IRCD 8 "10 July 2000"
 .SH NAME
-ircd \- The Internet Relay Chat Program Server 
+ircd \- The Undernet Internet Relay Chat Daemon
 .SH SYNOPSIS
 .hy 0
 .IP \fBircd\fP
-[-a] [-c] [-i] [-o] [-q] [-t] [-d directory]
-[-f configfile] [-w interface] [-x debuglevel] [-h hostname] [-p portnum]
+[-t] [-d directory] [-f configfile] [-x debuglevel] [-h hostname]
 .SH DESCRIPTION
 .LP
-\fIircd\fP is the server (daemon) program for the Internet Relay Chat
-Program.  The \fIircd\fP is a server in that its function is to "serve"
+\fIircd\fP is the Undernet Internet Relay Chat daemon.  
+\fIircd\fP is a server in that its function is to "serve"
 the client program \fIirc(1)\fP with messages and commands.  All commands
-and user messages are passed directly to the \fIircd\fP for processing
-and relaying to other ircd sites.  The \fIirc(1)\fP program depends upon
-there being an \fIircd\fP server running somewhere (either on your local
-UNIX site or a remote ircd site) so that it will have somewhere to connect
-to and thus allow the user to begin talking to other users. 
+and user messages are passed directly to \fIircd\fP for processing
+and relaying to other servers.  \fIirc(1)\fP depends upon
+there being an \fIircd\fP server running somewhere for it to connect to
+and thus allow the user to begin talking to other users.
+.LP
+There are many common clients including ircII, EPIC, and BitchX for UNIX,
+mIRC and pIRCh for Windows, and IRCle and Homer for the Macintosh.
 .SH OPTIONS
 .TP
 .B \-d directory
@@ -24,82 +25,46 @@ This option tells the server to change to that directory and use
 that as a reference point when opening \fIircd.conf\fP and other startup
 files.
 .TP
-.B \-o
-Starts up a local ircdaemon. Standard input can be used to send IRC
-commands to the daemon. The user logging in from standard input will
-be given operator privileges on this local ircd. If ircd is a setuid program,
-it will call setuid(getuid()) before going to local mode. This option
-can be used in inetd.conf to allow users to open their own irc clients
-by simply connecting their clients to the correct ports. For example:
-.TP
-.B
-irc stream tcp nowait irc /etc/ircd ircd \\-f/etc/ircd.conf \\-o
-
-allows users connecting to irc port (specified in /etc/services) to start
-up their own ircdaemon. The configuration file should be used to check from
-which hosts these connections are allowed from. This option also turns
-on the autodie option -a.
-.TP
-.B \-a
-Instructs the server to automatically die off if it loses all it's clients.
-.TP
 .B \-t
-Instructs the server run in the foreground and to direct debugging output to standard output.
+Instructs the server run in the foreground and to direct debugging output to
+standard output.
 .TP
 .B \-x#
-Defines the debuglevel for ircd. The higher the debuglevel, the more stuff
-gets directed to debugging file (or standard output if -t option was used
-as well).
-.TP
-.B \-i
-The server was started by inetd and it should start accepting connections
-from standard input. The following inetd.conf-line could be used to start
-up ircd automatically when needed:
-.TP
-.B
-ircd stream tcp wait irc /etc/ircd ircd \-i
-
-allows inetd to start up ircd on request.
+Defines the debug level for \fIircd\fP. The higher the debug level, the more
+messages get directed to debugging file (or standard output if the -t option is
+used).
 .TP
 .B \-w interface
-If the server was compiled with VIRTUAL_HOST (run 'make config' to toggle
-this compile option), then \fIinterface\fP is passed to gethostbyname(3) in
-order to retrieve the IP-number of the interface to bind to. An example
-would be to use '-w localhost', after which the server only listens on the
-loopback interface.  Run `ifconfig -a' to see which interfaces you have.
+This option is deprecated.  Outgoing connections are bound to the
+interface specified in the M: line, and incoming connections are accepted only on
+interfaces specified in the P: lines.
 .TP
 .B \-f filename
-Specifies the ircd.conf file to be used for this ircdaemon. The option
-is used to override the default ircd.conf given at compile time.
+Specifies the \fIircd.conf\fP file to be used for this server. The option
+is used to override the default \fIircd.conf\fP given at compile time.
 .TP
 .B \-c
-This flag must be given if you are running ircd from \fI/dev/console\fP or
-any other situation where fd 0 isnt a tty and you want the server to fork
+This flag must be given if you are running \fIircd\fP from \fI/dev/console\fP or
+any other situation where fd 0 isn't a TTY and you want the server to fork
 off and run in the background. This needs to be given if you are starting
 \fIircd\fP from an \fIrc\fP (such as \fI/etc/rc.local\fP) file.
 .TP
-.B \-q
-Using the -q option stops the server from doing DNS lookups on all the
-servers in your \fIircd.conf\fP file when it boots. This can take a lengthy
-amount of time if you have a large number of servers and they are not all
-close by.
-.TP
 .B \-h hostname
 Allows the user to manually set the server name at startup. The default
 name is hostname.domainname.
-.B \-p portname
-Specifies the server port where the daemon should start waiting for connections
-from other servers. Clients should connect to ports as specified in the ircd.conf file by means of a P: line.
 .TP
-.SH
-If you plan to connect your \fIircd\fP server to an existing Irc-Network,
-you will need to alter your local IRC CONFIGURATION FILE (typically named
-"ircd.conf") so that it will accept and make connections to other \fIircd\fP
-servers.  This file contains the hostnames, Network Addresses, and sometimes
-passwords for connections to other ircds around the world.  Because 
-description of the actual file format of the "ircs.conf" file is beyond the
-scope of this document, please refer to the file INSTALL in the IRC source
-files documentation directory.
+.B \-p portname
+This is deprecated in favor of specifying server ports in P: lines.
+
+.SH CONFIGURATION
+If you plan to connect your \fIircd\fP server to an existing IRC network,
+you will need to alter your local \fIircd\fP configuration file (typically named
+\fIircd.conf\fP) so that it will accept and make connections to other IRC
+servers.  This file contains the hostnames, network addresses, and
+passwords for connections to other IRC servers around the world.  Because 
+the description of the \fIircd.conf\fP file is beyond the scope of this
+document, please refer to the INSTALL file in the \fIircd\fP
+documentation directory.
 .LP
 BOOTING THE SERVER:  The \fIircd\fP server can be started as part of the
 UNIX boot procedure or just by placing the server into Unix Background.
@@ -136,12 +101,11 @@ For full COPYRIGHT see LICENSE file with IRC package.
 .RE
 .SH FILES
  /etc/utmp
- "irc.conf"
+ "ircd.conf"
 .SH "SEE ALSO"
 irc(1)
 .SH BUGS
-None... ;-) if somebody finds one, please inform author
+See the file 'BUGS' included in the distribution.
 .SH AUTHOR
-Jarkko Oikarinen, currently jto@tolsun.oulu.fi,
-manual page written by Jeff Trim, jtrim@orion.cair.du.edu,
-later modified by jto@tolsun.oulu.fi.
+The current authors of the undernet IRC daemon are coder-com@undernet.org,
+the original author was Jarkko Oikarinen.
\ No newline at end of file