doc/ircd.8

   1 .\" @(#)ircd.8 2.0 (beta version) 29 Mar 1989
   2 .TH IRCD 8 "29 March 1989"
   3 .SH NAME
   4 ircd \- The Internet Relay Chat Program Server
   5 .SH SYNOPSIS
   6 .hy 0
   7 .IP \fBircd\fP
   8 [-a] [-c] [-i] [-o] [-q] [-t] [-d directory]
   9 [-f configfile] [-w interface] [-x debuglevel] [-h hostname] [-p portnum]
  10 .SH DESCRIPTION
  11 .LP
  12 \fIircd\fP is the server (daemon) program for the Internet Relay Chat
  13 Program.  The \fIircd\fP is a server in that its function is to "serve"
  14 the client program \fIirc(1)\fP with messages and commands.  All commands
  15 and user messages are passed directly to the \fIircd\fP for processing
  16 and relaying to other ircd sites.  The \fIirc(1)\fP program depends upon
  17 there being an \fIircd\fP server running somewhere (either on your local
  18 UNIX site or a remote ircd site) so that it will have somewhere to connect
  19 to and thus allow the user to begin talking to other users.
  20 .SH OPTIONS
  21 .TP
  22 .B \-d directory
  23 This option tells the server to change to that directory and use
  24 that as a reference point when opening \fIircd.conf\fP and other startup
  25 files.
  26 .TP
  27 .B \-o
  28 Starts up a local ircdaemon. Standard input can be used to send IRC
  29 commands to the daemon. The user logging in from standard input will
  30 be given operator privileges on this local ircd. If ircd is a setuid program,
  31 it will call setuid(getuid()) before going to local mode. This option
  32 can be used in inetd.conf to allow users to open their own irc clients
  33 by simply connecting their clients to the correct ports. For example:
  34 .TP
  35 .B
  36 irc stream tcp nowait irc /etc/ircd ircd \\-f/etc/ircd.conf \\-o
  37
  38 allows users connecting to irc port (specified in /etc/services) to start
  39 up their own ircdaemon. The configuration file should be used to check from
  40 which hosts these connections are allowed from. This option also turns
  41 on the autodie option -a.
  42 .TP
  43 .B \-a
  44 Instructs the server to automatically die off if it loses all it's clients.
  45 .TP
  46 .B \-t
  47 Instructs the server run in the foreground and to direct debugging output to standard output.
  48 .TP
  49 .B \-x#
  50 Defines the debuglevel for ircd. The higher the debuglevel, the more stuff
  51 gets directed to debugging file (or standard output if -t option was used
  52 as well).
  53 .TP
  54 .B \-i
  55 The server was started by inetd and it should start accepting connections
  56 from standard input. The following inetd.conf-line could be used to start
  57 up ircd automatically when needed:
  58 .TP
  59 .B
  60 ircd stream tcp wait irc /etc/ircd ircd \-i
  61
  62 allows inetd to start up ircd on request.
  63 .TP
  64 .B \-w interface
  65 \fIinterface\fP is passed to gethostbyname(3) in order to retrieve the
  66 IP-number of the default interface to bind to.  An example would be to
  67 use `-w localhost' after which the server listens by default on the
  68 loopback interface.  Use `ifconfig -a' to see which interfaces you have.
  69 Without this option the hostname in the M: line is used as default
  70 interface and if that doesn't resolve, all interfaces are used. The
  71 server uses the default interface to listen for UDP packets (UPING)
  72 and for each listen port without a specified interface to bind to.
  73 Interfaces can be specified per listen port in the configuration file
  74 (ircd.conf) using P: lines. Note that the last P: line in the
  75 ircd.conf specifying an interface (not localhost) overrules the
  76 default CONNECT interface (outgoing connections) but does not change
  77 the default listen interface as described above.
  78 .TP
  79 .B \-f filename
  80 Specifies the ircd.conf file to be used for this ircdaemon. The option
  81 is used to override the default ircd.conf given at compile time.
  82 .TP
  83 .B \-c
  84 This flag must be given if you are running ircd from \fI/dev/console\fP or
  85 any other situation where fd 0 isnt a tty and you want the server to fork
  86 off and run in the background. This needs to be given if you are starting
  87 \fIircd\fP from an \fIrc\fP (such as \fI/etc/rc.local\fP) file.
  88 .TP
  89 .B \-q
  90 Using the -q option stops the server from doing DNS lookups on all the
  91 servers in your \fIircd.conf\fP file when it boots. This can take a lengthy
  92 amount of time if you have a large number of servers and they are not all
  93 close by.
  94 .TP
  95 .B \-h hostname
  96 Allows the user to manually set the server name at startup. The default
  97 name is hostname.domainname.
  98 .B \-p portname
  99 Specifies the server port where the daemon should start waiting for connections
 100 from other servers. Clients should connect to ports as specified in the ircd.conf file by means of a P: line.
 101 .TP
 102 .SH
 103 If you plan to connect your \fIircd\fP server to an existing Irc-Network,
 104 you will need to alter your local IRC CONFIGURATION FILE (typically named
 105 "ircd.conf") so that it will accept and make connections to other \fIircd\fP
 106 servers.  This file contains the hostnames, Network Addresses, and sometimes
 107 passwords for connections to other ircds around the world.  Because
 108 description of the actual file format of the "ircs.conf" file is beyond the
 109 scope of this document, please refer to the file INSTALL in the IRC source
 110 files documentation directory.
 111 .LP
 112 BOOTING THE SERVER:  The \fIircd\fP server can be started as part of the
 113 UNIX boot procedure or just by placing the server into Unix Background.
 114 Keep in mind that if it is *not* part of your UNIXES Boot-up procedure
 115 then you will have to manually start the \fIircd\fP server each time your
 116 UNIX is rebooted.  This means if your UNIX is prone to crashing
 117 or going for for repairs a lot it would make sense to start the \fIircd\fP
 118 server as part of your UNIX bootup procedure.  In some cases the \fIirc(1)\fP
 119 will automatically attempt to boot the \fIircd\fP server if the user is
 120 on the SAME UNIX that the \fIircd\fP is supposed to be running on.  If the
 121 \fIirc(1)\fP cannot connect to the \fIircd\fP server it will try to start
 122 the server on it's own and will then try to reconnect to the newly booted
 123 \fIircd\fP server.
 124 .SH EXAMPLE
 125 .RS
 126 .nf
 127 tolsun% \fBircd\fP
 128 .fi
 129 .RE
 130 .LP
 131 Places \fIircd\fP into UNIX Background and starts up the server for use.
 132 Note:  You do not have to add the "&" to this command, the program will
 133 automatically detach itself from tty.
 134 .SH COPYRIGHT
 135 (c) 1988,1989 University of Oulu, Computing Center, Finland,
 136 .LP
 137 (c) 1988,1989 Department of Information Processing Science,
 138 University of Oulu, Finland
 139 .LP
 140 (c) 1988,1989,1990,1991 Jarkko Oikarinen
 141 .LP
 142 For full COPYRIGHT see LICENSE file with IRC package.
 143 .LP
 144 .RE
 145 .SH FILES
 146  /etc/utmp
 147  "irc.conf"
 148 .SH "SEE ALSO"
 149 irc(1)
 150 .SH BUGS
 151 None... ;-) if somebody finds one, please inform author
 152 .SH AUTHOR
 153 Jarkko Oikarinen, currently jto@tolsun.oulu.fi,
 154 manual page written by Jeff Trim, jtrim@orion.cair.du.edu,
 155 later modified by jto@tolsun.oulu.fi.