1IRCD(8)                     System Manager's Manual                    IRCD(8)
2
3
4

NAME

6       ircd - The IRCD-Hybrid Internet Relay Chat server
7

SYNOPSIS

9       ircd   [-configfile   filename]   [-dlinefile   filename]   [-klinefile
10              filename] [-xlinefile filename]  [-logfile  filename]  [-pidfile
11              filename] [-foreground] [-version]
12

DESCRIPTION

14       ircd  is  the  server  (daemon)  program  for  the  Internet Relay Chat
15       Program.  The ircd is a server in that its function is to  "serve"  the
16       client  program  irc(1) and other compatible programs with messages and
17       commands.  All commands and user messages are passed  directly  to  the
18       ircd for processing and relaying to other IRC servers.
19
20       This  is  ircd-hybrid,  the  highly  modified  (and hopefully improved)
21       variant of the original ircd program by Jarkko Oikarinen.
22

OPTIONS

24       -configfile filename
25              Specifies the ircd.conf file to  be  used  for  this  ircd.  The
26              option  is  used  to  override  the  default  ircd.conf given at
27              compile time. By default, this  is  "etc/ircd.conf"  within  the
28              prefix you installed the ircd in.
29
30       -dlinefile filename
31
32       -klinefile filename
33
34       -xlinefile filename
35              Specifies  the files to be used for D-lines (host bans), K-lines
36              (hostmask bans), and X-lines (gecos bans), which by default  are
37              within  the  etc/  directory  of  your  installation  prefix  as
38              dline.conf, kline.conf, and xline.conf.
39
40       -logfile filename
41              Specifies an alternative logfile to be used than that  specified
42              in defaults.h
43
44       -pidfile filename
45              Specifies the file used by the ircd to store its process ID. The
46              option is used to override the default ircd.pid given at compile
47              time.
48
49       -foreground
50              Makes ircd run in the foreground
51
52       -version
53              Makes ircd print its version, and exit.
54

USAGE

56       If you plan to connect your ircd server to an existing IRC network, you
57       will need to alter your local IRC configuration file  (typically  named
58       "ircd.conf")  so  that it will accept and make connections to other IRC
59       servers.  This file contains the hostnames, IP addresses, and sometimes
60       passwords for connections to other ircds around the world.
61
62       The  example  ircd.conf in the etc/ directory documents itself. Read it
63       carefully or you may expose a risk on your  network  simply  by  having
64       your ircd running!
65

BOOTING THE SERVER

67       It  is sufficient to type ircd at the command line to start ircd-hybrid
68       into the background. If you wish to run ircd in the foreground (perhaps
69       for debugging purposes), use the -foreground parameter.
70
71       The ircd-hybrid package in your distribution may ship with an rc-script
72       which handles this for you. In Debian, it is /etc/init.d/ircd-hybrid.
73
74

EXAMPLE

76       # ircd -configfile /usr/share/ircd/ircd.conf -logfile /var/log/ircd.log
77
78       Starts ircd with the config file /usr/share/ircd/ircd.conf and  with  a
79       log  file /var/log/ircd.log. It implicitly forks back to the console --
80       to prevent this use -foreground.
81
82       Many  of  the  above  paths  are  hardcoded  at  compile  time  in  the
83       include/defaults.h  file, so it may be convenient to edit these to suit
84       your needs before you compile the ircd.
85
87       (c) 1988,1989 University of Oulu, Computing Center, Finland,
88
89       (c) 1988,1989 Department of Information Processing Science,  University
90       of Oulu, Finland
91
92       (c) 1988-1991 Jarkko Oikarinen
93
94       (c) 1997-2003 The IRCD-Hybrid project.
95
96       For full COPYRIGHT see the LICENSE file within the IRC source package.
97

BUGS

99       If you find a bug and you have a core file from ircd as a result, use a
100       debugger like gdb(1) to process the core file and send a  backtrace  to
101       bugs@ircd-hybrid.org.
102
103

AUTHORS

105       irc2.8 and earlier: Jarkko Oikarinen, currently jto@tolsun.oulu.fi. See
106       doc/old/Authors for more credits.
107
108       ircd-hybrid-7: the IRCD-Hybrid Project, bugs@ircd-hybrid.org.
109
110       Manual  page  written  by  Jeff  Trim,  jtrim@orion.cair.du.edu,  later
111       modified by jto@tolsun.oulu.fi.
112
113       Updated   by   W.  Campbell,  wcampbel@botbay.net,  Edward  Brocklesby,
114       ejb@klamath.uucp.leguin.org.uk,  and  highly  revised  by  Joshua  Kwan
115       (joshk@triplehelix.org) for the Debian distribution.
116
117
118
119ircd-hybrid-7                     14 May 2003                          IRCD(8)
Impressum