doc/ircd.8

   1 .\" @(#)ircd.8 2.0 (beta version) 29 Mar 1989
   2 .TH IRCD 8 "10 July 2000"
   3 .SH NAME
   4 ircd \- The Undernet Internet Relay Chat Daemon
   5 .SH SYNOPSIS
   6 .hy 0
   7 .IP \fBircd\fP
   8 [-t] [-d directory] [-f configfile] [-x debuglevel] [-h hostname]
   9 .SH DESCRIPTION
  10 .LP
  11 \fIircd\fP is the Undernet Internet Relay Chat daemon.
  12 \fIircd\fP is a server in that its function is to "serve"
  13 the client program \fIirc(1)\fP with messages and commands.  All commands
  14 and user messages are passed directly to \fIircd\fP for processing
  15 and relaying to other servers.  \fIirc(1)\fP depends upon
  16 there being an \fIircd\fP server running somewhere for it to connect to
  17 and thus allow the user to begin talking to other users.
  18 .LP
  19 There are many common clients including ircII, EPIC, and BitchX for UNIX,
  20 mIRC and pIRCh for Windows, and IRCle and Homer for the Macintosh.
  21 .SH OPTIONS
  22 .TP
  23 .B \-d directory
  24 This option tells the server to change to that directory and use
  25 that as a reference point when opening \fIircd.conf\fP and other startup
  26 files.
  27 .TP
  28 .B \-t
  29 Instructs the server run in the foreground and to direct debugging output to
  30 standard output.
  31 .TP
  32 .B \-x#
  33 Defines the debug level for \fIircd\fP. The higher the debug level, the more
  34 messages get directed to debugging file (or standard output if the -t option is
  35 used).
  36 .TP
  37 .B \-w interface
  38 This option is deprecated.  Outgoing connections are bound to the
  39 interface specified in the M: line, and incoming connections are accepted only on
  40 interfaces specified in the P: lines.
  41 .TP
  42 .B \-f filename
  43 Specifies the \fIircd.conf\fP file to be used for this server. The option
  44 is used to override the default \fIircd.conf\fP given at compile time.
  45 .TP
  46 .B \-c
  47 This flag must be given if you are running \fIircd\fP from \fI/dev/console\fP or
  48 any other situation where fd 0 isn't a TTY and you want the server to fork
  49 off and run in the background. This needs to be given if you are starting
  50 \fIircd\fP from an \fIrc\fP (such as \fI/etc/rc.local\fP) file.
  51 .TP
  52 .B \-h hostname
  53 Allows the user to manually set the server name at startup. The default
  54 name is hostname.domainname.
  55 .TP
  56 .B \-p portname
  57 This is deprecated in favor of specifying server ports in P: lines.
  58
  59 .SH CONFIGURATION
  60 If you plan to connect your \fIircd\fP server to an existing IRC network,
  61 you will need to alter your local \fIircd\fP configuration file (typically named
  62 \fIircd.conf\fP) so that it will accept and make connections to other IRC
  63 servers.  This file contains the hostnames, network addresses, and
  64 passwords for connections to other IRC servers around the world.  Because
  65 the description of the \fIircd.conf\fP file is beyond the scope of this
  66 document, please refer to the INSTALL file in the \fIircd\fP
  67 documentation directory.
  68 .LP
  69 BOOTING THE SERVER:  The \fIircd\fP server can be started as part of the
  70 UNIX boot procedure or just by placing the server into Unix Background.
  71 Keep in mind that if it is *not* part of your UNIXES Boot-up procedure
  72 then you will have to manually start the \fIircd\fP server each time your
  73 UNIX is rebooted.  This means if your UNIX is prone to crashing
  74 or going for for repairs a lot it would make sense to start the \fIircd\fP
  75 server as part of your UNIX bootup procedure.  In some cases the \fIirc(1)\fP
  76 will automatically attempt to boot the \fIircd\fP server if the user is
  77 on the SAME UNIX that the \fIircd\fP is supposed to be running on.  If the
  78 \fIirc(1)\fP cannot connect to the \fIircd\fP server it will try to start
  79 the server on it's own and will then try to reconnect to the newly booted
  80 \fIircd\fP server.
  81 .SH EXAMPLE
  82 .RS
  83 .nf
  84 tolsun% \fBircd\fP
  85 .fi
  86 .RE
  87 .LP
  88 Places \fIircd\fP into UNIX Background and starts up the server for use.
  89 Note:  You do not have to add the "&" to this command, the program will
  90 automatically detach itself from tty.
  91 .SH COPYRIGHT
  92 (c) 1988,1989 University of Oulu, Computing Center, Finland,
  93 .LP
  94 (c) 1988,1989 Department of Information Processing Science,
  95 University of Oulu, Finland
  96 .LP
  97 (c) 1988,1989,1990,1991 Jarkko Oikarinen
  98 .LP
  99 For full COPYRIGHT see LICENSE file with IRC package.
 100 .LP
 101 .RE
 102 .SH FILES
 103  /etc/utmp
 104  "ircd.conf"
 105 .SH "SEE ALSO"
 106 irc(1)
 107 .SH BUGS
 108 See the file 'BUGS' included in the distribution.
 109 .SH AUTHOR
 110 The current authors of the undernet IRC daemon are coder-com@undernet.org,
 111 the original author was Jarkko Oikarinen.