ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid/branches/8.2.x/doc/ircd.8
Revision: 1156
Committed: Tue Aug 9 20:29:20 2011 UTC (12 years, 7 months ago) by michael
Original Path: ircd-hybrid-8/doc/ircd.8
File size: 4157 byte(s)
Log Message:
- create ircd-hybrid-8 "branch"

File Contents

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

Properties

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