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