doc/ircd.8

   1 .\" @(#)ircd.8 2.0 22 April 2004
   2 .TH IRCD 8 "ircd-ratbox 22 April 2004
   3 .SH NAME
   4 ircd \- The Internet Relay Chat Program Server
   5 .SH SYNOPSIS
   6 .hy 0
   7 .IP \fBircd\fP
   8 [-dlinefile filename] [-configfile filename] [-klinefile filename]
   9 [-logfile filename] [-pidfile filename] [-resvfile filename]
  10 [-xlinefile filename] [-conftest] [-foreground] [-version]
  11 .SH DESCRIPTION
  12 .LP
  13 \fIircd\fP is the server (daemon) program for the Internet Relay Chat
  14 Program.  The \fIircd\fP is a server in that its function is to "serve"
  15 the client program \fIirc(1)\fP with messages and commands.  All commands
  16 and user messages are passed directly to the \fIircd\fP for processing
  17 and relaying to other ircd sites.
  18 .SH OPTIONS
  19 .TP
  20 .B \-dlinefile filename
  21 Specifies the D-line file to be used.  This file is used for both reading
  22 D-lines at startup, and writing to while \fIircd\fP is running.
  23 .TP
  24 .B \-configfile filename
  25 Specifies the ircd.conf file to be used for this ircdaemon. The option
  26 is used to override the default ircd.conf given at compile time.
  27 .TP
  28 .B \-klinefile filename
  29 Specifies the K-line file to be used.  This file is used for both reading
  30 K-lines at startup, and writing to while \fIircd\fP is running.
  31 .TP
  32 .B \-logfile filename
  33 Specifies an alternative logfile to be used than that specified in config.h
  34 .TP
  35 .B \-pidfile filename
  36 Specifies the ircd.pid used. The option is used to override the default
  37 ircd.pid given at compile time.
  38 .TP
  39 .B \-resvfile filename
  40 Specifies the resv.conf file to be used for this ircdaemon. The option
  41 is used to override the default resv.conf given at compile time.
  42 .TP
  43 .B \-xlinefile filename
  44 Specifies the xline.conf file to be used for this ircdaemon. The option
  45 is used to override the default xline.conf given at compile time.
  46 .TP
  47 .B \-conftest
  48 Makes \fIircd\fP check the ircd.conf for errors
  49 .TP
  50 .B \-foreground
  51 Makes \fIircd\fP run in the foreground
  52 .TP
  53 .B \-version
  54 Makes \fIircd\fP print its version, and exit.
  55 .SH USAGE
  56 If you plan to connect your \fIircd\fP server to an existing Irc-Network,
  57 you will need to alter your local IRC configuration file (typically named
  58 "ircd.conf") so that it will accept and make connections to other \fIircd\fP
  59 servers.  This file contains the hostnames, Network Addresses, and sometimes
  60 passwords for connections to other ircds around the world.  Because
  61 description of the actual file format of the "ircd.conf" file is beyond the
  62 scope of this document, please refer to the file INSTALL in the IRC source
  63 files documentation directory.
  64 .LP
  65 .SH BOOTING THE SERVER
  66 The \fIircd\fP server can be started as part of the
  67 Unix boot procedure or just by placing the server into Unix Background.
  68 Keep in mind that if it is \fBnot\fP part of your Unix's boot-up procedure
  69 then you will have to manually start the \fIircd\fP server each time your
  70 Unix is rebooted.  This means if your Unix is prone to crashing
  71 or going for for repairs a lot it would make sense to start the \fIircd\fP
  72 server as part of your UNIX bootup procedure.
  73 .SH EXAMPLE
  74 .RS
  75 .nf
  76 tolsun% \fBbin/ircd\fP
  77 .fi
  78 .RE
  79 .LP
  80 Places \fIircd\fP into Unix background and starts up the server for use.
  81 Note:  You do not have to add the "&" to this command, the program will
  82 automatically detach itself from tty.
  83 .RS
  84 .nf
  85 leguin% \fBbin/ircd -foreground\fP
  86 .fi
  87 .RE
  88 .LP
  89 Runs ircd in the foreground.
  90 .RS
  91 .nf
  92 .SH COPYRIGHT
  93 (c) 1988,1989 University of Oulu, Computing Center, Finland,
  94 .LP
  95 (c) 1988,1989 Department of Information Processing Science,
  96 University of Oulu, Finland
  97 .LP
  98 (c) 1988,1989,1990,1991 Jarkko Oikarinen
  99 .LP
 100 (c) 1997,1998,1999,2000,2001 The IRCD-Hybrid project.
 101 .LP
 102 For full COPYRIGHT see LICENSE file with IRC package.
 103 .LP
 104 .RE
 105 .SH FILES
 106  "ircd.conf"
 107 .SH "SEE ALSO"
 108 ircd.conf(5)
 109 .SH BUGS
 110 None... ;-) if somebody finds one, please inform author
 111 .SH AUTHOR
 112 irc2.8 and earlier: Jarkko Oikarinen, currently jto@tolsun.oulu.fi.
 113 .LP
 114 ircd-hybrid-7: IRCD-Hybrid Project, ircd-hybrid@the-project.org.
 115 .LP
 116 manual page written by Jeff Trim, jtrim@orion.cair.du.edu,
 117 later modified by jto@tolsun.oulu.fi.
 118 .LP
 119 modified for ircd-hybrid-7 by Edward Brocklesby, ejb@klamath.uucp.leguin.org.uk.
 120 .LP
 121 updated by W. Campbell, wcampbel@botbay.net