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 If the server was compiled with VIRTUAL_HOST (run 'make config' to toggle
  66 this compile option), then \fIinterface\fP is passed to gethostbyname(3) in
  67 order to retrieve the IP-number of the interface to bind to. An example
  68 would be to use '-w localhost', after which the server only listens on the
  69 loopback interface.  Run `ifconfig -a' to see which interfaces you have.
  70 .TP
  71 .B \-f filename
  72 Specifies the ircd.conf file to be used for this ircdaemon. The option
  73 is used to override the default ircd.conf given at compile time.
  74 .TP
  75 .B \-c
  76 This flag must be given if you are running ircd from \fI/dev/console\fP or
  77 any other situation where fd 0 isnt a tty and you want the server to fork
  78 off and run in the background. This needs to be given if you are starting
  79 \fIircd\fP from an \fIrc\fP (such as \fI/etc/rc.local\fP) file.
  80 .TP
  81 .B \-q
  82 Using the -q option stops the server from doing DNS lookups on all the
  83 servers in your \fIircd.conf\fP file when it boots. This can take a lengthy
  84 amount of time if you have a large number of servers and they are not all
  85 close by.
  86 .TP
  87 .B \-h hostname
  88 Allows the user to manually set the server name at startup. The default
  89 name is hostname.domainname.
  90 .B \-p portname
  91 Specifies the server port where the daemon should start waiting for connections
  92 from other servers. Clients should connect to ports as specified in the ircd.conf file by means of a P: line.
  93 .TP
  94 .SH
  95 If you plan to connect your \fIircd\fP server to an existing Irc-Network,
  96 you will need to alter your local IRC CONFIGURATION FILE (typically named
  97 "ircd.conf") so that it will accept and make connections to other \fIircd\fP
  98 servers.  This file contains the hostnames, Network Addresses, and sometimes
  99 passwords for connections to other ircds around the world.  Because
 100 description of the actual file format of the "ircs.conf" file is beyond the
 101 scope of this document, please refer to the file INSTALL in the IRC source
 102 files documentation directory.
 103 .LP
 104 BOOTING THE SERVER:  The \fIircd\fP server can be started as part of the
 105 UNIX boot procedure or just by placing the server into Unix Background.
 106 Keep in mind that if it is *not* part of your UNIXES Boot-up procedure
 107 then you will have to manually start the \fIircd\fP server each time your
 108 UNIX is rebooted.  This means if your UNIX is prone to crashing
 109 or going for for repairs a lot it would make sense to start the \fIircd\fP
 110 server as part of your UNIX bootup procedure.  In some cases the \fIirc(1)\fP
 111 will automatically attempt to boot the \fIircd\fP server if the user is
 112 on the SAME UNIX that the \fIircd\fP is supposed to be running on.  If the
 113 \fIirc(1)\fP cannot connect to the \fIircd\fP server it will try to start
 114 the server on it's own and will then try to reconnect to the newly booted
 115 \fIircd\fP server.
 116 .SH EXAMPLE
 117 .RS
 118 .nf
 119 tolsun% \fBircd\fP
 120 .fi
 121 .RE
 122 .LP
 123 Places \fIircd\fP into UNIX Background and starts up the server for use.
 124 Note:  You do not have to add the "&" to this command, the program will
 125 automatically detach itself from tty.
 126 .SH COPYRIGHT
 127 (c) 1988,1989 University of Oulu, Computing Center, Finland,
 128 .LP
 129 (c) 1988,1989 Department of Information Processing Science,
 130 University of Oulu, Finland
 131 .LP
 132 (c) 1988,1989,1990,1991 Jarkko Oikarinen
 133 .LP
 134 For full COPYRIGHT see LICENSE file with IRC package.
 135 .LP
 136 .RE
 137 .SH FILES
 138  /etc/utmp
 139  "irc.conf"
 140 .SH "SEE ALSO"
 141 irc(1)
 142 .SH BUGS
 143 None... ;-) if somebody finds one, please inform author
 144 .SH AUTHOR
 145 Jarkko Oikarinen, currently jto@tolsun.oulu.fi,
 146 manual page written by Jeff Trim, jtrim@orion.cair.du.edu,
 147 later modified by jto@tolsun.oulu.fi.