ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/branches/8.2.x/doc/ircd.8
Revision: 9858
Committed: Fri Jan 1 04:43:42 2021 UTC (3 years, 2 months ago) by michael
File size: 4330 byte(s)
Log Message:
- Bump copyright years

File Contents

# Content
1 .\" @(#)ircd.8 7b10 25 Oct 2001
2 .\" $Id$
3 .TH IRCD 8 "2021-01-01" "ircd-hybrid"
4 .SH NAME
5 ircd \- ircd-hybrid: an advanced, lightweight Internet Relay Chat Daemon
6 .SH SYNOPSIS
7 .hy 0
8 .IP \fBircd\fP
9 [-configfile filename] [-klinefile filename] [-dlinefile filename]
10 [-xlinefile filename] [-resvfile filename] [-logfile filename] [-pidfile filename]
11 [-foreground] [-version] [-help]
12 .SH DESCRIPTION
13 .LP
14 \fIircd\fP is the server (daemon) program for the Internet Relay Chat
15 Program. The \fIircd\fP is a server in that its function is to "serve"
16 the client program \fIirc(1)\fP and other compatible programs with
17 messages and commands. All commands and user messages are passed
18 directly to the \fIircd\fP for processing and relaying to other IRC
19 servers.
20
21 This is \fIircd-hybrid\fP, the highly modified (and hopefully improved)
22 variant of the original \fIircd\fP program by Jarkko Oikarinen.
23 .SH OPTIONS
24 .TP
25 .B \-configfile filename
26 Specifies the ircd.conf file to be used for this \fIircd\fP. The option
27 is used to override the default ircd.conf given at compile time. By default,
28 this is "etc/ircd.conf" within the prefix you installed the \fIircd\fP in.
29 .TP
30 .B \-klinefile filename
31 .TP
32 .B \-dlinefile filename
33 .TP
34 .B \-xlinefile filename
35 .TP
36 .B \-resvfile filename
37 Specifies the database files to be used for D-lines (host bans), K-lines (hostmask bans),
38 X-lines (gecos bans) and RESVs (jupes) which by default are within the var/lib/
39 directory of your installation prefix as dline.db, kline.db, xline.db and resv.db.
40 .TP
41 .B \-logfile filename
42 Specifies an alternative logfile to be used than that specified in include/defaults.h
43 .TP
44 .B \-pidfile filename
45 Specifies the file used by the \fIircd\fP to store its process ID. The option is
46 used to override the default ircd.pid given at compile time.
47 .TP
48 .B \-foreground
49 Makes \fIircd\fP run in the foreground.
50 .TP
51 .B \-version
52 Makes \fIircd\fP print its version and exit.
53 .TP
54 .B \-help
55 Makes \fIircd\fP print available options and exit.
56 .SH USAGE
57 If you plan to connect your IRC server to an existing IRC network,
58 you will need to alter your local IRC configuration file (typically named
59 "ircd.conf") so that it will accept and make connections to other IRC servers.
60 This file contains the hostnames, IP addresses and sometimes passwords
61 for connections to other \fIircds\fP around the world.
62
63 The example reference.conf in the etc/ directory documents itself. Read it
64 carefully or you may expose a risk on your network simply by having your
65 \fIircd\fP running!
66 .LP
67 .SH BOOTING THE SERVER
68 It is sufficient to type \fIircd\fP at the command line to start
69 \fIircd-hybrid\fP into the background. If you wish to run \fIircd\fP in the
70 foreground (perhaps for debugging purposes), use the \fB-foreground\fP
71 parameter.
72
73 The \fIircd-hybrid\fP package in your distribution may ship with an rc-script
74 which handles this for you. In Debian, it is \fB/etc/init.d/ircd-hybrid\fP.
75 .SH EXAMPLE
76 # ircd -configfile /usr/share/ircd/ircd.conf -logfile /var/log/ircd.log
77
78 Starts \fIircd\fP with the config file /usr/share/ircd/ircd.conf and
79 with a log file /var/log/ircd.log. It implicitly forks back to the
80 console -- to prevent this, use \fB-foreground\fP.
81
82 Many of the above paths are hard-coded at compile time in the
83 \fBinclude/defaults.h\fP file, so it may be convenient to edit these to
84 suit your needs before you compile the \fIircd\fP.
85 .SH COPYRIGHT
86 (c) 1988,1989 University of Oulu, Computing Center, Finland,
87 .LP
88 (c) 1988,1989 Department of Information Processing Science,
89 University of Oulu, Finland
90 .LP
91 (c) 1988-1991 Jarkko Oikarinen
92 .LP
93 (c) 1997-2021 ircd-hybrid development team
94 .LP
95 For full COPYRIGHT, see the COPYING file within the IRC source package.
96 .LP
97 .RE
98 .SH BUGS
99 If you find a bug and you have a core file from \fIircd\fP as a result, use a
100 debugger like \fBgdb(1)\fP to process the core file and send a backtrace
101 to \fBbugs@ircd-hybrid.org\fP.
102 .SH AUTHORS
103 irc2.8 and earlier: Jarkko Oikarinen, currently jto@tolsun.oulu.fi.
104 .LP
105 ircd-hybrid: ircd-hybrid development team, bugs@ircd-hybrid.org.
106 .LP
107 Manual page written by Jeff Trim, jtrim@orion.cair.du.edu,
108 later modified by jto@tolsun.oulu.fi.
109 .LP
110 Updated by W. Campbell, wcampbel@botbay.net, Edward Brocklesby,
111 ejb@klamath.uucp.leguin.org.uk, and highly revised by Joshua Kwan
112 (joshk@triplehelix.org) for the Debian distribution.

Properties

Name Value
svn:eol-style native
svn:keywords Id